Address
No description
type Address implements IAddressable {
address: SuiAddress!
asObject: Object
balance(
coinType: String!
): Balance
balances(
first: Int
after: String
last: Int
before: String
): BalanceConnection
dynamicField(
name: DynamicFieldName!
): DynamicField
dynamicFields(
first: Int
after: String
last: Int
before: String
): DynamicFieldConnection
dynamicObjectField(
name: DynamicFieldName!
): DynamicField
multiGetBalances(
keys: [String!]!
): [Balance!]
multiGetDynamicFields(
keys: [DynamicFieldName!]!
): [DynamicField]!
multiGetDynamicObjectFields(
keys: [DynamicFieldName!]!
): [DynamicField]!
objects(
first: Int
after: String
last: Int
before: String
filter: ObjectFilter
): MoveObjectConnection
}
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.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.dynamicField
● DynamicField
object
Access a dynamic field on an object using its type and BCS-encoded name.
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.
Address.dynamicObjectField.name
● DynamicFieldName!
non-null input
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
Interfaces
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
Member Of
AddressOwner
object ● BalanceChange
object ● ConsensusAddressOwner
object ● Event
object ● GasInput
object ● ObjectOwner
object ● Transaction
object