Allow class

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.

Annotations

Constructors

Allow(List<OperationStatus> operationStatus, List<String> operationTypes, List<RosettaError> errors, bool historicalBalanceLookup, List<String> callMethods, List<BalanceExemption> balanceExemptions, bool mempoolCoins, int? timestampStartIndex)
const
Allow.fromJson(Map<String, dynamic> map)
factory

Properties

balanceExemptions → List<BalanceExemption>
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).
final
callMethods → List<String>
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).
final
errors → List<RosettaError>
All RosettaError that this implementation could return. Any error that is returned during parsing that is not listed here will cause client validation to error.
final
hashCode → int
The hash code for this object.
no setterinherited
historicalBalanceLookup → bool
Any Rosetta implementation that supports querying the balance of an account at any height in the past should set this to true.
final
mempoolCoins → bool
Any Rosetta implementation that can update an AccountIdentifier's unspent coins based on the contents of the mem-pool should populate this field as true. If false, requests to /account/coins that set include_mempool as true will be automatically rejected.
final
operationStatus → List<OperationStatus>
All Operation.status this implementation supports. Any status that is returned during parsing that is not listed here will cause client validation to error.
final
operationTypes → List<String>
All Operations. Type this implementation supports. Any type that is returned during parsing that is not listed here will cause client validation to error.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
timestampStartIndex → int?
If populated, timestampStartIndex indicates the first block index where block timestamps are considered valid (i.e. all blocks less than timestampStartIndex 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 valid for all available blocks.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toJson() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited