Skip to main content

IAddressable

Interface implemented by GraphQL types representing entities that are identified by an address.

An address uniquely represents either the public key of an account, or an object's ID, but never both. It is not possible to determine which type an address represents up-front. If an object is wrapped, its contents will not be accessible via its address, but it will still be possible to access other objects it owns.

interface IAddressable {
  address: SuiAddress!
  addressAt(
    rootVersion: UInt53
    checkpoint: UInt53
  ): Address
  asTransactionObject(
    transactionDigest: String
  ): TransactionObject
  balance(
    coinType: String!
  ): Balance
  balances(
    first: Int
    after: String
    last: Int
    before: String
  ): BalanceConnection
  defaultNameRecord: NameRecord
  multiGetBalances(
    keys: [String!]!
  ): [Balance!]
  objects(
    first: Int
    after: String
    last: Int
    before: String
    filter: ObjectFilter
  ): MoveObjectConnection
}

Fields​

IAddressable.address ● SuiAddress! non-null scalar​

IAddressable.addressAt ● Address object​

Fetch the address as it was at a different root version, or checkpoint.

If no additional bound is provided, the address is fetched at the latest checkpoint known to the RPC.

IAddressable.addressAt.rootVersion ● UInt53 scalar​
IAddressable.addressAt.checkpoint ● UInt53 scalar​

IAddressable.asTransactionObject ● TransactionObject union​

How this addressable entity was referenced by a specific transaction.

Returns null if the object was not referenced, or was present only as a non-object marker variant of unchanged consensus input (e.g. cancelled, stream-ended, per-epoch).

The transactionDigest argument may be omitted when the query is scoped under a transaction context (e.g. a parent Transaction, TransactionEffects, or Event); the field then resolves against the in-scope transaction.

Passing an explicit transactionDigest other than the in-scope transaction in subscription context is not supported; for arbitrary transaction lookups, use the indexed Query API.

IAddressable.asTransactionObject.transactionDigest ● String scalar​

IAddressable.balance ● Balance object​

Fetch the total balance for coins with marker type coinType (e.g. 0x2::sui::SUI), owned by this address.

If the address does not own any coins of that type, a balance of zero is returned.

IAddressable.balance.coinType ● String! non-null scalar​

IAddressable.balances ● BalanceConnection object​

Total balance across coins owned by this address, grouped by coin type.

IAddressable.balances.first ● Int scalar​
IAddressable.balances.after ● String scalar​
IAddressable.balances.last ● Int scalar​
IAddressable.balances.before ● String scalar​

IAddressable.defaultNameRecord ● NameRecord object​

The domain explicitly configured as the default Name Service name for this address.

IAddressable.multiGetBalances ● [Balance!] list object​

Fetch the total balances keyed by coin types (e.g. 0x2::sui::SUI) owned by this address.

Returns null when no checkpoint is set in scope (e.g. execution scope). If the address does not own any coins of a given type, a balance of zero is returned for that type.

IAddressable.multiGetBalances.keys ● [String!]! non-null scalar​

IAddressable.objects ● MoveObjectConnection object​

Objects owned by this address, optionally filtered by type.

IAddressable.objects.first ● Int scalar​
IAddressable.objects.after ● String scalar​
IAddressable.objects.last ● Int scalar​
IAddressable.objects.before ● String scalar​
IAddressable.objects.filter ● ObjectFilter input​

Implemented By​

Address object ● CoinMetadata object ● DynamicField object ● MoveObject object ● MovePackage object ● Object object