package stacks.signer.v1

Get desktop application:
View/edit binary Protocol Buffers messages

For making a `accept-withdrawal-request` contract call in the sbtc-withdrawal smart contract.

Used in: StacksTransactionSignRequest

• optional QualifiedRequestId id = 1

  The ID of the withdrawal request generated by the `initiate-withdrawal-request` function in the sbtc-withdrawal smart contract along with the transaction ID of the transaction that generated the request and block hash of the Stacks block that confirmed the transaction.

• optional bitcoin.OutPoint outpoint = 2

  The outpoint of the bitcoin UTXO that was spent to fulfill the withdrawal request.

• uint64 tx_fee = 3

  This is the assessed transaction fee for fulfilling the withdrawal request.

• repeated bool signer_bitmap = 4

  A bitmap of how the signers voted. The length of the list must be less than or equal to 128. Here, we assume that a true implies that the associated signer voted *against* the withdrawal.

• optional StacksAddress deployer = 5

  The address that deployed the contract.

• optional bitcoin.BitcoinBlockHash sweep_block_hash = 6

  The block hash of the bitcoin block that contains a sweep transaction with the above `outpoint` as one of its outputs.

• uint64 sweep_block_height = 7

  The block height associated with the above bitcoin block hash.

Represents an acknowledgment of a BitcoinPreSignRequest.

Used in: SignerMessage

(message has no fields)

Information about a new Bitcoin block sign request

Used in: SignerMessage

• repeated TxRequestIds request_package = 1

  The set of sBTC request identifiers. This contains each of the requests for the entire transaction package. Each element in the vector corresponds to the requests that will be included in a single bitcoin transaction.

• double fee_rate = 2

  The current market fee rate in sat/vByte.

• optional Fees last_fees = 3

  The total fee amount and the fee rate for the last transaction that used this UTXO as an input.

For making a `complete-deposit` contract call in the sbtc-deposit smart contract.

Used in: StacksTransactionSignRequest

• optional bitcoin.OutPoint outpoint = 1

  The outpoint of the bitcoin UTXO that was spent as a deposit for sBTC.

• uint64 amount = 2

  The amount of sats swept in by the signers when they moved in the above UTXO.

• optional StacksPrincipal recipient = 3

  The address where the newly minted sBTC will be deposited.

• optional StacksAddress deployer = 4

  The address that deployed the sBTC smart contract containing the complete-deposit contract call.

• optional bitcoin.BitcoinTxid sweep_txid = 5

  The transaction ID for the sweep transaction that moved the deposit UTXO into the signers' UTXO. One of the inputs to the sweep transaction must be the above `outpoint`.

• optional bitcoin.BitcoinBlockHash sweep_block_hash = 6

  The block hash of the bitcoin block that contains a sweep transaction with the above `outpoint` as one of its inputs.

• uint64 sweep_block_height = 7

  The block height associated with the above bitcoin block hash.

Describes the fees for a transaction.

Used in: BitcoinPreSignRequest

• uint64 total = 1

  The total fee paid in sats for the transaction.

• double rate = 2

  The fee rate paid in sats per virtual byte.

An identifier for a withdrawal request, comprised of the Stacks transaction ID, the Stacks block ID that included the transaction, and the request-id generated by the clarity contract for the withdrawal request.

Used in: AcceptWithdrawal, RejectWithdrawal, TxRequestIds

• uint64 request_id = 1

  The ID that was generated in the clarity contract call for the withdrawal request.

• optional StacksTxid txid = 2

  The txid that generated the request.

• optional StacksBlockId block_hash = 3

  The Stacks block ID that includes the transaction that generated the request.

For making a `reject-withdrawal-request` contract call in the sbtc-withdrawal smart contract.

Used in: StacksTransactionSignRequest

• optional QualifiedRequestId id = 1

  The ID of the withdrawal request generated by the `initiate-withdrawal-request` function in the sbtc-withdrawal smart contract along with the transaction ID of the transaction that generated the request and block hash of the Stacks block that confirmed the transaction.

• repeated bool signer_bitmap = 2

  A bitmap of how the signers voted. The length of the list must be less than or equal to 128. Here, we assume that a true implies that the associated signer voted *against* the withdrawal.

• optional StacksAddress deployer = 3

  The address that deployed the smart contract.

For making a `rotate-keys-wrapper` contract call in the `sbtc-bootstrap-signers` smart contract.

Used in: StacksTransactionSignRequest

• repeated crypto.PublicKey new_keys = 1

  The new set of public keys for all known signers during this PoX cycle.

• optional crypto.PublicKey aggregate_key = 2

  The aggregate key created by combining the above public keys.

• optional StacksAddress deployer = 3

  The address that deployed the contract.

• uint32 signatures_required = 4

  The number of signatures required for the multi-sig wallet.

Wraps an inner type with a public key and a signature, allowing easy verification of the integrity of the inner data.

• optional crypto.EcdsaSignature signature = 1

  A signature over the hash of the inner structure.

• optional crypto.PublicKey signer_public_key = 2

  The public key of the signer that generated the signature.

• optional SignerMessage signer_message = 3

  The signed structure.

Represents a decision to accept or reject a deposit request.

Used in: SignerMessage

• optional bitcoin.OutPoint outpoint = 1

  The bitcoin outpoint that uniquely identifies the deposit request.

• bool can_accept = 2

  This specifies whether the sending signer's blocklist client blocked the deposit request. `true` here means the blocklist client did not block the request.

• bool can_sign = 3

  This specifies whether the sending signer can provide signature shares for the associated deposit request.

Messages exchanged between signers

Used in: Signed

• optional bitcoin.BitcoinBlockHash bitcoin_chain_tip = 1

  / The bitcoin chain tip defining the signers view of the blockchain at the time the message was created

• oneof payload

  The message payload

  • SignerDepositDecision signer_deposit_decision = 2

    / A decision related to signer deposit

  • SignerWithdrawalDecision signer_withdrawal_decision = 3

    A decision related to signer withdrawal

  • StacksTransactionSignRequest stacks_transaction_sign_request = 4

    A request to sign a Stacks transaction

  • StacksTransactionSignature stacks_transaction_signature = 5

    A signature of a Stacks transaction

  • WstsMessage wsts_message = 8

    Contains all variants for DKG and WSTS signing rounds

  • BitcoinPreSignRequest bitcoin_pre_sign_request = 10

    Information about a new sweep transaction

  • BitcoinPreSignAck bitcoin_pre_sign_ack = 11

    Represents an acknowledgment of a BitcoinPreSignRequest

Represents a decision to accept or reject a withdrawal request.

Used in: SignerMessage

• uint64 request_id = 1

  ID of the withdraw request.

• optional StacksBlockId block_id = 2

  The Stacks block ID of the Stacks block containing the request. It must be 32 bytes.

• optional StacksTxid txid = 3

  The stacks transaction ID that lead to the creation of the withdrawal request.

• bool accepted = 4

  Whether or not the signer has accepted the withdrawal request.

Used in: StacksTransactionSignRequest

• SMART_CONTRACT_UNSPECIFIED = 0

• SMART_CONTRACT_SBTC_REGISTRY = 1

  The sbtc-registry contract. This contract needs to be deployed before any other contract.

• SMART_CONTRACT_SBTC_TOKEN = 2

  The sbtc-token contract. This contract needs to be deployed right after the sbtc-registry contract.

• SMART_CONTRACT_SBTC_DEPOSIT = 3

  The sbtc-deposit contract. Can be deployed after the sbtc-token contract.

• SMART_CONTRACT_SBTC_WITHDRAWAL = 4

  The sbtc-withdrawal contract. Can be deployed after the sbtc-token contract.

• SMART_CONTRACT_SBTC_BOOTSTRAP = 5

  The sbtc-bootstrap-signers contract. Can be deployed after the sbtc-token contract.

Represents a request to sign a Stacks transaction.

Used in: SignerMessage

• optional crypto.PublicKey aggregate_key = 1

  This is the bitcoin aggregate key that was output from DKG. It is used to identify the signing set for the transaction.

• uint64 nonce = 2

  The nonce to use for the transaction.

• uint64 tx_fee = 3

  The transaction fee in microSTX.

• optional StacksTxid txid = 4

  The transaction ID of the associated contract call transaction.

• oneof contract_tx

  The contract transaction to sign.

  • CompleteDeposit complete_deposit = 5

    The `complete-deposit` contract call

  • AcceptWithdrawal accept_withdrawal = 6

    The `accept-withdrawal-request` contract call

  • RejectWithdrawal reject_withdrawal = 7

    The `reject-withdrawal-request` contract call

  • RotateKeys rotate_keys = 8

    The `rotate-keys-wrapper` contract call

  • SmartContract smart_contract = 9

    Ssmart contract deployment

Represents a signature of a Stacks transaction.

Used in: SignerMessage

• optional StacksTxid txid = 1

  Id of the signed transaction.

• optional crypto.RecoverableSignature signature = 2

  A recoverable ECDSA signature over the transaction.

This type is a container for all deposits and withdrawals that are part of a transaction package.

Used in: BitcoinPreSignRequest

• repeated bitcoin.OutPoint deposits = 1

  The deposit requests associated with the inputs in the transaction.

• repeated QualifiedRequestId withdrawals = 2

  The withdrawal requests associated with the outputs in the current transaction.

A wsts message.

Used in: SignerMessage

• oneof inner

  The wsts message

  • crypto.wsts.DkgBegin dkg_begin = 2

    Tell signers to begin DKG by sending DKG public shares

  • crypto.wsts.SignerDkgPublicShares signer_dkg_public_shares = 3

    Send DKG public shares

  • crypto.wsts.DkgPrivateBegin dkg_private_begin = 4

    Tell signers to send DKG private shares

  • crypto.wsts.DkgPrivateShares dkg_private_shares = 5

    Send DKG private shares

  • crypto.wsts.DkgEndBegin dkg_end_begin = 6

    Tell signers to compute shares and send DKG end

  • crypto.wsts.DkgEnd dkg_end = 7

    Tell coordinator that DKG is complete

  • crypto.wsts.NonceRequest nonce_request = 8

    Tell signers to send signing nonces

  • crypto.wsts.NonceResponse nonce_response = 9

    Tell coordinator signing nonces

  • crypto.wsts.SignatureShareRequest signature_share_request = 10

    Tell signers to construct signature shares

  • crypto.wsts.SignatureShareResponse signature_share_response = 11

    Tell coordinator signature shares

• oneof id

  • bitcoin.BitcoinTxid sweep = 12

    If this WSTS message is related to a Bitcoin signing round, this field will be set to the related Bitcoin transaction ID.

  • crypto.PublicKey dkg_verification = 13

    If this WSTS message is related to a rotate-keys transaction, this field will be set to the _new_ aggregate public key being verified.

  • crypto.Uint256 dkg = 14

    If this WSTS message is related to a DKG round, this field will be set to the 32-byte id determined based on the coordinator public key and block hash, set by the coordinator.