Skip to content

Commit da01357

Browse files
authored
docs(multisig): document calling requirements (#292)
1 parent a129522 commit da01357

File tree

2 files changed

+14
-4
lines changed

2 files changed

+14
-4
lines changed

contracts/multisig/src/msg.rs

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,11 +44,11 @@ pub enum ExecuteMsg {
4444
to sign their own address using the private key */
4545
signed_sender_address: HexBinary,
4646
},
47-
// Authorizes a contract to call StartSigningSession.
47+
// Authorizes a contract to call StartSigningSession. Callable only by governance
4848
AuthorizeCaller {
4949
contract_address: Addr,
5050
},
51-
// Unauthorizes a contract, so it can no longer call StartSigningSession.
51+
// Unauthorizes a contract, so it can no longer call StartSigningSession. Callable only by governance
5252
UnauthorizeCaller {
5353
contract_address: Addr,
5454
},

doc/src/contracts/multisig.md

+12-2
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,11 @@ SignatureVerifier->>Multisig: returns true/false
9494
deactivate Multisig
9595
```
9696

97+
## Authorization
98+
Prior to calling `StartSigningSession`, the prover contract must first be *authorized*.
99+
For a contract to become authorized, the governance account needs to call `AuthorizeCaller`, and specify the contract address to authorize.
100+
Similarly, the governance account can revoke authorization of a particular contract by calling `UnauthorizeCaller`.
101+
97102
## Interface
98103

99104
```Rust
@@ -108,9 +113,14 @@ pub enum ExecuteMsg {
108113
session_id: Uint64,
109114
signature: HexBinary,
110115
},
116+
RegisterWorkerSet {
117+
worker_set: WorkerSet,
118+
},
119+
// callable only by governance
111120
AuthorizeCaller {
112121
contract_address: Addr,
113122
},
123+
// callable only by governance
114124
UnauthorizeCaller {
115125
contract_address: Addr,
116126
},
@@ -161,11 +171,11 @@ pub enum Event {
161171
worker: Addr,
162172
public_key: PublicKey,
163173
},
164-
// Emitted when a StartSigningSession caller is authorized
174+
// Emitted when a contract is authorized by governance to create signing sessions
165175
CallerAuthorized {
166176
contract_address: Addr,
167177
},
168-
// Emitted when a StartSigningSession caller is unauthorized
178+
// Emitted when a contract is unauthorized by governance to create signing sessions
169179
CallerUnauthorized {
170180
contract_address: Addr,
171181
},

0 commit comments

Comments
 (0)