Skip to main content

client

Enumerations

EnumerationDescription
Network-

Classes

ClassDescription
IotaClient-
IotaHTTPTransportError-
JsonRpcError-
IotaHTTPStatusError-
IotaHTTPTransport-

Interfaces

InterfaceDescription
PaginationArguments-
OrderArguments-
IotaHTTPTransportOptions-
IotaTransportRequestOptions-
IotaTransportSubscribeOptions-
IotaTransport-
NetworkConfiguration-
KioskConfiguration-
AddressMetricsProvides metrics about the addresses.
Balance-
BalanceChange-
Checkpoint-
ClaimA claim consists of value and index_mod_4.
CoinStruct-
CommitteeInfoRPC representation of the [Committee] type.
DelegatedStake-
DelegatedTimelockedStake-
DevInspectArgsAdditional arguments supplied to dev inspect beyond what is allowed in today's API.
DevInspectResultsThe response from processing a dev inspect transaction
DisplayFieldsResponse-
DryRunTransactionBlockResponse-
DynamicFieldName-
ECMHLiveObjectSetDigestThe Sha256 digest of an EllipticCurveMultisetHash committing to the live object set.
EndOfEpochData-
EndOfEpochInfo-
EpochInfo-
EpochMetricsA light-weight version of EpochInfo for faster loading
EventIdUnique ID of an IOTA Event, the ID is a combination of transaction digest and event seq number.
GasCostSummarySummary of the charges in a transaction. Storage is charged independently of computation. There are 3 parts to the storage charges: storage_cost: it is the charge of storage at the time the transaction is executed. The cost of storage is the number of bytes of the objects being mutated multiplied by a variable storage cost per byte storage_rebate: this is the amount a user gets back when manipulating an object. The storage_rebate is the storage_cost for an object minus fees. non_refundable_storage_fee: not all the value of the object storage cost is given back to user and there is a small fraction that is kept by the system. This value tracks that charge.
IotaGasData-
GetPastObjectRequest-
IotaActiveJwk-
IotaAuthenticatorStateExpire-
IotaChangeEpoch-
IotaChangeEpochV2-
IotaCirculatingSupplyProvides a summary of the circulating IOTA supply.
CoinMetadata-
IotaExecutionResult-
IotaJWK-
IotaJwkId-
IotaMoveAbilitySet-
IotaMoveModuleId-
IotaMoveNormalizedEnum-
IotaMoveNormalizedField-
IotaMoveNormalizedFunction-
IotaMoveNormalizedModule-
IotaMoveNormalizedStruct-
IotaMoveStructTypeParameter-
IotaNameRecordA single record in the registry.
IotaObjectResponse-
MoveCallIotaTransactionThe transaction for calling a Move function, either an entry function or a public function (which cannot return references).
IotaSystemStateSummaryV1This is the JSON-RPC type for the IotaSystemStateV1 object. It flattens all fields to make them top-level fields such that it as minimum dependencies to the internal data structures of the IOTA system state type.
IotaSystemStateSummaryV2This is the JSON-RPC type for the IotaSystemStateV2 object. It flattens all fields to make them top-level fields such that it as minimum dependencies to the internal data structures of the IOTA system state type.
IotaValidatorSummaryThis is the JSON-RPC type for the IOTA validator. It flattens all inner structures to top-level fields so that they are decoupled from the internal definitions.
MoveAuthenticatorV1MoveAuthenticatorV1 is the first version of MoveAuthenticator.
MoveCallMetrics-
MoveCallParams-
MoveFunctionNameIdentifies a Move function.
MoveVariant-
MultiSigThe struct that contains signatures and public keys necessary for authenticating a MultiSig.
MultiSigPublicKeyThe struct that contains the public key used for authenticating a MultiSig.
NetworkMetrics-
IotaObjectData-
IotaObjectDataOptions-
IotaObjectRef-
IotaObjectResponseQuery-
OwnedObjectRef-
PaginatedCheckpointsnext_cursor points to the last item in the page; Reading with next_cursor will start from the next item after next_cursor if next_cursor is Some, otherwise it will start from the first item.
PaginatedCoinsnext_cursor points to the last item in the page; Reading with next_cursor will start from the next item after next_cursor if next_cursor is Some, otherwise it will start from the first item.
PaginatedDynamicFieldInfosnext_cursor points to the last item in the page; Reading with next_cursor will start from the next item after next_cursor if next_cursor is Some, otherwise it will start from the first item.
PaginatedEpochInfosnext_cursor points to the last item in the page; Reading with next_cursor will start from the next item after next_cursor if next_cursor is Some, otherwise it will start from the first item.
PaginatedEpochMetricssnext_cursor points to the last item in the page; Reading with next_cursor will start from the next item after next_cursor if next_cursor is Some, otherwise it will start from the first item.
PaginatedEventsnext_cursor points to the last item in the page; Reading with next_cursor will start from the next item after next_cursor if next_cursor is Some, otherwise it will start from the first item.
PaginatedObjectsResponsenext_cursor points to the last item in the page; Reading with next_cursor will start from the next item after next_cursor if next_cursor is Some, otherwise it will start from the first item.
PaginatedTransactionResponsenext_cursor points to the last item in the page; Reading with next_cursor will start from the next item after next_cursor if next_cursor is Some, otherwise it will start from the first item.
ParticipationMetricsProvides metrics about the participation in the network.
PasskeyAuthenticatorAn passkey authenticator with parsed fields. See field definition below. Can be initialized from [struct RawPasskeyAuthenticator].
ProtocolConfig-
CoinSupply-
IotaTransactionBlock-
TransactionBlockBytes-
TransactionBlockEffectsModifiedAtVersions-
IotaTransactionBlockResponse-
IotaTransactionBlockResponseOptions-
IotaTransactionBlockResponseQuery-
TransferObjectParams-
TypeOriginStore the origin of a data type where it first appeared in the version chain.
UpgradeInfoValue for the [MovePackage]'s linkage_table.
ValidatorApy-
ValidatorsApy-
ZkLoginAuthenticatorAn zk login authenticator with all the necessary fields.
ZkLoginInputsAll inputs required for the zk login proof verification and other public inputs.
ZkLoginProofThe struct for zk login proof.
DevInspectTransactionBlockParamsRuns the transaction in dev-inspect mode. Which allows for nearly any transaction (or Move call) with any arguments. Detailed results are provided, including both the transaction effects and any return values.
DryRunTransactionBlockParamsReturn transaction execution effects including the gas cost summary, while the effects are not committed to the chain.
ExecuteTransactionBlockParamsExecute the transaction and wait for results if desired. Request types: 1. WaitForEffectsCert: waits for TransactionEffectsCert and then return to client. This mode is a proxy for transaction finality. 2. WaitForLocalExecution: waits for TransactionEffectsCert and make sure the node executed the transaction locally before returning the client. The local execution makes sure this node is aware of this transaction when client fires subsequent queries. However if the node fails to execute the transaction locally in a timely manner, a bool type in the response is set to false to indicated the case. request_type is default to be WaitForEffectsCert unless options.show_events or options.show_effects is true
GetChainIdentifierParamsReturn the first four bytes of the chain's genesis checkpoint digest.
GetCheckpointParamsReturn a checkpoint
GetCheckpointsParamsReturn paginated list of checkpoints
GetEventsParamsReturn transaction events.
GetLatestCheckpointSequenceNumberParamsReturn the sequence number of the latest checkpoint that has been executed
GetMoveFunctionArgTypesParamsReturn the argument types of a Move function, based on normalized Type.
GetNormalizedMoveFunctionParamsReturn a structured representation of Move function
GetNormalizedMoveModuleParamsReturn a structured representation of Move module
GetNormalizedMoveModulesByPackageParamsReturn structured representations of all modules in the given package
GetNormalizedMoveStructParamsReturn a structured representation of Move struct
GetObjectParamsReturn the object information for a specified object
GetProtocolConfigParamsReturn the protocol config table for the given version number. If the version number is not specified, If none is specified, the node uses the version of the latest epoch it has processed.
GetTotalTransactionBlocksParamsReturn the total number of transaction blocks known to the server.
GetTransactionBlockParamsReturn the transaction response object.
IsTransactionIndexedOnNodeParamsReturn if the transaction has been indexed on the fullnode.
MultiGetObjectsParamsReturn the object data for a list of objects
MultiGetTransactionBlocksParamsReturns an ordered list of transaction responses The method will throw an error if the input contains any duplicate or the input size exceeds QUERY_MAX_RESULT_LIMIT
TryGetPastObjectParamsNote there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed. The result may vary across nodes depending on their pruning policies. Return the object information for a specified version
TryMultiGetPastObjectsParamsNote there is no software-level guarantee/SLA that objects with past versions can be retrieved by this API, even if the object and version exists/existed. The result may vary across nodes depending on their pruning policies. Return the object information for a specified version
ViewParamsCalls a move view function.
GetAllBalancesParamsReturn the total coin balance for all coin type, owned by the address owner.
GetAllCoinsParamsReturn all Coin objects owned by an address.
GetAllEpochAddressMetricsParamsAddress related metrics. Exclusively served by the indexer.
GetBalanceParamsReturn the total coin balance for one coin type, owned by the address owner.
GetCheckpointAddressMetricsParamsAddress related metrics. Exclusively served by the indexer.
GetCirculatingSupplyParamsReturn the circulating supply summary.
GetCoinMetadataParamsReturn metadata (e.g., symbol, decimals) for a coin.
GetCoinsParamsReturn all Coin<coin_type> objects owned by an address.
GetCommitteeInfoParamsReturn the committee information for the asked epoch.
GetCurrentEpochParamsReturn current epoch info. Exclusively served by the indexer.
GetDynamicFieldObjectParamsReturn the dynamic field object information for a specified object
GetDynamicFieldObjectV2ParamsReturn the dynamic field object information for a specified object with content options.
GetDynamicFieldsParamsReturn the list of dynamic field objects owned by an object.
GetEpochMetricsParamsReturn a list of epoch metrics, which is a subset of epoch info. Exclusively served by the indexer.
GetEpochsParamsReturn a list of epoch info. Exclusively served by the indexer.
GetLatestAddressMetricsParamsAddress related metrics. Exclusively served by the indexer.
GetLatestIotaSystemStateParamsReturn the latest IOTA system state object on networks supporting protocol version < 5. These are networks with node software release version < 0.11.
GetLatestIotaSystemStateV2ParamsReturn the latest IOTA system state object on networks supporting protocol version >= 5. These are networks with node software release version >= 0.11.
GetMoveCallMetricsParamsReturn move call metrics. Exclusively served by the indexer.
GetNetworkMetricsParamsReturn Network metrics. Exclusively served by the indexer.
GetParticipationMetricsParamsReturns the participation metrics. Participation is defined as the total number of unique addresses that have delegated stake in the current epoch. Includes both staked and timelocked staked IOTA. Exclusively served by the indexer.
GetReferenceGasPriceParamsReturn the reference gas price for the network
GetStakesParamsReturn all [DelegatedStake].
GetStakesByIdsParamsReturn one or more [DelegatedStake]. If a Stake was withdrawn its status will be Unstaked.
GetTimelockedStakesParamsReturn all [DelegatedTimelockedStake].
GetTimelockedStakesByIdsParamsReturn one or more [DelegatedTimelockedStake]. If a Stake was withdrawn its status will be Unstaked.
GetTotalSupplyParamsReturn total supply for a coin.
GetTotalTransactionsParamsReturn the total number of transactions. Exclusively served by the indexer.
GetValidatorsApyParamsReturn the validator APY
IotaNamesFindAllRegistrationNFTsParamsFind all registration NFTs for the given address.
IotaNamesLookupParamsReturn the resolved record for the given name.
IotaNamesReverseLookupParamsReturn the resolved name for the given address.
QueryEventsParamsReturn list of events for a specified query criteria.
SubscribeEventParamsSubscribe to a stream of IOTA event
SubscribeTransactionParamsSubscribe to a stream of IOTA transaction effects
UnsafeBatchTransactionParamsCreate an unsigned batched transaction.
UnsafeMergeCoinsParamsCreate an unsigned transaction to merge multiple coins into one coin.
UnsafeMoveCallParamsCreate an unsigned transaction to execute a Move call on the network, by calling the specified function in the module of a given package.
UnsafePayParamsSend Coin<T> to a list of addresses, where T can be any coin type, following a list of amounts, The object specified in the gas field will be used to pay the gas fee for the transaction. The gas object can not appear in input_coins. If the gas object is not specified, the RPC server will auto-select one.
UnsafePayAllIotaParamsSend all IOTA coins to one recipient. This is for IOTA coin only and does not require a separate gas coin object. Specifically, what pay_all_iota does are: 1. accumulate all IOTA from input coins and deposit all IOTA to the first input coin 2. transfer the updated first coin to the recipient and also use this first coin as gas coin object. 3. the balance of the first input coin after tx is sum(input_coins) - actual_gas_cost. 4. all other input coins other than the first are deleted.
UnsafePayIotaParamsSend IOTA coins to a list of addresses, following a list of amounts. This is for IOTA coin only and does not require a separate gas coin object. Specifically, what pay_iota does are: 1. debit each input_coin to create new coin following the order of amounts and assign it to the corresponding recipient. 2. accumulate all residual IOTA from input coins left and deposit all IOTA to the first input coin, then use the first input coin as the gas coin object. 3. the balance of the first input coin after tx is sum(input_coins) - sum(amounts) - actual_gas_cost 4. all other input coints other than the first one are deleted.
UnsafePublishParamsCreate an unsigned transaction to publish a Move package.
UnsafeRequestAddStakeParamsAdd stake to a validator's staking pool using multiple coins and amount.
UnsafeRequestAddTimelockedStakeParamsAdd timelocked stake to a validator's staking pool using multiple balances and amount.
UnsafeRequestWithdrawStakeParamsWithdraw stake from a validator's staking pool.
UnsafeRequestWithdrawTimelockedStakeParamsWithdraw timelocked stake from a validator's staking pool.
UnsafeSplitCoinParamsCreate an unsigned transaction to split a coin object into multiple coins.
UnsafeSplitCoinEqualParamsCreate an unsigned transaction to split a coin object into multiple equal-size coins.
UnsafeTransferIotaParamsCreate an unsigned transaction to send IOTA coin object to an IOTA address. The IOTA object is also used as the gas object.
UnsafeTransferObjectParamsCreate an unsigned transaction to transfer an object from one address to another. The object's type must allow public transfers

Type Aliases

Type AliasDescription
IotaClientOptionsConfiguration options for the IotaClient You must provide either a url or a transport
HttpHeadersAn object defining headers to be passed to the RPC server
RequestInspectorA function that can inspect and modify RPC requests before they are executed. Useful for monitoring, tracing, and error handling.
NetworkId-
ChainType-
EpochPage-
EpochMetricsPage-
CheckpointPage-
AllEpochsAddressMetrics-
MoveCallMetric-
DynamicFieldPage-
IotaMoveNormalizedModules-
IotaMoveObject-
IotaMovePackage-
ProgrammableTransaction-
LatestIotaSystemStateSummary-
IotaObjectChangePublished-
IotaObjectChangeTransferred-
IotaObjectChangeMutated-
IotaObjectChangeDeleted-
IotaObjectChangeWrapped-
IotaObjectChangeCreated-
CoinBalance-
Order-
Unsubscribe-
CallArg-
CheckpointCommitment-
CheckpointId-
CompressedSignatureUnlike [enum Signature], [enum CompressedSignature] does not contain public key.
ConsensusDeterminedVersionAssignmentsUses an enum to allow for future expansion of the ConsensusDeterminedVersionAssignments.
IotaParsedData-
DynamicFieldInfo-
DynamicFieldType-
IotaEvent-
IotaEventFilter-
ExecuteTransactionRequestType-
ExecutionStatus-
InputObjectKind-
IotaArgumentAn argument to a transaction in a programmable transaction block
IotaCallArg-
IotaEndOfEpochTransactionKind-
IotaMoveAbility-
IotaMoveNormalizedType-
IotaMoveViewCallResults-
IotaMoveVisibility-
IotaObjectDataFilter-
IotaSystemStateSummaryThis is the JSON-RPC type for IOTA system state objects. It is an enum type that can represent either V1 or V2 system state objects.
IotaTransactionA single transaction in a programmable transaction block.
IotaTransactionBlockBuilderMode-
IotaTransactionKindRepresents the type of a transaction. All transactions except ProgrammableTransaction are considered system transactions.
MoveAuthenticatorMoveAuthenticator is a GenericSignature variant that enables a new method of authentication through Move code. This function represents the data received by the Move authenticate function during the Account Abstraction authentication flow.
IotaMoveFunctionArgType-
MoveStruct-
MoveValue-
ObjectArg-
IotaObjectChangeObjectChange are derived from the object mutations in the TransactionEffect to provide richer object information.
ObjectRead-
ObjectResponseError-
ObjectValueKind-
ObjectOwner-
ProtocolConfigValue-
PtbInput-
PublicKey-
RPCTransactionRequestParams-
RawData-
Signature-
StakeObject-
TimelockedStake-
TransactionBlockData-
TransactionEffects-
IotaTransactionBlockKind-
TransactionFilter-
TransactionFilterV2-
GetOwnedObjectsParamsReturn the list of objects owned by an address. Note that if the address owns more than QUERY_MAX_RESULT_LIMIT objects, the pagination is not accurate, because previous page may have been updated when the next page is fetched. Please use iotax_queryObjects if this is a concern.
QueryTransactionBlocksParamsReturn list of transactions for a specified query criteria.

Functions

FunctionDescription
getAppsBackend-
isIotaClient-
getAllNetworks-
getNetwork-
getDefaultNetwork-
getFullnodeUrl-
getGraphQLUrl-