docs: specs for multisig (#2996)

Closes #736 Note: I played around with multisigs and wrote a script to show their basic functionality but that content seems more appropriate to live at https://docs.celestia.org/ than in the specs. Hence celestiaorg/docs#1351
celestiaorg · Jan 12, 2024 · b04f2d5 · b04f2d5
1 parent ad91a5b
commit b04f2d5
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/specs/src/README.md b/specs/src/README.md
@@ -14,6 +14,7 @@
   - [Public-Key Cryptography](./specs/public_key_cryptography.md)
   - [Data Square Layout](./specs/data_square_layout.md)
   - [Resource Pricing](./specs/resource_pricing.md)
+  - [Multisig](./specs/multisig.md)
 - [State Machine Modules](./specs/state_machine_modules.md)
   - [blob](https://github.com/celestiaorg/celestia-app/blob/main/x/blob/README.md)
   - [blobstream](https://github.com/celestiaorg/celestia-app/blob/main/x/blobstream/README.md)

diff --git a/specs/src/SUMMARY.md b/specs/src/SUMMARY.md
@@ -16,6 +16,7 @@
   - [Public-Key Cryptography](./specs/public_key_cryptography.md)
   - [Data Square Layout](./specs/data_square_layout.md)
   - [Resource Pricing](./specs/resource_pricing.md)
+  - [Multisig](./specs/multisig.md)
 - [State Machine Modules](./specs/state_machine_modules.md)
   - [blob](https://github.com/celestiaorg/celestia-app/blob/main/x/blob/README.md)
   - [blobstream](https://github.com/celestiaorg/celestia-app/blob/main/x/blobstream/README.md)

diff --git a/specs/src/specs/multisig.md b/specs/src/specs/multisig.md
@@ -0,0 +1,15 @@
+# Multisig
+
+Celestia inherits support for Multisig accounts from the Cosmos SDK. Multisig accounts behave similarly to regular accounts with the added requirement that a threshold of signatures is needed to authorize a transaction.
+
+The maximum number of signatures allowed for a multisig account is determined by the [param](./params.md) `auth.TxSigLimit`. The threshold and list of signers for a multisig account are set at the time of creation and can be viewed in the `pubkey` field of a key. For example:
+
+```shell
+$ celestia-appd keys show multisig
+- address: celestia17rehcgutjfra8zhjl8675t8hhw8wsavzzutv06
+  name: multisig
+  pubkey: '{"@type":"/cosmos.crypto.multisig.LegacyAminoPubKey","threshold":2,"public_keys":[{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"AxMTEFDH8oyBPIH+d2MKfCIY1yAsEd0HVekoPaAOiu9c"},{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"Ax0ANkTPWcCDWy9O2TcUXw90Z0DxnX2zqPvhi4VJPUl5"},{"@type":"/cosmos.crypto.secp256k1.PubKey","key":"AlUwWCGLzhclCMEKc2YLEap9H8JT5tWq1kB8BagU1TVH"}]}'
+  type: multi
+```
+
+Please see the [Cosmos SDK docs](https://docs.cosmos.network/main/user/run-node/multisig-guide#step-by-step-guide-to-multisig-transactions) for more information on how to use multisig accounts.