# README
Types
Types contains a collection of auto-generated Rosetta types. Using this package ensures that you don't need to automatically generate code on your own.
Installation
go get github.com/foundryservices/rosetta-sdk-go/types
# Functions
AccountString returns a human-readable representation of a *AccountIdentifier.
AddValues adds string amounts using big.Int.
AmountValue returns a *big.Int representation of an Amount.Value or an error.
BigInt returns a *big.Int representation of a value.
Bool returns a pointer to the bool passed as an argument.
ConstructPartialBlockIdentifier constructs a *PartialBlockIdentifier from a *BlockIdentifier.
CurrencyString returns a human-readable representation of a *Currency.
DivideValues divides a/b using big.Int.
ExtractAmount returns the Amount from a slice of Balance pertaining to an AccountAndCurrency.
Hash returns a deterministic hash for any interface.
Int64 returns a pointer to the int64 passed as an argument.
MarshalMap attempts to marshal an interface into a map[string]interface{}.
MultiplyValues multiplies a*b using big.Int.
NegateValue flips the sign of a value.
OperatorP returns a pointer to the Operator passed as an argument.
PrettyPrintStruct marshals a struct to JSON and returns it as a string.
PrintStruct marshals a struct to JSON and returns it as a string without newlines.
String returns a pointer to the string passed as an argument.
SubtractValues subtracts a-b using big.Int.
UnmarshalMap attempts to unmarshal a map[string]interface{} into an interface.
# Constants
List of BlockEventType.
List of Operator.
List of Direction.
List of ExemptionType.
List of ExemptionType.
List of ExemptionType.
List of CoinAction.
List of CoinAction.
List of SignatureType.
List of SignatureType.
List of SignatureType.
List of CurveType.
List of Direction.
List of Operator.
List of BlockEventType.
RosettaAPIVersion is the version of the Rosetta API specification used to generate code for this release of the SDK.
List of SignatureType.
List of SignatureType.
List of CurveType.
List of CurveType.
List of CurveType.
# Structs
AccountBalanceRequest An AccountBalanceRequest is utilized to make a balance request on the /account/balance endpoint.
AccountBalanceResponse An AccountBalanceResponse is returned on the /account/balance endpoint.
AccountCoin contains an *AccountIdentifier and a Coin that it owns.
AccountCoinsRequest AccountCoinsRequest is utilized to make a request on the /account/coins endpoint.
AccountCoinsResponse AccountCoinsResponse is returned on the /account/coins endpoint and includes all unspent Coins owned by an AccountIdentifier.
AccountCurrency is a simple struct combining a *types.Account and *types.Currency.
AccountIdentifier The account_identifier uniquely identifies an account within a network.
Allow Allow specifies supported Operation status, Operation types, and all possible error statuses.
Amount Amount is some Value of a Currency.
BalanceExemption BalanceExemption indicates that the balance for an exempt account could change without a corresponding Operation.
Block Blocks contain an array of Transactions that occurred at a particular BlockIdentifier.
BlockEvent BlockEvent represents the addition or removal of a BlockIdentifier from storage.
BlockIdentifier The block_identifier uniquely identifies a block in a particular network.
BlockRequest A BlockRequest is utilized to make a block request on the /block endpoint.
BlockResponse A BlockResponse includes a fully-populated block or a partially-populated block with a list of other transactions to fetch (other_transactions).
BlockTransaction BlockTransaction contains a populated Transaction and the BlockIdentifier that contains it.
BlockTransactionRequest A BlockTransactionRequest is used to fetch a Transaction included in a block that is not returned in a BlockResponse.
BlockTransactionResponse A BlockTransactionResponse contains information about a block transaction.
CallRequest CallRequest is the input to the `/call` endpoint.
CallResponse CallResponse contains the result of a `/call` invocation.
Coin Coin contains its unique identifier and the amount it represents.
CoinChange CoinChange is used to represent a change in state of a some coin identified by a coin_identifier.
CoinIdentifier CoinIdentifier uniquely identifies a Coin.
ConstructionCombineRequest ConstructionCombineRequest is the input to the `/construction/combine` endpoint.
ConstructionCombineResponse ConstructionCombineResponse is returned by `/construction/combine`.
ConstructionDeriveRequest ConstructionDeriveRequest is passed to the `/construction/derive` endpoint.
ConstructionDeriveResponse ConstructionDeriveResponse is returned by the `/construction/derive` endpoint.
ConstructionHashRequest ConstructionHashRequest is the input to the `/construction/hash` endpoint.
ConstructionMetadataRequest A ConstructionMetadataRequest is utilized to get information required to construct a transaction.
ConstructionMetadataResponse The ConstructionMetadataResponse returns network-specific metadata used for transaction construction.
ConstructionParseRequest ConstructionParseRequest is the input to the `/construction/parse` endpoint.
ConstructionParseResponse ConstructionParseResponse contains an array of operations that occur in a transaction blob.
ConstructionPayloadsRequest ConstructionPayloadsRequest is the request to `/construction/payloads`.
ConstructionPayloadsResponse ConstructionTransactionResponse is returned by `/construction/payloads`.
ConstructionPreprocessRequest ConstructionPreprocessRequest is passed to the `/construction/preprocess` endpoint so that a Rosetta implementation can determine which metadata it needs to request for construction.
ConstructionPreprocessResponse ConstructionPreprocessResponse contains `options` that will be sent unmodified to `/construction/metadata`.
ConstructionSubmitRequest The transaction submission request includes a signed transaction.
Currency Currency is composed of a canonical Symbol and Decimals.
Delegator Delegator is the identifier and value of a wallet delegating to a validator.
Error Instead of utilizing HTTP status codes to describe node errors (which often do not have a good analog), rich errors are returned using this object.
EventsBlocksRequest EventsBlocksRequest is utilized to fetch a sequence of BlockEvents indicating which blocks were added and removed from storage to reach the current state.
EventsBlocksResponse EventsBlocksResponse contains an ordered collection of BlockEvents and the max retrievable sequence.
MempoolResponse A MempoolResponse contains all transaction identifiers in the mempool for a particular network_identifier.
MempoolTransactionRequest A MempoolTransactionRequest is utilized to retrieve a transaction from the mempool.
MempoolTransactionResponse A MempoolTransactionResponse contains an estimate of a mempool transaction.
MetadataRequest A MetadataRequest is utilized in any request where the only argument is optional metadata.
NetworkIdentifier The network_identifier specifies which network a particular object is associated with.
NetworkListResponse A NetworkListResponse contains all NetworkIdentifiers that the node can serve information for.
NetworkOptionsResponse NetworkOptionsResponse contains information about the versioning of the node and the allowed operation statuses, operation types, and errors.
NetworkRequest A NetworkRequest is utilized to retrieve some data specific exclusively to a NetworkIdentifier.
NetworkStatusResponse NetworkStatusResponse contains basic information about the node's view of a blockchain network.
Operation Operations contain all balance-changing information within a transaction.
OperationIdentifier The operation_identifier uniquely identifies an operation within a transaction.
OperationStatus OperationStatus is utilized to indicate which Operation status are considered successful.
PartialBlockIdentifier When fetching data by BlockIdentifier, it may be possible to only specify the index or hash.
Peer A Peer is a representation of a node's peer.
PublicKey PublicKey contains a public key byte array for a particular CurveType encoded in hex.
RelatedTransaction The related_transaction allows implementations to link together multiple transactions.
SearchTransactionsRequest SearchTransactionsRequest is used to search for transactions matching a set of provided conditions in canonical blocks.
SearchTransactionsResponse SearchTransactionsResponse contains an ordered collection of BlockTransactions that match the query in SearchTransactionsRequest.
Signature Signature contains the payload that was signed, the public keys of the keypairs used to produce the signature, the signature (encoded in hex), and the SignatureType.
SigningPayload SigningPayload is signed by the client with the keypair associated with an AccountIdentifier using the specified SignatureType.
SubAccountIdentifier An account may have state specific to a contract address (ERC-20 token) and/or a stake (delegated balance).
SubNetworkIdentifier In blockchains with sharded state, the SubNetworkIdentifier is required to query some object on a specific shard.
SyncStatus SyncStatus is used to provide additional context about an implementation's sync status.
Transaction Transactions contain an array of Operations that are attributable to the same TransactionIdentifier.
TransactionIdentifier The transaction_identifier uniquely identifies a transaction in a particular network and block or in the mempool.
TransactionIdentifierResponse TransactionIdentifierResponse contains the transaction_identifier of a transaction that was submitted to either `/construction/hash` or `/construction/submit`.
Version The Version object is utilized to inform the client of the versions of different components of the Rosetta implementation.
# Type aliases
BlockEventType BlockEventType determines if a BlockEvent represents the addition or removal of a block.
CoinAction CoinActions are different state changes that a Coin can undergo.
CurveType CurveType is the type of cryptographic curve associated with a PublicKey.
Direction Used by RelatedTransaction to indicate the direction of the relation (i.e.
ExemptionType ExemptionType is used to indicate if the live balance for an account subject to a BalanceExemption could increase above, decrease below, or equal the computed balance.
Operator Operator is used by query-related endpoints to determine how to apply conditions.
SignatureType SignatureType is the type of a cryptographic signature.