Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: DeclareV3Common, DeployAccountV3, InvokeV3, TransactionInBlock.DeclareV0WithoutClass, TransactionInBlock.DeclareV1WithoutClass, TransactionInBlock.DeclareV2WithoutClass, TransactionInBlock.DeployAccountV1, TransactionInBlock.InvokeV0, TransactionInBlock.InvokeV1

• repeated Felt252 parts = 1

Used in: ContractDiff, DeclareV3Common, InvokeV3, L1HandlerV0, ProposalInit, SignedBlockHeader, TransactionInBlock.DeclareV0WithoutClass, TransactionInBlock.DeclareV1WithoutClass, TransactionInBlock.DeclareV2WithoutClass, TransactionInBlock.InvokeV0, TransactionInBlock.InvokeV1, Vote

• bytes elements = 1

• optional Iteration iteration = 1

Responses are sent ordered by the order given in the request.

Used in: NewBlock

• oneof header_message

  • SignedBlockHeader header = 1

  • Fin fin = 2

    Fin is sent after the peer sent all the data or when it encountered a block that it doesn't have its header.

Used in: NewBlock

• uint64 number = 1

• optional Hash header = 2

• repeated bytes proof = 1

Used in: Class

• string abi = 1

• repeated EntryPoint externals = 2

• repeated EntryPoint l1_handlers = 3

• repeated EntryPoint constructors = 4

• string program = 5

  Compressed in base64 representation.

Used in: Class, DeclareV3WithClass

• string abi = 1

• optional Cairo1EntryPoints entry_points = 2

• repeated Felt252 program = 3

• string contract_class_version = 4

Used in: Cairo1Class

• repeated SierraEntryPoint externals = 1

• repeated SierraEntryPoint l1_handlers = 2

• repeated SierraEntryPoint constructors = 3

Used in: StarkAuthentication

• optional Felt252 operational_public_key = 1

• bytes challenge = 2

  Exactly 16 bytes.

Used in: ClassesResponse

• oneof class

  • Cairo0Class cairo0 = 1

  • Cairo1Class cairo1 = 2

• uint32 domain = 3

• optional Hash class_hash = 4

• optional Iteration iteration = 1

Responses are sent ordered by the order given in the request.

• oneof class_message

  • Class class = 1

  • Fin fin = 2

    Fin is sent after the peer sent all the data or when it encountered a block that it doesn't have its classes.

Used in: ProposalFinPayload

• optional Felt252 concatenated_counts = 1

• optional Hash parent_commitment = 2

• optional Hash transaction_commitment = 3

• optional Hash event_commitment = 4

• optional Hash receipt_commitment = 5

Used in: SignedBlockHeader

• optional Felt252 r = 1

• optional Felt252 s = 2

Contains all transaction types that can be in a new block: - User transactions (same types as MempoolTransaction: Declare, DeployAccount, Invoke) - L1Handler transactions (messages from L1, not propagated via mempool)

Used in: TransactionBatch

• oneof txn

  • DeclareV3WithClass declare_v3 = 1

  • DeployAccountV3 deploy_account_v3 = 2

  • InvokeV3WithProof invoke_v3 = 3

  • L1HandlerV0 l1_handler = 4

• optional Hash transaction_hash = 5

Used in: StateDiffsResponse

• optional Address address = 1

• optional Felt252 nonce = 2

  Present only if the nonce was updated

• optional Hash class_hash = 3

  Present only if the contract was deployed or replaced in this block.

• repeated ContractStoredValue values = 4

• VolitionDomain domain = 5

optimized for flat storage, not through a trie (not sharing key prefixes)

Used in: ContractDiff

• optional Felt252 key = 1

• optional Felt252 value = 2

Used in: DeclareV3WithClass, TransactionInBlock.DeclareV3WithoutClass

• optional Address sender = 1

• optional AccountSignature signature = 2

• optional Felt252 nonce = 4

• optional Hash compiled_class_hash = 5

• optional ResourceBounds resource_bounds = 6

• uint64 tip = 7

• repeated Felt252 paymaster_data = 8

• repeated Felt252 account_deployment_data = 9

• VolitionDomain nonce_data_availability_mode = 10

• VolitionDomain fee_data_availability_mode = 11

Used in: ConsensusTransaction, MempoolTransaction

• optional DeclareV3Common common = 1

• optional Cairo1Class class = 2

Used in: StateDiffsResponse

• optional Hash class_hash = 1

• optional Hash compiled_class_hash = 2

  Present only if the class is Cairo1

see https://external.integration.starknet.io/feeder_gateway/get_transaction?transactionHash=0x29fd7881f14380842414cdfdd8d6c0b1f2174f8916edcfeb1ede1eb26ac3ef0

Used in: ConsensusTransaction, MempoolTransaction, TransactionInBlock

• optional AccountSignature signature = 1

• optional Hash class_hash = 2

• optional Felt252 nonce = 3

• optional Felt252 address_salt = 4

• repeated Felt252 calldata = 5

• optional ResourceBounds resource_bounds = 6

• uint64 tip = 7

• repeated Felt252 paymaster_data = 8

• VolitionDomain nonce_data_availability_mode = 9

• VolitionDomain fee_data_availability_mode = 10

Used in: Cairo0Class

• optional Felt252 selector = 1

• uint64 offset = 2

Used in: MessageToL1

• bytes elements = 1

Used in: EventsResponse

• optional Hash transaction_hash = 1

• optional Felt252 from_address = 3

• repeated Felt252 keys = 4

• repeated Felt252 data = 5

• optional Iteration iteration = 1

Responses are sent ordered by the order given in the request.

• oneof event_message

  • Event event = 1

  • Fin fin = 2

    Fin is sent after the peer sent all the data or when it encountered a block that it doesn't have its events.

Used in: AccountSignature, Cairo1Class, ChallengeAndIdentity, CommitmentParts, ConsensusSignature, ContractDiff, ContractStoredValue, DeclareV3Common, DeployAccountV3, EntryPoint, Event, InvokeV3, L1HandlerV0, MessageToL1, Receipt.Common, Receipt.Deploy, Receipt.DeployAccount, ResourceLimits, SierraEntryPoint, Signature, TransactionInBlock.DeclareV0WithoutClass, TransactionInBlock.DeclareV1WithoutClass, TransactionInBlock.DeclareV2WithoutClass, TransactionInBlock.Deploy, TransactionInBlock.DeployAccountV1, TransactionInBlock.InvokeV0, TransactionInBlock.InvokeV1

• bytes elements = 1

mark the end of a stream of messages

Used in: BlockHeadersResponse, ClassesResponse, EventsResponse, StateDiffsResponse, StreamMessage, TransactionsResponse

(message has no fields)

A hash value representable as a Felt252

Used in: BlockID, Class, CommitmentParts, ConsensusTransaction, ContractDiff, DeclareV3Common, DeclaredClass, DeployAccountV3, Event, Hashes, Iteration, MempoolTransaction, Patricia, ProposalFin, ProposalInit, SignedBlockHeader, StateDiffCommitment, TransactionInBlock, TransactionInBlock.DeclareV0WithoutClass, TransactionInBlock.DeclareV1WithoutClass, TransactionInBlock.DeclareV2WithoutClass, TransactionInBlock.DeclareV3WithoutClass, TransactionInBlock.Deploy, TransactionInBlock.DeployAccountV1, Vote

• bytes elements = 1

A 256 bit hash value (like Keccak256)

Used in: MerkleProof, PropellerUnit, Receipt.L1Handler

• bytes elements = 1

  Required to be 32 bytes long

Used in: Vote

• repeated Hash items = 1

see https://external.integration.starknet.io/feeder_gateway/get_transaction?transactionHash=0x41906f1c314cca5f43170ea75d3b1904196a10101190d2b12a41cc61cfd17c An invoke V3 transaction without client-side proof (only contains proof_facts).

Used in: InvokeV3WithProof, TransactionInBlock

• optional Address sender = 1

• optional AccountSignature signature = 2

• repeated Felt252 calldata = 3

• optional ResourceBounds resource_bounds = 4

• uint64 tip = 5

• repeated Felt252 paymaster_data = 6

• repeated Felt252 account_deployment_data = 7

• VolitionDomain nonce_data_availability_mode = 8

• VolitionDomain fee_data_availability_mode = 9

• optional Felt252 nonce = 10

• repeated Felt252 proof_facts = 11

An invoke V3 transaction with client-side proof. Used in consensus and mempool contexts where proof is included.

Used in: ConsensusTransaction, MempoolTransaction

• optional InvokeV3 invoke = 1

• bytes proof = 2

Used in: BlockHeadersRequest, ClassesRequest, EventsRequest, StateDiffsRequest, TransactionsRequest

• oneof start

  • uint64 block_number = 1

  • Hash header = 2

• Iteration.Direction direction = 3

• uint64 limit = 4

• uint64 step = 5

  to allow interleaving from several nodes

Used in: Iteration

• Forward = 0

• Backward = 1

Used in: ProposalInit, SignedBlockHeader

• Calldata = 0

• Blob = 1

Used in: ConsensusTransaction, TransactionInBlock

• optional Felt252 nonce = 1

• optional Address address = 2

• optional Felt252 entry_point_selector = 3

• repeated Felt252 calldata = 4

L2 gas info for the block (next price and gas used).

Used in: ProposalFinPayload

• optional Uint128 next_l2_gas_price_fri = 1

• uint64 l2_gas_used = 2

Doesn't contain L1Handler, as those don't need to be propagated and can be downloaded from L1.

Used in: MempoolTransactionBatch

• oneof txn

  • DeclareV3WithClass declare_v3 = 1

  • DeployAccountV3 deploy_account_v3 = 2

  • InvokeV3WithProof invoke_v3 = 3

• optional Hash transaction_hash = 4

• repeated MempoolTransaction transactions = 1

A Merkle proof consisting of sibling hashes used to verify that a leaf belongs to a Merkle tree. Each sibling hash is 32 bytes (SHA-256). The siblings are ordered from leaf level to root level.

Used in: PropellerUnit

• repeated Hash256 siblings = 1

  The sibling hashes needed to reconstruct the path from the leaf to the root. Each hash is 32 bytes.

Used in: Receipt.Common

• optional Felt252 from_address = 2

• repeated Felt252 payload = 3

• optional EthereumAddress to_address = 4

sent to all peers (except the ones this was received from, if any). for a fraction of peers, also send the GetBlockHeaders response (as if they asked for it for this block)

• oneof maybe_full

  • BlockID id = 1

  • BlockHeadersResponse header = 2

Used in: SignedBlockHeader

• uint64 n_leaves = 1

  needed to know the height, so as to how many nodes to expect in a proof.

• optional Hash root = 2

  and also when receiving all leaves, how many to expect

Used in: PropellerUnit

• bytes id = 1

Used in: Receipt.Common

• Wei = 0

• Fri = 1

A single unit in the Propeller protocol containing shards of erasure-coded data along with cryptographic proofs for verification.

Used in: PropellerUnitBatch

• optional ShardsOfPeer shards = 1

  The shards assigned to this unit's peer.

• uint64 index = 2

  The position of this unit in the erasure coding scheme.

• optional Hash256 merkle_root = 3

  The Merkle root of all units, used to verify unit integrity.

• optional MerkleProof merkle_proof = 4

  The Merkle proof that this unit belongs to the tree with the given root.

• optional PeerID publisher = 5

  The peer ID of the original publisher who created and signed this unit.

• bytes signature = 6

  Cryptographic signature from the publisher over the merkle_root.

• optional Hash256 committee_id = 7

  Committee identifier for multiplexing different message streams.

• uint64 nonce = 8

  A strictly increasing number, to avoid replays. Current implementation is nanoseconds since UNIX_EPOCH. TODO(guyn): CRITICAL: protect against replay attacks using this timestamp

A batch of PropellerUnits for efficient transmission.

• repeated PropellerUnit batch = 1

Used in: ProposalPart

• optional Hash proposal_commitment = 1

  Identifies a Starknet block based on the content streamed in the proposal.

• uint64 executed_transaction_count = 2

  Number of executed transactions in the proposal.

• optional ProposalFinPayload fin_payload = 3

Optional payload carried in ProposalFin: commitment parts and L2 gas.

Used in: ProposalFin

• optional CommitmentParts commitment_parts = 1

• optional L2GasInfo l2_gas_info = 2

Used in: ProposalPart

• uint64 height = 1

• uint32 round = 2

• optional uint32 valid_round = 3

• optional Address proposer = 4

• uint64 timestamp = 5

• optional Address builder = 6

• L1DataAvailabilityMode l1_da_mode = 7

• optional Uint128 l2_gas_price_fri = 8

• optional Uint128 l1_gas_price_fri = 9

• optional Uint128 l1_data_gas_price_fri = 10

• optional Uint128 l1_gas_price_wei = 11

• optional Uint128 l1_data_gas_price_wei = 12

• string starknet_version = 13

• optional Hash version_constant_commitment = 14

• optional Uint128 fee_proposal_fri = 15

  Proposer's recommended fee for future blocks. Present iff Starknet version >= V0_14_3.

Network format: 1. First message is ProposalInit (init, includes all block metadata) 2. transactions is sent repeatedly (for non-empty blocks) 3. Last message is ProposalFin

• oneof message

  • ProposalInit init = 1

  • ProposalFin fin = 2

  • TransactionBatch transactions = 3

Used in: TransactionWithReceipt

• oneof type

  • Receipt.Invoke invoke = 1

  • Receipt.L1Handler l1_handler = 2

  • Receipt.Declare declare = 3

  • Receipt.Deploy deprecated_deploy = 4

  • Receipt.DeployAccount deploy_account = 5

Used in: Declare, Deploy, DeployAccount, Invoke, L1Handler

• optional Felt252 actual_fee = 2

• PriceUnit price_unit = 3

• repeated MessageToL1 messages_sent = 4

• optional ExecutionResources execution_resources = 5

• optional string revert_reason = 6

Used in: Receipt

• optional Common common = 1

Used in: Receipt

• optional Common common = 1

• optional Felt252 contract_address = 2

Used in: Receipt

• optional Common common = 1

• optional Felt252 contract_address = 2

Used in: Common

• optional ExecutionResources.BuiltinCounter builtins = 1

• uint32 steps = 2

• uint32 memory_holes = 3

• optional ExecutionResources.GasVector da_gas_consumed = 4

• optional ExecutionResources.GasVector gas_consumed = 5

Used in: ExecutionResources

• uint32 bitwise = 1

• uint32 ecdsa = 2

• uint32 ec_op = 3

• uint32 pedersen = 4

• uint32 range_check = 5

• uint32 poseidon = 6

• uint32 keccak = 7

• uint32 output = 8

  TODO(alonl): add the missing builtins

TODO(alonl): remove GasVector and unsplit gas_consumed and da_gas_consumed

Used in: ExecutionResources

• uint64 l1_gas = 1

• uint64 l1_data_gas = 2

• uint64 l2_gas = 3

Used in: Receipt

• optional Common common = 1

Used in: Receipt

• optional Common common = 1

• optional Hash256 msg_hash = 2

Used in: DeclareV3Common, DeployAccountV3, InvokeV3

• optional ResourceLimits l1_gas = 1

• optional ResourceLimits l1_data_gas = 2

  This can be None only in transactions that don't support l2 gas. Starting from 0.14.0, MempoolTransaction and ConsensusTransaction shouldn't have None here.

• optional ResourceLimits l2_gas = 3

Used in: ResourceBounds

• uint64 max_amount = 1

  TODO(shahak, alonl): figure out if max_amount should be uint64 or Felt252

• optional Felt252 max_price_per_unit = 2

A single erasure-coded fragment of the original message.

Used in: ShardsOfPeer

• bytes data = 1

A collection of shards assigned to a single peer. The proto-encoded bytes of this message are used as Merkle tree leaf data, ensuring cross-language determinism.

Used in: PropellerUnit

• repeated Shard shards = 1

Used in: Cairo1EntryPoints

• uint64 index = 1

• optional Felt252 selector = 2

Used in: StarkAuthentication

• repeated Felt252 signature = 1

Note: commitments may change to be for the previous blocks like comet/tendermint hash of block header sent to L1

Used in: BlockHeadersResponse

• optional Hash block_hash = 1

  For the structure of the block hash, see https://docs.starknet.io/learn/protocol/blocks#block-hash

• optional Hash parent_hash = 2

• uint64 number = 3

  This can be deduced from context. We can consider removing this field.

• uint64 time = 4

  Encoded in Unix time.

• optional Address sequencer_address = 5

• optional Hash state_root = 6

  Patricia root of contract and class patricia tries. Each of those tries are of height 251. Same as in L1. Later more trees will be included

• optional StateDiffCommitment state_diff_commitment = 7

  The state diff commitment returned by the Starknet Feeder Gateway

• optional Patricia transactions = 8

  For more info, see https://community.starknet.io/t/introducing-p2p-authentication-and-mismatch-resolution-in-v0-12-2/97993 The leaves contain a hash of the transaction hash and transaction signature.

  By order of execution. TBD: required? the client can execute (powerful machine) and match state diff

• optional Patricia events = 9

  By order of issuance. TBD: in receipts?

• optional Hash receipts = 10

  By order of issuance. This is a patricia root. No need for length because it's the same length as transactions.

• string protocol_version = 11

  Starknet version

• optional Uint128 l1_gas_price_fri = 12

• optional Uint128 l1_gas_price_wei = 13

• optional Uint128 l1_data_gas_price_fri = 14

• optional Uint128 l1_data_gas_price_wei = 15

• optional Uint128 l2_gas_price_fri = 16

• optional Uint128 l2_gas_price_wei = 17

• uint64 l2_gas_consumed = 18

• optional Uint128 next_l2_gas_price = 19

• L1DataAvailabilityMode l1_data_availability_mode = 20

• repeated ConsensusSignature signatures = 21

  for now, we assume a small consensus, so this fits in 1M. Else, these will be repeated and extracted from this message.

• optional Uint128 fee_proposal_fri = 22

  Proposer's oracle-derived recommended fee. Absent for pre-V0_14_3 blocks. WARNING: this field is currently not part of the block hash, so the value must be trusted.

  can be more explicit here about the signature structure as this is not part of account abstraction

• oneof message

  • ChallengeAndIdentity challenge_and_identity = 1

  • Signature signature = 2

Used in: SignedBlockHeader

• uint64 state_diff_length = 1

• optional Hash root = 2

• optional Iteration iteration = 1

Responses are sent ordered by the order given in the request.

• oneof state_diff_message

  All of the messages related to a block need to be sent before a message from the next block is sent.

  • ContractDiff contract_diff = 1

    Multiple contract diffs for the same contract may appear continuously if the diff is too large or if it's more convenient.

  • DeclaredClass declared_class = 2

  • Fin fin = 3

    Fin is sent after the peer sent all the data or when it encountered a block that it doesn't have its state diff.

• oneof message

  • bytes content = 1

  • Fin fin = 2

• bytes stream_id = 3

• uint64 message_id = 4

Used in: ProposalPart

• repeated ConsensusTransaction transactions = 1

Used in: TransactionWithReceipt

• oneof txn

  • TransactionInBlock.DeclareV0WithoutClass declare_v0 = 1

  • TransactionInBlock.DeclareV1WithoutClass declare_v1 = 2

  • TransactionInBlock.DeclareV2WithoutClass declare_v2 = 3

  • TransactionInBlock.DeclareV3WithoutClass declare_v3 = 4

  • TransactionInBlock.Deploy deploy = 5

  • TransactionInBlock.DeployAccountV1 deploy_account_v1 = 6

  • DeployAccountV3 deploy_account_v3 = 7

  • TransactionInBlock.InvokeV0 invoke_v0 = 8

  • TransactionInBlock.InvokeV1 invoke_v1 = 9

  • InvokeV3 invoke_v3 = 10

  • L1HandlerV0 l1_handler = 11

• optional Hash transaction_hash = 12

Used in: TransactionInBlock

• optional Address sender = 1

• optional Felt252 max_fee = 2

• optional AccountSignature signature = 3

• optional Hash class_hash = 4

Used in: TransactionInBlock

• optional Address sender = 1

• optional Felt252 max_fee = 2

• optional AccountSignature signature = 3

• optional Hash class_hash = 4

• optional Felt252 nonce = 5

Used in: TransactionInBlock

• optional Address sender = 1

• optional Felt252 max_fee = 2

• optional AccountSignature signature = 3

• optional Hash class_hash = 4

• optional Felt252 nonce = 5

• optional Hash compiled_class_hash = 6

see https://external.integration.starknet.io/feeder_gateway/get_transaction?transactionHash=0x41d1f5206ef58a443e7d3d1ca073171ec25fa75313394318fc83a074a6631c3

Used in: TransactionInBlock

• optional DeclareV3Common common = 1

• optional Hash class_hash = 2

Used in: TransactionInBlock

• optional Hash class_hash = 1

• optional Felt252 address_salt = 2

• repeated Felt252 calldata = 3

• uint32 version = 4

Used in: TransactionInBlock

• optional Felt252 max_fee = 1

• optional AccountSignature signature = 2

• optional Hash class_hash = 3

• optional Felt252 nonce = 4

• optional Felt252 address_salt = 5

• repeated Felt252 calldata = 6

Used in: TransactionInBlock

• optional Felt252 max_fee = 1

• optional AccountSignature signature = 2

• optional Address address = 3

• optional Felt252 entry_point_selector = 4

• repeated Felt252 calldata = 5

Used in: TransactionInBlock

• optional Address sender = 1

• optional Felt252 max_fee = 2

• optional AccountSignature signature = 3

• repeated Felt252 calldata = 4

• optional Felt252 nonce = 5

Used in: TransactionsResponse

• optional TransactionInBlock transaction = 1

• optional Receipt receipt = 2

TBD: can support a flag to return tx hashes only, good for standalone mempool to remove them, or any node that keeps track of transaction streaming in the consensus.

• optional Iteration iteration = 1

Responses are sent ordered by the order given in the request. The order inside each block is according to the execution order.

• oneof transaction_message

  • TransactionWithReceipt transaction_with_receipt = 1

  • Fin fin = 2

    Fin is sent after the peer sent all the data or when it encountered a block that it doesn't have its transactions.

Used in: L2GasInfo, ProposalInit, SignedBlockHeader

• uint64 low = 1

• uint64 high = 2

Used in: ContractDiff, DeclareV3Common, DeployAccountV3, InvokeV3

• L1 = 0

• L2 = 1

• Vote.VoteType vote_type = 2

  We use a type field to distinguish between prevotes and precommits instead of different messages, to make sure the data, and therefore the signatures, are unambiguous between Prevote and Precommit.

• uint64 height = 3

• uint32 round = 4

• optional Hash proposal_commitment = 5

  This is optional since a vote can be NIL.

• optional Address voter = 6

• optional Hashes signature = 7

Used in: Vote

• Prevote = 0

• Precommit = 1