Get Network Options

post https://rpc.chain49.com/cardano/network/options

This endpoint returns the version information and allowed network-specific types for a NetworkIdentifier. Any NetworkIdentifier returned by /network/list should be accessible here. Because options are retrievable in the context of a NetworkIdentifier, it is possible to define unique options for each network.

Responses

Response body

object

version

object

required

The Version object is utilized to inform the client of the versions of different components of the Rosetta implementation.

rosetta_version

string

required

The rosetta_version is the version of the Rosetta interface the implementation adheres to. This can be useful for clients looking to reliably parse responses.

node_version

string

required

The node_version is the canonical version of the node runtime. This can help clients manage deployments.

middleware_version

string

When a middleware server is used to adhere to the Rosetta interface, it should return its version here. This can help clients manage deployments.

metadata

object

Any other information that may be useful about versioning of dependent services should be returned here.

Has additional fields

allow

object

required

Allow specifies supported Operation status, Operation types, and all possible error statuses. This Allow object is used by clients to validate the correctness of a Rosetta Server implementation. It is expected that these clients will error if they receive some response that contains any of the above information that is not specified here.

operation_statuses

array of objects

required

All Operation.Status this implementation supports. Any status that is returned during parsing that is not listed here will cause client validation to error.

operation_statuses*

object

status

string

required

The status is the network-specific status of the operation.

successful

boolean

required

An Operation is considered successful if the Operation.Amount should affect the Operation.Account. Some blockchains (like Bitcoin) only include successful operations in blocks but other blockchains (like Ethereum) include unsuccessful operations that incur a fee. To reconcile the computed balance from the stream of Operations, it is critical to understand which Operation.Status indicate an Operation is successful and should affect an Account.

operation_types

array of strings

required

All Operation.Type this implementation supports. Any type that is returned during parsing that is not listed here will cause client validation to error.

operation_types*

errors

array of objects

required

All Errors that this implementation could return. Any error that is returned during parsing that is not listed here will cause client validation to error.

errors*

object

code

int32

required

≥ 0

Code is a network-specific error code. If desired, this code can be equivalent to an HTTP status code.

message

string

required

Message is a network-specific error message. The message MUST NOT change for a given code. In particular, this means that any contextual information should be included in the details field.

description

string

Description allows the implementer to optionally provide additional information about an error. In many cases, the content of this field will be a copy-and-paste from existing developer documentation. Description can ONLY be populated with generic information about a particular type of error. It MUST NOT be populated with information about a particular instantiation of an error (use details for this). Whereas the content of Error.Message should stay stable across releases, the content of Error.Description will likely change across releases (as implementers improve error documentation). For this reason, the content in this field is not part of any type assertion (unlike Error.Message).

retriable

boolean

required

An error is retriable if the same request may succeed if submitted again.

details

object

Often times it is useful to return context specific to the request that caused the error (i.e. a sample of the stack trace or impacted account) in addition to the standard error message.

Has additional fields

historical_balance_lookup

boolean

required

Any Rosetta implementation that supports querying the balance of an account at any height in the past should set this to true.

timestamp_start_index

int64

≥ 0

If populated, timestamp_start_index indicates the first block index where block timestamps are considered valid (i.e. all blocks less than timestamp_start_index could have invalid timestamps). This is useful when the genesis block (or blocks) of a network have timestamp 0. If not populated, block timestamps are assumed to be valid for all available blocks.

call_methods

array of strings

required

All methods that are supported by the /call endpoint. Communicating which parameters should be provided to /call is the responsibility of the implementer (this is en lieu of defining an entire type system and requiring the implementer to define that in Allow).

call_methods*

balance_exemptions

array of objects

required

BalanceExemptions is an array of BalanceExemption indicating which account balances could change without a corresponding Operation. BalanceExemptions should be used sparingly as they may introduce significant complexity for integrators that attempt to reconcile all account balance changes. If your implementation relies on any BalanceExemptions, you MUST implement historical balance lookup (the ability to query an account balance at any BlockIdentifier).

balance_exemptions*

object

sub_account_address

string

SubAccountAddress is the SubAccountIdentifier.Address that the BalanceExemption applies to (regardless of the value of SubAccountIdentifier.Metadata).

currency

object

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

exemption_type

string

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. greater_or_equal: The live balance may increase above or equal the computed balance. This typically occurs with staking rewards that accrue on each block. less_or_equal: The live balance may decrease below or equal the computed balance. This typically occurs as balance moves from locked to spendable on a vesting account. * dynamic: The live balance may increase above, decrease below, or equal the computed balance. This typically occurs with tokens that have a dynamic supply.

greater_or_equal less_or_equal dynamic

mempool_coins

boolean

required

Any Rosetta implementation that can update an AccountIdentifier's unspent coins based on the contents of the mempool should populate this field as true. If false, requests to /account/coins that set include_mempool as true will be automatically rejected.

block_hash_case

string | null

Defaults to case_sensitive

This specifies the normalized case for block hash in the BlockIdentifier. If not specified, it's assumed to be case sensitive.

upper_case lower_case case_sensitive

transaction_hash_case

string | null

Defaults to case_sensitive

This specifies the normalized case for transaction hash in the TransactionIdentifier. If not specified, it's assumed to be case sensitive.

upper_case lower_case case_sensitive

Language

Credentials

Header

URL


xxxxxxxxxx
12
1
curl --request POST \
2
     --url https://rpc.chain49.com/cardano/network/options \
3
     --header 'accept: application/json' \
4
     --header 'content-type: application/json' \
5
     --data '
6
{
7
  "network_identifier": {
8
    "blockchain": "cardano",
9
    "network": "mainnet"
10
  }
11
}
12
'

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Expected response to a valid request

500unexpected error