package coinbase.crypto.rosetta.types

Get desktop application:
View/edit binary Protocol Buffers messages

AccountIdentifier The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated).

Used in: Operation

• string address = 1

  The address may be a cryptographic public key (or some encoding of it) or a provided username.

• optional SubAccountIdentifier sub_account = 2

  The sub account identifier

• map<string, google.protobuf.Any> metadata = 3

  Blockchains that utilize a username model (where the address is not a derivative of a cryptographic public key) should specify the public key(s) owned by the address in metadata.

Amount is some Value of a Currency. It is considered invalid to specify a Value without a Currency.

Used in: Operation

• string value = 1

  Value of the transaction in atomic units represented as an arbitrary-sized signed integer. For example, 1 BTC would be represented by a value of 100000000.

• optional Currency currency = 2

  Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins).

• map<string, google.protobuf.Any> metadata = 3

  The metadata is protocol specific metadata

Blocks contain an array of Transactions that occurred at a particular BlockIdentifier. A hard requirement for blocks returned by Rosetta implementations is that they MUST be immutable: once a client has requested and received a block identified by a specific BlockIndentifier, all future calls for that same BlockIdentifier must return the same block contents.

Used in: chainstorage.NativeBlock, chainstorage.RosettaBlock

• optional BlockIdentifier block_identifier = 2

  BlockIdentifier uniquely identifies a block in a particular network.

• optional BlockIdentifier parent_block_identifier = 3

  BlockIdentifier uniquely identifies a block in a particular network.

• optional google.protobuf.Timestamp timestamp = 4

  The timestamp of the block since the Unix Epoch. The rosetta spec only support timestamp in milliseconds granularity. (-- api-linter: core::0142::time-field-names=disabled go/aip/not-precedent: This field was called timestamp in rosetta spec. --)

• repeated Transaction transactions = 5

  Transactions within the block.

• map<string, google.protobuf.Any> metadata = 6

  Metadata for the block.

The block identifier uniquely identifies a block in a particular network.

Used in: Block

• int64 index = 1

  The block height. Note that this this should be >= 0

• string hash = 2

  The block hash.

CoinChange is used to represent a change in state of a coin identified by a coin_identifier. This object is part of the Operation model and must be populated for UTXO-based blockchains. Coincidentally, this abstraction of UTXOs allows for supporting both account-based transfers and UTXO-based transfers on the same blockchain (when a transfer is account-based, don't populate this model).

Used in: Operation

• optional CoinIdentifier coin_identifier = 1

  CoinIdentifier uniquely identifies a Coin.

• CoinChange.CoinAction coin_action = 2

  CoinActions are different state changes that a Coin can undergo

CoinActions are different state changes that a Coin can undergo. It is assumed that a single Coin cannot be created or spent more than once.

Used in: CoinChange

• COIN_ACTION_UNSPECIFIED = 0

  COIN_ACTION_UNSPECIFIED indicating a CoinAction is not set

• COIN_CREATED = 1

  COIN_CREATED indicating a Coin was created.

• COIN_SPENT = 2

  COIN_SPENT indicating a Coin was spent.

CoinIdentifier uniquely identifies a Coin.

Used in: CoinChange

• string identifier = 1

  Identifier should be populated with a globally unique identifier of a Coin. In Bitcoin, this identifier would be transaction_hash:index.

Currency is composed of a canonical Symbol and Decimals. This Decimals value is used to convert an Amount.Value from atomic units (Satoshis) to standard units (Bitcoins).

Used in: Amount

• string symbol = 1

  Canonical symbol associated with a currency.

• int32 decimals = 2

  Number of decimal places in the standard unit representation of the amount. For example, BTC has 8 decimals. Note that it is not possible to represent the value of some currency in atomic units that is not base 10.

• map<string, google.protobuf.Any> metadata = 3

  Any additional information related to the currency itself. For example, it would be useful to populate this object with the contract address of an ERC-20 token.

NetworkIdentifier specifies which network a particular object is associated with.

Used in: RelatedTransaction

• string blockchain = 1

  Blockchain the network is associated with

• string network = 2

  If a blockchain has a specific chain-id or network identifier, it should go in this field. It is up to the client to determine which network-specific identifier is mainnet or testnet.

• optional SubNetworkIdentifier sub_network_identifier = 3

  In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.

Operations contain all balance-changing information within a transaction. They are always one-sided (only affect 1 AccountIdentifier) and can succeed or fail independently from a Transaction. Operations are used both to represent on-chain data (Data API) and to construct new transactions (Construction API), creating a standard interface for reading and writing to blockchains.

Used in: Transaction

• optional OperationIdentifier operation_identifier = 1

  The operation_identifier uniquely identifies an operation within a transaction.

• repeated OperationIdentifier related_operations = 2

  Restrict referenced related_operations to identifier indices " the current operation_identifier.index. This ensures there exists a clear DAG-structure of relations. Since operations are one-sided, one could imagine relating operations in a single transfer or linking operations in a call tree.

• string type = 3

  Type is the network-specific type of the operation. Ensure that any type that can be returned here is also specified in the NetworkOptionsResponse. This can be very useful to downstream consumers that parse all block data.

• string status = 4

  Status is the network-specific status of the operation. Status is not defined on the transaction object because blockchains with smart contracts may have transactions that partially apply (some operations are successful and some are not). Blockchains with atomic transactions (all operations succeed or all operations fail) will have the same status for each operation. On-chain operations (operations retrieved in the /block and /block/transaction endpoints) MUST have a populated status field (anything on-chain must have succeeded or failed). However, operations provided during transaction construction (often times called "intent" in the documentation) MUST NOT have a populated status field (operations yet to be included on-chain have not yet succeeded or failed).

• optional AccountIdentifier account = 5

  The account_identifier uniquely identifies an account within a network. All fields in the account_identifier are utilized to determine this uniqueness (including the metadata field, if populated).

• optional Amount amount = 6

  Amount is some Value of a Currency. It is considered invalid to specify a Value without a Currency.

• optional CoinChange coin_change = 7

  CoinChange is used to represent a change in state of a some coin identified by a coin_identifier. This object is part of the Operation model and must be populated for UTXO-based blockchains. Coincidentally, this abstraction of UTXOs allows for supporting both account-based transfers and UTXO-based transfers on the same blockchain (when a transfer is account-based, don't populate this model).

• map<string, google.protobuf.Any> metadata = 8

  Metadata stores any protocol specific information regarding the operation

OperationIdentifier uniquely identifies an operation within a transaction.

Used in: Operation

• int64 index = 1

  The operation index is used to ensure each operation has a unique identifier within a transaction. This index is only relative to the transaction and NOT GLOBAL. The operations in each transaction should start from index 0. To clarify, there may not be any notion of an operation index in the blockchain being described.

• int64 network_index = 2

  Some blockchains specify an operation index that is essential for client use. For example, Bitcoin uses a network_index to identify which UTXO was used in a transaction. network_index should not be populated if there is no notion of an operation index in a blockchain (typically most account-based blockchains). Note that this this should be >= 0

RelatedTransaction allows implementations to link together multiple transactions.

Used in: Transaction

• optional NetworkIdentifier network_identifier = 1

  The network_identifier specifies which network a particular object is associated with. An unpopulated network identifier indicates that the related transaction is on the same network.

• optional TransactionIdentifier transaction_identifier = 2

  The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.

• RelatedTransaction.Direction direction = 3

  Used by RelatedTransaction to indicate the direction of the relation. Can be used to indicate if a transaction relation is from child to parent or the reverse.

Used by RelatedTransaction to indicate the direction of the relation (i.e. cross-shard/cross-network sends may reference backward to an earlier transaction and async execution may reference forward). Can be used to indicate if a transaction relation is from child to parent or the reverse.

Used in: RelatedTransaction

• DIRECTION_UNSPECIFIED = 0

  DIRECTION_UNSPECIFIED indicating the direction is not specified.

• FORWARD = 1

  FORWARD indicating a transaction relation is from parent to child.

• BACKWARD = 2

  BACKWARD indicating a transaction relation is from child to parent.

An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance). The sub_account_identifier should specify which state (if applicable) an account instantiation refers to.

Used in: AccountIdentifier

• string address = 1

  The SubAccount address may be a cryptographic value or some other identifier (ex: bonded) that uniquely specifies a SubAccount.

• map<string, google.protobuf.Any> metadata = 2

  If the SubAccount address is not sufficient to uniquely specify a SubAccount, any other identifying information can be stored here. It is important to note that two SubAccounts with identical addresses but differing metadata will not be considered equal by clients.

In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard. This identifier is optional for all non-sharded blockchains.

Used in: NetworkIdentifier

• string network = 1

  The subnetwork identifier.

• map<string, google.protobuf.Any> metadata = 2

  Metadata info for the subnetwork.

Transactions contain an array of Operations that are attributable to the same TransactionIdentifier.

Used in: chainstorage.NativeTransaction, Block

• optional TransactionIdentifier transaction_identifier = 1

  The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.

• repeated Operation operations = 2

  The operations is an array of Operations that are associated with the transaction

• repeated RelatedTransaction related_transactions = 3

  The related_transaction allows implementations to link together multiple transactions. An unpopulated network identifier indicates that the related transaction is on the same network.

• map<string, google.protobuf.Any> metadata = 4

  Transactions that are related to other transactions (like a cross-shard transaction) should include the tranaction_identifier of these transactions in the metadata.

TransactionIdentifier uniquely identifies a transaction in a particular network and block or in the mempool.

Used in: RelatedTransaction, Transaction

• string hash = 1

  The hash of the transaction. Any transactions that are attributable only to a block (ex: a block event) should use the hash of the block as the identifier.