Address

No description

type Address implements Node, IAddressable {
  address: SuiAddress!
  addressAt(
    rootVersion: UInt53
    checkpoint: UInt53
  ): Address
  asObject: Object
  balance(
    coinType: String!
  ): Balance
  balances(
    first: Int
    after: String
    last: Int
    before: String
  ): BalanceConnection
  defaultNameRecord: NameRecord
  dynamicField(
    name: DynamicFieldName!
  ): DynamicField
  dynamicFields(
    first: Int
    after: String
    last: Int
    before: String
  ): DynamicFieldConnection
  dynamicObjectField(
    name: DynamicFieldName!
  ): DynamicField
  id: ID!
  multiGetBalances(
    keys: [String!]!
  ): [Balance!]
  multiGetDynamicFields(
    keys: [DynamicFieldName!]!
  ): [DynamicField]!
  multiGetDynamicObjectFields(
    keys: [DynamicFieldName!]!
  ): [DynamicField]!
  objects(
    first: Int
    after: String
    last: Int
    before: String
    filter: ObjectFilter
  ): MoveObjectConnection
  transactions(
    first: Int
    after: String
    last: Int
    before: String
    relation: AddressTransactionRelationship
    filter: TransactionFilter
  ): TransactionConnection
}

Fields

Address.address ● SuiAddress! non-null scalar

The Address' identifier, a 32-byte number represented as a 64-character hex string, with a lead "0x".

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

Address.addressAt.rootVersion ● UInt53 scalar

Address.addressAt.checkpoint ● UInt53 scalar

Address.asObject ● Object object

Attempts to fetch the object at this address.

Address.balance ● Balance object

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

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

Address.balance.coinType ● String! non-null scalar

Address.balances ● BalanceConnection object

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

Address.balances.first ● Int scalar

Address.balances.after ● String scalar

Address.balances.last ● Int scalar

Address.balances.before ● String scalar

Address.defaultNameRecord ● NameRecord object

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

Address.dynamicField ● DynamicField object

Access a dynamic field on an object using its type and BCS-encoded name.

Returns null if a dynamic field with that name could not be found attached to the object with this address.

Address.dynamicField.name ● DynamicFieldName! non-null input

Address.dynamicFields ● DynamicFieldConnection object

Dynamic fields owned by this address.

The address must correspond to an object (account addresses cannot own dynamic fields), but that object may be wrapped.

Address.dynamicFields.first ● Int scalar

Address.dynamicFields.after ● String scalar

Address.dynamicFields.last ● Int scalar

Address.dynamicFields.before ● String scalar

Address.dynamicObjectField ● DynamicField object

Access a dynamic object field on an object using its type and BCS-encoded name.

Returns null if a dynamic object field with that name could not be found attached to the object with this address.

Address.dynamicObjectField.name ● DynamicFieldName! non-null input

Address.id ● ID! non-null scalar

The address's globally unique identifier, which can be passed to Query.node to refetch it.

Address.multiGetBalances ● [Balance!] list object

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

Returns None 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.

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

Address.multiGetDynamicFields ● [DynamicField]! non-null object

Access dynamic fields on an object using their types and BCS-encoded names.

Returns a list of dynamic fields that is guaranteed to be the same length as keys. If a dynamic field in keys could not be found in the store, its corresponding entry in the result will be null.

Address.multiGetDynamicFields.keys ● [DynamicFieldName!]! non-null input

Address.multiGetDynamicObjectFields ● [DynamicField]! non-null object

Access dynamic object fields on an object using their types and BCS-encoded names.

Returns a list of dynamic object fields that is guaranteed to be the same length as keys. If a dynamic object field in keys could not be found in the store, its corresponding entry in the result will be null.

Address.multiGetDynamicObjectFields.keys ● [DynamicFieldName!]! non-null input

Address.objects ● MoveObjectConnection object

Objects owned by this address, optionally filtered by type.

Address.objects.first ● Int scalar

Address.objects.after ● String scalar

Address.objects.last ● Int scalar

Address.objects.before ● String scalar

Address.objects.filter ● ObjectFilter input

Address.transactions ● TransactionConnection object

Transactions associated with this address.

Similar behavior to the transactions in Query but supporting the additional AddressTransactionRelationship filter, which defaults to SENT.

Address.transactions.first ● Int scalar

Address.transactions.after ● String scalar

Address.transactions.last ● Int scalar

Address.transactions.before ● String scalar

Address.transactions.relation ● AddressTransactionRelationship enum

Address.transactions.filter ● TransactionFilter input

Interfaces

Node interface

An interface implemented by types that can be uniquely identified by a globally unique ID, following the GraphQL Global Object Identification specification.

IAddressable interface

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.

Returned By

address query ● multiGetAddresses query

Member Of

Address object ● AddressOwner object ● BalanceChange object ● CoinMetadata object ● ConsensusAddressOwner object ● DynamicField object ● Event object ● GasInput object ● IAddressable interface ● MoveObject object ● MovePackage object ● MoveValue object ● NameRecord object ● Object object ● ObjectOwner object ● Transaction object