Creates new TokenClient instance
AptosClient instance
BurnToken by Creator
The hash of the transaction submitted to the API
creator of the token
address of the token owner
Token name
Amount of tokens which will be transfered
Optional extraArgs: OptionalTransactionArgsBurnToken by Owner
The hash of the transaction submitted to the API
creator of the token
address of the token creator
Token name
Amount of tokens which will be transfered
Optional extraArgs: OptionalTransactionArgsRemoves a token from pending claims list
The hash of the transaction submitted to the API
AptosAccount which will remove token from pending list
Hex-encoded 32 byte Aptos account address which had to claim token
Hex-encoded 32 byte Aptos account address which created a token
Name of collection where token is strored
Token name
the version of token PropertyMap with a default value 0.
Optional extraArgs: OptionalTransactionArgsClaims a token on specified account
The hash of the transaction submitted to the API
AptosAccount which will claim token
Hex-encoded 32 byte Aptos account address which holds a token
Hex-encoded 32 byte Aptos account address which created a token
Name of collection where token is stored
Token name
the version of token PropertyMap with a default value 0.
Optional extraArgs: OptionalTransactionArgsCreates a new NFT collection within the specified account
The hash of the transaction submitted to the API
AptosAccount where collection will be created
Collection name
Collection description
URL to additional info about collection
Maximum number of token_data allowed within this collection
Optional extraArgs: OptionalTransactionArgsCreates a new NFT within the specified account
The hash of the transaction submitted to the API
AptosAccount where token will be created
Name of collection, that token belongs to
Token name
Token description
Token supply
URL to additional info about token
The maxium of tokens can be minted from this token
the address to receive the royalty, the address can be a shared account address.
the denominator for calculating royalty
the numerator for calculating royalty
the property keys for storing on-chain properties
the property values to be stored on-chain
the type of property values
Optional extraArgs: OptionalTransactionArgsCreates a new NFT within the specified account
The hash of the transaction submitted to the API
AptosAccount where token will be created
Name of collection, that token belongs to
Token name
Token description
Token supply
URL to additional info about token
The maxium of tokens can be minted from this token
the address to receive the royalty, the address can be a shared account address.
the denominator for calculating royalty
the numerator for calculating royalty
the property keys for storing on-chain properties
the property values to be stored on-chain
the type of property values
configs which field is mutable
Optional extraArgs: OptionalTransactionArgsDirectly transfer the specified amount of tokens from account to receiver using a single multi signature transaction.
The hash of the transaction submitted to the API
AptosAccount where token from which tokens will be transfered
Hex-encoded 32 byte Aptos account address to which tokens will be transfered
Hex-encoded 32 byte Aptos account address to which created tokens
Name of collection where token is stored
Token name
Amount of tokens which will be transfered
Optional extraArgs: OptionalTransactionArgsQueries collection data
Collection data in below format
Collection {
// Describes the collection
description: string,
// Unique name within this creators account for this collection
name: string,
// URL for additional information/media
uri: string,
// Total number of distinct Tokens tracked by the collection
count: number,
// Optional maximum number of tokens allowed within this collections
maximum: number
}
Hex-encoded 32 byte Aptos account address which created a collection
Collection name
Queries token balance for the token creator
Queries token data from collection
Token data in below format
TokenData {
// Unique name within this creators account for this Token's collection
collection: string;
// Describes this Token
description: string;
// The name of this Token
name: string;
// Optional maximum number of this type of Token.
maximum: number;
// Total number of this type of Token
supply: number;
/// URL for additional information / media
uri: string;
}
Hex-encoded 32 byte Aptos account address which created a token
Name of collection, which holds a token
Token name
Queries token balance for a token account
{
creator: '0x1',
collection: 'Some collection',
name: 'Awesome token'
}
Token object in below format
Token {
id: TokenId;
value: number;
}
Hex-encoded 32 byte Aptos account address which created a token
token id
TODO: Update this:
creator mutates the properties of the tokens
The hash of the transaction submitted to the API
AptosAccount who modifies the token properties
the address of account owning the token
the creator of the token
the name of the token collection
the name of created token
the property_version of the token to be modified
the number of tokens to be modified
Optional extraArgs: OptionalTransactionArgsTransfers specified amount of tokens from account to receiver
The hash of the transaction submitted to the API
AptosAccount where token from which tokens will be transfered
Hex-encoded 32 byte Aptos account address to which tokens will be transfered
Hex-encoded 32 byte Aptos account address to which created tokens
Name of collection where token is stored
Token name
Amount of tokens which will be transfered
the version of token PropertyMap with a default value 0.
Optional extraArgs: OptionalTransactionArgsUser opt-in or out direct transfer through a boolean flag
The hash of the transaction submitted to the API
AptosAccount where the token will be transferred
boolean value indicates user want to opt-in or out of direct transfer
Optional extraArgs: OptionalTransactionArgsDirectly transfer token to a receiver. The receiver should have opted in to direct transfer
The hash of the transaction submitted to the API
AptosAccount where the token will be transferred
address of the token creator
Name of collection where token is stored
Amount of tokens which will be transfered
Optional extraArgs: OptionalTransactionArgsGenerated using TypeDoc
Class for creating, minting and managing minting NFT collections and tokens