Module codec

Source

Structs§

AssetInfo
Encoding of an asset type identifier
CoinbasePayload
A coinbase commits to 32 bytes of control-plane information
MinerReward
A record of a coin reward for a miner. There will be at most two of these for a miner: one for the coinbase + block-txs + confirmed-mblock-txs, and one for the produced-mblock-txs. The latter reward only stores the produced-mblock-txs, and is only ever stored if the microblocks are ever confirmed.
MinerRewardInfo
MultisigSpendingCondition
A structure that encodes enough state to authenticate a transaction’s execution against a Stacks address. public_keys + signatures_required determines the Principal. nonce is the “check number” for the Principal.
SinglesigSpendingCondition
StacksBlock
A block that contains blockchain-anchored data (corresponding to a LeaderBlockCommitOp)
StacksBlockHeader
The header for an on-chain-anchored Stacks block
StacksHeaderInfo
StacksMicroblock
A microblock that contains non-blockchain-anchored data, but is tied to an on-chain block
StacksMicroblockHeader
Header structure for a microblock
StacksPublicKeyBuffer
A container for public keys (compressed secp256k1 public keys)
StacksString
printable-ASCII-only string, but encodable. Note that it cannot be longer than ARRAY_MAX_LEN (4.1 billion bytes)
StacksTransaction
StacksTransactionSigner
TenureChangePayload
A transaction from Stackers to signal new mining tenure
ThresholdSignature
Schnorr threshold signature using types from wsts
TokenTransferMemo
TransactionContractCall
A transaction that calls into a smart contract
TransactionSmartContract
A transaction that instantiates a smart contract
Txid

Enums§

AssetInfoID
numeric wire-format ID of an asset info type variant
FungibleConditionCode
MultisigHashMode
NonfungibleConditionCode
PostConditionPrincipal
Post-condition principal.
PostConditionPrincipalID
SinglesigHashMode
TenureChangeCause
Cause of change in mining tenure Depending on cause, tenure can be ended or extended
TransactionAnchorMode
How a transaction may be appended to the Stacks blockchain
TransactionAuth
Types of transaction authorizations
TransactionAuthField
TransactionAuthFieldID
Transaction signatures are validated by calculating the public key from the signature, and verifying that all public keys hash to the signing account’s hash. To do so, we must preserve enough information in the auth structure to recover each public key’s bytes.
TransactionAuthFlags
TransactionPayload
TransactionPayloadID
TransactionPostCondition
Post-condition on a transaction
TransactionPostConditionMode
Post-condition modes for unspecified assets
TransactionPublicKeyEncoding
TransactionSpendingCondition
TransactionVersion
Stacks transaction versions

Constants§

MAX_BLOCK_LEN
MAX_EPOCH_SIZE
MAX_MICROBLOCK_SIZE
MAX_TRANSACTION_LEN
MINER_BLOCK_CONSENSUS_HASH
MINER_BLOCK_HEADER_HASH

Traits§

StacksMessageCodec
Helper trait for various primitive types that make up Stacks messages

Functions§

build_contrat_call_transaction