Default package

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Transaction.DeclareV0, Transaction.DeclareV1, Transaction.DeclareV2, Transaction.DeclareV3, Transaction.DeployAccountV1, Transaction.DeployAccountV3, Transaction.InvokeV0, Transaction.InvokeV1, Transaction.InvokeV3

• repeated Felt252 parts = 1

Used in: ContractDiff, Proposal, SignedBlockHeader, Transaction.DeclareV0, Transaction.DeclareV1, Transaction.DeclareV2, Transaction.DeclareV3, Transaction.InvokeV0, Transaction.InvokeV1, Transaction.InvokeV3, Transaction.L1HandlerV0, 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

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

• 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: ClassesResponse

• oneof class

  • Cairo0Class cairo0 = 1

  • Cairo1Class cairo1 = 2

• uint32 domain = 3

• 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.

• oneof message

  • Proposal proposal = 1

  • Vote vote = 2

Used in: SignedBlockHeader

• optional Felt252 r = 1

• optional Felt252 s = 2

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: StateDiffsResponse

• optional Hash class_hash = 1

• optional Hash compiled_class_hash = 2

  Present only if the class is Cairo1

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, ConsensusSignature, ContractDiff, ContractStoredValue, EntryPoint, Event, MessageToL1, Receipt.Common, Receipt.Deploy, Receipt.DeployAccount, ResourceLimits, SierraEntryPoint, Transaction.DeclareV0, Transaction.DeclareV1, Transaction.DeclareV2, Transaction.DeclareV3, Transaction.Deploy, Transaction.DeployAccountV1, Transaction.DeployAccountV3, Transaction.InvokeV0, Transaction.InvokeV1, Transaction.InvokeV3, Transaction.L1HandlerV0

• bytes elements = 1

mark the end of a stream of messages TBD: may not be required if we open a stream per request.

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

(message has no fields)

Used in: BlockID, ContractDiff, DeclaredClass, Event, Hashes, Iteration, Patricia, Proposal, Receipt.L1Handler, SignedBlockHeader, StateDiffCommitment, Transaction.DeclareV0, Transaction.DeclareV1, Transaction.DeclareV2, Transaction.DeclareV3, Transaction.Deploy, Transaction.DeployAccountV1, Transaction.DeployAccountV3, Vote

• bytes elements = 1

• repeated Hash items = 1

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: SignedBlockHeader

• Calldata = 0

• Blob = 1

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

• bytes id = 1

Used in: Receipt.Common

• Wei = 0

• Fri = 1

Used in: ConsensusMessage

• uint64 height = 1

• optional Address proposer = 2

• repeated Transaction transactions = 3

• optional Hash block_hash = 4

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

Used in: ExecutionResources

• uint64 l1_gas = 1

• uint64 l1_data_gas = 2

Used in: Receipt

• optional Common common = 1

Used in: Receipt

• optional Common common = 1

• optional Hash msg_hash = 2

Used in: Transaction.DeclareV3, Transaction.DeployAccountV3, Transaction.InvokeV3

• optional ResourceLimits l1_gas = 1

• optional ResourceLimits l2_gas = 2

Used in: ResourceBounds

• uint64 max_amount = 1

• optional Felt252 max_price_per_unit = 2

Used in: Cairo1EntryPoints

• uint64 index = 1

• optional Felt252 selector = 2

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/documentation/architecture_and_concepts/Network_Architecture/header/#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 gas_price_fri = 12

• optional Uint128 gas_price_wei = 13

• optional Uint128 data_gas_price_fri = 14

• optional Uint128 data_gas_price_wei = 15

• L1DataAvailabilityMode l1_data_availability_mode = 16

• repeated ConsensusSignature signatures = 17

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

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

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.

This is a transaction that is already accepted in a block. Once we have a mempool, we will define a separate message for BroadcastedTransaction.

Used in: Proposal, TransactionWithReceipt

• oneof txn

  • Transaction.DeclareV0 declare_v0 = 1

  • Transaction.DeclareV1 declare_v1 = 2

  • Transaction.DeclareV2 declare_v2 = 3

  • Transaction.DeclareV3 declare_v3 = 4

  • Transaction.Deploy deploy = 5

  • Transaction.DeployAccountV1 deploy_account_v1 = 6

  • Transaction.DeployAccountV3 deploy_account_v3 = 7

  • Transaction.InvokeV0 invoke_v0 = 8

  • Transaction.InvokeV1 invoke_v1 = 9

  • Transaction.InvokeV3 invoke_v3 = 10

  • Transaction.L1HandlerV0 l1_handler = 11

Used in: Transaction

• optional Address sender = 1

• optional Felt252 max_fee = 2

• optional AccountSignature signature = 3

• optional Hash class_hash = 4

Used in: Transaction

• optional Address sender = 1

• optional Felt252 max_fee = 2

• optional AccountSignature signature = 3

• optional Hash class_hash = 4

• optional Felt252 nonce = 5

Used in: Transaction

• 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: Transaction

• optional Address sender = 1

• optional AccountSignature signature = 2

• optional Hash class_hash = 3

• 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: Transaction

• optional Hash class_hash = 1

• optional Felt252 address_salt = 2

• repeated Felt252 calldata = 3

• uint32 version = 4

Used in: Transaction

• 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

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

Used in: Transaction

• 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: Transaction

• 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: Transaction

• optional Address sender = 1

• optional Felt252 max_fee = 2

• optional AccountSignature signature = 3

• repeated Felt252 calldata = 4

• optional Felt252 nonce = 5

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

Used in: Transaction

• 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

Used in: Transaction

• optional Felt252 nonce = 1

• optional Address address = 2

• optional Felt252 entry_point_selector = 3

• repeated Felt252 calldata = 4

Used in: TransactionsResponse

• optional Transaction 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: SignedBlockHeader

• uint64 low = 1

• uint64 high = 2

Used in: ContractDiff, Transaction.DeclareV3, Transaction.DeployAccountV3, Transaction.InvokeV3

• L1 = 0

• L2 = 1

Used in: ConsensusMessage

• 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

• optional Hash block_hash = 4

  This is optional since a vote can be NIL.

• optional Address voter = 5

Used in: Vote

• Prevote = 0

• Precommit = 1