Class AccountAbstract
Implemented by
Index
Constructors
Properties
Methods
Constructors
constructor
Properties
Readonly Abstract account
Account address associated with the account
+Readonly Abstract private
Private key associated with the account. +Note: this will be removed in the next major release, + as not all accounts have a private key.
+Readonly Abstract public
Public key associated with the account
+Abstract signing
Signing scheme used to sign transactions
+Methods
Abstract sign
Abstract sign
- sign
With Authenticator(message): AccountAuthenticator Sign a message using the available signing capabilities.
+Parameters
- message: HexInput
the signing message, as binary input
+
Returns AccountAuthenticator
the AccountAuthenticator containing the signature, together with the account's public key
+- message: HexInput
verify
- verify
Signature(args): boolean Parameters
- args: VerifySignatureArgs
Returns boolean
Static auth
- auth
Key(args): AuthenticationKey Parameters
- args: {
publicKey: AccountPublicKey;
}public
Key: AccountPublicKey PublicKey - public key of the account
+
Returns AuthenticationKey
The authentication key for the associated account
+Deprecated
use
+publicKey.authKey()instead. +This key enables account owners to rotate their private key(s) +associated with the account without changing the address that hosts their account. +See here for more info: https://aptos.dev/concepts/accounts#single-signer-authentication- args: {
Static from
- from
Derivation Path(args): Ed25519Account Derives an account with bip44 path and mnemonics
+Parameters
Returns Ed25519Account
- from
Derivation Path(args): SingleKeyAccount Parameters
Returns SingleKeyAccount
- from
Derivation Path(args): SingleKeyAccount Parameters
Returns SingleKeyAccount
- from
Derivation Path(args): Account Parameters
Returns Account
Static from
- from
Private Key(args): Ed25519Account Creates an account from the provided private key.
+Parameters
Returns Ed25519Account
- from
Private Key(args): SingleKeyAccount Parameters
Returns SingleKeyAccount
- from
Private Key(args): SingleKeyAccount Parameters
Returns SingleKeyAccount
- from
Private Key(args): Account Parameters
Returns Account
Static from
Static generate
- generate(args?): Ed25519Account
Derives an account from a randomly generated private key.
+Parameters
Optionalargs: GenerateEd25519AccountArgs
Returns Ed25519Account
An account compatible with the provided signature scheme
+- generate(args): SingleKeyAccount
Parameters
Returns SingleKeyAccount
- generate(args): SingleKeyAccount
Parameters
Returns SingleKeyAccount
- generate(args): Account
Parameters
- args: GenerateAccountArgs
Returns Account
Generated using TypeDoc
Class AccountAddress
NOTE: Only use this class for account addresses. For other hex data, e.g. transaction +hashes, use the Hex class.
+AccountAddress is used for working with account addresses. Account addresses, when +represented as a string, generally look like these examples:
+-
+
- 0x1 +
- 0xaa86fe99004361f747f91342ca13c426ca0cccb0c1217677180c9493bad6ef0c +
Proper formatting and parsing of account addresses is defined by AIP-40. +To learn more about the standard, read the AIP here: +https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
+The comments in this class make frequent reference to the LONG and SHORT formats, +as well as "special" addresses. To learn what these refer to see AIP-40.
+Hierarchy (view full)
- Serializable
- AccountAddress
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Account Address(input): AccountAddress Creates an instance of AccountAddress from a Uint8Array.
+Parameters
- input: Uint8Array
Returns AccountAddress
Properties
Readonly data
data: Uint8Array
This is the internal representation of an account address.
+Static FOUR
Static Readonly LENGTH
LENGTH: number = 32
The number of bytes that make up an account address.
+Static Readonly LONG_
LONG_
The length of an address string in LONG form without a leading 0x.
+Static ONE
Static THREE
Static TWO
Static ZERO
Methods
bcs
bcs
equals
- equals(other): boolean
Return whether AccountAddresses are equal. AccountAddresses are considered equal +if their underlying byte data is identical.
+Parameters
- other: AccountAddress
The AccountAddress to compare to.
+
Returns boolean
true if the AccountAddresses are equal, false if not.
+- other: AccountAddress
is
- is
Special(): boolean Returns whether an address is special, where special is defined as 0x0 to 0xf +inclusive. In other words, the last byte of the address must be < 0b10000 (16) +and every other byte must be zero.
+For more information on how special addresses are defined see AIP-40: +https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
+Returns boolean
true if the address is special, false if not.
+
serialize
- serialize(serializer): void
Serialize the AccountAddress to a Serializer instance's data buffer.
+Parameters
- serializer: Serializer
The serializer to serialize the AccountAddress to.
+
Returns void
void
+Example
+const serializer = new Serializer();
const address = AccountAddress.fromString("0x1");
address.serialize(serializer);
const bytes = serializer.toUint8Array();
// `bytes` is now the BCS-serialized address. +- serializer: Serializer
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
to
- to
String(): `0x${string}` Return the AccountAddress as a string as per AIP-40. +https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
+In short, it means that special addresses are represented in SHORT form, meaning +0x0 through to 0xf inclusive, and every other address is represented in LONG form, +meaning 0x + 64 hex characters.
+Returns `0x${string}`
AccountAddress as a string conforming to AIP-40.
+
to
- to
String Long(): `0x${string}` NOTE: Prefer to use
+toStringwhere possible.Whereas toString will format special addresses (as defined by isSpecial) using the +SHORT form (no leading 0s), this format the address in the LONG format +unconditionally.
+This means it will be 0x + 64 hex characters.
+Returns `0x${string}`
AccountAddress as a string in LONG form.
+
to
- to
String Long Without Prefix(): string NOTE: Prefer to use
+toStringwhere possible.Whereas toString will format special addresses (as defined by isSpecial) using the +SHORT form (no leading 0s), this function will include leading zeroes. The string +will not have a leading zero.
+This means it will be 64 hex characters without a leading 0x.
+Returns string
AccountAddress as a string in LONG form without a leading 0x.
+
to
to
Static deserialize
- deserialize(deserializer): AccountAddress
Deserialize an AccountAddress from the byte buffer in a Deserializer instance.
+Parameters
- deserializer: Deserializer
The deserializer to deserialize the AccountAddress from.
+
Returns AccountAddress
An instance of AccountAddress.
+Example
+const bytes = hexToBytes("0x0102030405060708091011121314151617181920212223242526272829303132");
const deserializer = new Deserializer(bytes);
const address = AccountAddress.deserialize(deserializer);
// `address` is now an instance of AccountAddress. +- deserializer: Deserializer
Static from
- from(input): AccountAddress
Convenience method for creating an AccountAddress from all known inputs.
+This handles, Uint8array, string, and AccountAddress itself
+Parameters
- input: AccountAddressInput
Returns AccountAddress
Static from
- from
Strict(input): AccountAddress Convenience method for creating an AccountAddress from all known inputs.
+This handles, Uint8array, string, and AccountAddress itself
+Parameters
- input: AccountAddressInput
Returns AccountAddress
Static from
- from
String(input): AccountAddress NOTE: This function has relaxed parsing behavior. For strict behavior, please use +the
+fromStringStrictfunction. Where possible usefromStringStrictrather than this +function,fromStringis only provided for backwards compatibility.Creates an instance of AccountAddress from a hex string.
+This function allows all formats defined by AIP-40. In short this means the +following formats are accepted:
+-
+
- LONG, with or without leading 0x +
- SHORT, with or without leading 0x +
Where:
+-
+
- LONG is 64 hex characters. +
- SHORT is 1 to 63 hex characters inclusive. +
- Padding zeroes are allowed, e.g. 0x0123 is valid. +
Learn more about the different address formats by reading AIP-40: +https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
+Parameters
- input: string
A hex string representing an account address.
+
Returns AccountAddress
An instance of AccountAddress.
+
Static from
- from
String Strict(input): AccountAddress NOTE: This function has strict parsing behavior. For relaxed behavior, please use +the
+fromStringfunction.Creates an instance of AccountAddress from a hex string.
+This function allows only the strictest formats defined by AIP-40. In short this +means only the following formats are accepted:
+-
+
- LONG +
- SHORT for special addresses +
Where:
+-
+
- LONG is defined as 0x + 64 hex characters. +
- SHORT for special addresses is 0x0 to 0xf inclusive without padding zeroes. +
This means the following are not accepted:
+-
+
- SHORT for non-special addresses. +
- Any address without a leading 0x. +
Learn more about the different address formats by reading AIP-40: +https://github.com/aptos-foundation/AIPs/blob/main/aips/aip-40.md.
+Parameters
- input: string
A hex string representing an account address.
+
Returns AccountAddress
An instance of AccountAddress.
+
Static is
- is
Valid(args): ParsingResult<AddressInvalidReason> Check if the string is a valid AccountAddress.
+Parameters
- args: {
input: AccountAddressInput;
strict?: boolean;
}input: AccountAddressInput
A hex string representing an account address.
+Optionalstrict?: booleanIf true, use strict parsing behavior. If false, use relaxed parsing behavior.
+
Returns ParsingResult<AddressInvalidReason>
valid = true if the string is valid, valid = false if not. If the string +is not valid, invalidReason will be set explaining why it is invalid.
+- args: {
Generated using TypeDoc
Class AccountAuthenticatorAbstract
Hierarchy (view full)
Index
Constructors
Methods
Constructors
constructor
- new
Account Authenticator(): AccountAuthenticator Returns AccountAuthenticator
Methods
bcs
bcs
is
- is
Ed25519(): this is AccountAuthenticatorEd25519 Returns this is AccountAuthenticatorEd25519
is
- is
Multi Ed25519(): this is AccountAuthenticatorMultiEd25519 Returns this is AccountAuthenticatorMultiEd25519
is
- is
Multi Key(): this is AccountAuthenticatorMultiKey Returns this is AccountAuthenticatorMultiKey
is
- is
Single Key(): this is AccountAuthenticatorSingleKey Returns this is AccountAuthenticatorSingleKey
Abstract serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): AccountAuthenticator
Parameters
- deserializer: Deserializer
Returns AccountAuthenticator
Generated using TypeDoc
Class AccountAuthenticatorEd25519
Transaction authenticator Ed25519 for a multi signer transaction
+Param: public_key
Account's Ed25519 public key.
+Param: signature
Account's Ed25519 signature
+Hierarchy (view full)
- AccountAuthenticator
- AccountAuthenticatorEd25519
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Account Authenticator Ed25519(public_key, signature): AccountAuthenticatorEd25519 Parameters
- public_key: Ed25519PublicKey
- signature: Ed25519Signature
Returns AccountAuthenticatorEd25519
Properties
Readonly public_
Readonly signature
Methods
bcs
bcs
is
- is
Ed25519(): this is AccountAuthenticatorEd25519 Returns this is AccountAuthenticatorEd25519
is
- is
Multi Ed25519(): this is AccountAuthenticatorMultiEd25519 Returns this is AccountAuthenticatorMultiEd25519
is
- is
Multi Key(): this is AccountAuthenticatorMultiKey Returns this is AccountAuthenticatorMultiKey
is
- is
Single Key(): this is AccountAuthenticatorSingleKey Returns this is AccountAuthenticatorSingleKey
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): AccountAuthenticator
Parameters
- deserializer: Deserializer
Returns AccountAuthenticator
Static load
- load(deserializer): AccountAuthenticatorEd25519
Parameters
- deserializer: Deserializer
Returns AccountAuthenticatorEd25519
Generated using TypeDoc
Class AccountAuthenticatorMultiEd25519
Transaction authenticator Multi Ed25519 for a multi signers transaction
+Param: public_key
Account's MultiEd25519 public key.
+Param: signature
Account's MultiEd25519 signature
+Hierarchy (view full)
- AccountAuthenticator
- AccountAuthenticatorMultiEd25519
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Account Authenticator Multi Ed25519(public_key, signature): AccountAuthenticatorMultiEd25519 Parameters
- public_key: MultiEd25519PublicKey
- signature: MultiEd25519Signature
Returns AccountAuthenticatorMultiEd25519
Properties
Readonly public_
Readonly signature
Methods
bcs
bcs
is
- is
Ed25519(): this is AccountAuthenticatorEd25519 Returns this is AccountAuthenticatorEd25519
is
- is
Multi Ed25519(): this is AccountAuthenticatorMultiEd25519 Returns this is AccountAuthenticatorMultiEd25519
is
- is
Multi Key(): this is AccountAuthenticatorMultiKey Returns this is AccountAuthenticatorMultiKey
is
- is
Single Key(): this is AccountAuthenticatorSingleKey Returns this is AccountAuthenticatorSingleKey
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): AccountAuthenticator
Parameters
- deserializer: Deserializer
Returns AccountAuthenticator
Static load
- load(deserializer): AccountAuthenticatorMultiEd25519
Parameters
- deserializer: Deserializer
Returns AccountAuthenticatorMultiEd25519
Generated using TypeDoc
Class AccountAuthenticatorMultiKey
AccountAuthenticatorMultiKey for a multi signer
+Param: public_keys
MultiKey
+Param: signatures
Signature
+Hierarchy (view full)
- AccountAuthenticator
- AccountAuthenticatorMultiKey
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Account Authenticator Multi Key(public_keys, signatures, signatures_bitmap): AccountAuthenticatorMultiKey Parameters
- public_keys: MultiKey
- signatures: AnySignature[]
- signatures_bitmap: Uint8Array
Returns AccountAuthenticatorMultiKey
Properties
Readonly public_
Readonly signatures
Readonly signatures_
signatures_
Methods
bcs
bcs
is
- is
Ed25519(): this is AccountAuthenticatorEd25519 Returns this is AccountAuthenticatorEd25519
is
- is
Multi Ed25519(): this is AccountAuthenticatorMultiEd25519 Returns this is AccountAuthenticatorMultiEd25519
is
- is
Multi Key(): this is AccountAuthenticatorMultiKey Returns this is AccountAuthenticatorMultiKey
is
- is
Single Key(): this is AccountAuthenticatorSingleKey Returns this is AccountAuthenticatorSingleKey
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): AccountAuthenticator
Parameters
- deserializer: Deserializer
Returns AccountAuthenticator
Static load
- load(deserializer): AccountAuthenticatorMultiKey
Parameters
- deserializer: Deserializer
Returns AccountAuthenticatorMultiKey
Generated using TypeDoc
Class AccountAuthenticatorSingleKey
AccountAuthenticatorSingleKey for a single signer
+Param: public_key
AnyPublicKey
+Param: signature
AnySignature
+Hierarchy (view full)
- AccountAuthenticator
- AccountAuthenticatorSingleKey
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Account Authenticator Single Key(public_key, signature): AccountAuthenticatorSingleKey Parameters
- public_key: AnyPublicKey
- signature: AnySignature
Returns AccountAuthenticatorSingleKey
Properties
Readonly public_
Readonly signature
Methods
bcs
bcs
is
- is
Ed25519(): this is AccountAuthenticatorEd25519 Returns this is AccountAuthenticatorEd25519
is
- is
Multi Ed25519(): this is AccountAuthenticatorMultiEd25519 Returns this is AccountAuthenticatorMultiEd25519
is
- is
Multi Key(): this is AccountAuthenticatorMultiKey Returns this is AccountAuthenticatorMultiKey
is
- is
Single Key(): this is AccountAuthenticatorSingleKey Returns this is AccountAuthenticatorSingleKey
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): AccountAuthenticator
Parameters
- deserializer: Deserializer
Returns AccountAuthenticator
Static load
- load(deserializer): AccountAuthenticatorSingleKey
Parameters
- deserializer: Deserializer
Returns AccountAuthenticatorSingleKey
Generated using TypeDoc
Class AccountPublicKeyAbstract
An abstract representation of an account public key.
+Provides a common interface for deriving an authentication key.
+Hierarchy (view full)
Index
Constructors
Methods
Constructors
constructor
- new
Account Public Key(): AccountPublicKey Returns AccountPublicKey
Methods
Abstract auth
- auth
Key(): AuthenticationKey Get the authentication key associated with this public key
+Returns AuthenticationKey
bcs
bcs
Abstract serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Abstract to
Abstract verify
- verify
Signature(args): boolean Verifies that the private key associated with this public key signed the message with the given signature.
+Parameters
- args: VerifySignatureArgs
Returns boolean
Generated using TypeDoc
Class AccountSequenceNumber
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Account Sequence Number(aptosConfig, account, maxWaitTime, maximumInFlight, sleepTime): AccountSequenceNumber Parameters
- aptosConfig: AptosConfig
- account: Account
- maxWaitTime: number
- maximumInFlight: number
- sleepTime: number
Returns AccountSequenceNumber
Properties
Readonly account
Readonly aptos
current
current
last
last
lock
lock: boolean = false
We want to guarantee that we preserve ordering of workers to requests.
+lock is used to try to prevent multiple coroutines from accessing a shared resource at the same time,
+which can result in race conditions and data inconsistency.
+This code actually doesn't do it though, since we aren't giving out a slot, it is still somewhat a race condition.
The ideal solution is likely that each thread grabs the next number from a incremental integer.
+When they complete, they increment that number and that entity is able to enter the lock.
+That would guarantee ordering.
max
max
maximum
maximum
sleep
sleep
Methods
initialize
next
synchronize
update
Generated using TypeDoc
Class AnyPublicKey
Represents any public key supported by Aptos.
+Since AIP-55 Aptos supports
+Legacy and Unified authentication keys.
Any unified authentication key is represented in the SDK as AnyPublicKey.
Hierarchy (view full)
- AccountPublicKey
- AnyPublicKey
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Any Public Key(publicKey): AnyPublicKey Parameters
- publicKey: PublicKey
Returns AnyPublicKey
Properties
Readonly public
Reference to the inner public key
+Readonly variant
Index of the underlying enum variant
+Methods
auth
- auth
Key(): AuthenticationKey Get the authentication key associated with this public key
+Returns AuthenticationKey
bcs
bcs
is
is
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
verify
- verify
Signature(args): boolean Verifies that the private key associated with this public key signed the message with the given signature.
+Parameters
- args: VerifySignatureArgs
Returns boolean
Static deserialize
- deserialize(deserializer): AnyPublicKey
Parameters
- deserializer: Deserializer
Returns AnyPublicKey
Static is
- is
Public Key(publicKey): publicKey is AnyPublicKey Parameters
- publicKey: AccountPublicKey
Returns publicKey is AnyPublicKey
Deprecated
use
+instanceof AnyPublicKeyinstead.
Generated using TypeDoc
Class AnySignature
Instance of signature that uses the SingleKey authentication scheme.
+This signature can only be generated by a SingleKeySigner, since it uses the
+same authentication scheme.
Hierarchy (view full)
- Signature
- AnySignature
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Any Signature(signature): AnySignature Parameters
- signature: Signature
Returns AnySignature
Properties
Readonly signature
Private Readonly variant
Index of the underlying enum variant
+Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
Static deserialize
- deserialize(deserializer): AnySignature
Parameters
- deserializer: Deserializer
Returns AnySignature
Generated using TypeDoc
Class Aptos
This class is the main entry point into Aptos's +APIs and separates functionality into different namespaces.
+To use the SDK, create a new Aptos instance to get access +to all the sdk functionality.
+Hierarchy
- Account
- ANS
- Coin
- DigitalAsset
- Event
- Faucet
- FungibleAsset
- General
- Staking
- Omit<Transaction, "build" | "simulate" | "submit" | "batch">
- Aptos
Index
Constructors
Properties
account
+ans
+coin
+config
+digital
Methods
add
Constructors
constructor
- new
Aptos(settings?): Aptos Parameters
Optionalsettings: AptosConfig
Returns Aptos
Properties
Readonly account
account: Account
Readonly ans
ans: ANS
Readonly coin
coin: Coin
Readonly config
Readonly digital
digital
Readonly event
event: Event
Readonly faucet
faucet: Faucet
Readonly fungible
fungible
Readonly general
general: General
Readonly staking
staking: Staking
Readonly transaction
transaction: Transaction
Methods
add
- add
Digital Asset Property Transaction(args): Promise<SimpleTransaction> Add a digital asset property
+Parameters
- args: {
creator: Account;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
propertyKey: string;
propertyType: "U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY";
propertyValue: PropertyValue;
}creator: Account
digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` Optionaloptions?: InputGenerateTransactionOptionsproperty
Key: string The property key for storing on-chain properties
+property
Type: "U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY" The type of property value
+property
Value: PropertyValue The property value to be stored on-chain
+
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
add
- add
Digital Asset Typed Property Transaction(args): Promise<SimpleTransaction> Add a typed digital asset property
+Parameters
- args: {
creator: Account;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
propertyKey: string;
propertyType: "U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY";
propertyValue: PropertyValue;
}creator: Account
digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` Optionaloptions?: InputGenerateTransactionOptionsproperty
Key: string The property key for storing on-chain properties
+property
Type: "U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY" The type of property value
+property
Value: PropertyValue The property value to be stored on-chain
+
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
batch
- batch
Transactions For Single Account(args): Promise<void> Parameters
- args: {
data: InputGenerateTransactionPayloadData[];
options?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">;
sender: Account;
}data: InputGenerateTransactionPayloadData[]
An array of transaction payloads
+Optionaloptions?: Omit<InputGenerateTransactionOptions, "accountSequenceNumber">optional. Transaction generation configurations (excluding accountSequenceNumber)
+sender: Account
The sender account to sign and submit the transaction
+
Returns Promise<void>
void. Throws if any error
+Deprecated
Prefer to use
+aptos.transaction.batch.forSingleAccount()Batch transactions for a single account.
+This function uses a transaction worker that receives payloads to be processed +and submitted to chain. +Note that this process is best for submitting multiple transactions that +dont rely on each other, i.e batch funds, batch token mints, etc.
+If any worker failure, the functions throws an error.
+- args: {
burn
- burn
Digital Asset Transaction(args): Promise<SimpleTransaction> Burn a digital asset by its creator
+Parameters
- args: {
creator: Account;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
}creator: Account
The creator account
+digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` Optionaloptions?: InputGenerateTransactionOptions
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
create
- create
Collection Transaction(args): Promise<SimpleTransaction> Creates a new collection within the specified account
+Parameters
- args: {
creator: Account;
description: string;
name: string;
options?: InputGenerateTransactionOptions;
uri: string;
} & CreateCollectionOptions
Returns Promise<SimpleTransaction>
A SimpleTransaction that when submitted will create the collection.
+- args: {
derive
- derive
Account From Private Key(args): Promise<Account> Derives an account by providing a private key. +This functions resolves the provided private key type and derives the public key from it.
+If the privateKey is a Secp256k1 type, it derives the account using the derived public key and +auth key using the SingleKey scheme locally.
+If the privateKey is a ED25519 type, it looks up the authentication key on chain, and uses it to resolve +whether it is a Legacy ED25519 key or a Unified ED25519 key. It then derives the account based +on that.
+Parameters
- args: {
privateKey: PrivateKey;
}private
Key: PrivateKey An account private key
+
Returns Promise<Account>
Account type
+- args: {
freeze
- freeze
Digital Asset Transafer Transaction(args): Promise<SimpleTransaction> Freeze digital asset transfer ability
+Parameters
- args: {
creator: Account;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
}creator: Account
The creator account
+digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` Optionaloptions?: InputGenerateTransactionOptions
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
fund
- fund
Account(args): Promise<UserTransactionResponse> This creates an account if it does not exist and mints the specified amount of +coins into that account
+Parameters
- args: {
accountAddress: AccountAddressInput;
amount: number;
options?: WaitForTransactionOptions;
}account
Address: AccountAddressInput Address of the account to fund
+amount: number
Amount of tokens to fund the account with
+Optionaloptions?: WaitForTransactionOptionsConfiguration options for waitForTransaction
+
Returns Promise<UserTransactionResponse>
Transaction hash of the transaction that funded the account
+- args: {
get
- get
AccountAPTAmount(args): Promise<number> Queries the account's APT amount
+Parameters
- args: {
accountAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
}account
Address: AccountAddressInput The account address we want to get the total count for
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+
Returns Promise<number>
Current amount of account's APT
+- args: {
get
- get
Account Coin Amount(args): Promise<number> Queries the account's coin amount by the coin type
+Parameters
- args: {
accountAddress: AccountAddressInput;
coinType: `${string}::${string}::${string}`;
minimumLedgerVersion?: AnyNumber;
}account
Address: AccountAddressInput The account address we want to get the total count for
+coin
Type: `${string}::${string}::${string}` The coin type to query
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+
Returns Promise<number>
Current amount of account's coin
+- args: {
get
- get
Account Coins Count(args): Promise<number> Queries the current count of an account's coins aggregated
+Parameters
- args: {
accountAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
}account
Address: AccountAddressInput The account address we want to get the total count for
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+
Returns Promise<number>
Current count of the aggregated count of all account's coins
+- args: {
get
- get
Account Coins Data(args): Promise<{
amount: any;
asset_type: string;
is_frozen: boolean;
is_primary: boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
metadata?: null | {
asset_type: string;
creator_address: string;
decimals: number;
icon_uri?: null | string;
last_transaction_timestamp: any;
last_transaction_version: any;
name: string;
project_uri?: null | string;
supply_aggregator_table_handle_v1?: null | string;
supply_aggregator_table_key_v1?: null | string;
symbol: string;
token_standard: string;
};
owner_address: string;
storage_id: string;
token_standard: string;
}[]> Queries an account's coins data
+Parameters
- args: {
accountAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<{
amount: any;
asset_type: string;
is_frozen: boolean;
is_primary: boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
metadata?: null | {
asset_type: string;
creator_address: string;
decimals: number;
icon_uri?: null | string;
last_transaction_timestamp: any;
last_transaction_version: any;
name: string;
project_uri?: null | string;
supply_aggregator_table_handle_v1?: null | string;
supply_aggregator_table_key_v1?: null | string;
symbol: string;
token_standard: string;
};
owner_address: string;
storage_id: string;
token_standard: string;
}> & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
}account
Address: AccountAddressInput The account address we want to get the coins data for
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: PaginationArgs & OrderByArg<{
amount: any;
asset_type: string;
is_frozen: boolean;
is_primary: boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
metadata?: null | {
asset_type: string;
creator_address: string;
decimals: number;
icon_uri?: null | string;
last_transaction_timestamp: any;
last_transaction_version: any;
name: string;
project_uri?: null | string;
supply_aggregator_table_handle_v1?: null | string;
supply_aggregator_table_key_v1?: null | string;
symbol: string;
token_standard: string;
};
owner_address: string;
storage_id: string;
token_standard: string;
}> & WhereArg<CurrentFungibleAssetBalancesBoolExp>
Returns Promise<{
amount: any;
asset_type: string;
is_frozen: boolean;
is_primary: boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
metadata?: null | {
asset_type: string;
creator_address: string;
decimals: number;
icon_uri?: null | string;
last_transaction_timestamp: any;
last_transaction_version: any;
name: string;
project_uri?: null | string;
supply_aggregator_table_handle_v1?: null | string;
supply_aggregator_table_key_v1?: null | string;
symbol: string;
token_standard: string;
};
owner_address: string;
storage_id: string;
token_standard: string;
}[]>Array with the coins data
+- args: {
get
- get
Account Collections With Owned Tokens(args): Promise<{
collection_id?: null | string;
collection_name?: null | string;
collection_uri?: null | string;
creator_address?: null | string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
distinct_tokens?: any;
last_transaction_version?: any;
owner_address?: null | string;
single_token_uri?: null | string;
}[]> Queries for all collections that an account currently has tokens for.
+This query returns all tokens (v1 and v2 standards) an account owns, including NFTs, fungible, soulbound, etc. +If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
+Parameters
- args: {
accountAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
options?: TokenStandardArg & PaginationArgs & OrderByArg<{
collection_id?: null | string;
collection_name?: null | string;
collection_uri?: null | string;
creator_address?: null | string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
distinct_tokens?: any;
last_transaction_version?: any;
owner_address?: null | string;
single_token_uri?: null | string;
}>;
}account
Address: AccountAddressInput The account address we want to get the collections for
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: TokenStandardArg & PaginationArgs & OrderByArg<{
collection_id?: null | string;
collection_name?: null | string;
collection_uri?: null | string;
creator_address?: null | string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
distinct_tokens?: any;
last_transaction_version?: any;
owner_address?: null | string;
single_token_uri?: null | string;
}>
Returns Promise<{
collection_id?: null | string;
collection_name?: null | string;
collection_uri?: null | string;
creator_address?: null | string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
distinct_tokens?: any;
last_transaction_version?: any;
owner_address?: null | string;
single_token_uri?: null | string;
}[]>Collections array with the collections data
+- args: {
get
- get
Account Domains(args): Promise<{
domain?: null | string;
expiration_timestamp?: any;
is_primary?: null | boolean;
owner_address?: null | string;
registered_address?: null | string;
subdomain?: null | string;
token_standard?: null | string;
}[]> Fetches all top level domain names for an account
+Parameters
- args: GetAccountDomainsArgs
Returns Promise<{
domain?: null | string;
expiration_timestamp?: any;
is_primary?: null | boolean;
owner_address?: null | string;
registered_address?: null | string;
subdomain?: null | string;
token_standard?: null | string;
}[]>a promise of an array of ANSName
+
get
- get
Account Events By Creation Number(args): Promise<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}[]> Get events by creation number and an account address
+Parameters
- args: {
accountAddress: AccountAddressInput;
creationNumber: AnyNumber;
minimumLedgerVersion?: AnyNumber;
}account
Address: AccountAddressInput The account address
+creation
Number: AnyNumber The event creation number
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+
Returns Promise<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}[]>Promise
+- args: {
get
- get
Account Events By Event Type(args): Promise<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}[]> Get events by event type and an account address
+Parameters
- args: {
accountAddress: AccountAddressInput;
eventType: `${string}::${string}::${string}`;
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}>;
}account
Address: AccountAddressInput The account address
+event
Type: `${string}::${string}::${string}` The event type
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: PaginationArgs & OrderByArg<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}>
Returns Promise<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}[]>Promise
+- args: {
get
- get
Account Info(args): Promise<AccountData> Queries the current state for an Aptos account given its account address
+Parameters
- args: {
accountAddress: AccountAddressInput;
}account
Address: AccountAddressInput Aptos account address
+
Returns Promise<AccountData>
The account data
+Example: An example of the returned account
+{
sequence_number: "1",
authentication_key: "0x5307b5f4bc67829097a8ba9b43dba3b88261eeccd1f709d9bde240fc100fbb69"
} +- args: {
get
- get
Account Module(args): Promise<MoveModuleBytecode> Queries for a specific account module given account address and module name
+Parameters
- args: {
accountAddress: AccountAddressInput;
moduleName: string;
options?: LedgerVersionArg;
}account
Address: AccountAddressInput Aptos account address
+module
Name: string The name of the module
+Optionaloptions?: LedgerVersionArg
Returns Promise<MoveModuleBytecode>
Account module
+Example: An example of an account module
+{
bytecode: "0xa11ceb0b0600000006010002030206050807070f0d081c200",
abi: { address: "0x1" }
} +- args: {
get
- get
Account Modules(args): Promise<MoveModuleBytecode[]> Queries for all modules in an account given an account address
+Note: In order to get all account modules, this function may call the API +multiple times as it auto paginates.
+Parameters
- args: {
accountAddress: AccountAddressInput;
options?: PaginationArgs & LedgerVersionArg;
}account
Address: AccountAddressInput Aptos account address
+Optionaloptions?: PaginationArgs & LedgerVersionArg
Returns Promise<MoveModuleBytecode[]>
Account modules
+- args: {
get
- get
Account Names(args): Promise<{
domain?: null | string;
expiration_timestamp?: any;
is_primary?: null | boolean;
owner_address?: null | string;
registered_address?: null | string;
subdomain?: null | string;
token_standard?: null | string;
}[]> Fetches all names for an account (both top level domains and subdomains)
+Parameters
- args: GetAccountNamesArgs
Returns Promise<{
domain?: null | string;
expiration_timestamp?: any;
is_primary?: null | boolean;
owner_address?: null | string;
registered_address?: null | string;
subdomain?: null | string;
token_standard?: null | string;
}[]>a promise of an array of ANSName
+
get
- get
Account Owned Objects(args): Promise<{
allow_ungated_transfer: boolean;
is_deleted: boolean;
last_guid_creation_num: any;
last_transaction_version: any;
object_address: string;
owner_address: string;
state_key_hash: string;
}[]> Queries an account's owned objects
+Parameters
- args: {
accountAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<{
allow_ungated_transfer: boolean;
is_deleted: boolean;
last_guid_creation_num: any;
last_transaction_version: any;
object_address: string;
owner_address: string;
state_key_hash: string;
}>;
}account
Address: AccountAddressInput The account address we want to get the objects for
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: PaginationArgs & OrderByArg<{
allow_ungated_transfer: boolean;
is_deleted: boolean;
last_guid_creation_num: any;
last_transaction_version: any;
object_address: string;
owner_address: string;
state_key_hash: string;
}>
Returns Promise<{
allow_ungated_transfer: boolean;
is_deleted: boolean;
last_guid_creation_num: any;
last_transaction_version: any;
object_address: string;
owner_address: string;
state_key_hash: string;
}[]>Objects array with the object data
+- args: {
get
- get
Account Owned Tokens(args): Promise<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}[]> Queries the account's current owned tokens.
+This query returns all tokens (v1 and v2 standards) an account owns, including NFTs, fungible, soulbound, etc. +If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
+Parameters
- args: {
accountAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
options?: TokenStandardArg & PaginationArgs & OrderByArg<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}>;
}account
Address: AccountAddressInput The account address we want to get the tokens for
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: TokenStandardArg & PaginationArgs & OrderByArg<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}>
Returns Promise<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}[]>Tokens array with the token data
+- args: {
get
- get
Account Owned Tokens From Collection Address(args): Promise<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}[]> Queries all current tokens of a specific collection that an account owns by the collection address
+This query returns all tokens (v1 and v2 standards) an account owns, including NFTs, fungible, soulbound, etc. +If you want to get only the token from a specific standard, you can pass an optional tokenStandard param
+Parameters
- args: {
accountAddress: AccountAddressInput;
collectionAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
options?: TokenStandardArg & PaginationArgs & OrderByArg<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}>;
}account
Address: AccountAddressInput The account address we want to get the tokens for
+collection
Address: AccountAddressInput The address of the collection being queried
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: TokenStandardArg & PaginationArgs & OrderByArg<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}>
Returns Promise<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}[]>Tokens array with the token data
+- args: {
get
- get
Account Resource<T>(args): Promise<T> Queries a specific account resource given account address and resource type. Note that the default is
+anyin order +to allow for ease of accessing properties of the object.Type Parameters
Parameters
- args: {
accountAddress: AccountAddressInput;
options?: LedgerVersionArg;
resourceType: `${string}::${string}::${string}`;
}account
Address: AccountAddressInput Aptos account address
+Optionaloptions?: LedgerVersionArgresource
Type: `${string}::${string}::${string}` String representation of an on-chain Move struct type, i.e "0x1::aptos_coin::AptosCoin"
+
Returns Promise<T>
Account resource
+Example: An example of an account resource
+{
value: 6
} +- args: {
get
- get
Account Resources(args): Promise<MoveResource[]> Queries all account resources given an account address
+Note: In order to get all account resources, this function may call the API +multiple times as it auto paginates.
+Parameters
- args: {
accountAddress: AccountAddressInput;
options?: PaginationArgs & LedgerVersionArg;
}account
Address: AccountAddressInput Aptos account address
+Optionaloptions?: PaginationArgs & LedgerVersionArg
Returns Promise<MoveResource[]>
Account resources
+- args: {
get
- get
Account Subdomains(args): Promise<{
domain?: null | string;
expiration_timestamp?: any;
is_primary?: null | boolean;
owner_address?: null | string;
registered_address?: null | string;
subdomain?: null | string;
token_standard?: null | string;
}[]> Fetches all subdomains names for an account
+Parameters
- args: GetAccountSubdomainsArgs
Returns Promise<{
domain?: null | string;
expiration_timestamp?: any;
is_primary?: null | boolean;
owner_address?: null | string;
registered_address?: null | string;
subdomain?: null | string;
token_standard?: null | string;
}[]>a promise of an array of ANSName
+
get
- get
Account Tokens Count(args): Promise<number> Queries the current count of tokens owned by an account
+Parameters
- args: {
accountAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
}account
Address: AccountAddressInput The account address
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+
Returns Promise<number>
Current count of tokens owned by the account
+- args: {
get
- get
Account Transactions(args): Promise<TransactionResponse[]> Queries account transactions given an account address
+Note: In order to get all account transactions, this function may call the API +multiple times as it auto paginates.
+Parameters
- args: {
accountAddress: AccountAddressInput;
options?: PaginationArgs;
}account
Address: AccountAddressInput Aptos account address
+Optionaloptions?: PaginationArgs
Returns Promise<TransactionResponse[]>
The account transactions
+- args: {
get
- get
Account Transactions Count(args): Promise<number> Queries the current count of transactions submitted by an account
+Parameters
- args: {
accountAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
}account
Address: AccountAddressInput The account address we want to get the total count for
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+
Returns Promise<number>
Current count of transactions made by an account
+- args: {
get
get
get
get
get
- get
Collection Data(args): Promise<{
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
}> Queries data of a specific collection by the collection creator address and the collection name.
+If, for some reason, a creator account has 2 collections with the same name in v1 and v2, +can pass an optional
+tokenStandardparameter to query a specific standardParameters
- args: {
collectionName: string;
creatorAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
options?: TokenStandardArg;
}collection
Name: string the name of the collection
+creator
Address: AccountAddressInput the address of the collection's creator
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: TokenStandardArg
Returns Promise<{
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
}>GetCollectionDataResponse response type
+- args: {
get
- get
Collection Data By Collection Id(args): Promise<{
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
}> Queries data of a specific collection by the collection ID.
+Parameters
- args: {
collectionId: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
}collection
Id: AccountAddressInput the ID of the collection, it's the same thing as the address of the collection object
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+
Returns Promise<{
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
}>GetCollectionDataResponse response type
+- args: {
get
- get
Collection Id(args): Promise<string> Queries a collection's ID.
+This is the same as the collection's object address in V2, but V1 does +not use objects, and does not have an address
+Parameters
- args: {
collectionName: string;
creatorAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
options?: TokenStandardArg;
}collection
Name: string the name of the collection
+creator
Address: AccountAddressInput the address of the collection's creator
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: TokenStandardArg
Returns Promise<string>
the collection id
+- args: {
get
- get
Current Digital Asset Ownership(args): Promise<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}> Gets digital asset ownership data given the address of a digital asset.
+Parameters
- args: {
digitalAssetAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
}digital
Asset Address: AccountAddressInput OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+
Returns Promise<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}>GetCurrentTokenOwnershipResponse containing relevant ownership data of the digital asset.
+- args: {
get
- get
Current Fungible Asset Balances(args?): Promise<{
amount: any;
asset_type: string;
is_frozen: boolean;
is_primary: boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
storage_id: string;
token_standard: string;
}[]> Queries all fungible asset balances
+Parameters
Optionalargs: {
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & WhereArg<CurrentFungibleAssetBalancesBoolExp>;
}OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: PaginationArgs & WhereArg<CurrentFungibleAssetBalancesBoolExp>
Returns Promise<{
amount: any;
asset_type: string;
is_frozen: boolean;
is_primary: boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
storage_id: string;
token_standard: string;
}[]>A list of fungible asset metadata
+
get
- get
Delegated Staking Activities(args): Promise<{
amount: any;
delegator_address: string;
event_index: any;
event_type: string;
pool_address: string;
transaction_version: any;
}[]> Queries delegated staking activities
+Parameters
- args: {
delegatorAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
poolAddress: AccountAddressInput;
}delegator
Address: AccountAddressInput Delegator address
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+pool
Address: AccountAddressInput Pool address
+
Returns Promise<{
amount: any;
delegator_address: string;
event_index: any;
event_type: string;
pool_address: string;
transaction_version: any;
}[]>GetDelegatedStakingActivitiesResponse response type
+- args: {
get
- get
Digital Asset Activity(args): Promise<{
after_value?: null | string;
before_value?: null | string;
entry_function_id_str?: null | string;
event_account_address: string;
event_index: any;
from_address?: null | string;
is_fungible_v2?: null | boolean;
property_version_v1: any;
to_address?: null | string;
token_amount: any;
token_data_id: string;
token_standard: string;
transaction_timestamp: any;
transaction_version: any;
type: string;
}[]> Gets the activity data given the address of a digital asset.
+Parameters
- args: {
digitalAssetAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<{
after_value?: null | string;
before_value?: null | string;
entry_function_id_str?: null | string;
event_account_address: string;
event_index: any;
from_address?: null | string;
is_fungible_v2?: null | boolean;
property_version_v1: any;
to_address?: null | string;
token_amount: any;
token_data_id: string;
token_standard: string;
transaction_timestamp: any;
transaction_version: any;
type: string;
}>;
}digital
Asset Address: AccountAddressInput OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: PaginationArgs & OrderByArg<{
after_value?: null | string;
before_value?: null | string;
entry_function_id_str?: null | string;
event_account_address: string;
event_index: any;
from_address?: null | string;
is_fungible_v2?: null | boolean;
property_version_v1: any;
to_address?: null | string;
token_amount: any;
token_data_id: string;
token_standard: string;
transaction_timestamp: any;
transaction_version: any;
type: string;
}>
Returns Promise<{
after_value?: null | string;
before_value?: null | string;
entry_function_id_str?: null | string;
event_account_address: string;
event_index: any;
from_address?: null | string;
is_fungible_v2?: null | boolean;
property_version_v1: any;
to_address?: null | string;
token_amount: any;
token_data_id: string;
token_standard: string;
transaction_timestamp: any;
transaction_version: any;
type: string;
}[]>GetTokenActivityResponse containing relevant activity data to the digital asset.
+- args: {
get
- get
Digital Asset Data(args): Promise<{
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
}> Gets digital asset data given the address of a digital asset.
+Parameters
- args: {
digitalAssetAddress: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
}digital
Asset Address: AccountAddressInput OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+
Returns Promise<{
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
}>GetTokenDataResponse containing relevant data to the digital asset.
+- args: {
get
- get
Domain Subdomains(args): Promise<{
domain?: null | string;
expiration_timestamp?: any;
is_primary?: null | boolean;
owner_address?: null | string;
registered_address?: null | string;
subdomain?: null | string;
token_standard?: null | string;
}[]> Fetches all subdomains names for a given domain. Note, this will not return the domain itself.
+Parameters
- args: GetDomainSubdomainsArgs
Returns Promise<{
domain?: null | string;
expiration_timestamp?: any;
is_primary?: null | boolean;
owner_address?: null | string;
registered_address?: null | string;
subdomain?: null | string;
token_standard?: null | string;
}[]>a promise of an array of ANSName
+
get
- get
Events(args?): Promise<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}[]> Get all events
+An optional
+wherecan be passed in to filter out the response.Parameters
Optionalargs: {
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}> & WhereArg<EventsBoolExp>;
}OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: PaginationArgs & OrderByArg<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}> & WhereArg<EventsBoolExp>
Returns Promise<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}[]>GetEventsQuery response type
+Example
+{ where:
{
transaction_version: { _eq: 123456 },
}
} +
get
- get
Expiration(args): Promise<undefined | number> Retrieve the expiration time of a domain name or subdomain name from the contract.
+
+// Will return the expiration of "test.aptos.apt" or undefined
const exp = await aptos.getExpiration({name: "test.aptos"})
// new Date(exp) would give you the date in question: 2021-01-01T00:00:00.000Z +Parameters
- args: {
name: string;
}name: string
A string of the name to retrieve
+
Returns Promise<undefined | number>
number as a unix timestamp in milliseconds.
+- args: {
get
- get
Fungible Asset Activities(args?): Promise<{
amount?: any;
asset_type: string;
block_height: any;
entry_function_id_str?: null | string;
event_index: any;
gas_fee_payer_address?: null | string;
is_frozen?: null | boolean;
is_gas_fee: boolean;
is_transaction_success: boolean;
owner_address: string;
storage_id: string;
storage_refund_amount: any;
token_standard: string;
transaction_timestamp: any;
transaction_version: any;
type: string;
}[]> Queries all fungible asset activities
+Parameters
Optionalargs: {
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & WhereArg<FungibleAssetActivitiesBoolExp>;
}OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: PaginationArgs & WhereArg<FungibleAssetActivitiesBoolExp>
Returns Promise<{
amount?: any;
asset_type: string;
block_height: any;
entry_function_id_str?: null | string;
event_index: any;
gas_fee_payer_address?: null | string;
is_frozen?: null | boolean;
is_gas_fee: boolean;
is_transaction_success: boolean;
owner_address: string;
storage_id: string;
storage_refund_amount: any;
token_standard: string;
transaction_timestamp: any;
transaction_version: any;
type: string;
}[]>A list of fungible asset metadata
+
get
- get
Fungible Asset Metadata(args?): Promise<{
asset_type: string;
creator_address: string;
decimals: number;
icon_uri?: null | string;
last_transaction_timestamp: any;
last_transaction_version: any;
name: string;
project_uri?: null | string;
supply_aggregator_table_handle_v1?: null | string;
supply_aggregator_table_key_v1?: null | string;
symbol: string;
token_standard: string;
}[]> Queries all fungible asset metadata.
+Parameters
Optionalargs: {
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & WhereArg<FungibleAssetMetadataBoolExp>;
}OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: PaginationArgs & WhereArg<FungibleAssetMetadataBoolExp>
Returns Promise<{
asset_type: string;
creator_address: string;
decimals: number;
icon_uri?: null | string;
last_transaction_timestamp: any;
last_transaction_version: any;
name: string;
project_uri?: null | string;
supply_aggregator_table_handle_v1?: null | string;
supply_aggregator_table_key_v1?: null | string;
symbol: string;
token_standard: string;
}[]>A list of fungible asset metadata
+
get
- get
Fungible Asset Metadata By Asset Type(args): Promise<{
asset_type: string;
creator_address: string;
decimals: number;
icon_uri?: null | string;
last_transaction_timestamp: any;
last_transaction_version: any;
name: string;
project_uri?: null | string;
supply_aggregator_table_handle_v1?: null | string;
supply_aggregator_table_key_v1?: null | string;
symbol: string;
token_standard: string;
}> Queries a fungible asset metadata
+This query returns the fungible asset metadata for a specific fungible asset.
+Parameters
- args: {
assetType: string;
minimumLedgerVersion?: AnyNumber;
}asset
Type: string The asset type of the fungible asset. +e.g +"0x1::aptos_coin::AptosCoin" for Aptos Coin +"0xc2948283c2ce03aafbb294821de7ee684b06116bb378ab614fa2de07a99355a8" - address format if this is fungible asset
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+
Returns Promise<{
asset_type: string;
creator_address: string;
decimals: number;
icon_uri?: null | string;
last_transaction_timestamp: any;
last_transaction_version: any;
name: string;
project_uri?: null | string;
supply_aggregator_table_handle_v1?: null | string;
supply_aggregator_table_key_v1?: null | string;
symbol: string;
token_standard: string;
}>A fungible asset metadata item
+- args: {
get
- get
Gas Price Estimation(): Promise<GasEstimation> Gives an estimate of the gas unit price required to get a +transaction on chain in a reasonable amount of time. +For more information https://api.mainnet.aptoslabs.com/v1/spec#/operations/estimate_gas_price
+Returns Promise<GasEstimation>
Object holding the outputs of the estimate gas API
+Example
+{
gas_estimate: number;
deprioritized_gas_estimate?: number;
prioritized_gas_estimate?: number;
} +
get
get
- get
Ledger Info(): Promise<LedgerInfo> Queries for the Aptos ledger info
+Returns Promise<LedgerInfo>
Aptos Ledger Info
+Example: An example of the returned data
+{
"chain_id": 4,
"epoch": "8",
"ledger_version": "714",
"oldest_ledger_version": "0",
"ledger_timestamp": "1694695496521775",
"node_role": "validator",
"oldest_block_height": "0",
"block_height": "359",
"git_hash": "c82193f36f4e185fed9f68c4ad21f6c6dd390c6e"
} +
get
- get
Module Events By Event Type(args): Promise<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}[]> Get module events by event type
+Parameters
- args: {
eventType: `${string}::${string}::${string}`;
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}>;
}event
Type: `${string}::${string}::${string}` The event type
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: PaginationArgs & OrderByArg<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}>
Returns Promise<{
account_address: string;
creation_number: any;
data: any;
event_index: any;
indexed_type: string;
sequence_number: any;
transaction_block_height: any;
transaction_version: any;
type: string;
}[]>Promise
+- args: {
get
- get
Name(args): Promise<undefined | {
domain?: null | string;
expiration_timestamp?: any;
is_primary?: null | boolean;
owner_address?: null | string;
registered_address?: null | string;
subdomain?: null | string;
token_standard?: null | string;
}> Fetches a single name from the indexer
+Parameters
- args: {
name: string;
}name: string
A string of the name to retrieve, e.g. "test.aptos.apt" +or "test.apt" or "test". Can be inclusive or exclusive of the .apt suffix. +Can be a subdomain.
+
Returns Promise<undefined | {
domain?: null | string;
expiration_timestamp?: any;
is_primary?: null | boolean;
owner_address?: null | string;
registered_address?: null | string;
subdomain?: null | string;
token_standard?: null | string;
}>A promise of an ANSName or undefined
+- args: {
get
- get
Number Of Delegators(args): Promise<number> Queries current number of delegators in a pool. Throws an error if the pool is not found.
+Parameters
- args: {
minimumLedgerVersion?: AnyNumber;
poolAddress: AccountAddressInput;
}OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+pool
Address: AccountAddressInput Pool address
+
Returns Promise<number>
The number of delegators for the given pool
+- args: {
get
- get
Number Of Delegators For All Pools(args?): Promise<{
num_active_delegator?: any;
pool_address?: null | string;
}[]> Queries current number of delegators in a pool. Throws an error if the pool is not found.
+Parameters
Optionalargs: {
minimumLedgerVersion?: AnyNumber;
options?: OrderByArg<{
num_active_delegator?: any;
pool_address?: null | string;
}>;
}OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: OrderByArg<{
num_active_delegator?: any;
pool_address?: null | string;
}>
Returns Promise<{
num_active_delegator?: any;
pool_address?: null | string;
}[]>GetNumberOfDelegatorsForAllPoolsResponse response type
+
get
- get
Owned Digital Assets(args): Promise<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}[]> Gets the digital assets that the given address owns.
+Parameters
- args: {
minimumLedgerVersion?: AnyNumber;
options?: PaginationArgs & OrderByArg<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}>;
ownerAddress: AccountAddressInput;
}OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: PaginationArgs & OrderByArg<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}>owner
Address: AccountAddressInput The address of the owner
+
Returns Promise<{
amount: any;
current_token_data?: null | {
collection_id: string;
current_collection?: null | {
collection_id: string;
collection_name: string;
creator_address: string;
current_supply: any;
description: string;
last_transaction_timestamp: any;
last_transaction_version: any;
max_supply?: any;
mutable_description?: null | boolean;
mutable_uri?: null | boolean;
table_handle_v1?: null | string;
token_standard: string;
total_minted_v2?: any;
uri: string;
};
decimals: any;
description: string;
is_fungible_v2?: null | boolean;
largest_property_version_v1?: any;
last_transaction_timestamp: any;
last_transaction_version: any;
maximum?: any;
supply: any;
token_data_id: string;
token_name: string;
token_properties: any;
token_standard: string;
token_uri: string;
};
is_fungible_v2?: null | boolean;
is_soulbound_v2?: null | boolean;
last_transaction_timestamp: any;
last_transaction_version: any;
owner_address: string;
property_version_v1: any;
storage_id: string;
table_type_v1?: null | string;
token_data_id: string;
token_properties_mutated_v1?: any;
token_standard: string;
}[]>GetOwnedTokensResponse containing ownership data of the digital assets belonging to the ownerAddresss.
+- args: {
get
- get
Owner Address(args): Promise<undefined | string> Retrieve the owner address of a domain name or subdomain name from the contract.
+
+// Will return the owner address of "test.aptos.apt" or undefined
const owner = await aptos.getOwnerAddress({name: "test.aptos"})
// owner = 0x123... +Parameters
- args: {
name: string;
}name: string
A string of the name to retrieve
+
Returns Promise<undefined | string>
MoveAddressType if the name is owned, undefined otherwise
+- args: {
get
- get
Primary Name(args): Promise<undefined | string> Retrieve the primary name for an account. An account can have +multiple names that target it, but only a single name that is primary. An +account also may not have a primary name.
+
+const name = await aptos.getPrimaryName({address: alice.accountAddress})
// name = test.aptos +Parameters
- args: {
address: AccountAddressInput;
}address: AccountAddressInput
A AccountAddressInput (address) of the account
+
Returns Promise<undefined | string>
a string if the account has a primary name, undefined otherwise
+- args: {
get
- get
Processor Status(processorType): Promise<{
last_success_version: any;
last_updated: any;
processor: string;
}> Query the processor status for a specific processor type.
+Parameters
- processorType: ProcessorType
The processor type to query
+
Returns Promise<{
last_success_version: any;
last_updated: any;
processor: string;
}>- processorType: ProcessorType
get
- get
Signing Message(args): Uint8Array Returns a signing message for a transaction.
+This allows a user to sign a transaction using their own preferred signing method, and +then submit it to the network.
+Parameters
- args: {
transaction: AnyRawTransaction;
}transaction: AnyRawTransaction
A raw transaction for signing elsewhere
+
Returns Uint8Array
- args: {
get
- get
Table Item<T>(args): Promise<T> Queries for a table item for a table identified by the handle and the key for the item. +Key and value types need to be passed in to help with key serialization and value deserialization.
+Type Parameters
Parameters
- args: {
data: TableItemRequest;
handle: string;
options?: LedgerVersionArg;
}data: TableItemRequest
Object that describes table item
+handle: string
A pointer to where that table is stored
+Optionaloptions?: LedgerVersionArg
Returns Promise<T>
Table item value rendered in JSON
+Example
+https://api.devnet.aptoslabs.com/v1/accounts/0x1/resource/0x1::coin::CoinInfo%3C0x1::aptos_coin::AptosCoin%3E
{
data.key_type = "address" // Move type of table key
data.value_type = "u128" // Move type of table value
data.key = "0x619dc29a0aac8fa146714058e8dd6d2d0f3bdf5f6331907bf91f3acd81e6935" // Value of table key
} +- args: {
get
- get
Target Address(args): Promise<undefined | string> Retrieve the target address of a domain or subdomain name. This is the +address the name points to for use on chain. Note, the target address can +point to addresses that are not the owner of the name
+
+const targetAddr = await aptos.getTargetAddress({name: "test.aptos"})
// targetAddr = 0x123... +Parameters
- args: {
name: string;
}name: string
A string of the name: primary, primary.apt, secondary.primary, secondary.primary.apt, etc.
+
Returns Promise<undefined | string>
MoveAddressType if the name has a target, undefined otherwise
+- args: {
get
- get
Transaction By Hash(args): Promise<TransactionResponse> Queries on-chain transaction by transaction hash. This function will return pending transactions.
+Parameters
Returns Promise<TransactionResponse>
Transaction from mempool (pending) or on-chain (committed) transaction
+
get
- get
Transaction By Version(args): Promise<TransactionResponse> Queries on-chain transaction by version. This function will not return pending transactions.
+Parameters
Returns Promise<TransactionResponse>
On-chain transaction. Only on-chain transactions have versions, so this +function cannot be used to query pending transactions.
+
get
- get
Transactions(args?): Promise<TransactionResponse[]> Queries on-chain transactions. This function will not return pending +transactions. For that, use
+getTransactionsByHash.Parameters
Optionalargs: {
options?: PaginationArgs;
}Optionaloptions?: PaginationArgs
Returns Promise<TransactionResponse[]>
Array of on-chain transactions
+
is
- is
Pending Transaction(args): Promise<boolean> Defines if specified transaction is currently in pending state
+To create a transaction hash:
+-
+
- Create a hash message from the bytes: "Aptos::Transaction" bytes + the BCS-serialized Transaction bytes. +
- Apply hash algorithm SHA3-256 to the hash message bytes. +
- Hex-encode the hash bytes with 0x prefix. +
Returns Promise<boolean>
+trueif transaction is in pending state andfalseotherwise
lookup
- lookup
Original Account Address(args): Promise<AccountAddress> Looks up the account address for a given authentication key
+This handles both if the account's authentication key has been rotated or not.
+Parameters
- args: {
authenticationKey: AccountAddressInput;
minimumLedgerVersion?: AnyNumber;
options?: LedgerVersionArg;
}authentication
Key: AccountAddressInput The authentication key
+OptionalminimumLedger Version?: AnyNumber Optional ledger version to sync up to, before querying
+Optionaloptions?: LedgerVersionArg
Returns Promise<AccountAddress>
Promise
+The accountAddress associated with the authentication key - args: {
mint
- mint
Digital Asset Transaction(args): Promise<SimpleTransaction> Create a transaction to mint a digital asset into the creators account within an existing collection.
+Parameters
- args: {
collection: string;
creator: Account;
description: string;
name: string;
options?: InputGenerateTransactionOptions;
propertyKeys?: string[];
propertyTypes?: ("U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY")[];
propertyValues?: PropertyValue[];
uri: string;
}collection: string
the name of the collection the digital asset belongs to
+creator: Account
the creator of the collection
+description: string
the description of the digital asset
+name: string
the name of the digital asset
+Optionaloptions?: InputGenerateTransactionOptionsOptionalpropertyKeys?: string[] OptionalpropertyTypes?: ("U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY")[] OptionalpropertyValues?: PropertyValue[] uri: string
the URI to additional info about the digital asset
+
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
mint
- mint
Soul Bound Transaction(args): Promise<SimpleTransaction> Mint a soul bound digital asset into a recipient's account
+Parameters
- args: {
account: Account;
collection: string;
description: string;
name: string;
options?: InputGenerateTransactionOptions;
propertyKeys?: string[];
propertyTypes?: ("U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY")[];
propertyValues?: PropertyValue[];
recipient: AccountAddress;
uri: string;
}account: Account
The account that mints the digital asset
+collection: string
The collection name that the digital asset belongs to
+description: string
The digital asset description
+name: string
The digital asset name
+Optionaloptions?: InputGenerateTransactionOptionsOptionalpropertyKeys?: string[] The property keys for storing on-chain properties
+OptionalpropertyTypes?: ("U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY")[] The type of property values
+OptionalpropertyValues?: PropertyValue[] The property values to be stored on-chain
+recipient: AccountAddress
The account address where the digital asset will be created
+uri: string
The digital asset URL
+
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
publish
- publish
Package Transaction(args): Promise<SimpleTransaction> Generates a transaction to publish a move package to chain.
+To get the
+metadataBytesandbyteCode, can compile using Aptos CLI with command +aptos move compile --save-metadata ..., +For more info https://aptos.dev/tutorials/your-first-dapp/#step-4-publish-a-move-moduleParameters
- args: {
account: AccountAddressInput;
metadataBytes: HexInput;
moduleBytecode: HexInput[];
options?: InputGenerateTransactionOptions;
}account: AccountAddressInput
The publisher account
+metadata
Bytes: HexInput The package metadata bytes
+module
Bytecode: HexInput[] An array of the bytecode of each module in the package in compiler output order
+Optionaloptions?: InputGenerateTransactionOptions
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
query
- query
Indexer<T>(args): Promise<T> A generic function for retrieving data from Aptos Indexer. +For more detailed queries specification see +https://cloud.hasura.io/public/graphiql?endpoint=https://api.mainnet.aptoslabs.com/v1/graphql
+Type Parameters
Parameters
- args: {
query: GraphqlQuery;
}query: GraphqlQuery
Returns Promise<T>
The provided T type
+Example
+{
query: `query MyQuery {
ledger_infos {
chain_id
}
}`;
} +- args: {
register
- register
Name(args): Promise<SimpleTransaction> Registers a new name
+
+// An example of registering a subdomain name assuming def.apt is already registered
// and belongs to the sender alice.
const txn = aptos.registerName({
sender: alice,
name: "test.aptos.apt",
expiration: {
policy: "subdomain:independent",
expirationDate: Date.now() + 30 * 24 * 60 * 60 * 1000,
},
}); +Parameters
- args: Omit<RegisterNameParameters, "aptosConfig">
Returns Promise<SimpleTransaction>
SimpleTransaction
+
remove
- remove
Digital Asset Property Transaction(args): Promise<SimpleTransaction> Remove a digital asset property
+Parameters
- args: {
creator: Account;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
propertyKey: string;
propertyType: "U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY";
propertyValue: PropertyValue;
}creator: Account
digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` Optionaloptions?: InputGenerateTransactionOptionsproperty
Key: string The property key for storing on-chain properties
+property
Type: "U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY" The type of property value
+property
Value: PropertyValue The property value to be stored on-chain
+
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
renew
- renew
Domain(args): Promise<SimpleTransaction> Renews a domain name
+Note: If a domain name was minted with V1 of the contract, it will automatically be upgraded to V2 via this transaction.
+
+await aptos.renewDomain({sender: alice, name: "test"})
// test.apt will be renewed for one year +Parameters
- args: {
name: string;
options?: InputGenerateTransactionOptions;
sender: Account;
years?: 1;
}name: string
A string of the domain the subdomain will be under. The signer must be the domain owner. +Subdomains cannot be renewed.
+Optionaloptions?: InputGenerateTransactionOptionssender: Account
The sender account
+Optionalyears?: 1The number of years to renew the name. Currently only one year is permitted.
+
Returns Promise<SimpleTransaction>
SimpleTransaction
+- args: {
rotate
- rotate
Auth Key(args): Promise<TransactionResponse> Rotate an account's auth key. After rotation, only the new private key can be used to sign txns for +the account. +Note: Only legacy Ed25519 scheme is supported for now. +More info: https://aptos.dev/guides/account-management/key-rotation/
+Parameters
- args: {
fromAccount: Account;
toNewPrivateKey: PrivateKey;
}from
Account: Account The account to rotate the auth key for
+to
New Private Key: PrivateKey The new private key to rotate to
+
Returns Promise<TransactionResponse>
PendingTransactionResponse
+- args: {
set
- set
Digital Asset Description Transaction(args): Promise<SimpleTransaction> Set the digital asset description
+Parameters
- args: {
creator: Account;
description: string;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
}creator: Account
The creator account
+description: string
The digital asset description
+digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` Optionaloptions?: InputGenerateTransactionOptions
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
set
- set
Digital Asset Name Transaction(args): Promise<SimpleTransaction> Set the digital asset name
+Parameters
- args: {
creator: Account;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
name: string;
options?: InputGenerateTransactionOptions;
}creator: Account
The creator account
+digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` name: string
The digital asset name
+Optionaloptions?: InputGenerateTransactionOptions
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
set
- set
Digital AssetURITransaction(args): Promise<SimpleTransaction> Set the digital asset name
+Parameters
- args: {
creator: Account;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
uri: string;
}creator: Account
The creator account
+digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` Optionaloptions?: InputGenerateTransactionOptionsuri: string
The digital asset uri
+
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
set
- set
Primary Name(args): Promise<SimpleTransaction> Sets the primary name for the sender. An account can have +multiple names that target it, but only a single name that is primary. An +account also may not have a primary name.
+
+await aptos.setPrimaryName({sender: alice, name: "test.aptos"})
const primaryName = await aptos.getPrimaryName({address: alice.accountAddress})
// primaryName = test.aptos +Parameters
- args: {
name?: string;
options?: InputGenerateTransactionOptions;
sender: Account;
}Optionalname?: stringA string of the name: test, test.apt, test.aptos, test.aptos.apt, etc.
+Optionaloptions?: InputGenerateTransactionOptionssender: Account
The sender account
+
Returns Promise<SimpleTransaction>
SimpleTransaction
+- args: {
set
- set
Target Address(args): Promise<SimpleTransaction> Sets the target address of a domain or subdomain name. This is the +address the name points to for use on chain. Note, the target address can +point to addresses that are not the owner of the name
+
+await aptos.setTargetAddress({sender: alice, name: "test.aptos", address: bob.accountAddress})
const address = await aptos.getTargetAddress({name: "test.aptos"})
// address = bob.accountAddress +Parameters
- args: {
address: AccountAddressInput;
name: string;
options?: InputGenerateTransactionOptions;
sender: Account;
}address: AccountAddressInput
A AccountAddressInput of the address to set the domain or subdomain to
+name: string
A string of the name: test.aptos.apt, test.apt, test, test.aptos, etc.
+Optionaloptions?: InputGenerateTransactionOptionssender: Account
Returns Promise<SimpleTransaction>
SimpleTransaction
+- args: {
sign
- sign(args): AccountAuthenticator
Sign a transaction that can later be submitted to chain
+Parameters
- args: {
signer: Account;
transaction: AnyRawTransaction;
}signer: Account
The signer account
+transaction: AnyRawTransaction
A raw transaction to sign on
+
Returns AccountAuthenticator
AccountAuthenticator
+- args: {
sign
- sign
And Submit Transaction(args): Promise<PendingTransactionResponse> Sign and submit a single signer transaction to chain
+Parameters
- args: {
signer: Account;
transaction: AnyRawTransaction;
}signer: Account
The signer account to sign the transaction
+transaction: AnyRawTransaction
An instance of a RawTransaction, plus optional secondary/fee payer addresses
+
+{
rawTransaction: RawTransaction,
secondarySignerAddresses? : Array<AccountAddress>,
feePayerAddress?: AccountAddress
} +
Returns Promise<PendingTransactionResponse>
PendingTransactionResponse
+- args: {
sign
- sign
As Fee Payer(args): AccountAuthenticator Sign a transaction as a fee payer that can later be submitted to chain
+Parameters
- args: {
signer: Account;
transaction: AnyRawTransaction;
}signer: Account
The fee payer signer account
+transaction: AnyRawTransaction
A raw transaction to sign on
+
Returns AccountAuthenticator
AccountAuthenticator
+- args: {
transfer
- transfer
Coin Transaction(args): Promise<SimpleTransaction> Generate a transfer coin transaction that can be simulated and/or signed and submitted
+Parameters
- args: {
amount: AnyNumber;
coinType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
recipient: AccountAddressInput;
sender: AccountAddressInput;
}amount: AnyNumber
The amount to transfer
+OptionalcoinType?: `${string}::${string}::${string}` optional. The coin struct type to transfer. Defaults to 0x1::aptos_coin::AptosCoin
+Optionaloptions?: InputGenerateTransactionOptionsrecipient: AccountAddressInput
The recipient address
+sender: AccountAddressInput
The sender account
+
Returns Promise<SimpleTransaction>
SimpleTransaction
+- args: {
transfer
- transfer
Digital Asset Transaction(args): Promise<SimpleTransaction> Transfer a digital asset (non fungible digital asset) ownership.
+We can transfer a digital asset only when the digital asset is not frozen +(i.e. owner transfer is not disabled such as for soul bound digital assets)
+Parameters
- args: {
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
recipient: AccountAddress;
sender: Account;
}digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` optional. The digital asset type, default to "0x4::token::Token"
+Optionaloptions?: InputGenerateTransactionOptionsrecipient: AccountAddress
The recipient account address
+sender: Account
The sender account of the current digital asset owner
+
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
transfer
- transfer
Fungible Asset(args): Promise<SimpleTransaction> Transfer
+amountof fungible asset from sender's primary store to recipient's primary store.Use this method to transfer any fungible asset including fungible token.
+Parameters
- args: {
amount: AnyNumber;
fungibleAssetMetadataAddress: AccountAddress;
options?: InputGenerateTransactionOptions;
recipient: AccountAddress;
sender: Account;
}amount: AnyNumber
fungible
Asset Metadata Address: AccountAddress Optionaloptions?: InputGenerateTransactionOptionsrecipient: AccountAddress
sender: Account
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain.
+- args: {
unfreeze
- unfreeze
Digital Asset Transafer Transaction(args): Promise<SimpleTransaction> Unfreeze digital asset transfer ability
+Parameters
- args: {
creator: Account;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
}creator: Account
The creator account
+digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` Optionaloptions?: InputGenerateTransactionOptions
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
update
- update
Digital Asset Property Transaction(args): Promise<SimpleTransaction> Update a digital asset property
+Parameters
- args: {
creator: Account;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
propertyKey: string;
propertyType: "U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY";
propertyValue: PropertyValue;
}creator: Account
digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` Optionaloptions?: InputGenerateTransactionOptionsproperty
Key: string The property key for storing on-chain properties
+property
Type: "U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY" The type of property value
+property
Value: PropertyValue The property value to be stored on-chain
+
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
update
- update
Digital Asset Typed Property Transaction(args): Promise<SimpleTransaction> Update a typed digital asset property
+Parameters
- args: {
creator: Account;
digitalAssetAddress: AccountAddressInput;
digitalAssetType?: `${string}::${string}::${string}`;
options?: InputGenerateTransactionOptions;
propertyKey: string;
propertyType: "U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY";
propertyValue: PropertyValue;
}creator: Account
digital
Asset Address: AccountAddressInput The digital asset address
+OptionaldigitalAsset Type?: `${string}::${string}::${string}` Optionaloptions?: InputGenerateTransactionOptionsproperty
Key: string The property key for storing on-chain properties
+property
Type: "U8" | "U16" | "U32" | "U64" | "U128" | "U256" | "BOOLEAN" | "ADDRESS" | "STRING" | "ARRAY" The type of property value
+property
Value: PropertyValue The property value to be stored on-chain
+
Returns Promise<SimpleTransaction>
A SimpleTransaction that can be simulated or submitted to chain
+- args: {
view
- view<T>(args): Promise<T>
Queries for a Move view function
+Type Parameters
- T extends MoveValue[]
Parameters
- args: {
options?: LedgerVersionArg;
payload: InputViewFunctionData;
}Optionaloptions?: LedgerVersionArgpayload: InputViewFunctionData
Payload for the view function
+
Returns Promise<T>
an array of Move values
+Example
+`
const payload: ViewRequest = {
function: "0x1::coin::balance",
typeArguments: ["0x1::aptos_coin::AptosCoin"],
functionArguments: [accountAddress],
};
` +
wait
- wait
For Transaction(args): Promise<CommittedTransactionResponse> Waits for a transaction to move past the pending state.
+There are 4 cases.
+-
+
- Transaction is successfully processed and committed to the chain.
-
+
- The function will resolve with the transaction response from the API. +
+ - Transaction is rejected for some reason, and is therefore not committed to the blockchain.
-
+
- The function will throw an AptosApiError with an HTTP status code indicating some problem with the request. +
+ - Transaction is committed but execution failed, meaning no changes were
+written to the blockchain state.
-
+
- If
checkSuccessis true, the function will throw a FailedTransactionError +IfcheckSuccessis false, the function will resolve with the transaction response where thesuccessfield is false.
+
+ - If
- Transaction does not move past the pending state within
args.options.timeoutSecsseconds.-
+
- The function will throw a WaitForTransactionError +
+
Parameters
- args: {
options?: WaitForTransactionOptions;
transactionHash: HexInput;
}Optionaloptions?: WaitForTransactionOptionstransaction
Hash: HexInput The hash of a transaction previously submitted to the blockchain.
+
Returns Promise<CommittedTransactionResponse>
The transaction on-chain. See above for more details.
+- Transaction is successfully processed and committed to the chain.
Generated using TypeDoc
Class AptosApiError
The type returned from an API error
+Param: name
the error name "AptosApiError"
+Param: url
the url the request was made to
+Param: status
the response status. i.e. 400
+Param: statusText
the response message
+Param: data
the response data
+Param: request
the AptosRequest
+Hierarchy
- Error
- AptosApiError
Index
Constructors
Properties
data
+message
+name
+request
+stack?
+status
+status
Methods
Constructors
constructor
- new
Aptos Api Error(request, response, message): AptosApiError Parameters
- request: AptosRequest
- response: AptosResponse<any, any>
- message: string
Returns AptosApiError
Properties
Readonly data
data: any
message
message: string
name
name: string
Readonly request
Optional stack
stack?: string
Readonly status
status: number
Readonly status
status
Readonly url
url: string
Static Optional prepare
prepare
Optional override for formatting stack traces
+Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Generated using TypeDoc
Class AptosConfig
This class holds the config information for the SDK client instance.
+ Index
Constructors
Properties
Constructors
constructor
- new
Aptos Config(settings?): AptosConfig Parameters
Optionalsettings: AptosSettings
Returns AptosConfig
Properties
Readonly client
The client instance the SDK uses. Defaults to `@aptos-labs/aptos-client
+Optional Readonly client
Optional client configurations
+Optional Readonly faucet
faucet?: string
The optional hardcoded faucet URL to send requests to instead of using the network
+Optional Readonly faucet
Optional specific Faucet configurations
+Optional Readonly fullnode
fullnode?: string
The optional hardcoded fullnode URL to send requests to instead of using the network
+Optional Readonly fullnode
Optional specific Fullnode configurations
+Optional Readonly indexer
indexer?: string
The optional hardcoded indexer URL to send requests to instead of using the network
+Optional Readonly indexer
Optional specific Indexer configurations
+Readonly network
The Network that this SDK is associated with. Defaults to DEVNET
+Generated using TypeDoc
Class AuthenticationKey
Each account stores an authentication key. Authentication key enables account owners to rotate +their private key(s) associated with the account without changing the address that hosts their account.
+Hierarchy (view full)
- Serializable
- AuthenticationKey
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Authentication Key(args): AuthenticationKey Returns AuthenticationKey
Properties
Readonly data
The raw bytes of the authentication key.
+Static Readonly LENGTH
LENGTH: number = 32
An authentication key is always a SHA3-256 hash of data, and is always 32 bytes.
+The data to hash depends on the underlying public key type and the derivation scheme.
+Methods
bcs
bcs
derived
- derived
Address(): AccountAddress Derives an account address from an AuthenticationKey. Since an AccountAddress is also 32 bytes, +the AuthenticationKey bytes are directly translated to an AccountAddress.
+Returns AccountAddress
AccountAddress
+
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
Static deserialize
- deserialize(deserializer): AuthenticationKey
Deserialize an AuthenticationKey from the byte buffer in a Deserializer instance.
+Parameters
- deserializer: Deserializer
The deserializer to deserialize the AuthenticationKey from.
+
Returns AuthenticationKey
An instance of AuthenticationKey.
+- deserializer: Deserializer
Static from
- from
Public Key(args): AuthenticationKey Converts a PublicKey(s) to an AuthenticationKey, using the derivation scheme inferred from the +instance of the PublicKey type passed in.
+Parameters
- args: {
publicKey: AccountPublicKey;
}public
Key: AccountPublicKey
Returns AuthenticationKey
AuthenticationKey
+- args: {
Static from
- from
Public Key And Scheme(args): AuthenticationKey Parameters
- args: {
publicKey: AccountPublicKey;
scheme: AuthenticationKeyScheme;
}the public key and scheme to use for the derivation
+public
Key: AccountPublicKey scheme: AuthenticationKeyScheme
Returns AuthenticationKey
Deprecated
Use
+fromPublicKeyinstead +Derives an AuthenticationKey from the public key seed bytes and an explicit derivation scheme.This facilitates targeting a specific scheme for deriving an authentication key from a public key.
+- args: {
Static from
- from
Scheme And Bytes(args): AuthenticationKey Parameters
- args: {
input: HexInput;
scheme: AuthenticationKeyScheme;
}input: HexInput
scheme: AuthenticationKeyScheme
Returns AuthenticationKey
- args: {
Generated using TypeDoc
Class Bool
Hierarchy (view full)
- Serializable
- Bool
Implements
Index
Constructors
constructor
Properties
Readonly value
value: boolean
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): Bool
Parameters
- deserializer: Deserializer
Returns Bool
Generated using TypeDoc
Class ChainId
Representation of a ChainId that can serialized and deserialized
+Hierarchy (view full)
- Serializable
- ChainId
Index
Constructors
constructor
Properties
Readonly chain
chain
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): ChainId
Parameters
- deserializer: Deserializer
Returns ChainId
Generated using TypeDoc
Class Deserializer
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Deserializer(data): Deserializer Parameters
- data: Uint8Array
Returns Deserializer
Properties
Private buffer
buffer: ArrayBuffer
Private offset
offset: number
Methods
deserialize
- deserialize<T>(cls): T
Helper function that primarily exists to support alternative syntax for deserialization. +That is, if we have a
+const deserializer: new Deserializer(...), instead of having to use +MyClass.deserialize(deserializer), we can calldeserializer.deserialize(MyClass).Type Parameters
Parameters
- cls: Deserializable<T>
The BCS-deserializable class to deserialize the buffered bytes into.
+
Returns T
the deserialized value of class type T
+Example
+const deserializer = new Deserializer(new Uint8Array([1, 2, 3]));
const value = deserializer.deserialize(MyClass); // where MyClass has a `deserialize` function
// value is now an instance of MyClass
// equivalent to `const value = MyClass.deserialize(deserializer)` +- cls: Deserializable<T>
deserialize
deserialize
deserialize
deserialize
- deserialize
Str(): string Deserializes a string. UTF8 string is supported. Reads the string's bytes length "l" first, +and then reads "l" bytes of content. Decodes the byte array into a string.
+BCS layout for "string": string_length | string_content +where string_length is a u32 integer encoded as a uleb128 integer, equal to the number of bytes in string_content.
+Returns string
Example
+const deserializer = new Deserializer(new Uint8Array([8, 49, 50, 51, 52, 97, 98, 99, 100]));
assert(deserializer.deserializeStr() === "1234abcd"); +
deserialize
deserialize
deserialize
deserialize
deserialize
- deserialize
U64(): bigint Deserializes a uint64 number.
+BCS layout for "uint64": Eight bytes. Binary format in little-endian representation.
+Returns bigint
Example
+const deserializer = new Deserializer(new Uint8Array([0x00, 0xEF, 0xCD, 0xAB, 0x78, 0x56, 0x34, 0x12]));
assert(deserializer.deserializeU64() === 1311768467750121216); +
deserialize
deserialize
deserialize
- deserialize
Vector<T>(cls): T[] Deserializes an array of BCS Deserializable values given an existing Deserializer +instance with a loaded byte buffer.
+Type Parameters
Parameters
- cls: Deserializable<T>
The BCS-deserializable class to deserialize the buffered bytes into.
+
Returns T[]
an array of deserialized values of type T
+Example
+// serialize a vector of addresses
const addresses = new Array<AccountAddress>(
AccountAddress.from("0x1"),
AccountAddress.from("0x2"),
AccountAddress.from("0xa"),
AccountAddress.from("0xb"),
);
const serializer = new Serializer();
serializer.serializeVector(addresses);
const serializedBytes = serializer.toUint8Array();
// deserialize the bytes into an array of addresses
const deserializer = new Deserializer(serializedBytes);
const deserializedAddresses = deserializer.deserializeVector(AccountAddress);
// deserializedAddresses is now an array of AccountAddress instances +- cls: Deserializable<T>
Private read
Generated using TypeDoc
Class Ed25519Account
Signer implementation for the Ed25519 authentication scheme. +This extends an Ed25519Account by adding signing capabilities through an Ed25519PrivateKey.
+Note: Generating a signer instance does not create the account on-chain.
+Implements
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Ed25519 Account(args): Ed25519Account Parameters
Returns Ed25519Account
Properties
Readonly account
Account address associated with the account
+Readonly private
Private key associated with the account
+Readonly public
Public key associated with the account
+Readonly signing
Signing scheme used to sign transactions
+Methods
sign
- sign(message): Ed25519Signature
Sign the given message with the private key.
+Parameters
- message: HexInput
in HexInput format
+
Returns Ed25519Signature
AccountSignature
+- message: HexInput
sign
- sign
With Authenticator(message): AccountAuthenticatorEd25519 Sign a message using the available signing capabilities.
+Parameters
- message: HexInput
the signing message, as binary input
+
Returns AccountAuthenticatorEd25519
the AccountAuthenticator containing the signature, together with the account's public key
+- message: HexInput
verify
Static from
- from
Derivation Path(args): Ed25519Account Derives an account with bip44 path and mnemonics
+Parameters
Returns Ed25519Account
Static generate
- generate(): Ed25519Account
Derives a signer from a randomly generated private key
+Returns Ed25519Account
Generated using TypeDoc
Class Ed25519PrivateKey
Represents the private key of an Ed25519 key pair.
+Hierarchy (view full)
- Serializable
- Ed25519PrivateKey
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Ed25519 Private Key(hexInput): Ed25519PrivateKey Create a new PrivateKey instance from a Uint8Array or String.
+Parameters
- hexInput: HexInput
HexInput (string or Uint8Array)
+
Returns Ed25519PrivateKey
- hexInput: HexInput
Properties
Private Readonly signing
signing
The Ed25519 signing key
+Static Readonly LENGTH
LENGTH: number = 32
Length of an Ed25519 private key
+Static Readonly SLIP_
SLIP_
The Ed25519 key seed to use for BIP-32 compatibility +See more https://github.com/satoshilabs/slips/blob/master/slip-0010.md
+Methods
bcs
bcs
public
- public
Key(): Ed25519PublicKey Derive the Ed25519PublicKey for this private key.
+Returns Ed25519PublicKey
Ed25519PublicKey
+
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
sign
- sign(message): Ed25519Signature
Sign the given message with the private key.
+Parameters
- message: HexInput
in HexInput format
+
Returns Ed25519Signature
Signature
+- message: HexInput
to
to
Static deserialize
- deserialize(deserializer): Ed25519PrivateKey
Parameters
- deserializer: Deserializer
Returns Ed25519PrivateKey
Static from
- from
Derivation Path(path, mnemonics): Ed25519PrivateKey Derives a private key from a mnemonic seed phrase.
+To derive multiple keys from the same phrase, change the path
+IMPORTANT: Ed25519 supports hardened derivation only (since it lacks a key homomorphism, +so non-hardened derivation cannot work)
+Parameters
- path: string
the BIP44 path
+ - mnemonics: string
the mnemonic seed phrase
+
Returns Ed25519PrivateKey
- path: string
Static Private from
- from
Derivation Path Inner(path, seed, offset?): Ed25519PrivateKey A private inner function so we can separate from the main fromDerivationPath() method +to add tests to verify we create the keys correctly.
+Parameters
- path: string
the BIP44 path
+ - seed: Uint8Array
the seed phrase created by the mnemonics
+ - offset: number = HARDENED_OFFSET
the offset used for key derivation, defaults to 0x80000000
+
Returns Ed25519PrivateKey
- path: string
Static generate
- generate(): Ed25519PrivateKey
Generate a new random private key.
+Returns Ed25519PrivateKey
Ed25519PrivateKey
+
Static is
- is
Private Key(privateKey): privateKey is Ed25519PrivateKey Parameters
- privateKey: PrivateKey
Returns privateKey is Ed25519PrivateKey
Deprecated
use
+instanceof Ed25519PrivateKeyinstead.
Generated using TypeDoc
Class Ed25519PublicKey
Represents the public key of an Ed25519 key pair.
+Since AIP-55 Aptos supports
+Legacy and Unified authentication keys.
Ed25519 scheme is represented in the SDK as Legacy authentication key and also
+as AnyPublicKey that represents any Unified authentication key
Hierarchy (view full)
- AccountPublicKey
- Ed25519PublicKey
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Ed25519 Public Key(hexInput): Ed25519PublicKey Create a new PublicKey instance from a Uint8Array or String.
+Parameters
- hexInput: HexInput
A HexInput (string or Uint8Array)
+
Returns Ed25519PublicKey
- hexInput: HexInput
Properties
Private Readonly key
Bytes of the public key
+Static Readonly LENGTH
LENGTH: number = 32
Length of an Ed25519 public key
+Methods
auth
- auth
Key(): AuthenticationKey Get the authentication key associated with this public key
+Returns AuthenticationKey
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
verify
- verify
Signature(args): boolean Verifies a signed data with a public key
+Parameters
- args: VerifySignatureArgs
Returns boolean
Static deserialize
- deserialize(deserializer): Ed25519PublicKey
Parameters
- deserializer: Deserializer
Returns Ed25519PublicKey
Static is
- is
Public Key(publicKey): publicKey is Ed25519PublicKey Parameters
- publicKey: AccountPublicKey
Returns publicKey is Ed25519PublicKey
Deprecated
use
+instanceof Ed25519PublicKeyinstead.
Generated using TypeDoc
Class Ed25519Signature
A signature of a message signed using an Ed25519 private key
+Hierarchy (view full)
- Signature
- Ed25519Signature
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Ed25519 Signature(hexInput): Ed25519Signature Parameters
- hexInput: HexInput
Returns Ed25519Signature
Properties
Private Readonly data
The signature bytes
+Static Readonly LENGTH
LENGTH: 64 = 64
Length of an Ed25519 signature
+Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
Static deserialize
- deserialize(deserializer): Ed25519Signature
Parameters
- deserializer: Deserializer
Returns Ed25519Signature
Generated using TypeDoc
Class EntryFunction
Representation of a EntryFunction that can serialized and deserialized
+ Index
Constructors
Properties
Methods
Constructors
constructor
- new
Entry Function(module_name, function_name, type_args, args): EntryFunction Contains the payload to run a function within a module.
+Parameters
- module_name: ModuleId
Fully qualified module name in format "account_address::module_name" e.g. "0x1::coin"
+ - function_name: Identifier
The function name. e.g "transfer"
+ - type_args: TypeTag[]
Type arguments that move function requires.
+ - args: EntryFunctionArgument[]
arguments to the move function.
+
Returns EntryFunction
Example
A coin transfer function has one type argument "CoinType".
+
+public entry fun transfer<CoinType>(from: &signer, to: address, amount: u64) +Example
A coin transfer function has three arguments "from", "to" and "amount".
+
+public entry fun transfer<CoinType>(from: &signer, to: address, amount: u64) +- module_name: ModuleId
Properties
Readonly args
Readonly function_
Readonly module_
Readonly type_
Methods
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static build
- build(module_id, function_name, type_args, args): EntryFunction
A helper function to build a EntryFunction payload from raw primitive values
+Parameters
- module_id: `${string}::${string}`
Fully qualified module name in format "AccountAddress::module_id" e.g. "0x1::coin"
+ - function_name: string
Function name
+ - type_args: TypeTag[]
Type arguments that move function requires.
+ - args: EntryFunctionArgument[]
Arguments to the move function.
+
Returns EntryFunction
EntryFunction
+Example
A coin transfer function has one type argument "CoinType".
+
+public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64,) +Example
A coin transfer function has three arguments "from", "to" and "amount".
+
+public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64,) +- module_id: `${string}::${string}`
Static deserialize
- deserialize(deserializer): EntryFunction
Deserializes an entry function payload with the arguments represented as EntryFunctionBytes instances.
+Parameters
- deserializer: Deserializer
Returns EntryFunction
A deserialized EntryFunction payload for a transaction.
+See
EntryFunctionBytes
+NOTE: When you deserialize an EntryFunction payload with this method, the entry function +arguments are populated into the deserialized instance as type-agnostic, raw fixed bytes +in the form of the EntryFunctionBytes class.
+In order to correctly deserialize these arguments as their actual type representations, you +must know the types of the arguments beforehand and deserialize them yourself individually.
+One way you could achieve this is by using the ABIs for an entry function and deserializing each +argument as its given, corresponding type.
+
Generated using TypeDoc
Class EntryFunctionBytes
This class exists solely to represent a sequence of fixed bytes as a serialized entry function, because +serializing an entry function appends a prefix that's only used for entry function arguments.
+NOTE: Attempting to use this class for a serialized script function will result in erroneous +and unexpected behavior.
+If you wish to convert this class back to a TransactionArgument, you must know the type +of the argument beforehand, and use the appropriate class to deserialize the bytes within +an instance of this class.
+Hierarchy (view full)
- Serializable
- EntryFunctionBytes
Implements
Index
Constructors
Private constructor
- new
Entry Function Bytes(value): EntryFunctionBytes Parameters
- value: HexInput
Returns EntryFunctionBytes
Properties
Readonly value
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer, length): EntryFunctionBytes
The only way to create an instance of this class is to use this static method.
+This function should only be used when deserializing a sequence of EntryFunctionPayload arguments.
+Parameters
- deserializer: Deserializer
the deserializer instance with the buffered bytes
+ - length: number
the length of the bytes to deserialize
+
Returns EntryFunctionBytes
an instance of this class, which will now only be usable as an EntryFunctionArgument
+- deserializer: Deserializer
Generated using TypeDoc
Class FeePayerRawTransaction
Representation of a Fee Payer Transaction that can serialized and deserialized
+Hierarchy (view full)
- RawTransactionWithData
- FeePayerRawTransaction
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Fee Payer Raw Transaction(raw_txn, secondary_signer_addresses, fee_payer_address): FeePayerRawTransaction Parameters
- raw_txn: RawTransaction
- secondary_signer_addresses: AccountAddress[]
- fee_payer_address: AccountAddress
Returns FeePayerRawTransaction
Properties
Readonly fee_
The fee payer account address
+Readonly raw_
The raw transaction
+Readonly secondary_
The secondary signers on this transaction - optional and can be empty
+Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize a Raw Transaction With Data
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): RawTransactionWithData
Deserialize a Raw Transaction With Data
+Parameters
- deserializer: Deserializer
Returns RawTransactionWithData
Static load
- load(deserializer): FeePayerRawTransaction
Parameters
- deserializer: Deserializer
Returns FeePayerRawTransaction
Generated using TypeDoc
Class FixedBytes
This class exists to represent a contiguous sequence of already serialized BCS-bytes.
+It differs from most other Serializable classes in that its internal byte buffer is serialized to BCS + bytes exactly as-is, without prepending the length of the bytes.
+If you want to write your own serialization function and pass the bytes as a transaction argument, + you should use this class.
+ This class is also more generally used to represent type-agnostic BCS bytes as a vector
An example of this is the bytes resulting from entry function arguments that have been serialized + for an entry function.
+Example
const yourCustomSerializedBytes = new Uint8Array([1, 2, 3, 4, 5, 6, 7, 8]);
const fixedBytes = new FixedBytes(yourCustomSerializedBytes);
const payload = await generateTransactionPayload({
function: "0xbeefcafe::your_module::your_function_that_requires_custom_serialization",
functionArguments: [yourCustomBytes],
});
For example, if you store each of the 32 bytes for an address as a U8 in a MoveVector<U8>, when you
serialize that MoveVector<U8>, it will be serialized to 33 bytes. If you solely want to pass around
the 32 bytes as a Serializable class that *does not* prepend the length to the BCS-serialized representation,
use this class.
+Params
value: HexInput representing a sequence of Uint8 bytes
+Returns
a Serializable FixedBytes instance, which when serialized, does not prepend the length of the bytes
+See
EntryFunctionBytes
+Hierarchy (view full)
- Serializable
- FixedBytes
Implements
Index
Constructors
constructor
- new
Fixed Bytes(value): FixedBytes Parameters
- value: HexInput
Returns FixedBytes
Properties
value
value: Uint8Array
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer, length): FixedBytes
Parameters
- deserializer: Deserializer
- length: number
Returns FixedBytes
Generated using TypeDoc
Class Hex
NOTE: Do not use this class when working with account addresses, use AccountAddress.
+NOTE: When accepting hex data as input to a function, prefer to accept HexInput and +then use the static helper methods of this class to convert it into the desired +format. This enables the greatest flexibility for the developer.
+Hex is a helper class for working with hex data. Hex data, when represented as a +string, generally looks like this, for example: 0xaabbcc, 45cd32, etc.
+You might use this class like this:
+getTransactionByHash(txnHash: HexInput): Promise<Transaction> {
const txnHashString = Hex.fromHexInput(txnHash).toString();
return await getTransactionByHashInner(txnHashString);
}
+This call to Hex.fromHexInput().toString() converts the HexInput to a hex string
+with a leading 0x prefix, regardless of what the input format was.
These are some other ways to chain the functions together:
+-
+
Hex.fromString({ hexInput: "0x1f" }).toUint8Array()
+new Hex([1, 3]).toStringWithoutPrefix()
+
Index
Constructors
constructor
Properties
Private Readonly data
data: Uint8Array
Methods
equals
- equals(other): boolean
Return whether Hex instances are equal. Hex instances are considered equal if +their underlying byte data is identical.
+Parameters
- other: Hex
The Hex instance to compare to.
+
Returns boolean
true if the Hex instances are equal, false if not.
+- other: Hex
to
to
to
Static from
Static from
Static is
- is
Valid(str): ParsingResult<HexInvalidReason> Check if the string is valid hex.
+Parameters
- str: string
A hex string representing byte data.
+
Returns ParsingResult<HexInvalidReason>
valid = true if the string is valid, false if not. If the string is not +valid, invalidReason and invalidReasonMessage will be set explaining why it is +invalid.
+- str: string
Generated using TypeDoc
Class Identifier
Representation of an Identifier that can serialized and deserialized. +We use Identifier to represent the module "name" in "ModuleId" and +the "function name" in "EntryFunction"
+Hierarchy (view full)
- Serializable
- Identifier
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Identifier(identifier): Identifier Parameters
- identifier: string
Returns Identifier
Properties
identifier
identifier: string
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): Identifier
Parameters
- deserializer: Deserializer
Returns Identifier
Generated using TypeDoc
Class ModuleId
Representation of a ModuleId that can serialized and deserialized +ModuleId means the module address (e.g "0x1") and the module name (e.g "coin")
+Hierarchy (view full)
- Serializable
- ModuleId
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Module Id(address, name): ModuleId Full name of a module.
+Parameters
- address: AccountAddress
The account address. e.g "0x1"
+ - name: Identifier
The module name under the "address". e.g "coin"
+
Returns ModuleId
- address: AccountAddress
Properties
Readonly address
Readonly name
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): ModuleId
Parameters
- deserializer: Deserializer
Returns ModuleId
Static from
Generated using TypeDoc
Class MoveOption<T>
Type Parameters
- T extends Serializable & EntryFunctionArgument
Hierarchy (view full)
- Serializable
- MoveOption
Implements
Index
Constructors
Properties
Methods
bcs
Constructors
constructor
- new
Move Option<T>(value?): MoveOption<T> Type Parameters
- T extends Serializable & EntryFunctionArgument
Parameters
Optionalvalue: null | T
Returns MoveOption<T>
Properties
Optional Readonly value
Private vec
Methods
bcs
bcs
is
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
unwrap
- unwrap(): T
Retrieves the inner value of the MoveOption.
+This method is inspired by Rust's
+Option<T>.unwrap(). +In Rust, attempting to unwrap aNonevalue results in a panic.Similarly, this method will throw an error if the value is not present.
+Returns T
The contained value if present.
+Example
+const option = new MoveOption<Bool>(new Bool(true));
const value = option.unwrap(); // Returns the Bool instance +Throws
Throws an error if the MoveOption does not contain a value.
+
Static Bool
- Bool(value?): MoveOption<Bool>
Factory method to generate a MoveOption
+from a booleanorundefined.Parameters
Optionalvalue: null | boolean
Returns MoveOption<Bool>
a MoveOption
+with an inner value valueExample
+MoveOption.Bool(true).isSome() === true;
MoveOption.Bool().isSome() === false;
MoveOption.Bool(undefined).isSome() === false; +Params
value: the value used to fill the MoveOption. If
+valueis undefined +the resulting MoveOption's .isSome() method will return false.
Static Move
- Move
String(value?): MoveOption<MoveString> Factory method to generate a MoveOption
+from a stringorundefined.Parameters
Optionalvalue: null | string
Returns MoveOption<MoveString>
a MoveOption
+with an inner value valueExample
+MoveOption.MoveString("hello").isSome() === true;
MoveOption.MoveString("").isSome() === true;
MoveOption.MoveString().isSome() === false;
MoveOption.MoveString(undefined).isSome() === false; +Params
value: the value used to fill the MoveOption. If
+valueis undefined +the resulting MoveOption's .isSome() method will return false.
Static U128
- U128(value?): MoveOption<U128>
Factory method to generate a MoveOption
+from a numberor abigintorundefined.Parameters
Optionalvalue: null | AnyNumber
Returns MoveOption<U128>
a MoveOption
+with an inner value valueExample
+MoveOption.U128(1).isSome() === true;
MoveOption.U128().isSome() === false;
MoveOption.U128(undefined).isSome() === false; +Params
value: the value used to fill the MoveOption. If
+valueis undefined +the resulting MoveOption's .isSome() method will return false.
Static U16
- U16(value?): MoveOption<U16>
Factory method to generate a MoveOption
+from a numberorundefined.Parameters
Optionalvalue: null | number
Returns MoveOption<U16>
a MoveOption
+with an inner value valueExample
+MoveOption.U16(1).isSome() === true;
MoveOption.U16().isSome() === false;
MoveOption.U16(undefined).isSome() === false; +Params
value: the value used to fill the MoveOption. If
+valueis undefined +the resulting MoveOption's .isSome() method will return false.
Static U256
- U256(value?): MoveOption<U256>
Factory method to generate a MoveOption
+from a numberor abigintorundefined.Parameters
Optionalvalue: null | AnyNumber
Returns MoveOption<U256>
a MoveOption
+with an inner value valueExample
+MoveOption.U256(1).isSome() === true;
MoveOption.U256().isSome() === false;
MoveOption.U256(undefined).isSome() === false; +Params
value: the value used to fill the MoveOption. If
+valueis undefined +the resulting MoveOption's .isSome() method will return false.
Static U32
- U32(value?): MoveOption<U32>
Factory method to generate a MoveOption
+from a numberorundefined.Parameters
Optionalvalue: null | number
Returns MoveOption<U32>
a MoveOption
+with an inner value valueExample
+MoveOption.U32(1).isSome() === true;
MoveOption.U32().isSome() === false;
MoveOption.U32(undefined).isSome() === false; +Params
value: the value used to fill the MoveOption. If
+valueis undefined +the resulting MoveOption's .isSome() method will return false.
Static U64
- U64(value?): MoveOption<U64>
Factory method to generate a MoveOption
+from a numberor abigintorundefined.Parameters
Optionalvalue: null | AnyNumber
Returns MoveOption<U64>
a MoveOption
+with an inner value valueExample
+MoveOption.U64(1).isSome() === true;
MoveOption.U64().isSome() === false;
MoveOption.U64(undefined).isSome() === false; +Params
value: the value used to fill the MoveOption. If
+valueis undefined +the resulting MoveOption's .isSome() method will return false.
Static U8
- U8(value?): MoveOption<U8>
Factory method to generate a MoveOption
+from a numberorundefined.Parameters
Optionalvalue: null | number
Returns MoveOption<U8>
a MoveOption
+with an inner value valueExample
+MoveOption.U8(1).isSome() === true;
MoveOption.U8().isSome() === false;
MoveOption.U8(undefined).isSome() === false; +Params
value: the value used to fill the MoveOption. If
+valueis undefined +the resulting MoveOption's .isSome() method will return false.
Static deserialize
- deserialize<U>(deserializer, cls): MoveOption<U>
Type Parameters
- U extends Serializable & EntryFunctionArgument
Parameters
- deserializer: Deserializer
- cls: Deserializable<U>
Returns MoveOption<U>
Generated using TypeDoc
Class MoveString
Hierarchy (view full)
- Serializable
- MoveString
Implements
Index
Constructors
constructor
- new
Move String(value): MoveString Parameters
- value: string
Returns MoveString
Properties
value
value: string
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): MoveString
Parameters
- deserializer: Deserializer
Returns MoveString
Generated using TypeDoc
Class MoveVector<T>
This class is the Aptos Typescript SDK representation of a Move vector<T>,
+where T represents either a primitive type (bool, u8, u64, ...)
+or a BCS-serializable struct itself.
It is a BCS-serializable, array-like type that contains an array of values of type T,
+where T is a class that implements Serializable.
The purpose of this class is to facilitate easy construction of BCS-serializable
+Move vector<T> types.
Example
// in Move: `vector<u8> [1, 2, 3, 4];`
const vecOfU8s = new MoveVector<U8>([new U8(1), new U8(2), new U8(3), new U8(4)]);
// in Move: `std::bcs::to_bytes(vector<u8> [1, 2, 3, 4]);`
const bcsBytes = vecOfU8s.toUint8Array();
// vector<vector<u8>> [ vector<u8> [1], vector<u8> [1, 2, 3, 4], vector<u8> [5, 6, 7, 8] ];
const vecOfVecs = new MoveVector<MoveVector<U8>>([
new MoveVector<U8>([new U8(1)]),
MoveVector.U8([1, 2, 3, 4]),
MoveVector.U8([5, 6, 7, 8]),
]);
// vector<Option<u8>> [ std::option::some<u8>(1), std::option::some<u8>(2) ];
const vecOfOptionU8s = new MoveVector<MoveOption<U8>>([
MoveOption.U8(1),
MoveOption.U8(2),
]);
// vector<MoveString> [ std::string::utf8(b"hello"), std::string::utf8(b"world") ];
const vecOfStrings = new MoveVector([new MoveString("hello"), new MoveString("world")]);
const vecOfStrings2 = MoveVector.MoveString(["hello", "world"]);
+Params
values: an Array
Returns
a MoveVector<T> with the values values
Type Parameters
- T extends Serializable & EntryFunctionArgument
Hierarchy (view full)
- Serializable
- MoveVector
Implements
Index
Constructors
constructor
- new
Move Vector<T>(values): MoveVector<T> Type Parameters
- T extends Serializable & EntryFunctionArgument
Parameters
- values: T[]
Returns MoveVector<T>
Properties
values
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void NOTE: This function will only work when the inner values in the
+MoveVectorareU8s.Parameters
- serializer: Serializer
Returns void
Static Bool
- Bool(values): MoveVector<Bool>
Factory method to generate a MoveVector of Bools from an array of booleans.
+Parameters
- values: boolean[]
Returns MoveVector<Bool>
a
+MoveVector<Bool>Example
+const v = MoveVector.Bool([true, false, true, false]); +Params
values: an array of
+boolsto convert to Bools
Static Move
- Move
String(values): MoveVector<MoveString> Factory method to generate a MoveVector of MoveStrings from an array of strings.
+Parameters
- values: string[]
Returns MoveVector<MoveString>
a
+MoveVector<MoveString>Example
+const v = MoveVector.MoveString(["hello", "world"]); +Params
values: an array of
+stringsto convert to MoveStrings
Static U128
- U128(values): MoveVector<U128>
Factory method to generate a MoveVector of U128s from an array of numbers or bigints.
+Parameters
- values: AnyNumber[]
Returns MoveVector<U128>
a
+MoveVector<U128>Example
+const v = MoveVector.U128([1, 2, 3, 4]); +Params
values: an array of numbers of type
+number | bigintto convert to U128s
Static U16
- U16(values): MoveVector<U16>
Factory method to generate a MoveVector of U16s from an array of numbers.
+Parameters
- values: number[]
Returns MoveVector<U16>
a
+MoveVector<U16>Example
+const v = MoveVector.U16([1, 2, 3, 4]); +Params
values: an array of
+numbersto convert to U16s
Static U256
- U256(values): MoveVector<U256>
Factory method to generate a MoveVector of U256s from an array of numbers or bigints.
+Parameters
- values: AnyNumber[]
Returns MoveVector<U256>
a
+MoveVector<U256>Example
+const v = MoveVector.U256([1, 2, 3, 4]); +Params
values: an array of numbers of type
+number | bigintto convert to U256s
Static U32
- U32(values): MoveVector<U32>
Factory method to generate a MoveVector of U32s from an array of numbers.
+Parameters
- values: number[]
Returns MoveVector<U32>
a
+MoveVector<U32>Example
+const v = MoveVector.U32([1, 2, 3, 4]); +Params
values: an array of
+numbersto convert to U32s
Static U64
- U64(values): MoveVector<U64>
Factory method to generate a MoveVector of U64s from an array of numbers or bigints.
+Parameters
- values: AnyNumber[]
Returns MoveVector<U64>
a
+MoveVector<U64>Example
+const v = MoveVector.U64([1, 2, 3, 4]); +Params
values: an array of numbers of type
+number | bigintto convert to U64s
Static U8
- U8(values): MoveVector<U8>
Factory method to generate a MoveVector of U8s from an array of numbers.
+Parameters
- values: number[] | HexInput
Returns MoveVector<U8>
a
+MoveVector<U8>Example
+const v = MoveVector.U8([1, 2, 3, 4]); +Params
values: an array of
+numbersto convert to U8s
Static deserialize
- deserialize<T>(deserializer, cls): MoveVector<T>
Deserialize a MoveVector of type T, specifically where T is a Serializable and Deserializable type.
+NOTE: This only works with a depth of one. Generics will not work.
+NOTE: This will not work with types that aren't of the Serializable class.
+If you're looking for a more flexible deserialization function, you can use the deserializeVector function +in the Deserializer class.
+Type Parameters
- T extends Serializable & EntryFunctionArgument
Parameters
- deserializer: Deserializer
- cls: Deserializable<T>
Returns MoveVector<T>
a MoveVector of the corresponding class T +*
+Example
+const vec = MoveVector.deserialize(deserializer, U64); +Params
deserializer: the Deserializer instance to use, with bytes loaded into it already. +cls: the class to typecast the input values to, must be a Serializable and Deserializable type.
+
Generated using TypeDoc
Class MultiAgentRawTransaction
Representation of a Multi Agent Transaction that can serialized and deserialized
+Hierarchy (view full)
- RawTransactionWithData
- MultiAgentRawTransaction
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Multi Agent Raw Transaction(raw_txn, secondary_signer_addresses): MultiAgentRawTransaction Parameters
- raw_txn: RawTransaction
- secondary_signer_addresses: AccountAddress[]
Returns MultiAgentRawTransaction
Properties
Readonly raw_
The raw transaction
+Readonly secondary_
The secondary signers on this transaction
+Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize a Raw Transaction With Data
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): RawTransactionWithData
Deserialize a Raw Transaction With Data
+Parameters
- deserializer: Deserializer
Returns RawTransactionWithData
Static load
- load(deserializer): MultiAgentRawTransaction
Parameters
- deserializer: Deserializer
Returns MultiAgentRawTransaction
Generated using TypeDoc
Class MultiEd25519PublicKey
Represents the public key of a K-of-N Ed25519 multi-sig transaction.
+Hierarchy (view full)
- AccountPublicKey
- MultiEd25519PublicKey
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Multi Ed25519 Public Key(args): MultiEd25519PublicKey Public key for a K-of-N multi-sig transaction. A K-of-N multi-sig transaction means that for such a +transaction to be executed, at least K out of the N authorized signers have signed the transaction +and passed the check conducted by the chain.
+Parameters
- args: {
publicKeys: Ed25519PublicKey[];
threshold: number;
}public
Keys: Ed25519PublicKey[] A list of public keys
+threshold: number
At least "threshold" signatures must be valid
+
Returns MultiEd25519PublicKey
- args: {
Properties
Readonly public
List of Ed25519 public keys for this LegacyMultiEd25519PublicKey
+Readonly threshold
threshold: number
The minimum number of valid signatures required, for the number of public keys specified
+Static Readonly MAX_
MAX_
Maximum number of public keys supported
+Static Readonly MIN_
MIN_
Minimum number of public keys needed
+Static Readonly MIN_
MIN_
Minimum threshold for the number of valid signatures required
+Methods
auth
- auth
Key(): AuthenticationKey Get the authentication key associated with this public key
+Returns AuthenticationKey
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
verify
- verify
Signature(args): boolean Verifies that the private key associated with this public key signed the message with the given signature.
+Parameters
- args: VerifySignatureArgs
Returns boolean
Static deserialize
- deserialize(deserializer): MultiEd25519PublicKey
Parameters
- deserializer: Deserializer
Returns MultiEd25519PublicKey
Generated using TypeDoc
Class MultiEd25519Signature
Represents the signature of a K-of-N Ed25519 multi-sig transaction.
+Hierarchy (view full)
- Signature
- MultiEd25519Signature
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Multi Ed25519 Signature(args): MultiEd25519Signature Signature for a K-of-N multi-sig transaction.
+Parameters
- args: {
bitmap: number[] | Uint8Array;
signatures: Ed25519Signature[];
}bitmap: number[] | Uint8Array
4 bytes, at most 32 signatures are supported. If Nth bit value is
+1, the Nth +signature should be provided insignatures. Bits are read from left to right. +Alternatively, you can specify an array of bitmap positions. +Valid position should range between 0 and 31.signatures: Ed25519Signature[]
A list of signatures
+
Returns MultiEd25519Signature
See
-
+
- Creating a Signed Transaction +
- MultiEd25519Signature.createBitmap +
- args: {
Properties
Readonly bitmap
bitmap: Uint8Array
32-bit Bitmap representing who signed the transaction
+This is represented where each public key can be masked to determine whether the message was signed by that key.
+Readonly signatures
The list of underlying Ed25519 signatures
+Static BITMAP_
BITMAP_
Number of bytes in the bitmap representing who signed the transaction (32-bits)
+Static MAX_
MAX_
Maximum number of Ed25519 signatures supported
+Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
Static create
- create
Bitmap(args): Uint8Array Helper method to create a bitmap out of the specified bit positions
+Parameters
- args: {
bits: number[];
}bits: number[]
The bitmap positions that should be set. A position starts at index 0. +Valid position should range between 0 and 31.
+
Returns Uint8Array
bitmap that is 32bit long
+Example
Here's an example of valid
+bits
+[0, 2, 31] +
+[0, 2, 31]means the 1st, 3rd and 32nd bits should be set in the bitmap. +The result bitmap should be 0b1010000000000000000000000000001- args: {
Static deserialize
- deserialize(deserializer): MultiEd25519Signature
Parameters
- deserializer: Deserializer
Returns MultiEd25519Signature
Generated using TypeDoc
Class MultiKey
Represents the public key of a multi-agent account.
+The public keys of each individual agent can be any type of public key supported by Aptos.
+Since AIP-55 Aptos supports
+Legacy and Unified authentication keys.
Hierarchy (view full)
- AccountPublicKey
- MultiKey
Index
Constructors
Properties
Methods
Constructors
constructor
Properties
Readonly public
List of any public keys
+Readonly signatures
signatures
The minimum number of valid signatures required, for the number of public keys specified
+Methods
auth
- auth
Key(): AuthenticationKey Get the authentication key associated with this public key
+Returns AuthenticationKey
bcs
bcs
create
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
verify
- verify
Signature(args): boolean Verifies that the private key associated with this public key signed the message with the given signature.
+Parameters
- args: VerifySignatureArgs
Returns boolean
Static deserialize
- deserialize(deserializer): MultiKey
Parameters
- deserializer: Deserializer
Returns MultiKey
Generated using TypeDoc
Class MultiKeySignature
An abstract representation of a crypto signature, +associated to a specific signature scheme e.g. Ed25519 or Secp256k1
+This is the product of signing a message directly from a PrivateKey +and can be verified against a CryptoPublicKey.
+Hierarchy (view full)
- Signature
- MultiKeySignature
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Multi Key Signature(args): MultiKeySignature Signature for a K-of-N multi-sig transaction.
+Parameters
- args: {
bitmap: number[] | Uint8Array;
signatures: (Signature | AnySignature)[];
}bitmap: number[] | Uint8Array
4 bytes, at most 32 signatures are supported. If Nth bit value is
+1, the Nth +signature should be provided insignatures. Bits are read from left to rightsignatures: (Signature | AnySignature)[]
A list of signatures
+
Returns MultiKeySignature
- args: {
Properties
Readonly bitmap
bitmap: Uint8Array
32-bit Bitmap representing who signed the transaction
+This is represented where each public key can be masked to determine whether the message was signed by that key.
+Readonly signatures
The list of underlying Ed25519 signatures
+Static BITMAP_
BITMAP_
Number of bytes in the bitmap representing who signed the transaction (32-bits)
+Static MAX_
MAX_
Maximum number of Ed25519 signatures supported
+Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
Static create
- create
Bitmap(args): Uint8Array Helper method to create a bitmap out of the specified bit positions
+Parameters
- args: {
bits: number[];
}bits: number[]
The bitmap positions that should be set. A position starts at index 0. +Valid position should range between 0 and 31.
+
Returns Uint8Array
bitmap that is 32bit long
+Example
Here's an example of valid
+bits
+[0, 2, 31] +
+[0, 2, 31]means the 1st, 3rd and 32nd bits should be set in the bitmap. +The result bitmap should be 0b1010000000000000000000000000001- args: {
Static deserialize
- deserialize(deserializer): MultiKeySignature
Parameters
- deserializer: Deserializer
Returns MultiKeySignature
Generated using TypeDoc
Class MultiSig
Representation of a MultiSig that can serialized and deserialized
+ Index
Constructors
Properties
Methods
Constructors
constructor
- new
Multi Sig(multisig_address, transaction_payload?): MultiSig Contains the payload to run a multi-sig account transaction.
+Parameters
- multisig_address: AccountAddress
The multi-sig account address the transaction will be executed as.
+ Optionaltransaction_payload: MultiSigTransactionPayloadThe payload of the multi-sig transaction. This is optional when executing a multi-sig + transaction whose payload is already stored on chain.
+
Returns MultiSig
- multisig_address: AccountAddress
Properties
Readonly multisig_
Optional Readonly transaction_
Methods
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): MultiSig
Parameters
- deserializer: Deserializer
Returns MultiSig
Generated using TypeDoc
Class MultiSigTransactionPayload
Representation of a MultiSig Transaction Payload from multisig_account.move
+that can be serialized and deserialized
This class exists right now to represent an extensible transaction payload class for
+transactions used in multisig_account.move. Eventually, this class will be able to
+support script payloads when the multisig_account.move module supports them.
Hierarchy (view full)
- Serializable
- MultiSigTransactionPayload
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Multi Sig Transaction Payload(transaction_payload): MultiSigTransactionPayload Contains the payload to run a multi-sig account transaction.
+Parameters
- transaction_payload: EntryFunction
The payload of the multi-sig transaction. +This can only be EntryFunction for now but, +Script might be supported in the future.
+
Returns MultiSigTransactionPayload
- transaction_payload: EntryFunction
Properties
Readonly transaction_
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): MultiSigTransactionPayload
Parameters
- deserializer: Deserializer
Returns MultiSigTransactionPayload
Generated using TypeDoc
Class ParsingError<T>
This error is used to explain why parsing failed.
+Type Parameters
Hierarchy
- Error
- ParsingError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Parsing Error<T>(message, invalidReason): ParsingError<T> Type Parameters
Parameters
- message: string
- invalidReason: T
Returns ParsingError<T>
Properties
invalid
This provides a programmatic way to access why parsing failed. Downstream devs +might want to use this to build their own error messages if the default error +messages are not suitable for their use case. This should be an enum.
+message
message: string
name
name: string
Optional stack
stack?: string
Static Optional prepare
prepare
Optional override for formatting stack traces
+Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Generated using TypeDoc
Class PublicKeyAbstract
An abstract representation of a public key.
+Provides a common interface for verifying any signature.
+Hierarchy (view full)
Index
Constructors
Methods
Constructors
constructor
Methods
bcs
bcs
Abstract serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Abstract to
Abstract verify
- verify
Signature(args): boolean Verifies that the private key associated with this public key signed the message with the given signature.
+Parameters
- args: VerifySignatureArgs
Returns boolean
Generated using TypeDoc
Class RawTransaction
Representation of a Raw Transaction that can serialized and deserialized
+Hierarchy (view full)
- Serializable
- RawTransaction
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Raw Transaction(sender, sequence_number, payload, max_gas_amount, gas_unit_price, expiration_timestamp_secs, chain_id): RawTransaction RawTransactions contain the metadata and payloads that can be submitted to Aptos chain for execution. +RawTransactions must be signed before Aptos chain can execute them.
+Parameters
- sender: AccountAddress
The sender Account Address
+ - sequence_number: bigint
Sequence number of this transaction. This must match the sequence number stored in + the sender's account at the time the transaction executes.
+ - payload: TransactionPayload
Instructions for the Aptos Blockchain, including publishing a module, + execute an entry function or execute a script payload.
+ - max_gas_amount: bigint
Maximum total gas to spend for this transaction. The account must have more + than this gas or the transaction will be discarded during validation.
+ - gas_unit_price: bigint
Price to be paid per gas unit.
+ - expiration_timestamp_secs: bigint
The blockchain timestamp at which the blockchain would discard this transaction.
+ - chain_id: ChainId
The chain ID of the blockchain that this transaction is intended to be run on.
+
Returns RawTransaction
- sender: AccountAddress
Properties
Readonly chain_
Readonly expiration_
expiration_
Readonly gas_
gas_
Readonly max_
max_
Readonly payload
Readonly sender
Readonly sequence_
sequence_
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): RawTransaction
Parameters
- deserializer: Deserializer
Returns RawTransaction
Generated using TypeDoc
Class RawTransactionWithDataAbstract
Representation of a Raw Transaction With Data that can serialized and deserialized
+Hierarchy (view full)
- Serializable
- RawTransactionWithData
Index
Constructors
Methods
Constructors
constructor
- new
Raw Transaction With Data(): RawTransactionWithData Returns RawTransactionWithData
Methods
bcs
bcs
Abstract serialize
- serialize(serializer): void
Serialize a Raw Transaction With Data
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): RawTransactionWithData
Deserialize a Raw Transaction With Data
+Parameters
- deserializer: Deserializer
Returns RawTransactionWithData
Generated using TypeDoc
Class RotationProofChallenge
Representation of the challenge which is needed to sign by owner of the account +to rotate the authentication key.
+Hierarchy (view full)
- Serializable
- RotationProofChallenge
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Rotation Proof Challenge(args): RotationProofChallenge Parameters
- args: {
currentAuthKey: AccountAddress;
newPublicKey: PublicKey;
originator: AccountAddress;
sequenceNumber: AnyNumber;
}current
Auth Key: AccountAddress new
Public Key: PublicKey originator: AccountAddress
sequence
Number: AnyNumber
Returns RotationProofChallenge
- args: {
Properties
Readonly account
Readonly current
Readonly module
Readonly new
Readonly originator
Readonly sequence
Readonly struct
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Generated using TypeDoc
Class Script
Representation of a Script that can serialized and deserialized
+ Index
Constructors
constructor
- new
Script(bytecode, type_args, args): Script Scripts contain the Move bytecodes payload that can be submitted to Aptos chain for execution.
+Parameters
- bytecode: Uint8Array
The move module bytecode
+ - type_args: TypeTag[]
The type arguments that the bytecode function requires.
+ - args: ScriptFunctionArgument[]
The arguments that the bytecode function requires.
+
Returns Script
Example
A coin transfer function has one type argument "CoinType".
+
+public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64,) +Example
A coin transfer function has three arguments "from", "to" and "amount".
+
+public(script) fun transfer<CoinType>(from: &signer, to: address, amount: u64,) +- bytecode: Uint8Array
Properties
Readonly args
The arguments that the bytecode function requires.
+Readonly bytecode
bytecode: Uint8Array
The move module bytecode
+Readonly type_
The type arguments that the bytecode function requires.
+Methods
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): Script
Parameters
- deserializer: Deserializer
Returns Script
Generated using TypeDoc
Class Secp256k1PrivateKey
A Secp256k1 ecdsa private key
+Hierarchy (view full)
- Serializable
- Secp256k1PrivateKey
Implements
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Secp256k1 Private Key(hexInput): Secp256k1PrivateKey Create a new PrivateKey instance from a Uint8Array or String.
+Parameters
- hexInput: HexInput
A HexInput (string or Uint8Array)
+
Returns Secp256k1PrivateKey
- hexInput: HexInput
Properties
Private Readonly key
The private key bytes
+Static Readonly LENGTH
LENGTH: number = 32
Length of Secp256k1 ecdsa private key
+Methods
bcs
bcs
public
- public
Key(): Secp256k1PublicKey Derive the Secp256k1PublicKey from this private key.
+Returns Secp256k1PublicKey
Secp256k1PublicKey
+
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
sign
- sign(message): Secp256k1Signature
Sign the given message with the private key.
+Parameters
- message: HexInput
in HexInput format
+
Returns Secp256k1Signature
Signature
+- message: HexInput
to
to
Static deserialize
- deserialize(deserializer): Secp256k1PrivateKey
Parameters
- deserializer: Deserializer
Returns Secp256k1PrivateKey
Static from
- from
Derivation Path(path, mnemonics): Secp256k1PrivateKey Derives a private key from a mnemonic seed phrase.
+Parameters
- path: string
the BIP44 path
+ - mnemonics: string
the mnemonic seed phrase
+
Returns Secp256k1PrivateKey
The generated key
+- path: string
Static Private from
- from
Derivation Path Inner(path, seed): Secp256k1PrivateKey A private inner function so we can separate from the main fromDerivationPath() method +to add tests to verify we create the keys correctly.
+Parameters
- path: string
the BIP44 path
+ - seed: Uint8Array
the seed phrase created by the mnemonics
+
Returns Secp256k1PrivateKey
The generated key
+- path: string
Static generate
- generate(): Secp256k1PrivateKey
Generate a new random private key.
+Returns Secp256k1PrivateKey
Secp256k1PrivateKey
+
Static is
- is
Private Key(privateKey): privateKey is Secp256k1PrivateKey Parameters
- privateKey: PrivateKey
Returns privateKey is Secp256k1PrivateKey
Deprecated
use
+instanceof Secp256k1PrivateKeyinstead
Generated using TypeDoc
Class Secp256k1PublicKey
Represents the Secp256k1 ecdsa public key
+Secp256k1 authentication key is represented in the SDK as AnyPublicKey.
Hierarchy (view full)
- PublicKey
- Secp256k1PublicKey
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Secp256k1 Public Key(hexInput): Secp256k1PublicKey Create a new PublicKey instance from a Uint8Array or String.
+Parameters
- hexInput: HexInput
A HexInput (string or Uint8Array)
+
Returns Secp256k1PublicKey
- hexInput: HexInput
Properties
Private Readonly key
Static Readonly LENGTH
LENGTH: number = 65
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
verify
- verify
Signature(args): boolean Verifies that the private key associated with this public key signed the message with the given signature.
+Parameters
- args: VerifySignatureArgs
Returns boolean
Static deserialize
- deserialize(deserializer): Secp256k1PublicKey
Parameters
- deserializer: Deserializer
Returns Secp256k1PublicKey
Static is
- is
Public Key(publicKey): publicKey is Secp256k1PublicKey Parameters
- publicKey: PublicKey
Returns publicKey is Secp256k1PublicKey
Deprecated
use
+instanceof Secp256k1PublicKeyinstead
Generated using TypeDoc
Class Secp256k1Signature
A signature of a message signed using a Secp256k1 ecdsa private key
+Hierarchy (view full)
- Signature
- Secp256k1Signature
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Secp256k1 Signature(hexInput): Secp256k1Signature Create a new Signature instance from a Uint8Array or String.
+Parameters
- hexInput: HexInput
A HexInput (string or Uint8Array)
+
Returns Secp256k1Signature
- hexInput: HexInput
Properties
Private Readonly data
The signature bytes
+Static Readonly LENGTH
LENGTH: 64 = 64
Secp256k1 ecdsa signatures are 256-bit.
+Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
to
Static deserialize
- deserialize(deserializer): Secp256k1Signature
Parameters
- deserializer: Deserializer
Returns Secp256k1Signature
Generated using TypeDoc
Class SerializableAbstract
Hierarchy (view full)
- Serializable
- EntryFunctionBytes
- FixedBytes
- Bool
- U8
- U16
- U32
- U64
- U128
- U256
- MoveVector
- MoveString
- MoveOption
- AccountAddress
- AuthenticationKey
- Ed25519PrivateKey
- PublicKey
- Secp256k1PrivateKey
- Signature
- AccountAuthenticator
- TransactionAuthenticator
- ChainId
- Identifier
- ModuleId
- RawTransaction
- RawTransactionWithData
- RotationProofChallenge
- SignedTransaction
- TransactionPayload
- MultiSigTransactionPayload
- TypeTag
- StructTag
Index
Constructors
Methods
Constructors
constructor
- new
Serializable(): Serializable Returns Serializable
Methods
bcs
bcs
Abstract serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Generated using TypeDoc
Class Serializer
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Serializer(length?): Serializer Parameters
- length: number = 64
Returns Serializer
Properties
Private buffer
buffer: ArrayBuffer
Private offset
offset: number
Methods
Protected append
Private ensure
serialize
- serialize<T>(value): void
Serializes a
+Serializablevalue, facilitating composable serialization.Type Parameters
- T extends Serializable
Parameters
- value: T
The Serializable value to serialize
+
Returns void
the serializer instance
+Example
+// Define the MoveStruct class that implements the Serializable interface
class MoveStruct extends Serializable {
constructor(
public creatorAddress: AccountAddress, // where AccountAddress extends Serializable
public collectionName: string,
public tokenName: string
) {}
serialize(serializer: Serializer): void {
serializer.serialize(this.creatorAddress); // Composable serialization of another Serializable object
serializer.serializeStr(this.collectionName);
serializer.serializeStr(this.tokenName);
}
}
// Construct a MoveStruct
const moveStruct = new MoveStruct(new AccountAddress(...), "MyCollection", "TokenA");
// Serialize a string, a u64 number, and a MoveStruct instance.
const serializer = new Serializer();
serializer.serializeStr("ExampleString");
serializer.serializeU64(12345678);
serializer.serialize(moveStruct);
// Get the bytes from the Serializer instance
const serializedBytes = serializer.toUint8Array(); +
serialize
serialize
serialize
serialize
- serialize
Str(value): void Serializes a string. UTF8 string is supported.
+The number of bytes in the string content is serialized first, as a uleb128-encoded u32 integer. +Then the string content is serialized as UTF8 encoded bytes.
+BCS layout for "string": string_length | string_content +where string_length is a u32 integer encoded as a uleb128 integer, equal to the number of bytes in string_content.
+Parameters
- value: string
Returns void
Example
+const serializer = new Serializer();
serializer.serializeStr("1234abcd");
assert(serializer.toUint8Array() === new Uint8Array([8, 49, 50, 51, 52, 97, 98, 99, 100])); +
serialize
- serialize
U128(value): void Serializes a uint128 number.
+BCS layout for "uint128": Sixteen bytes. Binary format in little-endian representation.
+Parameters
- value: AnyNumber
Returns void
serialize
- serialize
U16(value): void Serializes a uint16 number.
+BCS layout for "uint16": Two bytes. Binary format in little-endian representation.
+Parameters
- value: number
Returns void
Example
+const serializer = new Serializer();
serializer.serializeU16(4660);
assert(serializer.toUint8Array() === new Uint8Array([0x34, 0x12])); +
serialize
- serialize
U256(value): void Serializes a uint256 number.
+BCS layout for "uint256": Sixteen bytes. Binary format in little-endian representation.
+Parameters
- value: AnyNumber
Returns void
serialize
- serialize
U32(value): void Serializes a uint32 number.
+BCS layout for "uint32": Four bytes. Binary format in little-endian representation.
+Parameters
- value: number
Returns void
Example
+const serializer = new Serializer();
serializer.serializeU32(305419896);
assert(serializer.toUint8Array() === new Uint8Array([0x78, 0x56, 0x34, 0x12])); +
serialize
serialize
- serialize
U64(value): void Serializes a uint64 number.
+BCS layout for "uint64": Eight bytes. Binary format in little-endian representation.
+Parameters
- value: AnyNumber
Returns void
Example
+const serializer = new Serializer();
serializer.serializeU64(1311768467750121216);
assert(serializer.toUint8Array() === new Uint8Array([0x00, 0xEF, 0xCD, 0xAB, 0x78, 0x56, 0x34, 0x12])); +
serialize
serialize
- serialize
Vector<T>(values): void Serializes an array of BCS Serializable values to a serializer instance. +Note that this does not return anything. The bytes are added to the serializer instance's byte buffer.
+Type Parameters
- T extends Serializable
Parameters
- values: T[]
The array of BCS Serializable values
+
Returns void
Example
+const addresses = new Array<AccountAddress>(
AccountAddress.from("0x1"),
AccountAddress.from("0x2"),
AccountAddress.from("0xa"),
AccountAddress.from("0xb"),
);
const serializer = new Serializer();
serializer.serializeVector(addresses);
const serializedBytes = serializer.toUint8Array();
// serializedBytes is now the BCS-serialized bytes
// The equivalent value in Move would be:
// `bcs::to_bytes(&vector<address> [@0x1, @0x2, @0xa, @0xb])`; +
Private serialize
to
Generated using TypeDoc
Class SignatureAbstract
An abstract representation of a crypto signature, +associated to a specific signature scheme e.g. Ed25519 or Secp256k1
+This is the product of signing a message directly from a PrivateKey +and can be verified against a CryptoPublicKey.
+Hierarchy (view full)
Index
Constructors
Methods
Constructors
constructor
Methods
bcs
bcs
Abstract serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Abstract to
Generated using TypeDoc
Class SignedTransaction
Hierarchy (view full)
- Serializable
- SignedTransaction
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Signed Transaction(raw_txn, authenticator): SignedTransaction A SignedTransaction consists of a raw transaction and an authenticator. The authenticator +contains a client's public key and the signature of the raw transaction.
+Parameters
- raw_txn: RawTransaction
- authenticator: TransactionAuthenticator
Contains a client's public key and the signature of the raw transaction. +Authenticator has 3 flavors: single signature, multi-signature and multi-agent.
+
Returns SignedTransaction
Properties
Readonly authenticator
Readonly raw_
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): SignedTransaction
Parameters
- deserializer: Deserializer
Returns SignedTransaction
Generated using TypeDoc
Class SingleKeyAccount
Signer implementation for the SingleKey authentication scheme. +This extends a SingleKeyAccount by adding signing capabilities through a valid private key. +Currently, the only supported signature schemes are Ed25519 and Secp256k1.
+Note: Generating a signer instance does not create the account on-chain.
+Implements
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Single Key Account(args): SingleKeyAccount Parameters
Returns SingleKeyAccount
Properties
Readonly account
Account address associated with the account
+Readonly private
Private key associated with the account
+Readonly public
Public key associated with the account
+Readonly signing
Signing scheme used to sign transactions
+Methods
sign
- sign(message): AnySignature
Sign the given message with the private key.
+Parameters
- message: HexInput
in HexInput format
+
Returns AnySignature
AccountSignature
+- message: HexInput
sign
- sign
With Authenticator(message): AccountAuthenticatorSingleKey Sign a message using the available signing capabilities.
+Parameters
- message: HexInput
the signing message, as binary input
+
Returns AccountAuthenticatorSingleKey
the AccountAuthenticator containing the signature, together with the account's public key
+- message: HexInput
verify
Static from
- from
Derivation Path(args): SingleKeyAccount Derives an account with bip44 path and mnemonics, +Default to using an Ed25519 signature scheme.
+Parameters
Returns SingleKeyAccount
Static generate
- generate(args?): SingleKeyAccount
Derives an account from a randomly generated private key. +Default generation is using an Ed25519 key
+Parameters
- args: SingleKeySignerGenerateArgs = {}
Returns SingleKeyAccount
Account with the given signature scheme
+
Generated using TypeDoc
Class StructTag
Hierarchy (view full)
- Serializable
- StructTag
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Struct Tag(address, module_name, name, type_args): StructTag Parameters
- address: AccountAddress
- module_name: Identifier
- name: Identifier
- type_args: TypeTag[]
Returns StructTag
Properties
Readonly address
Readonly module
Readonly name
Readonly type
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): StructTag
Parameters
- deserializer: Deserializer
Returns StructTag
Generated using TypeDoc
Class TransactionAuthenticatorAbstract
Hierarchy (view full)
Index
Constructors
Methods
Constructors
constructor
- new
Transaction Authenticator(): TransactionAuthenticator Returns TransactionAuthenticator
Methods
bcs
bcs
Abstract serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): TransactionAuthenticator
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticator
Generated using TypeDoc
Class TransactionAuthenticatorEd25519
Transaction authenticator Ed25519 for a single signer transaction
+Param: public_key
Client's public key.
+Param: signature
Ed25519 signature of a raw transaction.
+See
Creating a Signed Transaction +for details about generating a signature.
+Hierarchy (view full)
- TransactionAuthenticator
- TransactionAuthenticatorEd25519
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Transaction Authenticator Ed25519(public_key, signature): TransactionAuthenticatorEd25519 Parameters
- public_key: Ed25519PublicKey
- signature: Ed25519Signature
Returns TransactionAuthenticatorEd25519
Properties
Readonly public_
Readonly signature
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): TransactionAuthenticator
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticator
Static load
- load(deserializer): TransactionAuthenticatorEd25519
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticatorEd25519
Generated using TypeDoc
Class TransactionAuthenticatorFeePayer
Transaction authenticator for a fee payer transaction
+Param: sender
Sender account authenticator
+Param: secondary_signer_addresses
Secondary signers address
+Param: secondary_signers
Secondary signers account authenticators
+Param: fee_payer
Object of the fee payer account address and the fee payer authentication
+Hierarchy (view full)
- TransactionAuthenticator
- TransactionAuthenticatorFeePayer
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Transaction Authenticator Fee Payer(sender, secondary_signer_addresses, secondary_signers, fee_payer): TransactionAuthenticatorFeePayer Parameters
- sender: AccountAuthenticator
- secondary_signer_addresses: AccountAddress[]
- secondary_signers: AccountAuthenticator[]
- fee_payer: {
address: AccountAddress;
authenticator: AccountAuthenticator;
}address: AccountAddress
authenticator: AccountAuthenticator
Returns TransactionAuthenticatorFeePayer
Properties
Readonly fee_
Type declaration
address: AccountAddress
authenticator: AccountAuthenticator
Readonly secondary_
Readonly secondary_
Readonly sender
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): TransactionAuthenticator
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticator
Static load
- load(deserializer): TransactionAuthenticatorMultiAgent
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticatorMultiAgent
Generated using TypeDoc
Class TransactionAuthenticatorMultiAgent
Transaction authenticator for a multi-agent transaction
+Param: sender
Sender account authenticator
+Param: secondary_signer_addresses
Secondary signers address
+Param: secondary_signers
Secondary signers account authenticators
+Hierarchy (view full)
- TransactionAuthenticator
- TransactionAuthenticatorMultiAgent
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Transaction Authenticator Multi Agent(sender, secondary_signer_addresses, secondary_signers): TransactionAuthenticatorMultiAgent Parameters
- sender: AccountAuthenticator
- secondary_signer_addresses: AccountAddress[]
- secondary_signers: AccountAuthenticator[]
Returns TransactionAuthenticatorMultiAgent
Properties
Readonly secondary_
Readonly secondary_
Readonly sender
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): TransactionAuthenticator
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticator
Static load
- load(deserializer): TransactionAuthenticatorMultiAgent
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticatorMultiAgent
Generated using TypeDoc
Class TransactionAuthenticatorMultiEd25519
Transaction authenticator Ed25519 for a multi signers transaction
+Param: public_key
Client's public key.
+Param: signature
Multi Ed25519 signature of a raw transaction.
+Hierarchy (view full)
- TransactionAuthenticator
- TransactionAuthenticatorMultiEd25519
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Transaction Authenticator Multi Ed25519(public_key, signature): TransactionAuthenticatorMultiEd25519 Parameters
- public_key: MultiEd25519PublicKey
- signature: MultiEd25519Signature
Returns TransactionAuthenticatorMultiEd25519
Properties
Readonly public_
Readonly signature
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): TransactionAuthenticator
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticator
Static load
- load(deserializer): TransactionAuthenticatorMultiEd25519
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticatorMultiEd25519
Generated using TypeDoc
Class TransactionAuthenticatorSingleSender
Single Sender authenticator for a single signer transaction
+Param: sender
AccountAuthenticator
+Hierarchy (view full)
- TransactionAuthenticator
- TransactionAuthenticatorSingleSender
Index
Constructors
constructor
- new
Transaction Authenticator Single Sender(sender): TransactionAuthenticatorSingleSender Parameters
- sender: AccountAuthenticator
Returns TransactionAuthenticatorSingleSender
Properties
Readonly sender
Methods
bcs
bcs
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): TransactionAuthenticator
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticator
Static load
- load(deserializer): TransactionAuthenticatorSingleSender
Parameters
- deserializer: Deserializer
Returns TransactionAuthenticatorSingleSender
Generated using TypeDoc
Class TransactionPayloadAbstract
Representation of the supported Transaction Payload +that can serialized and deserialized
+Hierarchy (view full)
Index
Constructors
Methods
Constructors
constructor
- new
Transaction Payload(): TransactionPayload Returns TransactionPayload
Methods
bcs
bcs
Abstract serialize
- serialize(serializer): void
Serialize a Transaction Payload
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): TransactionPayload
Deserialize a Transaction Payload
+Parameters
- deserializer: Deserializer
Returns TransactionPayload
Generated using TypeDoc
Class TransactionPayloadEntryFunction
Representation of a Transaction Payload Entry Function that can serialized and deserialized
+Hierarchy (view full)
- TransactionPayload
- TransactionPayloadEntryFunction
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Transaction Payload Entry Function(entryFunction): TransactionPayloadEntryFunction Parameters
- entryFunction: EntryFunction
Returns TransactionPayloadEntryFunction
Properties
Readonly entry
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize a Transaction Payload
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): TransactionPayload
Deserialize a Transaction Payload
+Parameters
- deserializer: Deserializer
Returns TransactionPayload
Static load
- load(deserializer): TransactionPayloadEntryFunction
Parameters
- deserializer: Deserializer
Returns TransactionPayloadEntryFunction
Generated using TypeDoc
Class TransactionPayloadMultiSig
Representation of a Transaction Payload Multi-sig that can serialized and deserialized
+Hierarchy (view full)
- TransactionPayload
- TransactionPayloadMultiSig
Index
Constructors
constructor
- new
Transaction Payload Multi Sig(multiSig): TransactionPayloadMultiSig Parameters
- multiSig: MultiSig
Returns TransactionPayloadMultiSig
Properties
Readonly multi
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize a Transaction Payload
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): TransactionPayload
Deserialize a Transaction Payload
+Parameters
- deserializer: Deserializer
Returns TransactionPayload
Static load
- load(deserializer): TransactionPayloadMultiSig
Parameters
- deserializer: Deserializer
Returns TransactionPayloadMultiSig
Generated using TypeDoc
Class TransactionPayloadScript
Representation of a Transaction Payload Script that can serialized and deserialized
+Hierarchy (view full)
- TransactionPayload
- TransactionPayloadScript
Index
Constructors
constructor
- new
Transaction Payload Script(script): TransactionPayloadScript Parameters
- script: Script
Returns TransactionPayloadScript
Properties
Readonly script
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize a Transaction Payload
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): TransactionPayload
Deserialize a Transaction Payload
+Parameters
- deserializer: Deserializer
Returns TransactionPayload
Static load
- load(deserializer): TransactionPayloadScript
Parameters
- deserializer: Deserializer
Returns TransactionPayloadScript
Generated using TypeDoc
Class TransactionWorker
TransactionWorker provides a simple framework for receiving payloads to be processed.
+Once one start() the process and pushes a new transaction, the worker acquires
+the current account's next sequence number (by using the AccountSequenceNumber class),
+generates a signed transaction and pushes an async submission process into the outstandingTransactions queue.
+At the same time, the worker processes transactions by reading the outstandingTransactions queue
+and submits the next transaction to chain, it
-
+
- waits for resolution of the submission process or get pre-execution validation error +and 2) waits for the resolution of the execution process or get an execution error. +The worker fires events for any submission and/or execution success and/or failure. +
Hierarchy
- EventEmitter<TransactionWorkerEvents>
- TransactionWorker
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Transaction Worker(aptosConfig, account, maxWaitTime?, maximumInFlight?, sleepTime?): TransactionWorker Provides a simple framework for receiving payloads to be processed.
+Parameters
- aptosConfig: AptosConfig
a config object
+ - account: Account
- maxWaitTime: number = 30
the max wait time to wait before resyncing the sequence number +to the current on-chain state, default to 30
+ - maximumInFlight: number = 100
submit up to
+maximumInFlighttransactions per account. +Mempool limits the number of transactions per account to 100, hence why we default to 100. - sleepTime: number = 10
If
+maximumInFlightare in flight, waitsleepTimeseconds before re-evaluating, default to 10
Returns TransactionWorker
- aptosConfig: AptosConfig
Properties
Readonly account
Readonly account
Readonly aptos
executed
executed
transactions that have been committed to chain
+outstanding
signed transactions waiting to be submitted
+sent
sent
transactions that have been submitted to chain
+started
started: boolean
Readonly task
task
Type declaration
- (): Promise<void>
Returns Promise<void>
transactions
transactions
transactions payloads waiting to be generated and signed
+TODO support entry function payload from ABI builder
+Static prefixed
prefixed: string | boolean
Methods
add
- add
Listener<T>(event, fn, context?): this Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- fn: ((...args) => void)
- (...args): void
Parameters
Rest...args: ArgumentMap<TransactionWorkerEvents>[Extract<T, keyof TransactionWorkerEvents>]
Returns void
Optionalcontext: any
Returns this
check
- check
Transaction(sentTransaction, sequenceNumber): Promise<void> Once transaction has been sent to chain, we check for its execution status.
+Parameters
- sentTransaction: PromiseFulfilledResult<PendingTransactionResponse>
transactions that were sent to chain and are now waiting to be executed
+ - sequenceNumber: bigint
the account's sequence number that was sent with the transaction
+
Returns Promise<void>
- sentTransaction: PromiseFulfilledResult<PendingTransactionResponse>
emit
- emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
+Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
Rest...args: ArgumentMap<TransactionWorkerEvents>[Extract<T, keyof TransactionWorkerEvents>]
Returns boolean
event
- event
Names(): (keyof TransactionWorkerEvents)[] Return an array listing the events for which the emitter has registered +listeners.
+Returns (keyof TransactionWorkerEvents)[]
generate
- generate
Next Transaction(account, sequenceNumber): Promise<undefined | SimpleTransaction> Generates a signed transaction that can be submitted to chain
+Parameters
- account: Account
an Aptos account
+ - sequenceNumber: bigint
a sequence number the transaction will be generated with
+
Returns Promise<undefined | SimpleTransaction>
- account: Account
listener
- listener
Count(event): number Return the number of listeners listening to a given event.
+Parameters
- event: keyof TransactionWorkerEvents
Returns number
listeners
- listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
+Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
Returns ((...args) => void)[]
off
- off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
Optionalfn: ((...args) => void)- (...args): void
Parameters
Rest...args: ArgumentMap<TransactionWorkerEvents>[Extract<T, keyof TransactionWorkerEvents>]
Returns void
Optionalcontext: anyOptionalonce: boolean
Returns this
on
- on<T>(event, fn, context?): this
Add a listener for a given event.
+Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- fn: ((...args) => void)
- (...args): void
Parameters
Rest...args: ArgumentMap<TransactionWorkerEvents>[Extract<T, keyof TransactionWorkerEvents>]
Returns void
Optionalcontext: any
Returns this
once
- once<T>(event, fn, context?): this
Add a one-time listener for a given event.
+Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
- fn: ((...args) => void)
- (...args): void
Parameters
Rest...args: ArgumentMap<TransactionWorkerEvents>[Extract<T, keyof TransactionWorkerEvents>]
Returns void
Optionalcontext: any
Returns this
process
- process
Transactions(): Promise<void> Reads the outstanding transaction queue and submits the transaction to chain.
+If the transaction has fulfilled, it pushes the transaction to the processed +transactions queue and fires a transactionsFulfilled event.
+If the transaction has failed, it pushes the transaction to the processed +transactions queue with the failure reason and fires a transactionsFailed event.
+Returns Promise<void>
push
- push(transactionData, options?): Promise<void>
Push transaction to the transactions queue
+Parameters
- transactionData: InputGenerateTransactionPayloadData
Transaction payload
+ Optionaloptions: InputGenerateTransactionOptions
Returns Promise<void>
- transactionData: InputGenerateTransactionPayloadData
remove
remove
- remove
Listener<T>(event, fn?, context?, once?): this Remove the listeners of a given event.
+Type Parameters
- T extends keyof TransactionWorkerEvents
Parameters
- event: T
Optionalfn: ((...args) => void)- (...args): void
Parameters
Rest...args: ArgumentMap<TransactionWorkerEvents>[Extract<T, keyof TransactionWorkerEvents>]
Returns void
Optionalcontext: anyOptionalonce: boolean
Returns this
run
start
stop
submit
Generated using TypeDoc
Class TypeTagAbstract
Hierarchy (view full)
Constructors
constructor
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
Abstract serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
Abstract to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Generated using TypeDoc
Class TypeTagAddress
Hierarchy (view full)
- TypeTag
- TypeTagAddress
Constructors
constructor
- new
Type Tag Address(): TypeTagAddress Returns TypeTagAddress
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(_deserializer): TypeTagAddress
Parameters
- _deserializer: Deserializer
Returns TypeTagAddress
Generated using TypeDoc
Class TypeTagBool
Hierarchy (view full)
- TypeTag
- TypeTagBool
Constructors
constructor
- new
Type Tag Bool(): TypeTagBool Returns TypeTagBool
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(_deserializer): TypeTagBool
Parameters
- _deserializer: Deserializer
Returns TypeTagBool
Generated using TypeDoc
Class TypeTagGeneric
Generics are used for type parameters in entry functions. However, +they are not actually serialized into a real type, so they cannot be +used as a type directly.
+Hierarchy (view full)
- TypeTag
- TypeTagGeneric
Constructors
constructor
- new
Type Tag Generic(value): TypeTagGeneric Parameters
- value: number
Returns TypeTagGeneric
Properties
Readonly value
value: number
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(deserializer): TypeTagGeneric
Parameters
- deserializer: Deserializer
Returns TypeTagGeneric
Generated using TypeDoc
Class TypeTagParserError
Hierarchy
- Error
- TypeTagParserError
Index
Constructors
Properties
Methods
Constructors
constructor
- new
Type Tag Parser Error(typeTagStr, invalidReason): TypeTagParserError Parameters
- typeTagStr: string
- invalidReason: TypeTagParserErrorType
Returns TypeTagParserError
Properties
message
message: string
name
name: string
Optional stack
stack?: string
Static Optional prepare
prepare
Optional override for formatting stack traces
+Type declaration
- (err, stackTraces): any
Parameters
- err: Error
- stackTraces: CallSite[]
Returns any
Static stack
stack
Methods
Static capture
Generated using TypeDoc
Class TypeTagReference
Hierarchy (view full)
- TypeTag
- TypeTagReference
Constructors
constructor
- new
Type Tag Reference(value): TypeTagReference Parameters
- value: TypeTag
Returns TypeTagReference
Properties
Readonly value
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(deserializer): TypeTagReference
Parameters
- deserializer: Deserializer
Returns TypeTagReference
Generated using TypeDoc
Class TypeTagSigner
Hierarchy (view full)
- TypeTag
- TypeTagSigner
Constructors
constructor
- new
Type Tag Signer(): TypeTagSigner Returns TypeTagSigner
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(_deserializer): TypeTagSigner
Parameters
- _deserializer: Deserializer
Returns TypeTagSigner
Generated using TypeDoc
Class TypeTagStruct
Hierarchy (view full)
- TypeTag
- TypeTagStruct
Constructors
constructor
- new
Type Tag Struct(value): TypeTagStruct Parameters
- value: StructTag
Returns TypeTagStruct
Properties
Readonly value
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
is
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
Type Tag(address, moduleName, structName): boolean Parameters
- address: AccountAddress
- moduleName: string
- structName: string
Returns boolean
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(deserializer): TypeTagStruct
Parameters
- deserializer: Deserializer
Returns TypeTagStruct
Generated using TypeDoc
Class TypeTagU128
Hierarchy (view full)
- TypeTag
- TypeTagU128
Constructors
constructor
- new
Type Tag U128(): TypeTagU128 Returns TypeTagU128
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(_deserializer): TypeTagU128
Parameters
- _deserializer: Deserializer
Returns TypeTagU128
Generated using TypeDoc
Class TypeTagU16
Hierarchy (view full)
- TypeTag
- TypeTagU16
Constructors
constructor
- new
Type Tag U16(): TypeTagU16 Returns TypeTagU16
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(_deserializer): TypeTagU16
Parameters
- _deserializer: Deserializer
Returns TypeTagU16
Generated using TypeDoc
Class TypeTagU256
Hierarchy (view full)
- TypeTag
- TypeTagU256
Constructors
constructor
- new
Type Tag U256(): TypeTagU256 Returns TypeTagU256
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(_deserializer): TypeTagU256
Parameters
- _deserializer: Deserializer
Returns TypeTagU256
Generated using TypeDoc
Class TypeTagU32
Hierarchy (view full)
- TypeTag
- TypeTagU32
Constructors
constructor
- new
Type Tag U32(): TypeTagU32 Returns TypeTagU32
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(_deserializer): TypeTagU32
Parameters
- _deserializer: Deserializer
Returns TypeTagU32
Generated using TypeDoc
Class TypeTagU64
Hierarchy (view full)
- TypeTag
- TypeTagU64
Constructors
constructor
- new
Type Tag U64(): TypeTagU64 Returns TypeTagU64
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(_deserializer): TypeTagU64
Parameters
- _deserializer: Deserializer
Returns TypeTagU64
Generated using TypeDoc
Class TypeTagU8
Hierarchy (view full)
- TypeTag
- TypeTagU8
Constructors
constructor
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(_deserializer): TypeTagU8
Parameters
- _deserializer: Deserializer
Returns TypeTagU8
Generated using TypeDoc
Class TypeTagVector
Hierarchy (view full)
- TypeTag
- TypeTagVector
Constructors
constructor
- new
Type Tag Vector(value): TypeTagVector Parameters
- value: TypeTag
Returns TypeTagVector
Properties
Readonly value
Methods
bcs
bcs
is
- is
Address(): this is TypeTagAddress Returns this is TypeTagAddress
is
- is
Bool(): this is TypeTagBool Returns this is TypeTagBool
is
- is
Generic(): this is TypeTagGeneric Returns this is TypeTagGeneric
is
- is
Signer(): this is TypeTagSigner Returns this is TypeTagSigner
is
- is
Struct(): this is TypeTagStruct Returns this is TypeTagStruct
is
- is
U128(): this is TypeTagU128 Returns this is TypeTagU128
is
- is
U16(): this is TypeTagU16 Returns this is TypeTagU16
is
- is
U256(): this is TypeTagU256 Returns this is TypeTagU256
is
- is
U32(): this is TypeTagU32 Returns this is TypeTagU32
is
- is
U64(): this is TypeTagU64 Returns this is TypeTagU64
is
is
- is
Vector(): this is TypeTagVector Returns this is TypeTagVector
serialize
- serialize(serializer): void
Parameters
- serializer: Serializer
Returns void
to
Static deserialize
- deserialize(deserializer): TypeTag
Parameters
- deserializer: Deserializer
Returns TypeTag
Static load
- load(deserializer): TypeTagVector
Parameters
- deserializer: Deserializer
Returns TypeTagVector
Static u8
- u8(): TypeTagVector
Returns TypeTagVector
Generated using TypeDoc
Class U128
Hierarchy (view full)
- Serializable
- U128
Implements
Index
Constructors
constructor
Properties
Readonly value
value: bigint
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): U128
Parameters
- deserializer: Deserializer
Returns U128
Generated using TypeDoc
Class U16
Hierarchy (view full)
- Serializable
- U16
Implements
Index
Constructors
constructor
Properties
Readonly value
value: number
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): U16
Parameters
- deserializer: Deserializer
Returns U16
Generated using TypeDoc
Class U256
Hierarchy (view full)
- Serializable
- U256
Implements
Index
Constructors
constructor
Properties
Readonly value
value: bigint
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): U256
Parameters
- deserializer: Deserializer
Returns U256
Generated using TypeDoc
Class U32
Hierarchy (view full)
- Serializable
- U32
Implements
Index
Constructors
constructor
Properties
Readonly value
value: number
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): U32
Parameters
- deserializer: Deserializer
Returns U32
Generated using TypeDoc
Class U64
Hierarchy (view full)
- Serializable
- U64
Implements
Index
Constructors
constructor
Properties
Readonly value
value: bigint
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): U64
Parameters
- deserializer: Deserializer
Returns U64
Generated using TypeDoc
Class U8
Hierarchy (view full)
Implements
Index
Constructors
constructor
Properties
Readonly value
value: number
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Static deserialize
- deserialize(deserializer): U8
Parameters
- deserializer: Deserializer
Returns U8
Generated using TypeDoc
Enumeration AccountAuthenticatorVariant
Transaction Authenticator enum as they are represented in Rust +https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs#L414
+ Index
Enumeration Members
Enumeration Members
Ed25519
Ed25519: 0
Multi
Multi
Multi
Multi
Single
Single
Generated using TypeDoc
Enumeration AddressInvalidReason
This enum is used to explain why an address was invalid.
+ Index
Enumeration Members
INCORRECT_
INCORRECT_
INVALID_
INVALID_
INVALID_
INVALID_
LEADING_
LEADING_
LONG_
LONG_
TOO_
TOO_
TOO_
TOO_
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Enumeration DeriveScheme
Scheme used for deriving account addresses from other data
+ Index
Enumeration Members
Derive
Derive
Derives an address using an AUID, used for objects
+Derive
Derive
Derives an address from a GUID, used for objects
+Derive
Derive
Derives an address from another object address
+Derive
Derive
Derives an address from seed bytes, used for named objects
+Derive
Derive
Derives an address from seed bytes, used for resource accounts
+Generated using TypeDoc
Generated using TypeDoc
Enumeration KeyType
A list of supported key types and associated seeds
+ Index
Enumeration Members
ED25519
+
Enumeration Members
ED25519
ED25519: "ed25519 seed"
Generated using TypeDoc
Enumeration MimeType
Index
Enumeration Members
Enumeration Members
BCS
BCS: "application/x-bcs"
BCS representation, used for accept type BCS output
+BCS_
BCS_
BCS representation, used for transaction submission in BCS input
+BCS_
BCS_
JSON
JSON: "application/json"
JSON representation, used for transaction submission and accept type JSON output
+Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Enumeration ProcessorType
The list of supported Processor types for our indexer api.
+These can be found from the processor_status table in the indexer database. +https://cloud.hasura.io/public/graphiql?endpoint=https://api.mainnet.aptoslabs.com/v1/graphql
+ Index
Enumeration Members
ACCOUNT_
ACCOUNT_
DEFAULT
DEFAULT: "default_processor"
EVENTS_
EVENTS_
FUNGIBLE_
FUNGIBLE_
STAKE_
STAKE_
TOKEN_
TOKEN_
USER_
USER_
Generated using TypeDoc
Generated using TypeDoc
Enumeration ScriptTransactionArgumentVariants
Script transaction arguments enum as they are represented in Rust +https://github.com/aptos-labs/aptos-core/blob/main/third_party/move/move-core/types/src/transaction_argument.rs#L11
+Enumeration Members
Address
Address: 3
Bool
Bool: 5
U128
U128: 2
U16
U16: 6
U256
U256: 8
U32
U32: 7
U64
U64: 1
U8
U8: 0
U8
U8
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Enumeration TransactionAuthenticatorVariant
Transaction Authenticator enum as they are represented in Rust +https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/authenticator.rs#L44
+ Index
Enumeration Members
Enumeration Members
Ed25519
Ed25519: 0
Fee
Fee
Multi
Multi
Multi
Multi
Single
Single
Generated using TypeDoc
Enumeration TransactionPayloadVariants
Transaction payload enum as they are represented in Rust +https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/mod.rs#L478
+ Index
Enumeration Members
Enumeration Members
Entry
Entry
Multisig
Multisig: 3
Script
Script: 0
Generated using TypeDoc
Enumeration TransactionResponseType
TRANSACTION TYPES
+ Index
Enumeration Members
Enumeration Members
Block
Block
Genesis
Genesis: "genesis_transaction"
Pending
Pending: "pending_transaction"
State
State
User
User: "user_transaction"
Validator
Validator: "validator_transaction"
Generated using TypeDoc
Enumeration TransactionVariants
Transaction variants enum as they are represented in Rust +https://github.com/aptos-labs/aptos-core/blob/main/types/src/transaction/mod.rs#L440
+ Index
Enumeration Members
Enumeration Members
Fee
Fee
Multi
Multi
Generated using TypeDoc
Enumeration TransactionWorkerEventsEnum
Index
Enumeration Members
Enumeration Members
Execution
Execution
Transaction
Transaction
Transaction
Transaction
Transaction
Transaction
Transaction
Transaction
Generated using TypeDoc
Enumeration TypeTagParserErrorType
Index
Enumeration Members
Invalid
Enumeration Members
Invalid
Invalid
Invalid
Invalid
Invalid
Invalid
Missing
Missing
Type
Type
Unexpected
Unexpected
Unexpected
Unexpected
Unexpected
Unexpected
Unexpected
Unexpected
Unexpected
Unexpected
Unexpected
Unexpected
Unexpected
Unexpected
Generated using TypeDoc
Enumeration TypeTagVariants
TypeTag enum as they are represented in Rust +https://github.com/aptos-labs/aptos-core/blob/main/third_party/move/move-core/types/src/language_storage.rs#L27
+Enumeration Members
Address
Address: 4
Bool
Bool: 0
Generic
Generic: 255
Reference
Reference: 254
Signer
Signer: 5
Struct
Struct: 7
U128
U128: 3
U16
U16: 8
U256
U256: 10
U32
U32: 9
U64
U64: 2
U8
U8: 1
Vector
Vector: 6
Generated using TypeDoc
Function CKDPriv
- CKDPriv(__namedParameters, index): DerivedKeys
Derive a child key from the private key
+Parameters
- __namedParameters: DerivedKeys
- index: number
Returns DerivedKeys
Generated using TypeDoc
Generated using TypeDoc
Function aptosRequest
- aptos
Request<Req, Res>(options, aptosConfig, apiType): Promise<AptosResponse<Req, Res>> The main function to use when doing an API request.
+Type Parameters
Parameters
- options: AptosRequest
AptosRequest
+ - aptosConfig: AptosConfig
The config information for the SDK client instance
+ - apiType: AptosApiType
Returns Promise<AptosResponse<Req, Res>>
the response or AptosApiError
+- options: AptosRequest
Generated using TypeDoc
Function buildTransaction
- build
Transaction(args): Promise<SimpleTransaction> We are defining function signatures, each with its specific input and output. +These are the possible function signature for our
+generateTransactionfunction. +When we call ourgenerateTransactionfunction with the relevant type properties, +Typescript can infer the return type based on the appropriate function overload.Parameters
Returns Promise<SimpleTransaction>
- build
Transaction(args): Promise<MultiAgentTransaction> Generates a transaction based on the provided arguments
+Note: we can start with one function to support all different payload/transaction types, +and if to complex to use, we could have function for each type
+Parameters
Returns Promise<MultiAgentTransaction>
An instance of a RawTransaction, plus optional secondary/fee payer addresses
+
+{
rawTransaction: RawTransaction,
secondarySignerAddresses? : Array<AccountAddress>,
feePayerAddress?: AccountAddress
} +
Generated using TypeDoc
Function checkOrConvertArgument
- check
Or Convert Argument(arg, param, position, genericTypeParams): EntryFunctionArgumentTypes Parameters
- arg: SimpleEntryFunctionArgumentTypes | EntryFunctionArgumentTypes
- param: TypeTag
- position: number
- genericTypeParams: TypeTag[]
Returns EntryFunctionArgumentTypes
Generated using TypeDoc
Function convertArgument
- convert
Argument(functionName, functionAbi, arg, position, genericTypeParams): EntryFunctionArgumentTypes Converts a non-BCS encoded argument into BCS encoded, if necessary
+Parameters
- functionName: string
- functionAbi: FunctionABI
- arg: SimpleEntryFunctionArgumentTypes | EntryFunctionArgumentTypes
- position: number
- genericTypeParams: TypeTag[]
Returns EntryFunctionArgumentTypes
Generated using TypeDoc
Function createObjectAddress
- create
Object Address(creatorAddress, seed): AccountAddress Creates an object address from creator address and seed
+Parameters
- creatorAddress: AccountAddress
The object creator account address
+ - seed: string | Uint8Array
The seed in either Uint8Array | string type
+
Returns AccountAddress
The object account address
+- creatorAddress: AccountAddress
Generated using TypeDoc
Function createTokenAddress
- create
Token Address(creatorAddress, collectionName, tokenName): AccountAddress Creates a token object address from creator address, collection name and token name
+Parameters
- creatorAddress: AccountAddress
The token creator account address
+ - collectionName: string
The collection name
+ - tokenName: string
The token name
+
Returns AccountAddress
The token account address
+- creatorAddress: AccountAddress
Generated using TypeDoc
Function deriveKey
- derive
Key(hashSeed, data): DerivedKeys Parameters
- hashSeed: string | Uint8Array
- data: string | Uint8Array
Returns DerivedKeys
Generated using TypeDoc
Function deriveTransactionType
- derive
Transaction Type(transaction): AnyRawTransactionInstance Derive the raw transaction type - FeePayerRawTransaction or MultiAgentRawTransaction or RawTransaction
+Parameters
- transaction: AnyRawTransaction
A aptos transaction type
+
Returns AnyRawTransactionInstance
FeePayerRawTransaction | MultiAgentRawTransaction | RawTransaction
+- transaction: AnyRawTransaction
Generated using TypeDoc
Function deserializeFromScriptArgument
- deserialize
From Script Argument(deserializer): TransactionArgument Deserialize a Script Transaction Argument
+Parameters
- deserializer: Deserializer
Returns TransactionArgument
Generated using TypeDoc
Generated using TypeDoc
Function fetchEntryFunctionAbi
- fetch
Entry Function Abi(moduleAddress, moduleName, functionName, aptosConfig): Promise<EntryFunctionABI> Fetches the ABI for an entry function from the module
+Parameters
- moduleAddress: string
- moduleName: string
- functionName: string
- aptosConfig: AptosConfig
Returns Promise<EntryFunctionABI>
Generated using TypeDoc
Function fetchFunctionAbi
- fetch
Function Abi(moduleAddress, moduleName, functionName, aptosConfig): Promise<MoveFunction | undefined> Fetches a function ABI from the on-chain module ABI. It doesn't validate whether it's a view or entry function.
+Parameters
- moduleAddress: string
- moduleName: string
- functionName: string
- aptosConfig: AptosConfig
Returns Promise<MoveFunction | undefined>
Generated using TypeDoc
Function fetchViewFunctionAbi
- fetch
View Function Abi(moduleAddress, moduleName, functionName, aptosConfig): Promise<ViewFunctionABI> Fetches the ABI for a view function from the module
+Parameters
- moduleAddress: string
- moduleName: string
- functionName: string
- aptosConfig: AptosConfig
Returns Promise<ViewFunctionABI>
Generated using TypeDoc
Function findFirstNonSignerArg
- find
First Non Signer Arg(functionAbi): number Finds first non-signer arg.
+A function is often defined with a
+signeror&signerarguments at the start, which are filled in +by signatures, and not by the caller.Parameters
- functionAbi: MoveFunction
Returns number
Generated using TypeDoc
Function generateMultiSignersSignedTransaction
- generate
Multi Signers Signed Transaction(transaction, senderAuthenticator, feePayerAuthenticator?, additionalSignersAuthenticators?): Uint8Array Generate a multi signers signed transaction that can be submitted to chain
+Parameters
- transaction: MultiAgentRawTransaction | FeePayerRawTransaction
MultiAgentRawTransaction | FeePayerRawTransaction
+ - senderAuthenticator: AccountAuthenticator
The account authenticator of the transaction sender
+ OptionalfeePayerAuthenticator: AccountAuthenticatorOptionaladditionalSignersAuthenticators: AccountAuthenticator[]
Returns Uint8Array
A SignedTransaction
+- transaction: MultiAgentRawTransaction | FeePayerRawTransaction
Generated using TypeDoc
Function generateRawTransaction
- generate
Raw Transaction(args): Promise<RawTransaction> Generates a raw transaction
+Parameters
- args: {
aptosConfig: AptosConfig;
feePayerAddress?: AccountAddressInput;
options?: InputGenerateTransactionOptions;
payload: AnyTransactionPayloadInstance;
sender: AccountAddressInput;
}aptos
Config: AptosConfig AptosConfig
+OptionalfeePayer Address?: AccountAddressInput Optionaloptions?: InputGenerateTransactionOptionspayload: AnyTransactionPayloadInstance
The transaction payload - can create by using generateTransactionPayload()
+sender: AccountAddressInput
The transaction's sender account address as a hex input
+
Returns Promise<RawTransaction>
RawTransaction
+- args: {
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function generateSigningMessage
- generate
Signing Message(transaction): Uint8Array Parameters
- transaction: AnyRawTransaction
Returns Uint8Array
Generated using TypeDoc
Function generateTransactionPayload
- generate
Transaction Payload(args): Promise<TransactionPayloadScript> We are defining function signatures, each with its specific input and output. +These are the possible function signature for our
+generateTransactionPayloadfunction. +When we call ourgenerateTransactionPayloadfunction with the relevant type properties, +Typescript can infer the return type based on the appropriate function overload.Parameters
- args: InputScriptData
Returns Promise<TransactionPayloadScript>
- generate
Transaction Payload(args): Promise<TransactionPayloadEntryFunction> Builds a transaction payload based on the data argument and returns +a transaction payload - TransactionPayloadScript | TransactionPayloadMultiSig | TransactionPayloadEntryFunction
+This uses the RemoteABI by default, and the remote ABI can be skipped by using generateTransactionPayloadWithABI
+Parameters
Returns Promise<TransactionPayloadEntryFunction>
TransactionPayload
+- generate
Transaction Payload(args): Promise<TransactionPayloadMultiSig> Builds a transaction payload based on the data argument and returns +a transaction payload - TransactionPayloadScript | TransactionPayloadMultiSig | TransactionPayloadEntryFunction
+This uses the RemoteABI by default, and the remote ABI can be skipped by using generateTransactionPayloadWithABI
+Parameters
Returns Promise<TransactionPayloadMultiSig>
TransactionPayload
+
Generated using TypeDoc
Function generateTransactionPayloadWithABI
- generate
Transaction Payload WithABI(args): TransactionPayloadEntryFunction Parameters
Returns TransactionPayloadEntryFunction
- generate
Transaction Payload WithABI(args): TransactionPayloadMultiSig Parameters
- args: InputMultiSigDataWithABI
Returns TransactionPayloadMultiSig
Generated using TypeDoc
Function generateViewFunctionPayload
- generate
View Function Payload(args): Promise<EntryFunction> Parameters
Returns Promise<EntryFunction>
Generated using TypeDoc
Function generateViewFunctionPayloadWithABI
- generate
View Function Payload WithABI(args): EntryFunction Parameters
Returns EntryFunction
Generated using TypeDoc
Function get
- get<Req, Res>(options): Promise<AptosResponse<Req, Res>>
Main function to do a Get request
+Type Parameters
Parameters
- options: GetRequestOptions
GetRequestOptions
+
Returns Promise<AptosResponse<Req, Res>>
- options: GetRequestOptions
Generated using TypeDoc
Function getAptosFullNode
- get
Aptos Full Node<Req, Res>(options): Promise<AptosResponse<Req, Res>> Type Parameters
Parameters
- options: GetAptosRequestOptions
Returns Promise<AptosResponse<Req, Res>>
Generated using TypeDoc
Function getAuthenticatorForSimulation
- get
Authenticator For Simulation(publicKey): AccountAuthenticatorEd25519 | AccountAuthenticatorSingleKey Parameters
- publicKey: PublicKey
Returns AccountAuthenticatorEd25519 | AccountAuthenticatorSingleKey
Generated using TypeDoc
Function getFunctionParts
Generated using TypeDoc
Function isBcsAddress
- is
Bcs Address(arg): arg is AccountAddress Parameters
Returns arg is AccountAddress
Generated using TypeDoc
Generated using TypeDoc
Function isBcsFixedBytes
- is
Bcs Fixed Bytes(arg): arg is FixedBytes Parameters
Returns arg is FixedBytes
Generated using TypeDoc
Function isBcsString
- is
Bcs String(arg): arg is MoveString Parameters
Returns arg is MoveString
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function isBlockMetadataTransactionResponse
- is
Block Metadata Transaction Response(response): response is BlockMetadataTransactionResponse Parameters
- response: TransactionResponse
Returns response is BlockMetadataTransactionResponse
Generated using TypeDoc
Generated using TypeDoc
Function isEd25519Signature
- is
Ed25519 Signature(signature): signature is TransactionFeePayerSignature Parameters
- signature: TransactionSignature
Returns signature is TransactionFeePayerSignature
Generated using TypeDoc
Function isEncodedEntryFunctionArgument
- is
Encoded Entry Function Argument(arg): arg is EntryFunctionArgumentTypes Parameters
Returns arg is EntryFunctionArgumentTypes
Generated using TypeDoc
Function isFeePayerSignature
- is
Fee Payer Signature(signature): signature is TransactionFeePayerSignature Parameters
- signature: TransactionSignature
Returns signature is TransactionFeePayerSignature
Generated using TypeDoc
Function isGenesisTransactionResponse
- is
Genesis Transaction Response(response): response is GenesisTransactionResponse Parameters
- response: TransactionResponse
Returns response is GenesisTransactionResponse
Generated using TypeDoc
Generated using TypeDoc
Function isMultiAgentSignature
- is
Multi Agent Signature(signature): signature is TransactionMultiAgentSignature Parameters
- signature: TransactionSignature
Returns signature is TransactionMultiAgentSignature
Generated using TypeDoc
Function isMultiEd25519Signature
- is
Multi Ed25519 Signature(signature): signature is TransactionMultiEd25519Signature Parameters
- signature: TransactionSignature
Returns signature is TransactionMultiEd25519Signature
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function isPendingTransactionResponse
- is
Pending Transaction Response(response): response is PendingTransactionResponse Parameters
- response: TransactionResponse
Returns response is PendingTransactionResponse
Generated using TypeDoc
Function isScriptDataInput
- is
Script Data Input(arg): arg is InputScriptData Parameters
Returns arg is InputScriptData
Generated using TypeDoc
Function isSecp256k1Signature
- is
Secp256k1 Signature(signature): signature is TransactionFeePayerSignature Parameters
- signature: TransactionSignature
Returns signature is TransactionFeePayerSignature
Generated using TypeDoc
Function isStateCheckpointTransactionResponse
- is
State Checkpoint Transaction Response(response): response is StateCheckpointTransactionResponse Parameters
- response: TransactionResponse
Returns response is StateCheckpointTransactionResponse
Generated using TypeDoc
Generated using TypeDoc
Function isUserTransactionResponse
- is
User Transaction Response(response): response is UserTransactionResponse Parameters
- response: TransactionResponse
Returns response is UserTransactionResponse
Generated using TypeDoc
Function isValidBIP44Path
- is
ValidBIP44 Path(path): boolean Aptos derive path is 637
+Parse and validate a path that is compliant to BIP-44 in form m/44'/637'/{account_index}'/{change_index}/{address_index} +for Secp256k1
+Note that for secp256k1, last two components must be non-hardened.
+Parameters
- path: string
path string (e.g.
+m/44'/637'/0'/0/0).
Returns boolean
- path: string
Generated using TypeDoc
Function isValidHardenedPath
- is
Valid Hardened Path(path): boolean Aptos derive path is 637
+Parse and validate a path that is compliant to SLIP-0010 and BIP-44 +in form m/44'/637'/{account_index}'/{change_index}'/{address_index}'. +See SLIP-0010 https://github.com/satoshilabs/slips/blob/master/slip-0044.md +See BIP-44 https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki
+Note that for Ed25519, all components must be hardened. +This is because non-hardened [PK] derivation would not work due to Ed25519's lack of a key homomorphism. +Specifically, you cannot derive the PK associated with derivation path a/b/c given the PK of a/b. +This is because the PK in Ed25519 is, more or less, computed as 𝑔𝐻(𝑠𝑘), +with the hash function breaking the homomorphism.
+Parameters
- path: string
path string (e.g.
+m/44'/637'/0'/0'/0').
Returns boolean
- path: string
Generated using TypeDoc
Function isValidatorTransactionResponse
- is
Validator Transaction Response(response): response is ValidatorTransactionResponse Parameters
- response: TransactionResponse
Returns response is ValidatorTransactionResponse
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Function paginateWithCursor
- paginate
With Cursor<Req, Res>(options): Promise<Res> Type Parameters
Parameters
- options: GetAptosRequestOptions
Returns Promise<Res>
Generated using TypeDoc
Function parseTypeTag
- parse
Type Tag(typeStr, options?): TypeTag All types are made of a few parts they're either:
+-
+
- A simple type e.g. u8 +
- A standalone struct e.g. 0x1::account::Account +
- A nested struct e.g. 0x1::coin::Coin<0x1234::coin::MyCoin> +
There are a few more special cases that need to be handled, however.
+-
+
- Multiple generics e.g 0x1::pair::Pair<u8, u16> +
- Spacing in the generics e.g. 0x1::pair::Pair< u8 , u16> +
- Nested generics of different depths e.g. 0x1::pair::Pair<0x1::coin::Coin<0x1234::coin::MyCoin>, u8> +
- Generics for types in ABIs are filled in with placeholders e.g T1, T2, T3 +
Parameters
- typeStr: string
Optionaloptions: {
allowGenerics?: boolean;
}OptionalallowGenerics?: boolean
Returns TypeTag
Generated using TypeDoc
Function post
- post<Req, Res>(options): Promise<AptosResponse<Req, Res>>
Main function to do a Post request
+Type Parameters
Parameters
- options: PostRequestOptions
PostRequestOptions
+
Returns Promise<AptosResponse<Req, Res>>
- options: PostRequestOptions
Generated using TypeDoc
Function postAptosFaucet
- post
Aptos Faucet<Req, Res>(options): Promise<AptosResponse<Req, Res>> Type Parameters
Parameters
- options: PostAptosRequestOptions
Returns Promise<AptosResponse<Req, Res>>
Generated using TypeDoc
Function postAptosFullNode
- post
Aptos Full Node<Req, Res>(options): Promise<AptosResponse<Req, Res>> Type Parameters
Parameters
- options: PostAptosRequestOptions
Returns Promise<AptosResponse<Req, Res>>
Generated using TypeDoc
Function postAptosIndexer
- post
Aptos Indexer<Req, Res>(options): Promise<AptosResponse<Req, Res>> Type Parameters
Parameters
- options: PostAptosRequestOptions
Returns Promise<AptosResponse<Req, Res>>
Generated using TypeDoc
Function request
- request<Req, Res>(options, client): Promise<ClientResponse<Res>>
Given a url and method, sends the request with axios and +returns the response.
+Type Parameters
Parameters
- options: ClientRequest<Req>
- client: Client
Returns Promise<ClientResponse<Res>>
Generated using TypeDoc
Function sign
- sign(args): AccountAuthenticator
Sign a transaction that can later be submitted to chain
+Parameters
- args: {
signer: Account;
transaction: AnyRawTransaction;
}signer: Account
The signer account to sign the transaction
+transaction: AnyRawTransaction
A aptos transaction type to sign
+
Returns AccountAuthenticator
The signer AccountAuthenticator
+- args: {
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
@aptos-labs/ts-sdk - v1.11.0
Class Hierarchy
- Serializable
- EntryFunctionBytes
- FixedBytes
- Bool
- U8
- U16
- U32
- U64
- U128
- U256
- MoveVector
- MoveString
- MoveOption
- AccountAddress
- AuthenticationKey
- Ed25519PrivateKey
- PublicKey
- Secp256k1PrivateKey
- Signature
- AccountAuthenticator
- TransactionAuthenticator
- ChainId
- Identifier
- ModuleId
- RawTransaction
- RawTransactionWithData
- RotationProofChallenge
- SignedTransaction
- TransactionPayload
- MultiSigTransactionPayload
- TypeTag
- StructTag
- EntryFunctionBytes
Generated using TypeDoc
@aptos-labs/ts-sdk - v1.11.0
Typescript SDK for Aptos
Latest Version
+
Experimental Development Version
The Aptos TypeScript SDK provides a convenient way to interact with the Aptos blockchain using TypeScript. It offers a +set of utility functions, classes, and types to simplify the integration process and enhance developer productivity.
+This repository supports version >= 0.0.0 of the Aptos SDK npm package.
+Installation
For use in Node.js or a web application
Install with your favorite package manager such as npm, yarn, or pnpm:
+pnpm install @aptos-labs/ts-sdk
+For use in a browser (<= 1.9.1 version only)
You can add the SDK to your web application using a script tag:
+<script src="https://unpkg.com/@aptos-labs/ts-sdk/dist/browser/index.global.js" />
+Then, the SDK can be accessed through window.aptosSDK.
Usage
Initialize Aptos to access the SDK API.
// initiate the main entry point into Aptos SDK
const aptos = new Aptos();
+If you want to pass in a custom config
+// an optional config information for the SDK client instance.
const config = new AptosConfig({ network: Network.LOCAL }); // default network is devnet
const aptos = new Aptos(config);
+Read data from chain
+
const modules = await aptos.getAccountModules({ accountAddress: "0x123" });
+Account management (default to Ed25519)
++Note: We introduce a Single Sender authentication (as introduced in AIP-55). Generating an account defaults to Legacy Ed25519 authentication with the option to use the Single Sender unified authentication
+
+
Generate new keys
const account = Account.generate(); // defaults to Legacy Ed25519
const account = Account.generate({ scheme: SigningSchemeInput.Secp256k1Ecdsa }); // Single Sender Secp256k1
const account = Account.generate({ scheme: SigningSchemeInput.Ed25519, legacy: false }); // Single Sender Ed25519
+Derive from private key
// Create a private key instance for Ed25519 scheme
const privateKey = new Ed25519PrivateKey("myEd25519privatekeystring");
// Or for Secp256k1 scheme
const privateKey = new Secp256k1PrivateKey("mySecp256k1privatekeystring");
// Derive an account from private key
// This is used as a local calculation and therefore is used to instantiate an `Account`
// that has not had its authentication key rotated
const account = await Account.fromPrivateKey({ privateKey });
// Also, can use this function that resolves the provided private key type and derives the public key from it
// to support key rotation and differentiation between Legacy Ed25519 and Unified authentications
// Read more https://github.com/aptos-labs/aptos-ts-sdk/blob/main/src/api/account.ts#L364
const aptos = new Aptos();
const account = await aptos.deriveAccountFromPrivateKey({ privateKey });
+Derive from private key and address
// Create a private key instance for Ed25519 scheme
const privateKey = new Ed25519PrivateKey("myEd25519privatekeystring");
// Or for Secp256k1 scheme
const privateKey = new Secp256k1PrivateKey("mySecp256k1privatekeystring");
// Derive an account from private key and address
// create an AccountAddress instance from the account address string
const address = AccountAddress.from("myaccountaddressstring");
// Derieve an account from private key and address
const account = await Account.fromPrivateKeyAndAddress({ privateKey, address });
+Derive from path
const path = "m/44'/637'/0'/0'/1";
const mnemonic = "various float stumble...";
const account = Account.fromDerivationPath({ path, mnemonic });
+Submit transaction
+
Single Signer transaction
Using transaction submission api
+const alice: Account = Account.generate();
const bobAddress = "0xb0b";
// build transaction
const transaction = await aptos.transaction.build.simple({
sender: alice.accountAddress,
data: {
function: "0x1::coin::transfer",
typeArguments: ["0x1::aptos_coin::AptosCoin"],
functionArguments: [bobAddress, 100],
},
});
// using sign and submit separately
const senderAuthenticator = aptos.transaction.sign({ signer: alice, transaction });
const committedTransaction = await aptos.transaction.submit.simple({ transaction, senderAuthenticator });
// using signAndSubmit combined
const committedTransaction = await aptos.signAndSubmitTransaction({ signer: alice, transaction });
+Using built in transferCoinTransaction
const alice: Account = Account.generate();
const bobAddress = "0xb0b";
// build transaction
const transaction = await aptos.transferCoinTransaction({
sender: alice,
recipient: bobAddress,
amount: 100,
});
const pendingTransaction = await aptos.signAndSubmitTransaction({ signer: alice, transaction });
+Documentation and examples
-
+
- For full SDK documentation, check out the TypeScript SDK documentation +
- For reference documenation, check out the API reference documentation for the associated version. +
- For in-depth examples, check out the examples folder with ready-made
package.jsonfiles to get you going quickly!
+
Testing
To run the SDK tests, simply run from the root of this repository:
+++Note: for a better experience, make sure there is no aptos local node process up and running (can check if there is a process running on port 8080).
+
pnpm i
pnpm test
+Troubleshooting
If you see import error when you do this
+import { Aptos, AptosConfig, Network } from "@aptos-labs/ts-sdk";
+It could be your tsconfig.json is not incompatible, make sure your moduleResolution is set to node instead of bundler.
Contributing
If you found a bug or would like to request a feature, please file an issue. +If, based on the discussion on an issue you would like to offer a code change, please make a pull request. +If neither of these describes what you would like to contribute, checkout out the contributing guide.
+Generated using TypeDoc
Interface AptosResponse<Req, Res>
The API response type
+Param: status
the response status. i.e. 200
+Param: statusText
the response message
+Param: data
the response data
+Param: url
the url the request was made to
+Param: headers
the response headers
+Param: config
(optional) - the request object
+Param: request
(optional) - the request object
+interface AptosResponse<Req, Res> {
config?: any;
data: Res;
headers: any;
request?: Req;
status: number;
statusText: string;
url: string;
}
config?: any;
data: Res;
headers: any;
request?: Req;
status: number;
statusText: string;
url: string;
}
Type Parameters
Properties
Optional config
config?: any
data
headers
headers: any
Optional request
status
status: number
status
status
url
url: string
Generated using TypeDoc
Interface Client
Index
Methods
provider
+
Methods
provider
- provider<Req, Res>(requestOptions): Promise<ClientResponse<Res>>
Type Parameters
Parameters
- requestOptions: ClientRequest<Req>
Returns Promise<ClientResponse<Res>>
Generated using TypeDoc
Interface ClientRequest<Req>
interface ClientRequest<Req> {
body?: Req;
contentType?: string;
headers?: Record<string, any>;
method: "GET" | "POST";
overrides?: ClientHeadersType & {
API_KEY?: string;
WITH_CREDENTIALS?: boolean;
} & {
AUTH_TOKEN?: string;
};
params?: any;
url: string;
}
body?: Req;
contentType?: string;
headers?: Record<string, any>;
method: "GET" | "POST";
overrides?: ClientHeadersType & {
API_KEY?: string;
WITH_CREDENTIALS?: boolean;
} & {
AUTH_TOKEN?: string;
};
params?: any;
url: string;
}
Type Parameters
Index
Properties
Properties
Optional body
Optional content
content
Optional headers
headers?: Record<string, any>
method
method: "GET" | "POST"
Optional overrides
overrides?: ClientHeadersType & {
API_KEY?: string;
WITH_CREDENTIALS?: boolean;
} & {
AUTH_TOKEN?: string;
}
API_KEY?: string;
WITH_CREDENTIALS?: boolean;
} & {
AUTH_TOKEN?: string;
}
Type declaration
OptionalAPI_KEY?: string OptionalWITH_CREDENTIALS?: boolean
Type declaration
OptionalAUTH_TOKEN?: string
Optional params
params?: any
url
url: string
Generated using TypeDoc
Interface ClientResponse<Res>
interface ClientResponse<Res> {
config?: any;
data: Res;
headers?: any;
request?: any;
response?: any;
status: number;
statusText: string;
}
config?: any;
data: Res;
headers?: any;
request?: any;
response?: any;
status: number;
statusText: string;
}
Type Parameters
Properties
Optional config
config?: any
data
Optional headers
headers?: any
Optional request
request?: any
Optional response
response?: any
status
status: number
status
status
Generated using TypeDoc
Interface CreateAccountFromPrivateKeyArgs
Arguments for creating an opaque Account from any supported private key.
+This is used when the private key type is not known at compilation time.
interface CreateAccountFromPrivateKeyArgs {
address?: AccountAddressInput;
legacy?: boolean;
privateKey: PrivateKey;
}
address?: AccountAddressInput;
legacy?: boolean;
privateKey: PrivateKey;
}
Index
Properties
Properties
Optional address
Optional legacy
legacy?: boolean
private
Generated using TypeDoc
Interface CreateEd25519AccountFromPrivateKeyArgs
Arguments for creating an Ed25519Account from an Ed25519PrivateKey.
+This is the default input type when passing an Ed25519PrivateKey.
+In order to use the SingleKey authentication scheme, legacy needs to be explicitly set to false.
interface CreateEd25519AccountFromPrivateKeyArgs {
address?: AccountAddressInput;
legacy?: true;
privateKey: Ed25519PrivateKey;
}
address?: AccountAddressInput;
legacy?: true;
privateKey: Ed25519PrivateKey;
}
Index
Properties
Properties
Optional address
Optional legacy
legacy?: true
private
Generated using TypeDoc
Interface CreateEd25519SingleKeyAccountFromPrivateKeyArgs
Arguments for creating an SingleKeyAccount from an Ed25519PrivateKey.
+The legacy argument needs to be explicitly set to false in order to
+use the SingleKey authentication scheme.
interface CreateEd25519SingleKeyAccountFromPrivateKeyArgs {
address?: AccountAddressInput;
legacy: false;
privateKey: Ed25519PrivateKey;
}
address?: AccountAddressInput;
legacy: false;
privateKey: Ed25519PrivateKey;
}
Index
Properties
Properties
Optional address
legacy
legacy: false
private
Generated using TypeDoc
Interface CreateSingleKeyAccountFromPrivateKeyArgs
Arguments for creating an SingleKeyAccount from any supported private key
+that is not an Ed25519PrivateKey.
+The legacy argument defaults to false and cannot be explicitly set to true.
interface CreateSingleKeyAccountFromPrivateKeyArgs {
address?: AccountAddressInput;
legacy?: false;
privateKey: PrivateKey;
}
address?: AccountAddressInput;
legacy?: false;
privateKey: PrivateKey;
}
Index
Properties
Properties
Optional address
Optional legacy
legacy?: false
private
Generated using TypeDoc
Interface Deserializable<T>
This interface exists to define Deserializable
Type Parameters
Index
Methods
Methods
deserialize
- deserialize(deserializer): T
Parameters
- deserializer: Deserializer
Returns T
Generated using TypeDoc
Interface Ed25519SignerConstructorArgs
interface Ed25519SignerConstructorArgs {
address?: AccountAddressInput;
privateKey: Ed25519PrivateKey;
}
address?: AccountAddressInput;
privateKey: Ed25519PrivateKey;
}
Index
Properties
Properties
Optional address
private
Generated using TypeDoc
Generated using TypeDoc
Interface EntryFunctionArgument
interface EntryFunctionArgument {
bcsToBytes(): Uint8Array;
bcsToHex(): Hex;
serialize(serializer): void;
serializeForEntryFunction(serializer): void;
}
bcsToBytes(): Uint8Array;
bcsToHex(): Hex;
serialize(serializer): void;
serializeForEntryFunction(serializer): void;
}
Hierarchy (view full)
- EntryFunctionArgument
Implemented by
Index
Methods
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface InputGenerateMultiAgentRawTransactionArgs
Interface of the arguments to generate a multi-agent transaction.
+Used to provide to generateTransaction() method in the transaction builder flow
interface InputGenerateMultiAgentRawTransactionArgs {
aptosConfig: AptosConfig;
feePayerAddress?: AccountAddressInput;
options?: InputGenerateTransactionOptions;
payload: AnyTransactionPayloadInstance;
secondarySignerAddresses: AccountAddressInput[];
sender: AccountAddressInput;
}
aptosConfig: AptosConfig;
feePayerAddress?: AccountAddressInput;
options?: InputGenerateTransactionOptions;
payload: AnyTransactionPayloadInstance;
secondarySignerAddresses: AccountAddressInput[];
sender: AccountAddressInput;
}
Index
Properties
Properties
aptos
Optional fee
Optional options
payload
secondary
sender
Generated using TypeDoc
Interface InputGenerateMultiAgentRawTransactionData
Interface that holds the user data input when generating a multi-agent transaction
+interface InputGenerateMultiAgentRawTransactionData {
data: InputGenerateTransactionPayloadData;
options?: InputGenerateTransactionOptions;
secondarySignerAddresses: AccountAddressInput[];
sender: AccountAddressInput;
withFeePayer?: boolean;
}
data: InputGenerateTransactionPayloadData;
options?: InputGenerateTransactionOptions;
secondarySignerAddresses: AccountAddressInput[];
sender: AccountAddressInput;
withFeePayer?: boolean;
}
Index
Properties
Properties
data
Optional options
secondary
sender
Optional with
with
Generated using TypeDoc
Interface InputGenerateSingleSignerRawTransactionArgs
Interface of the arguments to generate a single signer transaction.
+Used to provide to generateTransaction() method in the transaction builder flow
interface InputGenerateSingleSignerRawTransactionArgs {
aptosConfig: AptosConfig;
feePayerAddress?: AccountAddressInput;
options?: InputGenerateTransactionOptions;
payload: AnyTransactionPayloadInstance;
sender: AccountAddressInput;
}
aptosConfig: AptosConfig;
feePayerAddress?: AccountAddressInput;
options?: InputGenerateTransactionOptions;
payload: AnyTransactionPayloadInstance;
sender: AccountAddressInput;
}
Index
Properties
Properties
aptos
Optional fee
Optional options
payload
sender
Generated using TypeDoc
Interface InputGenerateSingleSignerRawTransactionData
Interface that holds the user data input when generating a single signer transaction
+interface InputGenerateSingleSignerRawTransactionData {
data: InputGenerateTransactionPayloadData;
options?: InputGenerateTransactionOptions;
secondarySignerAddresses?: undefined;
sender: AccountAddressInput;
withFeePayer?: boolean;
}
data: InputGenerateTransactionPayloadData;
options?: InputGenerateTransactionOptions;
secondarySignerAddresses?: undefined;
sender: AccountAddressInput;
withFeePayer?: boolean;
}
Index
Properties
Properties
data
Optional options
Optional secondary
secondary
sender
Optional with
with
Generated using TypeDoc
Interface InputSubmitTransactionData
Interface that holds the user data input when submitting a transaction
+interface InputSubmitTransactionData {
additionalSignersAuthenticators?: AccountAuthenticator[];
feePayerAuthenticator?: AccountAuthenticator;
senderAuthenticator: AccountAuthenticator;
transaction: AnyRawTransaction;
}
additionalSignersAuthenticators?: AccountAuthenticator[];
feePayerAuthenticator?: AccountAuthenticator;
senderAuthenticator: AccountAuthenticator;
transaction: AnyRawTransaction;
}
Index
Properties
Optional additional
Optional fee
sender
transaction
Generated using TypeDoc
Interface MultiAgentTransaction
Interface that holds the return data when generating a multi-agent transaction.
+Param: rawTransaction
a bcs serialized raw transaction
+Param: secondarySignerAddresses
secondary signer addresses for multi-agent transaction
+interface MultiAgentTransaction {
feePayerAddress?: AccountAddress;
rawTransaction: RawTransaction;
secondarySignerAddresses: AccountAddress[];
}
feePayerAddress?: AccountAddress;
rawTransaction: RawTransaction;
secondarySignerAddresses: AccountAddress[];
}
Index
Properties
Properties
Optional fee
raw
secondary
Generated using TypeDoc
Generated using TypeDoc
Interface PaginationArgs
Controls the number of results that are returned and the starting position of those results.
+Param: offset
parameter specifies the starting position of the query result within the set of data. Default is 0.
+Param: limit
specifies the maximum number of items or records to return in a query result. Default is 25.
+Properties
Optional limit
limit?: number
Optional offset
Generated using TypeDoc
Interface PrivateKey
An abstract representation of a private key. +It is associated to a signature scheme and provides signing capabilities.
+interface PrivateKey {
publicKey(): PublicKey;
sign(message): Signature;
toUint8Array(): Uint8Array;
}
publicKey(): PublicKey;
sign(message): Signature;
toUint8Array(): Uint8Array;
}
Implemented by
Index
Methods
Methods
public
sign
to
Generated using TypeDoc
Generated using TypeDoc
Interface ScriptFunctionArgument
interface ScriptFunctionArgument {
bcsToBytes(): Uint8Array;
bcsToHex(): Hex;
serialize(serializer): void;
serializeForScriptFunction(serializer): void;
}
bcsToBytes(): Uint8Array;
bcsToHex(): Hex;
serialize(serializer): void;
serializeForScriptFunction(serializer): void;
}
Hierarchy (view full)
- ScriptFunctionArgument
Index
Methods
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Generated using TypeDoc
Interface SimpleTransaction
Interface that holds the return data when generating a single signer transaction
+Param: rawTransaction
a bcs serialized raw transaction
+interface SimpleTransaction {
feePayerAddress?: AccountAddress;
rawTransaction: RawTransaction;
secondarySignerAddresses?: undefined;
}
feePayerAddress?: AccountAddress;
rawTransaction: RawTransaction;
secondarySignerAddresses?: undefined;
}
Index
Properties
Properties
Optional fee
raw
Optional secondary
secondary
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Interface TransactionArgument
interface TransactionArgument {
bcsToBytes(): Uint8Array;
bcsToHex(): Hex;
serialize(serializer): void;
serializeForEntryFunction(serializer): void;
serializeForScriptFunction(serializer): void;
}
bcsToBytes(): Uint8Array;
bcsToHex(): Hex;
serialize(serializer): void;
serializeForEntryFunction(serializer): void;
serializeForScriptFunction(serializer): void;
}
Hierarchy (view full)
- EntryFunctionArgument
- ScriptFunctionArgument
- TransactionArgument
Implemented by
Index
Methods
bcs
bcs
serialize
- serialize(serializer): void
Serialize an argument to BCS-serialized bytes.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Entry Function(serializer): void Serialize an argument as a type-agnostic, fixed byte sequence. The byte sequence contains +the number of the following bytes followed by the BCS-serialized bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
serialize
- serialize
For Script Function(serializer): void Serialize an argument to BCS-serialized bytes as a type aware byte sequence. +The byte sequence contains an enum variant index followed by the BCS-serialized +bytes for a typed argument.
+Parameters
- serializer: Serializer
Returns void
Generated using TypeDoc
Interface TransactionWorkerEvents
interface TransactionWorkerEvents {
executionFinish: ((data) => void);
transactionExecuted: ((data) => void);
transactionExecutionFailed: ((data) => void);
transactionSendFailed: ((data) => void);
transactionSent: ((data) => void);
}
executionFinish: ((data) => void);
transactionExecuted: ((data) => void);
transactionExecutionFailed: ((data) => void);
transactionSendFailed: ((data) => void);
transactionSent: ((data) => void);
}
Index
Properties
execution
execution
Type declaration
- (data): void
Parameters
- data: ExecutionFinishEventData
Returns void
transaction
transaction
Type declaration
- (data): void
Parameters
- data: SuccessEventData
Returns void
transaction
transaction
Type declaration
- (data): void
Parameters
- data: FailureEventData
Returns void
transaction
transaction
Type declaration
- (data): void
Parameters
- data: FailureEventData
Returns void
transaction
transaction
Type declaration
- (data): void
Parameters
- data: SuccessEventData
Returns void
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
Generated using TypeDoc
@aptos-labs/ts-sdk - v1.11.0
Index
Enumerations
Account
Classes
Account
+Account
Interfaces
Aptos
Type Aliases
Account
Variables
APTOS_
Functions
CKDPriv
+aptos
Generated using TypeDoc
Type alias AccountAddressInput
Generated using TypeDoc
Type alias AccountData
Account
authentication_key: string;
sequence_number: string;
}
authentication_key: string;
sequence_number: string;
}
Type declaration
authentication_
key: string sequence_
number: string
Generated using TypeDoc
Type alias AccountSignature
Account
The union of all single account signatures.
+Generated using TypeDoc
Type alias AnyNumber
Any
Generated using TypeDoc
Type alias AnyRawTransaction
Unified type that holds all the return interfaces when generating different transaction types
+Generated using TypeDoc
Type alias AnyRawTransactionInstance
Type that holds all raw transaction instances Aptos SDK supports
+Generated using TypeDoc
Type alias AnyTransactionPayloadInstance
Any
The generated transaction payload type that was produces from generateTransactionPayload() function.
Generated using TypeDoc
Type alias AptosRequest
Aptos
acceptType?: string;
body?: any;
contentType?: string;
method: "GET" | "POST";
originMethod?: string;
overrides?: ClientConfig & FullNodeConfig & IndexerConfig & FaucetConfig;
params?: Record<string, string | AnyNumber | boolean | undefined>;
path?: string;
url: string;
}
acceptType?: string;
body?: any;
contentType?: string;
method: "GET" | "POST";
originMethod?: string;
overrides?: ClientConfig & FullNodeConfig & IndexerConfig & FaucetConfig;
params?: Record<string, string | AnyNumber | boolean | undefined>;
path?: string;
url: string;
}
The API request type
+Type declaration
OptionalacceptType?: string Optionalbody?: anyOptionalcontentType?: string method: "GET" | "POST"
OptionaloriginMethod?: string Optionaloverrides?: ClientConfig & FullNodeConfig & IndexerConfig & FaucetConfigOptionalparams?: Record<string, string | AnyNumber | boolean | undefined>Optionalpath?: stringurl: string
Param: url
the url to make the request to, i.e https://fullnode.devnet.aptoslabs.com/v1
+Param: method
the request method "GET" | "POST"
+Param: endpoint
(optional) - the endpoint to make the request to, i.e transactions
+Param: body
(optional) - the body of the request
+Param: contentType
(optional) - the content type to set the content-type header to,
+by default is set to application/json
Param: params
(optional) - query params to add to the request
+Param: originMethod
(optional) - the local method the request came from
+Param: overrides
(optional) - a ClientConfig object type to override request data
Generated using TypeDoc
Type alias AptosSettings
Aptos
client?: Client;
clientConfig?: ClientConfig;
faucet?: string;
faucetConfig?: FaucetConfig;
fullnode?: string;
fullnodeConfig?: FullNodeConfig;
indexer?: string;
indexerConfig?: IndexerConfig;
network?: Network;
}
client?: Client;
clientConfig?: ClientConfig;
faucet?: string;
faucetConfig?: FaucetConfig;
fullnode?: string;
fullnodeConfig?: FullNodeConfig;
indexer?: string;
indexerConfig?: IndexerConfig;
network?: Network;
}
Set of configuration options that can be provided when initializing the SDK. +The purpose of these options is to configure various aspects of the SDK's +behavior and interaction with the Aptos network
+Type declaration
OptionalReadonlyclient?: ClientOptionalReadonlyclientConfig?: ClientConfig OptionalReadonlyfaucet?: stringOptionalReadonlyfaucetConfig?: FaucetConfig OptionalReadonlyfullnode?: stringOptionalReadonlyfullnodeConfig?: FullNodeConfig OptionalReadonlyindexer?: stringOptionalReadonlyindexerConfig?: IndexerConfig OptionalReadonlynetwork?: Network
Generated using TypeDoc
Type alias AuthenticationKeyScheme
A list of Authentication Key schemes that are supported by Aptos.
+They are combinations of signing schemes and derive schemes.
+Generated using TypeDoc
Type alias Block
Block: {
block_hash: string;
block_height: string;
block_timestamp: string;
first_version: string;
last_version: string;
transactions?: TransactionResponse[];
}
block_hash: string;
block_height: string;
block_timestamp: string;
first_version: string;
last_version: string;
transactions?: TransactionResponse[];
}
A Block type
+Type declaration
block_
hash: string block_
height: string block_
timestamp: string first_
version: string last_
version: string Optionaltransactions?: TransactionResponse[]The transactions in the block in sequential order
+
Generated using TypeDoc
Type alias BlockMetadataTransactionResponse
Block
accumulator_root_hash: string;
changes: WriteSetChange[];
epoch: string;
event_root_hash: string;
events: Event[];
failed_proposer_indices: number[];
gas_used: string;
hash: string;
id: string;
previous_block_votes_bitvec: number[];
proposer: string;
round: string;
state_change_hash: string;
state_checkpoint_hash: string | null;
success: boolean;
timestamp: string;
type: BlockMetadata;
version: string;
vm_status: string;
}
accumulator_root_hash: string;
changes: WriteSetChange[];
epoch: string;
event_root_hash: string;
events: Event[];
failed_proposer_indices: number[];
gas_used: string;
hash: string;
id: string;
previous_block_votes_bitvec: number[];
proposer: string;
round: string;
state_change_hash: string;
state_checkpoint_hash: string | null;
success: boolean;
timestamp: string;
type: BlockMetadata;
version: string;
vm_status: string;
}
Type declaration
accumulator_
root_ hash: string changes: WriteSetChange[]
Final state of resources changed by the transaction
+epoch: string
event_
root_ hash: string events: Event[]
The events emitted at the block creation
+failed_
proposer_ indices: number[] The indices of the proposers who failed to propose
+gas_
used: string hash: string
id: string
previous_
block_ votes_ bitvec: number[] Previous block votes
+proposer: string
round: string
state_
change_ hash: string state_
checkpoint_ hash: string | null success: boolean
Whether the transaction was successful
+timestamp: string
type: BlockMetadata
version: string
vm_
status: string The VM status of the transaction, can tell useful information in a failure
+
Generated using TypeDoc
Type alias ClientConfig
A configuration object we can pass with the request to the server.
+Type declaration
OptionalAPI_KEY?: string OptionalWITH_CREDENTIALS?: boolean
Param: API_KEY
api key generated from developer portal https://developers.aptoslabs.com/manage/api-keys}
+Param: HEADERS
extra headers we want to send with the request
+Param: WITH_CREDENTIALS
whether to carry cookies. By default, it is set to true and cookies will be sent
+Generated using TypeDoc
Type alias ClientHeadersType
Client
HEADERS?: Record<string, string | number | boolean>;
}
HEADERS?: Record<string, string | number | boolean>;
}
General type definition for client HEADERS
+Type declaration
OptionalHEADERS?: Record<string, string | number | boolean>
Generated using TypeDoc
Type alias CommittedTransactionResponse
Committed
Generated using TypeDoc
Type alias DecodedTableData
Decoded
key: any;
key_type: string;
value: any;
value_type: string;
}
key: any;
key_type: string;
value: any;
value_type: string;
}
Type declaration
key: any
Key of table in JSON
+key_
type: string Type of key
+value: any
Value of table in JSON
+value_
type: string Type of value
+
Generated using TypeDoc
Type alias DeletedTableData
Deleted
key: any;
key_type: string;
}
key: any;
key_type: string;
}
Deleted table data
+Type declaration
key: any
Deleted key
+key_
type: string Deleted key type
+
Generated using TypeDoc
Type alias DerivedKeys
Derived
chainCode: Uint8Array;
key: Uint8Array;
}
chainCode: Uint8Array;
key: Uint8Array;
}
Type declaration
chain
Code: Uint8Array key: Uint8Array
Generated using TypeDoc
Type alias DirectWriteSet
Type declaration
changes: WriteSetChange[]
events: Event[]
type: string
Generated using TypeDoc
Type alias EntryFunctionABI
Interface of an Entry function's ABI.
+This is used to provide type checking and simple input conversion on ABI based transaction submission.
+Type declaration
Optionalsigners?: number
Generated using TypeDoc
Type alias EntryFunctionArgumentTypes
Entry
Entry function arguments to be used when building a raw transaction using BCS serialized arguments
+Generated using TypeDoc
Type alias EntryFunctionPayloadResponse
Entry
arguments: any[];
function: MoveFunctionId;
type: string;
type_arguments: string[];
}
arguments: any[];
function: MoveFunctionId;
type: string;
type_arguments: string[];
}
Type declaration
arguments: any[]
Arguments of the function
+function: MoveFunctionId
type: string
type_
arguments: string[] Type arguments of the function
+
Generated using TypeDoc
Generated using TypeDoc
Type alias EventGuid
Event
account_address: string;
creation_number: string;
}
account_address: string;
creation_number: string;
}
Type declaration
account_
address: string creation_
number: string
Generated using TypeDoc
Type alias ExecutionFinishEventData
Execution
message: string;
}
message: string;
}
Type declaration
message: string
Generated using TypeDoc
Type alias FailureEventData
Failure
error: string;
message: string;
}
error: string;
message: string;
}
Type declaration
error: string
message: string
Generated using TypeDoc
Type alias FaucetConfig
A Faucet only configuration object
+Type declaration
OptionalAUTH_TOKEN?: string
Param: HEADERS
extra headers we want to send with the request
+Param: AUTH_TOKEN
an auth token to send with a faucet request
+Generated using TypeDoc
Type alias FullNodeConfig
A Fullnode only configuration object
+Param: HEADERS
extra headers we want to send with the request
+Generated using TypeDoc
Type alias FunctionABI
Data need for a generic function ABI, both view and entry
+Type declaration
parameters: TypeTag[]
type
Parameters: MoveFunctionGenericTypeParam[]
Generated using TypeDoc
Type alias GasEstimation
Gas
deprioritized_gas_estimate?: number;
gas_estimate: number;
prioritized_gas_estimate?: number;
}
deprioritized_gas_estimate?: number;
gas_estimate: number;
prioritized_gas_estimate?: number;
}
Type holding the outputs of the estimate gas API
+Type declaration
Optionaldeprioritized_gas_ estimate?: number The deprioritized estimate for the gas unit price
+gas_
estimate: number The current estimate for the gas unit price
+Optionalprioritized_gas_ estimate?: number The prioritized estimate for the gas unit price
+
Generated using TypeDoc
Type alias GenerateAccount
Generated using TypeDoc
Generated using TypeDoc
Type alias GenerateAccountWithSingleSignerSecp256k1Key
Input type to generate an account using Single Signer +Secp256k1
+Type declaration
Optionallegacy?: falsescheme: Secp256k1Ecdsa
Generated using TypeDoc
Generated using TypeDoc
Type alias GenesisTransactionResponse
Genesis
accumulator_root_hash: string;
changes: WriteSetChange[];
event_root_hash: string;
events: Event[];
gas_used: string;
hash: string;
payload: GenesisPayload;
state_change_hash: string;
state_checkpoint_hash?: string;
success: boolean;
type: Genesis;
version: string;
vm_status: string;
}
accumulator_root_hash: string;
changes: WriteSetChange[];
event_root_hash: string;
events: Event[];
gas_used: string;
hash: string;
payload: GenesisPayload;
state_change_hash: string;
state_checkpoint_hash?: string;
success: boolean;
type: Genesis;
version: string;
vm_status: string;
}
Type declaration
accumulator_
root_ hash: string changes: WriteSetChange[]
Final state of resources changed by the transaction
+event_
root_ hash: string events: Event[]
Events emitted during genesis
+gas_
used: string hash: string
payload: GenesisPayload
state_
change_ hash: string Optionalstate_checkpoint_ hash?: string success: boolean
Whether the transaction was successful
+type: Genesis
version: string
vm_
status: string The VM status of the transaction, can tell useful information in a failure
+
Generated using TypeDoc
Type alias GetANSNameResponse
GetANSName
Generated using TypeDoc
Type alias GetAccountCoinsDataResponse
Get
Generated using TypeDoc
Type alias GetAccountCollectionsWithOwnedTokenResponse
Get
Generated using TypeDoc
Type alias GetAccountOwnedObjectsResponse
Get
CUSTOM RESPONSE TYPES FOR THE END USER
+To provide a good dev exp, we build custom types derived from the +query types to be the response type the end developer/user will +work with.
+These types are used as the return type when calling a sdk api function +that calls the function that queries the server (usually under the /api/ folder)
+Generated using TypeDoc
Type alias GetAccountOwnedTokensFromCollectionResponse
Get
Generated using TypeDoc
Type alias GetAccountOwnedTokensQueryResponse
Get
Generated using TypeDoc
Type alias GetAptosRequestOptions
Generated using TypeDoc
Type alias GetChainTopUserTransactionsResponse
Get
Generated using TypeDoc
Type alias GetCollectionDataResponse
Get
Generated using TypeDoc
Type alias GetCurrentFungibleAssetBalancesResponse
Get
Generated using TypeDoc
Type alias GetCurrentTokenOwnershipResponse
Get
Generated using TypeDoc
Type alias GetDelegatedStakingActivitiesResponse
Get
Generated using TypeDoc
Type alias GetEventsResponse
Get
Generated using TypeDoc
Type alias GetFungibleAssetActivitiesResponse
Get
Generated using TypeDoc
Type alias GetFungibleAssetMetadataResponse
Get
Generated using TypeDoc
Type alias GetNumberOfDelegatorsResponse
Get
Generated using TypeDoc
Type alias GetOwnedTokensResponse
Get
Generated using TypeDoc
Type alias GetProcessorStatusResponse
Get
Generated using TypeDoc
Type alias GetRequestOptions
Get
acceptType?: MimeType;
aptosConfig: AptosConfig;
contentType?: MimeType;
originMethod: string;
overrides?: ClientConfig;
params?: Record<string, string | AnyNumber | boolean | undefined>;
path: string;
type: AptosApiType;
}
acceptType?: MimeType;
aptosConfig: AptosConfig;
contentType?: MimeType;
originMethod: string;
overrides?: ClientConfig;
params?: Record<string, string | AnyNumber | boolean | undefined>;
path: string;
type: AptosApiType;
}
Type declaration
OptionalacceptType?: MimeType The accepted content type of the response of the API
+aptos
Config: AptosConfig The config for the API client
+OptionalcontentType?: MimeType The content type of the request body
+origin
Method: string The name of the API method
+Optionaloverrides?: ClientConfigSpecific client overrides for this request to override aptosConfig
+Optionalparams?: Record<string, string | AnyNumber | boolean | undefined>The query parameters for the request
+path: string
The URL path to the API method
+type: AptosApiType
The type of API endpoint to call e.g. fullnode, indexer, etc
+
Generated using TypeDoc
Type alias GetTokenActivityResponse
Get
Generated using TypeDoc
Type alias GetTokenDataResponse
Get
Generated using TypeDoc
Type alias GraphqlQuery
Graphql
query: string;
variables?: {};
}
query: string;
variables?: {};
}
The graphql query type to pass into the queryIndexer function
Type declaration
query: string
Optionalvariables?: {}
Generated using TypeDoc
Type alias HexInput
Hex
Hex data as input to a function
+Generated using TypeDoc
Type alias IndexerConfig
An Indexer only configuration object
+Param: HEADERS
extra headers we want to send with the request
+Generated using TypeDoc
Type alias InputEntryFunctionData
Input
abi?: EntryFunctionABI;
function: MoveFunctionId;
functionArguments: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[];
typeArguments?: (TypeTag | string)[];
}
abi?: EntryFunctionABI;
function: MoveFunctionId;
functionArguments: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[];
typeArguments?: (TypeTag | string)[];
}
The data needed to generate an Entry Function payload
+Type declaration
Optionalabi?: EntryFunctionABIfunction: MoveFunctionId
function
Arguments: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[] OptionaltypeArguments?: (TypeTag | string)[]
Generated using TypeDoc
Type alias InputEntryFunctionDataWithABI
Type declaration
abi: EntryFunctionABI
Generated using TypeDoc
Type alias InputEntryFunctionDataWithRemoteABI
Type declaration
aptos
Config: AptosConfig
Generated using TypeDoc
Type alias InputGenerateRawTransactionArgs
Input
Unified type that holds all the interfaces to generate different transaction types
+Generated using TypeDoc
Type alias InputGenerateTransactionData
Input
Unified type that holds all the user data input interfaces when generating different transaction types
+Generated using TypeDoc
Type alias InputGenerateTransactionOptions
Input
accountSequenceNumber?: AnyNumber;
expireTimestamp?: number;
gasUnitPrice?: number;
maxGasAmount?: number;
}
accountSequenceNumber?: AnyNumber;
expireTimestamp?: number;
gasUnitPrice?: number;
maxGasAmount?: number;
}
Optional options to set when generating a transaction
+Type declaration
OptionalaccountSequence Number?: AnyNumber OptionalexpireTimestamp?: number OptionalgasUnit Price?: number OptionalmaxGas Amount?: number
Generated using TypeDoc
Type alias InputGenerateTransactionPayloadData
Unified type for the data needed to generate a transaction payload of types: +Entry Function | Script | Multi Sig
+Generated using TypeDoc
Type alias InputGenerateTransactionPayloadDataWithABI
Input
Generated using TypeDoc
Type alias InputGenerateTransactionPayloadDataWithRemoteABI
Input
Generated using TypeDoc
Type alias InputMultiSigData
The data needed to generate a Multi Sig payload
+Type declaration
multisig
Address: AccountAddressInput
Generated using TypeDoc
Type alias InputMultiSigDataWithABI
Type declaration
multisig
Address: AccountAddressInput
Generated using TypeDoc
Type alias InputMultiSigDataWithRemoteABI
Input
multisigAddress: AccountAddressInput;
} & InputEntryFunctionDataWithRemoteABI
multisigAddress: AccountAddressInput;
} & InputEntryFunctionDataWithRemoteABI
The data needed to generate a Multi Sig payload
+Type declaration
multisig
Address: AccountAddressInput
Generated using TypeDoc
Type alias InputScriptData
Input
bytecode: HexInput;
functionArguments: ScriptFunctionArgumentTypes[];
typeArguments?: TypeTag[];
}
bytecode: HexInput;
functionArguments: ScriptFunctionArgumentTypes[];
typeArguments?: TypeTag[];
}
The data needed to generate a Script payload
+Type declaration
bytecode: HexInput
function
Arguments: ScriptFunctionArgumentTypes[] OptionaltypeArguments?: TypeTag[]
Generated using TypeDoc
Type alias InputSimulateTransactionData
Input
feePayerPublicKey?: PublicKey;
options?: InputSimulateTransactionOptions;
secondarySignersPublicKeys?: PublicKey[];
signerPublicKey: PublicKey;
transaction: AnyRawTransaction;
}
feePayerPublicKey?: PublicKey;
options?: InputSimulateTransactionOptions;
secondarySignersPublicKeys?: PublicKey[];
signerPublicKey: PublicKey;
transaction: AnyRawTransaction;
}
Type declaration
OptionalfeePayer Public Key?: PublicKey For a fee payer transaction (aka Sponsored Transaction)
+Optionaloptions?: InputSimulateTransactionOptionsOptionalsecondarySigners Public Keys?: PublicKey[] For a fee payer or multi-agent transaction that requires additional signers in
+signer
Public Key: PublicKey For a single signer transaction
+transaction: AnyRawTransaction
The transaction to simulate, probably generated by
+generateTransaction()
Generated using TypeDoc
Type alias InputSimulateTransactionOptions
Input
estimateGasUnitPrice?: boolean;
estimateMaxGasAmount?: boolean;
estimatePrioritizedGasUnitPrice?: boolean;
}
estimateGasUnitPrice?: boolean;
estimateMaxGasAmount?: boolean;
estimatePrioritizedGasUnitPrice?: boolean;
}
Type declaration
OptionalestimateGas Unit Price?: boolean OptionalestimateMax Gas Amount?: boolean OptionalestimatePrioritized Gas Unit Price?: boolean
Generated using TypeDoc
Type alias InputViewFunctionData
Input
abi?: ViewFunctionABI;
function: MoveFunctionId;
functionArguments?: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[];
typeArguments?: (TypeTag | string)[];
}
abi?: ViewFunctionABI;
function: MoveFunctionId;
functionArguments?: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[];
typeArguments?: (TypeTag | string)[];
}
The data needed to generate a View Function payload
+Type declaration
Optionalabi?: ViewFunctionABIfunction: MoveFunctionId
OptionalfunctionArguments?: (EntryFunctionArgumentTypes | SimpleEntryFunctionArgumentTypes)[] OptionaltypeArguments?: (TypeTag | string)[]
Generated using TypeDoc
Type alias InputViewFunctionDataWithABI
Data needed to generate a view function, with an already fetched ABI
+Type declaration
abi: ViewFunctionABI
Generated using TypeDoc
Type alias InputViewFunctionDataWithRemoteABI
Data needed to generate a view function payload and fetch the remote ABI
+Type declaration
aptos
Config: AptosConfig
Generated using TypeDoc
Type alias LedgerInfo
Ledger
block_height: string;
chain_id: number;
epoch: string;
git_hash?: string;
ledger_timestamp: string;
ledger_version: string;
node_role: RoleType;
oldest_block_height: string;
oldest_ledger_version: string;
}
block_height: string;
chain_id: number;
epoch: string;
git_hash?: string;
ledger_timestamp: string;
ledger_version: string;
node_role: RoleType;
oldest_block_height: string;
oldest_ledger_version: string;
}
Type declaration
block_
height: string chain_
id: number Chain ID of the current chain
+epoch: string
Optionalgit_hash?: string Git hash of the build of the API endpoint. Can be used to determine the exact +software version used by the API endpoint.
+ledger_
timestamp: string ledger_
version: string node_
role: RoleType oldest_
block_ height: string oldest_
ledger_ version: string
Generated using TypeDoc
Generated using TypeDoc
Type alias MoveAddressType
Move
Generated using TypeDoc
Type alias MoveFunction
Move
generic_type_params: MoveFunctionGenericTypeParam[];
is_entry: boolean;
is_view: boolean;
name: string;
params: string[];
return: string[];
visibility: MoveFunctionVisibility;
}
generic_type_params: MoveFunctionGenericTypeParam[];
is_entry: boolean;
is_view: boolean;
name: string;
params: string[];
return: string[];
visibility: MoveFunctionVisibility;
}
Move function
+Type declaration
generic_
type_ params: MoveFunctionGenericTypeParam[] Generic type params associated with the Move function
+is_
entry: boolean Whether the function can be called as an entry function directly in a transaction
+is_
view: boolean Whether the function is a view function or not
+name: string
params: string[]
Parameters associated with the move function
+return: string[]
Return type of the function
+visibility: MoveFunctionVisibility
Generated using TypeDoc
Type alias MoveFunctionGenericTypeParam
Move abilities tied to the generic type param and associated with the function that uses it
+Type declaration
constraints: MoveAbility[]
Generated using TypeDoc
Type alias MoveFunctionId
Generated using TypeDoc
Type alias MoveModule
Move
address: string;
exposed_functions: MoveFunction[];
friends: MoveModuleId[];
name: string;
structs: MoveStruct[];
}
address: string;
exposed_functions: MoveFunction[];
friends: MoveModuleId[];
name: string;
structs: MoveStruct[];
}
A Move module
+Type declaration
address: string
exposed_
functions: MoveFunction[] Public functions of the module
+friends: MoveModuleId[]
Friends of the module
+name: string
structs: MoveStruct[]
Structs of the module
+
Generated using TypeDoc
Type alias MoveModuleBytecode
Type declaration
Optionalabi?: MoveModulebytecode: string
Generated using TypeDoc
Type alias MoveModuleId
Move
Move module id is a string representation of Move module. +Module name is case-sensitive.
+Generated using TypeDoc
Type alias MoveObjectType
Move
Generated using TypeDoc
Type alias MoveOptionType
Generated using TypeDoc
Type alias MoveResource
Type declaration
data: {}
type: MoveStructId
Generated using TypeDoc
Type alias MoveScriptBytecode
Move script bytecode
+Type declaration
Optionalabi?: MoveFunctionbytecode: string
Generated using TypeDoc
Type alias MoveStruct
Move
abilities: MoveAbility[];
fields: MoveStructField[];
generic_type_params: MoveFunctionGenericTypeParam[];
is_native: boolean;
name: string;
}
abilities: MoveAbility[];
fields: MoveStructField[];
generic_type_params: MoveFunctionGenericTypeParam[];
is_native: boolean;
name: string;
}
A move struct
+Type declaration
abilities: MoveAbility[]
Abilities associated with the struct
+fields: MoveStructField[]
Fields associated with the struct
+generic_
type_ params: MoveFunctionGenericTypeParam[] Generic types associated with the struct
+is_
native: boolean Whether the struct is a native struct of Move
+name: string
Generated using TypeDoc
Type alias MoveStructField
Move
name: string;
type: string;
}
name: string;
type: string;
}
Move struct field
+Type declaration
name: string
type: string
Generated using TypeDoc
Type alias MoveStructId
Move
This is the format for a fully qualified struct, resource, or entry function in Move.
+Generated using TypeDoc
Type alias MoveStructType
Move
Type declaration
Generated using TypeDoc
Type alias MoveType
Move
Generated using TypeDoc
Type alias MoveUint128Type
Move
Generated using TypeDoc
Type alias MoveUint16Type
Move
Generated using TypeDoc
Type alias MoveUint256Type
Move
Generated using TypeDoc
Type alias MoveUint32Type
Move
Generated using TypeDoc
Type alias MoveUint64Type
Move
Generated using TypeDoc
Type alias MoveUint8Type
Move
Map of Move types to local TypeScript types
+Generated using TypeDoc
Type alias MoveValue
Move
Possible Move values acceptable by move functions (entry, view)
+Map of a Move value to the corresponding TypeScript value
+Bool -> boolean
u8, u16, u32 -> number
u64, u128, u256 -> string
String -> string
Address -> 0x${string}
Struct - 0x${string}::${string}::${string}
Object -> 0x${string}
Vector -> Array<MoveValue>
Option -> MoveValue | null | undefined
Generated using TypeDoc
Type alias MultisigPayloadResponse
Multisig
multisig_address: string;
transaction_payload?: EntryFunctionPayloadResponse;
type: string;
}
multisig_address: string;
transaction_payload?: EntryFunctionPayloadResponse;
type: string;
}
Type declaration
multisig_
address: string Optionaltransaction_payload?: EntryFunctionPayloadResponse type: string
Generated using TypeDoc
Type alias OrderBy<T>
A generic type that being passed by each function and holds an +array of properties we can sort the query by
+Type Parameters
Generated using TypeDoc
Type alias OrderByValue
Order
Generated using TypeDoc
Type alias ParsingResult<T>
Whereas ParsingError is thrown when parsing fails, e.g. in a fromString function, +this type is returned from "defensive" functions like isValid.
+Type Parameters
Type declaration
OptionalinvalidReason?: T If valid is false, this will be a code explaining why parsing failed.
+OptionalinvalidReason Message?: string If valid is false, this will be a string explaining why parsing failed.
+valid: boolean
True if valid, false otherwise.
+
Generated using TypeDoc
Type alias PendingTransactionResponse
Pending
expiration_timestamp_secs: string;
gas_unit_price: string;
hash: string;
max_gas_amount: string;
payload: TransactionPayloadResponse;
sender: string;
sequence_number: string;
signature?: TransactionSignature;
type: Pending;
}
expiration_timestamp_secs: string;
gas_unit_price: string;
hash: string;
max_gas_amount: string;
payload: TransactionPayloadResponse;
sender: string;
sequence_number: string;
signature?: TransactionSignature;
type: Pending;
}
Type declaration
expiration_
timestamp_ secs: string gas_
unit_ price: string hash: string
max_
gas_ amount: string payload: TransactionPayloadResponse
sender: string
sequence_
number: string Optionalsignature?: TransactionSignaturetype: Pending
Generated using TypeDoc
Type alias PostAptosRequestOptions
Generated using TypeDoc
Type alias PostRequestOptions
Post
acceptType?: MimeType;
aptosConfig: AptosConfig;
body?: any;
contentType?: MimeType;
originMethod: string;
overrides?: ClientConfig;
params?: Record<string, string | AnyNumber | boolean | undefined>;
path: string;
type: AptosApiType;
}
acceptType?: MimeType;
aptosConfig: AptosConfig;
body?: any;
contentType?: MimeType;
originMethod: string;
overrides?: ClientConfig;
params?: Record<string, string | AnyNumber | boolean | undefined>;
path: string;
type: AptosApiType;
}
Type declaration
OptionalacceptType?: MimeType The accepted content type of the response of the API
+aptos
Config: AptosConfig The config for the API client
+Optionalbody?: anyThe body of the request, should match the content type of the request
+OptionalcontentType?: MimeType The content type of the request body
+origin
Method: string The name of the API method
+Optionaloverrides?: ClientConfigSpecific client overrides for this request to override aptosConfig
+Optionalparams?: Record<string, string | AnyNumber | boolean | undefined>The query parameters for the request
+path: string
The URL path to the API method
+type: AptosApiType
The type of API endpoint to call e.g. fullnode, indexer, etc
+
Generated using TypeDoc
Type alias ScriptFunctionArgumentTypes
Script
Script function arguments to be used when building a raw transaction using BCS serialized arguments
+Generated using TypeDoc
Type alias ScriptPayloadResponse
Script
arguments: any[];
code: MoveScriptBytecode;
type: string;
type_arguments: string[];
}
arguments: any[];
code: MoveScriptBytecode;
type: string;
type_arguments: string[];
}
Type declaration
arguments: any[]
Arguments of the function
+code: MoveScriptBytecode
type: string
type_
arguments: string[] Type arguments of the function
+
Generated using TypeDoc
Type alias ScriptWriteSet
Type declaration
execute_
as: string script: ScriptPayloadResponse
type: string
Generated using TypeDoc
Type alias SimpleEntryFunctionArgumentTypes
Simple
Entry function arguments to be used when building a raw transaction using remote ABI
+Generated using TypeDoc
Type alias SingleKeySignerFromDerivationPathArgs
Single
mnemonic: string;
path: string;
}
mnemonic: string;
path: string;
}
Type declaration
mnemonic: string
path: string
Generated using TypeDoc
Type alias StateCheckpointTransactionResponse
State
accumulator_root_hash: string;
changes: WriteSetChange[];
event_root_hash: string;
gas_used: string;
hash: string;
state_change_hash: string;
state_checkpoint_hash: string | null;
success: boolean;
timestamp: string;
type: StateCheckpoint;
version: string;
vm_status: string;
}
accumulator_root_hash: string;
changes: WriteSetChange[];
event_root_hash: string;
gas_used: string;
hash: string;
state_change_hash: string;
state_checkpoint_hash: string | null;
success: boolean;
timestamp: string;
type: StateCheckpoint;
version: string;
vm_status: string;
}
Type declaration
accumulator_
root_ hash: string changes: WriteSetChange[]
Final state of resources changed by the transaction
+event_
root_ hash: string gas_
used: string hash: string
state_
change_ hash: string state_
checkpoint_ hash: string | null success: boolean
Whether the transaction was successful
+timestamp: string
type: StateCheckpoint
version: string
vm_
status: string The VM status of the transaction, can tell useful information in a failure
+
Generated using TypeDoc
Type alias SuccessEventData
Success
message: string;
transactionHash: string;
}
message: string;
transactionHash: string;
}
Type declaration
message: string
transaction
Hash: string
Generated using TypeDoc
Generated using TypeDoc
Type alias TokenStandard
Token
Refers to the token standard we want to query for
+Generated using TypeDoc
Type alias TransactionEd25519Signature
Transaction
public_key: string;
signature: "ed25519_signature";
type: string;
}
public_key: string;
signature: "ed25519_signature";
type: string;
}
Type declaration
public_
key: string signature: "ed25519_signature"
type: string
Generated using TypeDoc
Type alias TransactionFeePayerSignature
Transaction
fee_payer_address: string;
fee_payer_signer: AccountSignature;
secondary_signer_addresses: string[];
secondary_signers: AccountSignature[];
sender: AccountSignature;
type: "fee_payer_signature";
}
fee_payer_address: string;
fee_payer_signer: AccountSignature;
secondary_signer_addresses: string[];
secondary_signers: AccountSignature[];
sender: AccountSignature;
type: "fee_payer_signature";
}
Type declaration
fee_
payer_ address: string fee_
payer_ signer: AccountSignature secondary_
signer_ addresses: string[] The other involved parties' addresses
+secondary_
signers: AccountSignature[] The associated signatures, in the same order as the secondary addresses
+sender: AccountSignature
type: "fee_payer_signature"
Generated using TypeDoc
Type alias TransactionMultiAgentSignature
Transaction
secondary_signer_addresses: string[];
secondary_signers: AccountSignature[];
sender: AccountSignature;
type: "multi_agent_signature";
}
secondary_signer_addresses: string[];
secondary_signers: AccountSignature[];
sender: AccountSignature;
type: "multi_agent_signature";
}
Type declaration
secondary_
signer_ addresses: string[] The other involved parties' addresses
+secondary_
signers: AccountSignature[] The associated signatures, in the same order as the secondary addresses
+sender: AccountSignature
type: "multi_agent_signature"
Generated using TypeDoc
Type alias TransactionMultiEd25519Signature
Transaction
bitmap: string;
public_keys: string[];
signatures: string[];
threshold: number;
type: "multi_ed25519_signature";
}
bitmap: string;
public_keys: string[];
signatures: string[];
threshold: number;
type: "multi_ed25519_signature";
}
Type declaration
bitmap: string
public_
keys: string[] The public keys for the Ed25519 signature
+signatures: string[]
Signature associated with the public keys in the same order
+threshold: number
The number of signatures required for a successful transaction
+type: "multi_ed25519_signature"
Generated using TypeDoc
Type alias TransactionPayloadResponse
Transaction
Generated using TypeDoc
Type alias TransactionResponse
Generated using TypeDoc
Type alias TransactionSecp256k1Signature
Transaction
public_key: string;
signature: "secp256k1_ecdsa_signature";
type: string;
}
public_key: string;
signature: "secp256k1_ecdsa_signature";
type: string;
}
Type declaration
public_
key: string signature: "secp256k1_ecdsa_signature"
type: string
Generated using TypeDoc
Type alias TransactionSignature
Transaction
These are the JSON representations of transaction signatures returned from the node API.
+Generated using TypeDoc
Type alias Uint128
Uint128: bigint
Generated using TypeDoc
Type alias Uint16
Uint16: number
Generated using TypeDoc
Type alias Uint256
Uint256: bigint
Generated using TypeDoc
Type alias Uint32
Uint32: number
Generated using TypeDoc
Type alias Uint64
Uint64: bigint
Generated using TypeDoc
Type alias Uint8
Uint8: number
BCS types
+Generated using TypeDoc
Type alias UserTransactionResponse
User
accumulator_root_hash: string;
changes: WriteSetChange[];
event_root_hash: string;
events: Event[];
expiration_timestamp_secs: string;
gas_unit_price: string;
gas_used: string;
hash: string;
max_gas_amount: string;
payload: TransactionPayloadResponse;
sender: string;
sequence_number: string;
signature?: TransactionSignature;
state_change_hash: string;
state_checkpoint_hash: string | null;
success: boolean;
timestamp: string;
type: User;
version: string;
vm_status: string;
}
accumulator_root_hash: string;
changes: WriteSetChange[];
event_root_hash: string;
events: Event[];
expiration_timestamp_secs: string;
gas_unit_price: string;
gas_used: string;
hash: string;
max_gas_amount: string;
payload: TransactionPayloadResponse;
sender: string;
sequence_number: string;
signature?: TransactionSignature;
state_change_hash: string;
state_checkpoint_hash: string | null;
success: boolean;
timestamp: string;
type: User;
version: string;
vm_status: string;
}
Type declaration
accumulator_
root_ hash: string changes: WriteSetChange[]
Final state of resources changed by the transaction
+event_
root_ hash: string events: Event[]
Events generated by the transaction
+expiration_
timestamp_ secs: string gas_
unit_ price: string gas_
used: string hash: string
max_
gas_ amount: string payload: TransactionPayloadResponse
sender: string
sequence_
number: string Optionalsignature?: TransactionSignaturestate_
change_ hash: string state_
checkpoint_ hash: string | null success: boolean
Whether the transaction was successful
+timestamp: string
type: User
version: string
vm_
status: string The VM status of the transaction, can tell useful information in a failure
+
Generated using TypeDoc
Type alias ValidatorTransactionResponse
Validator
accumulator_root_hash: string;
changes: WriteSetChange[];
event_root_hash: string;
events: Event[];
gas_used: string;
hash: string;
state_change_hash: string;
state_checkpoint_hash: string | null;
success: boolean;
timestamp: string;
type: Validator;
version: string;
vm_status: string;
}
accumulator_root_hash: string;
changes: WriteSetChange[];
event_root_hash: string;
events: Event[];
gas_used: string;
hash: string;
state_change_hash: string;
state_checkpoint_hash: string | null;
success: boolean;
timestamp: string;
type: Validator;
version: string;
vm_status: string;
}
Type declaration
accumulator_
root_ hash: string changes: WriteSetChange[]
Final state of resources changed by the transaction
+event_
root_ hash: string events: Event[]
The events emitted by the validator transaction
+gas_
used: string hash: string
state_
change_ hash: string state_
checkpoint_ hash: string | null success: boolean
Whether the transaction was successful
+timestamp: string
type: Validator
version: string
vm_
status: string The VM status of the transaction, can tell useful information in a failure
+
Generated using TypeDoc
Type alias ViewFunctionABI
Interface of an View function's ABI.
+This is used to provide type checking and simple input conversion on ABI based transaction submission.
+Type declaration
return
Types: TypeTag[]
Generated using TypeDoc
Type alias WaitForTransactionOptions
Wait
checkSuccess?: boolean;
timeoutSecs?: number;
waitForIndexer?: boolean;
}
checkSuccess?: boolean;
timeoutSecs?: number;
waitForIndexer?: boolean;
}
Option properties to pass for waitForTransaction() function
+Type declaration
OptionalcheckSuccess?: boolean OptionaltimeoutSecs?: number OptionalwaitFor Indexer?: boolean
Generated using TypeDoc
Type alias WriteSet
Generated using TypeDoc
Type alias WriteSetChange
Write
WRITESET CHANGE TYPES
+Generated using TypeDoc
Type alias WriteSetChangeDeleteModule
Write
address: string;
module: MoveModuleId;
state_key_hash: string;
type: string;
}
address: string;
module: MoveModuleId;
state_key_hash: string;
type: string;
}
Type declaration
address: string
module: MoveModuleId
state_
key_ hash: string State key hash
+type: string
Generated using TypeDoc
Type alias WriteSetChangeDeleteResource
Write
address: string;
resource: string;
state_key_hash: string;
type: string;
}
address: string;
resource: string;
state_key_hash: string;
type: string;
}
Type declaration
address: string
resource: string
state_
key_ hash: string type: string
Generated using TypeDoc
Type alias WriteSetChangeDeleteTableItem
Write
data?: DeletedTableData;
handle: string;
key: string;
state_key_hash: string;
type: string;
}
data?: DeletedTableData;
handle: string;
key: string;
state_key_hash: string;
type: string;
}
Type declaration
Optionaldata?: DeletedTableDatahandle: string
key: string
state_
key_ hash: string type: string
Generated using TypeDoc
Type alias WriteSetChangeWriteModule
Write
address: string;
data: MoveModuleBytecode;
state_key_hash: string;
type: string;
}
address: string;
data: MoveModuleBytecode;
state_key_hash: string;
type: string;
}
Type declaration
address: string
data: MoveModuleBytecode
state_
key_ hash: string type: string
Generated using TypeDoc
Type alias WriteSetChangeWriteResource
Write
address: string;
data: MoveResource;
state_key_hash: string;
type: string;
}
address: string;
data: MoveResource;
state_key_hash: string;
type: string;
}
Type declaration
address: string
data: MoveResource
state_
key_ hash: string type: string
Generated using TypeDoc
Type alias WriteSetChangeWriteTableItem
Write
data?: DecodedTableData;
handle: string;
key: string;
state_key_hash: string;
type: string;
value: string;
}
data?: DecodedTableData;
handle: string;
key: string;
state_key_hash: string;
type: string;
value: string;
}
Type declaration
Optionaldata?: DecodedTableDatahandle: string
key: string
state_
key_ hash: string type: string
value: string
Generated using TypeDoc
Variable APTOS_BIP44_REGEXConst
APTOS_
Generated using TypeDoc
Variable APTOS_COINConst
APTOS_
The default gas currency for the network.
+Generated using TypeDoc
Variable APTOS_HARDENED_REGEXConst
APTOS_
Aptos derive path is 637
+Generated using TypeDoc
Variable DEFAULT_MAX_GAS_AMOUNTConst
DEFAULT_
The default max gas amount when none is given.
+This is the maximum number of gas units that will be used by a transaction before being rejected.
+Note that max gas amount varies based on the transaction. A larger transaction will go over this +default gas amount, and the value will need to be changed for the specific transaction.
+Generated using TypeDoc
Variable DEFAULT_TXN_EXP_SEC_FROM_NOWConst
DEFAULT_
The default transaction expiration seconds from now.
+This time is how long until the blockchain nodes will reject the transaction.
+Note that the transaction expiration time varies based on network connection and network load. It may need to be +increased for the transaction to be processed.
+Generated using TypeDoc
Variable DEFAULT_TXN_TIMEOUT_SECConst
DEFAULT_
The default number of seconds to wait for a transaction to be processed.
+This time is the amount of time that the SDK will wait for a transaction to be processed when waiting for +the results of the transaction. It may take longer based on network connection and network load.
+Generated using TypeDoc
Variable HARDENED_OFFSETConst
HARDENED_
Generated using TypeDoc
Variable NetworkToChainIdConst
Network
Generated using TypeDoc
Variable NetworkToFaucetAPIConst
Network
Generated using TypeDoc
Variable NetworkToIndexerAPIConst
Network
Generated using TypeDoc
Variable NetworkToNetworkNameConst
Generated using TypeDoc
Variable NetworkToNodeAPIConst
Network
Generated using TypeDoc
Variable RAW_TRANSACTION_SALTConst
RAW_
Generated using TypeDoc
Variable RAW_TRANSACTION_WITH_DATA_SALTConst
RAW_
Generated using TypeDoc
Variable promiseFulfilledStatusConst
promise
Generated using TypeDoc
Interface for a generic Aptos account.
+The interface is defined as abstract class to provide a single entrypoint for account generation, +either through
+Account.generate()orAccount.fromDerivationPath. +Despite this being an abstract class, it should be treated as an interface and enforced using +theimplementskeyword.Note: Generating an account instance does not create the account on-chain.
+