Skip to content

Commit

Permalink
spec: clean up file organization in protocol spec
Browse files Browse the repository at this point in the history
This breaks links; we don't currently have a way to check that automatically,
fixing that is next up.
  • Loading branch information
hdevalence committed Mar 11, 2024
1 parent 75f21c1 commit 10919e6
Show file tree
Hide file tree
Showing 32 changed files with 35 additions and 49 deletions.
50 changes: 25 additions & 25 deletions docs/protocol/src/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,7 @@
- [Notes, Nullifiers, and Trees](./concepts/notes_nullifiers_trees.md)
- [Transactions](./concepts/transactions.md)
- [Governance](./concepts/governance.md)
- [Cryptographic Protocol](./protocol.md)
- [Cryptographic Primitives](./crypto.md)
- [Cryptographic Primitives](./crypto.md)
- [Proving Considerations](./crypto/proofs.md)
- [The `decaf377` group](./crypto/decaf377.md)
- [Costs and Alternatives](./crypto/decaf377/costs.md)
Expand All @@ -34,39 +33,38 @@
- [The `eddy` construction](./crypto/flow/eddy.md)
- [Distributed Key Generation](./crypto/flow-encryption/dkg.md)
- [Homomorphic Threshold Encryption](./crypto/flow-encryption/threshold-encryption.md)
- [Flow Encryption and Consensus](./protocol/flow-consensus.md)
- [Flow Encryption and Consensus](./crypto/flow-encryption/flow-consensus.md)
- [Groth 16 Setup Ceremony](./setup.md)
- [Groth16 Recap](./setup/groth16_recap.md)
- [Discrete Logarithm Proofs](./setup/dlog_proofs.md)
- [Contributions](./setup/contributions.md)
- [Addresses and Keys](./protocol/addresses_keys.md)
- [Spending Keys](./protocol/addresses_keys/spend_key.md)
- [Viewing Keys](./protocol/addresses_keys/viewing_keys.md)
- [Addresses and Detection Keys](./protocol/addresses_keys/addresses.md)
- [Payload Keys](./protocol/transaction_crypto.md)
- [Addresses and Keys](./addresses_keys.md)
- [Spending Keys](./addresses_keys/spend_key.md)
- [Viewing Keys](./addresses_keys/viewing_keys.md)
- [Addresses and Detection Keys](./addresses_keys/addresses.md)
- [Payload Keys](./addresses_keys/transaction_crypto.md)
- [State Commitment Tree](./sct.md)
- [Tiered Commitment Tree](./sct/tct.md)
- [Nullifiers](./protocol/notes/nullifiers.md)
- [Asset Model](./assets.md)
- [Nullifiers](./sct/nullifiers.md)
- [Assets and Values](./assets.md)
- [Transaction Model](./transactions.md)
- [Transaction Signing](./transactions/signing.md)
- [Action Reference](./transactions/actions.md)
- [Multi-Asset Shielded Pool](./shielded_pool.md)
- [Note Plaintexts](./protocol/notes/note_plaintexts.md)
- [Note Commitments](./protocol/notes/note_commitments.md)
- [Note Ciphertexts](./protocol/notes/note_ciphertexts.md)
- [Note Plaintexts](./shielded_pool/note_plaintexts.md)
- [Note Commitments](./shielded_pool/note_commitments.md)
- [Note Ciphertexts](./shielded_pool/note_ciphertexts.md)
- [Transaction Actions](./shielded_pool/action.md)
- [`Spend`](./protocol/action_descriptions/spend.md)
- [`Output`](./protocol/action_descriptions/outputs.md)
- [Decentralized Exchange](./zswap.md)
- [Sealed-Bid Batch Swaps](./zswap/swap.md)
- [Concentrated Liquidity](./zswap/concentrated_liquidity.md)
- [LPNFTs](./zswap/lpnft.md)
- [`Spend`](./shielded_pool/action/spend.md)
- [`Output`](./shielded_pool/action/output.md)
- [Decentralized Exchange](./dex.md)
- [Sealed-Bid Batch Swaps](./dex/swap.md)
- [Concentrated Liquidity](./dex/concentrated_liquidity.md)
- [LPNFTs](./dex/lpnft.md)
- [On-Chain Routing](./dex/routing.md)
- [Liquidity Compensation](./zswap/liquidity_compensation.md)
- [Transaction Actions](./dex/actions.md)
- [`Swap`](./protocol/action_descriptions/swap.md)
- [`SwapClaim`](./protocol/action_descriptions/swap_claim.md)
- [Transaction Actions](./dex/action.md)
- [`Swap`](./dex/action/swap.md)
- [`SwapClaim`](./dex/action/swap_claim.md)
- [`Position` Actions](./dex/actions/position.md)
- [Staking and Delegation](./stake.md)
- [Staking Tokens](./stake/tokens.md)
Expand All @@ -79,9 +77,11 @@
- [Transaction Actions](./stake/action.md)
- [`Delegate`](./stake/action/delegate.md)
- [`Undelegate`](./stake/action/undelegate.md)
- [`UndelegateClaim`](./protocol/action_descriptions/undelegate_claim.md)
- [`UndelegateClaim`](./stake/action/undelegate_claim.md)
- [Governance](./governance.md)
- [Transaction Actions](./governance/action.md)
- [`DelegatorVote`](./protocol/action_descriptions/delegator_vote.md)
- [`DelegatorVote`](./governance/action/delegator_vote.md)
- [IBC Integration](./ibc.md)
- [Transaction Actions](./ibc/action.md)
- [`IbcRelay`](./ibc/action/ibc_relay.md)
- [`Ics20Withdrawal`](./ibc/action/ics20_withdrawal.md)
File renamed without changes.
4 changes: 2 additions & 2 deletions docs/protocol/src/assets.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Asset Model
# Assets and Values

Penumbra can record arbitrary assets. These assets either originate on Penumbra
itself, or, more commonly, originate on other IBC-connected chains. To record
Expand All @@ -10,7 +10,7 @@ context.

To be precise, we define:

- an *amount* to be an untyped `u64` quantity of some asset;
- an *amount* to be an untyped `u128` quantity of some asset;
- an *asset ID* to be an $\mathbb F_q$ element;
- a *value* to be a typed quantity, i.e., an amount and an asset ID.

Expand Down
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions docs/protocol/src/dex/action/position.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Position Actions
File renamed without changes.
File renamed without changes.
File renamed without changes.
File renamed without changes.
1 change: 1 addition & 0 deletions docs/protocol/src/ibc/action/ibc_relay.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# IbcRelay
1 change: 1 addition & 0 deletions docs/protocol/src/ibc/action/ics20_withdrawal.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
# Ics20Withdrawal
16 changes: 0 additions & 16 deletions docs/protocol/src/protocol.md

This file was deleted.

5 changes: 0 additions & 5 deletions docs/protocol/src/protocol/action_descriptions.md

This file was deleted.

Empty file.
File renamed without changes.
5 changes: 5 additions & 0 deletions docs/protocol/src/shielded_pool/action.md
Original file line number Diff line number Diff line change
@@ -1 +1,6 @@
# Transaction Actions

The shielded pool component defines the following actions:

- [`core.component.shielded_pool.v1.Spend`](./action/spend.md)
- [`core.component.shielded_pool.v1.Output`](./action/output.md)
1 change: 0 additions & 1 deletion docs/protocol/src/zswap/liquidity_compensation.md

This file was deleted.

0 comments on commit 10919e6

Please sign in to comment.