@moralisweb3/common-aptos-utils
Version:
1,422 lines (1,388 loc) • 276 kB
TypeScript
import { Config, MoralisData, MoralisDataFormatted, BigNumberish, BigNumber, ConfigKey, Core, Module } from '@moralisweb3/common-core';
declare class CommonAptosUtilsConfigSetup {
static register(config: Config): void;
}
/**
* Valid input for a new AptosAddress instance.
* This can be an existing AptosAddress or a valid address string.
*
* @example "0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90"
* @example AptosAddress.create("0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90")
*/
type AptosAddressInput = AptosAddress | string;
type AptosAddressJSON = string;
/**
* A representation of an address on the Aptos network.
*
* Use this class any time you work with an address.
*
* @category DataType
*/
declare class AptosAddress implements MoralisData {
readonly address: string;
/**
* Create a new instance of AptosAddress from any valid address input.
*
* @example `const address = AptosAddress.create("0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90")`
* @throws an error when a passed address is invalid.
*/
static create(address: AptosAddressInput): AptosAddress;
static fromJSON(json: AptosAddressJSON): AptosAddress;
private static parse;
constructor(address: string);
/**
* @deprecated This method will be removed soon. To format the value, use one of the properties.
*/
format(): MoralisDataFormatted;
/**
* Check the equality between two Aptos addresses
* @example `AptosAddress.equals("0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90", "0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90")`
*/
static equals(addressA: AptosAddressInput, addressB: AptosAddressInput): boolean;
/**
* Checks the equality of the current address with another Aptos address.
* @example `address.equals("0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90")`
* @example `address.equals(AptosAddress.create("0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90"))`
*/
equals(address: AptosAddressInput): boolean;
/**
* @returns a string representing the address.
* @example address.toString(); // "0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90"
*/
toString(): string;
/**
* @returns a string representing the address.
* @example address.toJSON(); // "0x54ad3d30af77b60d939ae356e6606de9a4da67583f02b962d2d3f2e481484e90"
*/
toJSON(): AptosAddressJSON;
/**
* @returns a string representing the address, the leading zeros are removed from the address.
* @example address.short; // "0x1"
*/
get short(): string;
}
declare const aptosNetworkNames: readonly ["mainnet", "testnet", "devnet"];
/**
* A name of Aptos network.
*
* @example "mainnet"
* @example "devnet"
*/
type AptosNetworkName = typeof aptosNetworkNames[number];
/**
* A name of Aptos network.
*
* @example "mainnet"
* @example "devnet"
*/
type AptosNetworkJSON = AptosNetworkName | string;
/**
* Valid input for a new AptosNetwork instance.
* This can be an existing AptosNetwork or a valid network name.
*
* @example "mainnet"
* @example "devnet"
* @example AptosNetwork.create("mainnet")
*/
type AptosNetworkInput = AptosNetwork | AptosNetworkJSON;
/**
* A representation of a Aptos network.
*
* @category DataType
*/
declare class AptosNetwork implements MoralisData {
readonly network: AptosNetworkName;
/**
* Returns MAINNET network
*
* @example AptosNetwork.MAINNET
*/
static get MAINNET(): AptosNetwork;
/**
* Returns TESTNET network
*
* @example AptosNetwork.MAINNET
*/
static get TESTNET(): AptosNetwork;
/**
* Returns DEVNET network
*
* @example AptosNetwork.MAINNET
*/
static get DEVNET(): AptosNetwork;
/**
* Create a new instance of AptosNetwork from any valid network input.
*
* @example `const network = AptosNetwork.create("mainnet")`
* @throws an error when a passed network is invalid.
*/
static create(network: AptosNetworkInput): AptosNetwork;
private static parse;
private constructor();
/**
* @deprecated This method will be removed soon. To format the value, use one of the properties.
*/
format(): MoralisDataFormatted;
/**
* Checks the equality of the current network with another Aptos network.
* @example `network.equals("mainnet")`
* @example `network.equals(AptosNetwork.create("mainnet"))`
*/
equals(network: AptosNetworkInput): boolean;
/**
* @returns a string representing the network.
* @example network.toJSON(); // "mainnet"
*/
toJSON(): string;
/**
* @returns a string representing the network.
* @example network.toString(); // "mainnet"
*/
toString(): string;
}
/**
* Type containing valid Aptos native units
*/
type AptosNativeUnit = 'aptos' | 'octas' | number;
/**
* Valid input for a new AptosNative instance.
* This can be an existing {@link AptosNative} or a valid {@link @moralisweb3/common-core!BigNumberish} type
*/
type AptosNativeInput = AptosNative | BigNumberish;
type AptosNativeJSON = string;
/**
* The AptosNative class is a MoralisData that references to the value of Aptos native currency APT
*
* @category DataType
*/
declare class AptosNative implements MoralisData {
private readonly rawValue;
/**
* Create a new instance of AptosNative from any valid {@link AptosNativeInput} value.
* @param value - the value to create the AptosNative from
* @param unit - the unit of the value (optional), defaults to `aptos`
* @returns a new instance of AptosNative
* @example
* ```ts
* const native = AptosNative.create(2, 'octas');
* const native = AptosNative.create(2);
*```
*/
static create(value: AptosNativeInput, unit?: AptosNativeUnit): AptosNative;
static fromJSON(json: AptosNativeJSON): AptosNative;
private static parse;
private constructor();
/**
* Compares two AptosNativeish values.
* @param valueA - the first value to compare
* @param valueB - the second value to compare
* @returns true if the values are equal
* @example
* ```ts
* AptosNative.equals(AptosNative.create(1), AptosNative.create(1)); // true
* ```
*/
static equals(valueA: AptosNativeInput, valueB: AptosNativeInput): boolean;
/**
* Compares AptosNative with current instance.
* @param value - the value to compare with
* @returns true if the values are equal
* @example
* ```ts
* const native = AptosNative.create(2, 'octas');
* native.equals(AptosNative.create(1)); // false
* ```
*/
equals(value: AptosNative): boolean;
/**
* @deprecated This method will be removed soon. To format the value, use one of the properties.
*/
format(): MoralisDataFormatted;
/**
* Converts the AptosNative to a string.
* @returns the value of the AptosNative as a string
* @example `native.toJSON()`
*/
toJSON(): AptosNativeJSON;
/**
* Converts the AptosNative to a string.
* @returns the value of the AptosNative as a string
* @example `native.toString()`
*/
toString(): string;
/**
* @returns the value of the AptosNative as a BigNumber
* @example `native.value`
*/
get value(): BigNumber;
/**
* Converts the AptosNative to an aptos unit.
* @returns the value of the AptosNative as an aptos string
* @example `native.aptos`
*/
get aptos(): string;
/**
* Converts the AptosNative to a string.
* @returns the value of the AptosNative as a string
* @example `native.lamports`
*/
get octas(): string;
}
declare const CommonAptosUtilsConfig: {
defaultAptosNetwork: ConfigKey<AptosNetworkInput>;
};
declare class AptosNetworkResolver {
static resolve(network: AptosNetworkInput | undefined, core: Core): AptosNetworkName;
}
declare class CommonAptosUtils extends Module {
static readonly moduleName = "aptosUtils";
static create(core?: Core): CommonAptosUtils;
private constructor();
setup(): void;
start(): void;
get AptosAddress(): typeof AptosAddress;
get AptosNative(): typeof AptosNative;
get AptosNetwork(): typeof AptosNetwork;
}
type AptosNFTTokenResponseDefaultPropertiesJSON = object;
type AptosNFTTokenResponseDefaultPropertiesInput = object;
type AptosNFTTokenResponseDefaultPropertiesValue = object;
declare abstract class AptosNFTTokenResponseDefaultProperties {
static create(input: AptosNFTTokenResponseDefaultPropertiesInput | AptosNFTTokenResponseDefaultPropertiesValue): AptosNFTTokenResponseDefaultPropertiesValue;
static fromJSON(json: AptosNFTTokenResponseDefaultPropertiesJSON): AptosNFTTokenResponseDefaultPropertiesValue;
}
interface AptosNFTTokenResponseJSON {
readonly collection_data_id_hash: string;
readonly collection_name: string;
readonly creator_address: AptosAddressJSON;
readonly default_properties: AptosNFTTokenResponseDefaultPropertiesJSON;
readonly description: string;
readonly description_mutable: boolean;
readonly largest_property_version: string;
readonly last_transaction_timestamp: string;
readonly last_transaction_version: string;
readonly maximum: string;
readonly maximum_mutable: boolean;
readonly metadata_uri: string;
readonly name: string;
readonly payee_address: AptosAddressJSON;
readonly properties_mutable: boolean;
readonly royalty_mutable: boolean;
readonly royalty_points_denominator: string;
readonly royalty_points_numerator: string;
readonly supply: string;
readonly token_data_id_hash: string;
readonly uri_mutable: boolean;
}
interface AptosNFTTokenResponseInput {
readonly collectionDataIdHash: string;
readonly collectionName: string;
readonly creatorAddress: AptosAddressInput | AptosAddress;
readonly defaultProperties: AptosNFTTokenResponseDefaultPropertiesInput | AptosNFTTokenResponseDefaultPropertiesValue;
readonly description: string;
readonly descriptionMutable: boolean;
readonly largestPropertyVersion: string;
readonly lastTransactionTimestamp: string;
readonly lastTransactionVersion: string;
readonly maximum: string;
readonly maximumMutable: boolean;
readonly metadataUri: string;
readonly name: string;
readonly payeeAddress: AptosAddressInput | AptosAddress;
readonly propertiesMutable: boolean;
readonly royaltyMutable: boolean;
readonly royaltyPointsDenominator: string;
readonly royaltyPointsNumerator: string;
readonly supply: string;
readonly tokenDataIdHash: string;
readonly uriMutable: boolean;
}
declare class AptosNFTTokenResponse {
static create(input: AptosNFTTokenResponseInput | AptosNFTTokenResponse): AptosNFTTokenResponse;
static fromJSON(json: AptosNFTTokenResponseJSON): AptosNFTTokenResponse;
/**
* @description The identifier of the collection
*/
readonly collectionDataIdHash: string;
/**
* @description The name of the collection
*/
readonly collectionName: string;
/**
* @description The address of the creator of the collection
*/
readonly creatorAddress: AptosAddress;
/**
* @description The default properties of the token
*/
readonly defaultProperties: AptosNFTTokenResponseDefaultPropertiesValue;
/**
* @description The description of the collection
*/
readonly description: string;
/**
* @description Whether the description can be changed
*/
readonly descriptionMutable: boolean;
/**
* @description largest_property_version
*/
readonly largestPropertyVersion: string;
/**
* @description The timestamp of the last transaction
*/
readonly lastTransactionTimestamp: string;
/**
* @description The version of the last transaction
*/
readonly lastTransactionVersion: string;
/**
* @description The maximum number of tokens that can be minted
*/
readonly maximum: string;
/**
* @description Whether the maximum number of tokens can be changed
*/
readonly maximumMutable: boolean;
/**
* @description The URI of the image of the token
*/
readonly metadataUri: string;
/**
* @description The name of the token
*/
readonly name: string;
/**
* @description The address that last payed for the token
*/
readonly payeeAddress: AptosAddress;
/**
* @description Whether the properties of the token can be changed
*/
readonly propertiesMutable: boolean;
/**
* @description Whether the royalty of the token can be changed
*/
readonly royaltyMutable: boolean;
/**
* @description The denominator for royalty points
*/
readonly royaltyPointsDenominator: string;
/**
* @description The numerator for royalty points
*/
readonly royaltyPointsNumerator: string;
/**
* @description The number of tokens minted
*/
readonly supply: string;
/**
* @description The identifier of the token
*/
readonly tokenDataIdHash: string;
/**
* @description Whether the URI of the image can be changed
*/
readonly uriMutable: boolean;
private constructor();
toJSON(): AptosNFTTokenResponseJSON;
}
interface GetNFTsByIdsOperationRequest {
/**
* @description The identifiers of the tokens to get
*/
readonly tokenIds: string[];
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTsByIdsOperationRequestJSON {
readonly token_ids: string[];
readonly network?: AptosNetworkJSON;
}
declare const GetNFTsByIdsOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosNFTTokenResponseJSON[]): AptosNFTTokenResponse[];
serializeRequest(request: GetNFTsByIdsOperationRequest): GetNFTsByIdsOperationRequestJSON;
};
interface AptosNFTTokensByCollectionResponseJSON {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTTokenResponseJSON[];
}
interface AptosNFTTokensByCollectionResponseInput {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTTokenResponseInput[] | AptosNFTTokenResponse[];
}
declare class AptosNFTTokensByCollectionResponse {
static create(input: AptosNFTTokensByCollectionResponseInput | AptosNFTTokensByCollectionResponse): AptosNFTTokensByCollectionResponse;
static fromJSON(json: AptosNFTTokensByCollectionResponseJSON): AptosNFTTokensByCollectionResponse;
/**
* @description The cursor to use for the next page of results. (Cursor is null on last page)
*/
readonly cursor: string;
/**
* @description Indicates if there is a next page of results
*/
readonly hasNextPage: boolean;
/**
* @description The tokens for the given collection
*/
readonly result: AptosNFTTokenResponse[];
private constructor();
toJSON(): AptosNFTTokensByCollectionResponseJSON;
}
interface GetNFTsByCollectionOperationRequest {
/**
* @description The collection data id hash of the collection
*/
readonly collectionDataIdHash: string;
/**
* @description The number of results to return
*/
readonly limit: number;
/**
* @description The number of results to skip
*/
readonly offset?: number;
/**
* @description The cursor to use for getting the next page
*/
readonly cursor?: string;
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTsByCollectionOperationRequestJSON {
readonly collection_data_id_hash: string;
readonly limit: number;
readonly offset?: number;
readonly cursor?: string;
readonly network?: AptosNetworkJSON;
}
declare const GetNFTsByCollectionOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosNFTTokensByCollectionResponseJSON): AptosNFTTokensByCollectionResponse;
serializeRequest(request: GetNFTsByCollectionOperationRequest): GetNFTsByCollectionOperationRequestJSON;
};
interface AptosNFTTokensByCreatorsResponseJSON {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTTokenResponseJSON[];
}
interface AptosNFTTokensByCreatorsResponseInput {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTTokenResponseInput[] | AptosNFTTokenResponse[];
}
declare class AptosNFTTokensByCreatorsResponse {
static create(input: AptosNFTTokensByCreatorsResponseInput | AptosNFTTokensByCreatorsResponse): AptosNFTTokensByCreatorsResponse;
static fromJSON(json: AptosNFTTokensByCreatorsResponseJSON): AptosNFTTokensByCreatorsResponse;
/**
* @description The cursor to use for the next page of results. (Cursor is null on last page)
*/
readonly cursor: string;
/**
* @description Indicates if there is a next page of results
*/
readonly hasNextPage: boolean;
/**
* @description The collections for the given creators
*/
readonly result: AptosNFTTokenResponse[];
private constructor();
toJSON(): AptosNFTTokensByCreatorsResponseJSON;
}
interface GetNFTsByCreatorsOperationRequest {
/**
* @description The number of tokens to return
*/
readonly limit: number;
/**
* @description The number of results to skip
*/
readonly offset?: number;
/**
* @description The cursor to use for getting the next page
*/
readonly cursor?: string;
/**
* @description The addresses of the creators
*/
readonly creatorAddresses: AptosAddressInput[] | AptosAddress[];
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTsByCreatorsOperationRequestJSON {
readonly limit: number;
readonly offset?: number;
readonly cursor?: string;
readonly creator_addresses: AptosAddressJSON[];
readonly network?: AptosNetworkJSON;
}
declare const GetNFTsByCreatorsOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosNFTTokensByCreatorsResponseJSON): AptosNFTTokensByCreatorsResponse;
serializeRequest(request: GetNFTsByCreatorsOperationRequest): GetNFTsByCreatorsOperationRequestJSON;
};
interface AptosNFTCollectionItemResponseJSON {
readonly collection_data_id_hash: string;
readonly collection_name: string;
readonly creator_address: AptosAddressJSON;
readonly description: string;
readonly description_mutable: boolean;
readonly last_transaction_timestamp: string;
readonly last_transaction_version: string;
readonly maximum: string;
readonly maximum_mutable: boolean;
readonly metadata_uri: string;
readonly supply: string;
readonly table_handle: string;
readonly uri_mutable: boolean;
}
interface AptosNFTCollectionItemResponseInput {
readonly collectionDataIdHash: string;
readonly collectionName: string;
readonly creatorAddress: AptosAddressInput | AptosAddress;
readonly description: string;
readonly descriptionMutable: boolean;
readonly lastTransactionTimestamp: string;
readonly lastTransactionVersion: string;
readonly maximum: string;
readonly maximumMutable: boolean;
readonly metadataUri: string;
readonly supply: string;
readonly tableHandle: string;
readonly uriMutable: boolean;
}
declare class AptosNFTCollectionItemResponse {
static create(input: AptosNFTCollectionItemResponseInput | AptosNFTCollectionItemResponse): AptosNFTCollectionItemResponse;
static fromJSON(json: AptosNFTCollectionItemResponseJSON): AptosNFTCollectionItemResponse;
/**
* @description The identifier of the collection
*/
readonly collectionDataIdHash: string;
/**
* @description The name of the collection
*/
readonly collectionName: string;
/**
* @description The address of the creator of the collection
*/
readonly creatorAddress: AptosAddress;
/**
* @description The description of the collection
*/
readonly description: string;
/**
* @description Whether the description can be changed
*/
readonly descriptionMutable: boolean;
/**
* @description The timestamp of the last transaction
*/
readonly lastTransactionTimestamp: string;
/**
* @description The version of the last transaction
*/
readonly lastTransactionVersion: string;
/**
* @description The maximum number of tokens that can be minted
*/
readonly maximum: string;
/**
* @description Whether the maximum number of tokens can be changed
*/
readonly maximumMutable: boolean;
/**
* @description The URI of the image of the collection
*/
readonly metadataUri: string;
/**
* @description The number of tokens minted
*/
readonly supply: string;
/**
* @description The address of the table that stores the tokens
*/
readonly tableHandle: string;
/**
* @description Whether the URI of the image can be changed
*/
readonly uriMutable: boolean;
private constructor();
toJSON(): AptosNFTCollectionItemResponseJSON;
}
interface AptosNFTCollectionsByNameRangeResponseJSON {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTCollectionItemResponseJSON[];
}
interface AptosNFTCollectionsByNameRangeResponseInput {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTCollectionItemResponseInput[] | AptosNFTCollectionItemResponse[];
}
declare class AptosNFTCollectionsByNameRangeResponse {
static create(input: AptosNFTCollectionsByNameRangeResponseInput | AptosNFTCollectionsByNameRangeResponse): AptosNFTCollectionsByNameRangeResponse;
static fromJSON(json: AptosNFTCollectionsByNameRangeResponseJSON): AptosNFTCollectionsByNameRangeResponse;
/**
* @description The cursor to use for the next page of results. (Cursor is null on last page)
*/
readonly cursor: string;
/**
* @description Indicates if there is a next page of results
*/
readonly hasNextPage: boolean;
/**
* @description The collections for the given creator
*/
readonly result: AptosNFTCollectionItemResponse[];
private constructor();
toJSON(): AptosNFTCollectionsByNameRangeResponseJSON;
}
interface GetNFTCollectionsOperationRequest {
/**
* @description The number of results to return
*/
readonly limit: number;
/**
* @description The number of results to skip
*/
readonly offset?: number;
/**
* @description The cursor to use for getting the next page
*/
readonly cursor?: string;
/**
* @description The name of the collection to start from (inclusive and case sensitive)
*/
readonly fromName?: string;
/**
* @description The name of the collection to end at (inclusive and case sensitive)
*/
readonly toName?: string;
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTCollectionsOperationRequestJSON {
readonly limit: number;
readonly offset?: number;
readonly cursor?: string;
readonly fromName?: string;
readonly toName?: string;
readonly network?: AptosNetworkJSON;
}
declare const GetNFTCollectionsOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosNFTCollectionsByNameRangeResponseJSON): AptosNFTCollectionsByNameRangeResponse;
serializeRequest(request: GetNFTCollectionsOperationRequest): GetNFTCollectionsOperationRequestJSON;
};
interface GetNFTCollectionsByIdsOperationRequest {
/**
* @description The identifiers of the collections to get
*/
readonly ids: string[];
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTCollectionsByIdsOperationRequestJSON {
readonly ids: string[];
readonly network?: AptosNetworkJSON;
}
declare const GetNFTCollectionsByIdsOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosNFTCollectionItemResponseJSON[]): AptosNFTCollectionItemResponse[];
serializeRequest(request: GetNFTCollectionsByIdsOperationRequest): GetNFTCollectionsByIdsOperationRequestJSON;
};
interface AptosNFTCollectionsByCreatorResponseJSON {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTCollectionItemResponseJSON[];
}
interface AptosNFTCollectionsByCreatorResponseInput {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTCollectionItemResponseInput[] | AptosNFTCollectionItemResponse[];
}
declare class AptosNFTCollectionsByCreatorResponse {
static create(input: AptosNFTCollectionsByCreatorResponseInput | AptosNFTCollectionsByCreatorResponse): AptosNFTCollectionsByCreatorResponse;
static fromJSON(json: AptosNFTCollectionsByCreatorResponseJSON): AptosNFTCollectionsByCreatorResponse;
/**
* @description The cursor to use for the next page of results. (Cursor is null on last page)
*/
readonly cursor: string;
/**
* @description Indicates if there is a next page of results
*/
readonly hasNextPage: boolean;
/**
* @description The collections for the given creator
*/
readonly result: AptosNFTCollectionItemResponse[];
private constructor();
toJSON(): AptosNFTCollectionsByCreatorResponseJSON;
}
interface GetNFTCollectionsByCreatorOperationRequest {
/**
* @description The number of results to return
*/
readonly limit: number;
/**
* @description The number of results to skip
*/
readonly offset?: number;
/**
* @description The cursor to use for getting the next page
*/
readonly cursor?: string;
/**
* @description The address of the creator
*/
readonly creatorAddress: AptosAddressInput | AptosAddress;
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTCollectionsByCreatorOperationRequestJSON {
readonly limit: number;
readonly offset?: number;
readonly cursor?: string;
readonly creator_address: AptosAddressJSON;
readonly network?: AptosNetworkJSON;
}
declare const GetNFTCollectionsByCreatorOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosNFTCollectionsByCreatorResponseJSON): AptosNFTCollectionsByCreatorResponse;
serializeRequest(request: GetNFTCollectionsByCreatorOperationRequest): GetNFTCollectionsByCreatorOperationRequestJSON;
};
type AptosNFTOwnerResponseTokenPropertiesJSON = object;
type AptosNFTOwnerResponseTokenPropertiesInput = object;
type AptosNFTOwnerResponseTokenPropertiesValue = object;
declare abstract class AptosNFTOwnerResponseTokenProperties {
static create(input: AptosNFTOwnerResponseTokenPropertiesInput | AptosNFTOwnerResponseTokenPropertiesValue): AptosNFTOwnerResponseTokenPropertiesValue;
static fromJSON(json: AptosNFTOwnerResponseTokenPropertiesJSON): AptosNFTOwnerResponseTokenPropertiesValue;
}
interface AptosNFTOwnerResponseJSON {
readonly amount: AptosNativeJSON;
readonly collection_data_id_hash: string;
readonly collection_name: string;
readonly creator_address: AptosAddressJSON;
readonly last_transaction_timestamp: string;
readonly last_transaction_version: string;
readonly name: string;
readonly owner_address: AptosAddressJSON;
readonly property_version: string;
readonly table_type: string;
readonly token_data_id_hash: string;
readonly token_properties: AptosNFTOwnerResponseTokenPropertiesJSON;
}
interface AptosNFTOwnerResponseInput {
readonly amount: AptosNativeInput | AptosNative;
readonly collectionDataIdHash: string;
readonly collectionName: string;
readonly creatorAddress: AptosAddressInput | AptosAddress;
readonly lastTransactionTimestamp: string;
readonly lastTransactionVersion: string;
readonly name: string;
readonly ownerAddress: AptosAddressInput | AptosAddress;
readonly propertyVersion: string;
readonly tableType: string;
readonly tokenDataIdHash: string;
readonly tokenProperties: AptosNFTOwnerResponseTokenPropertiesInput | AptosNFTOwnerResponseTokenPropertiesValue;
}
declare class AptosNFTOwnerResponse {
static create(input: AptosNFTOwnerResponseInput | AptosNFTOwnerResponse): AptosNFTOwnerResponse;
static fromJSON(json: AptosNFTOwnerResponseJSON): AptosNFTOwnerResponse;
/**
* @description The number of tokens that belonging to the owner
*/
readonly amount: AptosNative;
/**
* @description The identifier of the collection
*/
readonly collectionDataIdHash: string;
/**
* @description The name of the collection
*/
readonly collectionName: string;
/**
* @description The address of the creator of the collection
*/
readonly creatorAddress: AptosAddress;
/**
* @description The timestamp of the last transaction
*/
readonly lastTransactionTimestamp: string;
/**
* @description The version of the last transaction
*/
readonly lastTransactionVersion: string;
/**
* @description The name of the token
*/
readonly name: string;
/**
* @description The address of the owner of the token
*/
readonly ownerAddress: AptosAddress;
/**
* @description The property version of the token
*/
readonly propertyVersion: string;
/**
* @description The data structure of the token
*/
readonly tableType: string;
/**
* @description The identifier of the token
*/
readonly tokenDataIdHash: string;
/**
* @description The properties of the token
*/
readonly tokenProperties: AptosNFTOwnerResponseTokenPropertiesValue;
private constructor();
toJSON(): AptosNFTOwnerResponseJSON;
}
interface AptosNFTOwnersByTokensResponseJSON {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTOwnerResponseJSON[];
}
interface AptosNFTOwnersByTokensResponseInput {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTOwnerResponseInput[] | AptosNFTOwnerResponse[];
}
declare class AptosNFTOwnersByTokensResponse {
static create(input: AptosNFTOwnersByTokensResponseInput | AptosNFTOwnersByTokensResponse): AptosNFTOwnersByTokensResponse;
static fromJSON(json: AptosNFTOwnersByTokensResponseJSON): AptosNFTOwnersByTokensResponse;
/**
* @description The cursor to use for the next page of results. (Cursor is null on last page)
*/
readonly cursor: string;
/**
* @description Indicates if there is a next page of results
*/
readonly hasNextPage: boolean;
/**
* @description The owners for the given tokens
*/
readonly result: AptosNFTOwnerResponse[];
private constructor();
toJSON(): AptosNFTOwnersByTokensResponseJSON;
}
interface GetNFTOwnersByTokensOperationRequest {
/**
* @description The number of results to return
*/
readonly limit: number;
/**
* @description The number of results to skip
*/
readonly offset?: number;
/**
* @description The cursor to use for getting the next page
*/
readonly cursor?: string;
/**
* @description The identifiers of the tokens to get owners for
*/
readonly tokenIds: string[];
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTOwnersByTokensOperationRequestJSON {
readonly limit: number;
readonly offset?: number;
readonly cursor?: string;
readonly token_ids: string[];
readonly network?: AptosNetworkJSON;
}
declare const GetNFTOwnersByTokensOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosNFTOwnersByTokensResponseJSON): AptosNFTOwnersByTokensResponse;
serializeRequest(request: GetNFTOwnersByTokensOperationRequest): GetNFTOwnersByTokensOperationRequestJSON;
};
interface AptosNFTOwnersByCollectionResponseJSON {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTOwnerResponseJSON[];
}
interface AptosNFTOwnersByCollectionResponseInput {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTOwnerResponseInput[] | AptosNFTOwnerResponse[];
}
declare class AptosNFTOwnersByCollectionResponse {
static create(input: AptosNFTOwnersByCollectionResponseInput | AptosNFTOwnersByCollectionResponse): AptosNFTOwnersByCollectionResponse;
static fromJSON(json: AptosNFTOwnersByCollectionResponseJSON): AptosNFTOwnersByCollectionResponse;
/**
* @description The cursor to use for the next page of results. (Cursor is null on last page)
*/
readonly cursor: string;
/**
* @description Indicates if there is a next page of results
*/
readonly hasNextPage: boolean;
/**
* @description The owners for the given collection
*/
readonly result: AptosNFTOwnerResponse[];
private constructor();
toJSON(): AptosNFTOwnersByCollectionResponseJSON;
}
interface GetNFTOwnersByCollectionOperationRequest {
/**
* @description The id of the token
*/
readonly collectionDataIdHash: string;
/**
* @description The number of results to return
*/
readonly limit: number;
/**
* @description The number of results to skip
*/
readonly offset?: number;
/**
* @description The cursor to use for getting the next page
*/
readonly cursor?: string;
/**
* @description The addresses of the wallets to blacklist
*/
readonly walletBlacklist?: string[];
/**
* @description The addresses of the wallets to whitelist
*/
readonly walletWhitelist?: string[];
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTOwnersByCollectionOperationRequestJSON {
readonly collection_data_id_hash: string;
readonly limit: number;
readonly offset?: number;
readonly cursor?: string;
readonly wallet_blacklist?: string[];
readonly wallet_whitelist?: string[];
readonly network?: AptosNetworkJSON;
}
declare const GetNFTOwnersByCollectionOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosNFTOwnersByCollectionResponseJSON): AptosNFTOwnersByCollectionResponse;
serializeRequest(request: GetNFTOwnersByCollectionOperationRequest): GetNFTOwnersByCollectionOperationRequestJSON;
};
interface AptosNFTOwnersOfCollectionResponseJSON {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: string[];
}
interface AptosNFTOwnersOfCollectionResponseInput {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: string[];
}
declare class AptosNFTOwnersOfCollectionResponse {
static create(input: AptosNFTOwnersOfCollectionResponseInput | AptosNFTOwnersOfCollectionResponse): AptosNFTOwnersOfCollectionResponse;
static fromJSON(json: AptosNFTOwnersOfCollectionResponseJSON): AptosNFTOwnersOfCollectionResponse;
/**
* @description The cursor to use for the next page of results. (Cursor is null on last page)
*/
readonly cursor: string;
/**
* @description Indicates if there is a next page of results
*/
readonly hasNextPage: boolean;
/**
* @description The owner addresses for the given collection
*/
readonly result: string[];
private constructor();
toJSON(): AptosNFTOwnersOfCollectionResponseJSON;
}
interface GetNFTOwnersOfCollectionOperationRequest {
/**
* @description The id of the token
*/
readonly collectionDataIdHash: string;
/**
* @description The number of results to return
*/
readonly limit: number;
/**
* @description The number of results to skip
*/
readonly offset?: number;
/**
* @description The cursor to use for getting the next page
*/
readonly cursor?: string;
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTOwnersOfCollectionOperationRequestJSON {
readonly collection_data_id_hash: string;
readonly limit: number;
readonly offset?: number;
readonly cursor?: string;
readonly network?: AptosNetworkJSON;
}
declare const GetNFTOwnersOfCollectionOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosNFTOwnersOfCollectionResponseJSON): AptosNFTOwnersOfCollectionResponse;
serializeRequest(request: GetNFTOwnersOfCollectionOperationRequest): GetNFTOwnersOfCollectionOperationRequestJSON;
};
interface AptosNFTTransferResponseJSON {
readonly coin_amount?: AptosNativeJSON;
readonly coin_type?: string;
readonly collection_data_id_hash: string;
readonly collection_name: string;
readonly creator_address: AptosAddressJSON;
readonly event_account_address: string;
readonly event_creation_number: string;
readonly event_sequence_number: string;
readonly from_address?: AptosAddressJSON;
readonly name: string;
readonly property_version: string;
readonly to_address?: AptosAddressJSON;
readonly token_amount: AptosNativeJSON;
readonly token_data_id_hash: string;
readonly transaction_timestamp: string;
readonly transaction_version: string;
readonly transfer_type: string;
}
interface AptosNFTTransferResponseInput {
readonly coinAmount?: AptosNativeInput | AptosNative;
readonly coinType?: string;
readonly collectionDataIdHash: string;
readonly collectionName: string;
readonly creatorAddress: AptosAddressInput | AptosAddress;
readonly eventAccountAddress: string;
readonly eventCreationNumber: string;
readonly eventSequenceNumber: string;
readonly fromAddress?: AptosAddressInput | AptosAddress;
readonly name: string;
readonly propertyVersion: string;
readonly toAddress?: AptosAddressInput | AptosAddress;
readonly tokenAmount: AptosNativeInput | AptosNative;
readonly tokenDataIdHash: string;
readonly transactionTimestamp: string;
readonly transactionVersion: string;
readonly transferType: string;
}
declare class AptosNFTTransferResponse {
static create(input: AptosNFTTransferResponseInput | AptosNFTTransferResponse): AptosNFTTransferResponse;
static fromJSON(json: AptosNFTTransferResponseJSON): AptosNFTTransferResponse;
/**
* @description The number of tokens transferred
*/
readonly coinAmount?: AptosNative;
/**
* @description The type of tokens transferred
*/
readonly coinType?: string;
/**
* @description The identifier of the collection
*/
readonly collectionDataIdHash: string;
/**
* @description The name of the collection
*/
readonly collectionName: string;
/**
* @description The address of the creator of the collection
*/
readonly creatorAddress: AptosAddress;
/**
* @description The account address of the transfer
*/
readonly eventAccountAddress: string;
/**
* @description The creation number of the event
*/
readonly eventCreationNumber: string;
/**
* @description The sequence number of the event
*/
readonly eventSequenceNumber: string;
/**
* @description The address sending the transfer
*/
readonly fromAddress?: AptosAddress;
/**
* @description The name of the token
*/
readonly name: string;
/**
* @description The property version of the token
*/
readonly propertyVersion: string;
/**
* @description The address recieving the transfer
*/
readonly toAddress?: AptosAddress;
/**
* @description The number of tokens transferred
*/
readonly tokenAmount: AptosNative;
/**
* @description The identifier of the token
*/
readonly tokenDataIdHash: string;
/**
* @description The timestamp of the transfer
*/
readonly transactionTimestamp: string;
/**
* @description The version of the transaction that the transfer is a part of
*/
readonly transactionVersion: string;
/**
* @description The type of transfer
*/
readonly transferType: string;
private constructor();
toJSON(): AptosNFTTransferResponseJSON;
}
interface AptosNFTTransfersByTokensResponseJSON {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTTransferResponseJSON[];
}
interface AptosNFTTransfersByTokensResponseInput {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTTransferResponseInput[] | AptosNFTTransferResponse[];
}
declare class AptosNFTTransfersByTokensResponse {
static create(input: AptosNFTTransfersByTokensResponseInput | AptosNFTTransfersByTokensResponse): AptosNFTTransfersByTokensResponse;
static fromJSON(json: AptosNFTTransfersByTokensResponseJSON): AptosNFTTransfersByTokensResponse;
/**
* @description The cursor to use for the next page of results. (Cursor is null on last page)
*/
readonly cursor: string;
/**
* @description Indicates if there is a next page of results
*/
readonly hasNextPage: boolean;
/**
* @description The collections for the given creators
*/
readonly result: AptosNFTTransferResponse[];
private constructor();
toJSON(): AptosNFTTransfersByTokensResponseJSON;
}
interface GetNFTTransfersByIdsOperationRequest {
/**
* @description The number of tokens to return
*/
readonly limit: number;
/**
* @description The number of results to skip
*/
readonly offset?: number;
/**
* @description The cursor to use for getting the next page
*/
readonly cursor?: string;
/**
* @description The addresses of the wallets to blacklist
*/
readonly walletBlacklist?: string[];
/**
* @description The addresses of the wallets to whitelist
*/
readonly walletWhitelist?: string[];
/**
* @description The identifiers of the tokens to get
*/
readonly tokenIds: string[];
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTTransfersByIdsOperationRequestJSON {
readonly limit: number;
readonly offset?: number;
readonly cursor?: string;
readonly wallet_blacklist?: string[];
readonly wallet_whitelist?: string[];
readonly token_ids: string[];
readonly network?: AptosNetworkJSON;
}
declare const GetNFTTransfersByIdsOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosNFTTransfersByTokensResponseJSON): AptosNFTTransfersByTokensResponse;
serializeRequest(request: GetNFTTransfersByIdsOperationRequest): GetNFTTransfersByIdsOperationRequestJSON;
};
interface AptosGetNFTTransfersByCollectionResponseJSON {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTTransferResponseJSON[];
}
interface AptosGetNFTTransfersByCollectionResponseInput {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTTransferResponseInput[] | AptosNFTTransferResponse[];
}
declare class AptosGetNFTTransfersByCollectionResponse {
static create(input: AptosGetNFTTransfersByCollectionResponseInput | AptosGetNFTTransfersByCollectionResponse): AptosGetNFTTransfersByCollectionResponse;
static fromJSON(json: AptosGetNFTTransfersByCollectionResponseJSON): AptosGetNFTTransfersByCollectionResponse;
/**
* @description The cursor to use for the next page of results. (Cursor is null on last page)
*/
readonly cursor: string;
/**
* @description Indicates if there is a next page of results
*/
readonly hasNextPage: boolean;
/**
* @description The collections for the given creators
*/
readonly result: AptosNFTTransferResponse[];
private constructor();
toJSON(): AptosGetNFTTransfersByCollectionResponseJSON;
}
interface GetNFTTransfersByCollectionOperationRequest {
/**
* @description The collection data id hash of the token
*/
readonly collectionDataIdHash: string;
/**
* @description The number of results to return
*/
readonly limit: number;
/**
* @description The number of results to skip
*/
readonly offset?: number;
/**
* @description The cursor to use for getting the next page
*/
readonly cursor?: string;
/**
* @description The addresses of the wallets to whitelist
*/
readonly walletWhitelist?: string[];
/**
* @description The addresses of the wallets to blacklist
*/
readonly walletBlacklist?: string[];
/**
* @description The network of query. Defaults to mainnet.
*/
readonly network?: AptosNetworkInput | AptosNetwork;
}
interface GetNFTTransfersByCollectionOperationRequestJSON {
readonly collection_data_id_hash: string;
readonly limit: number;
readonly offset?: number;
readonly cursor?: string;
readonly wallet_whitelist?: string[];
readonly wallet_blacklist?: string[];
readonly network?: AptosNetworkJSON;
}
declare const GetNFTTransfersByCollectionOperation: {
operationId: string;
groupName: string;
httpMethod: string;
routePattern: string;
parameterNames: string[];
hasResponse: boolean;
hasBody: boolean;
parseResponse(json: AptosGetNFTTransfersByCollectionResponseJSON): AptosGetNFTTransfersByCollectionResponse;
serializeRequest(request: GetNFTTransfersByCollectionOperationRequest): GetNFTTransfersByCollectionOperationRequestJSON;
};
interface AptosGetNFTTransfersByCreatorsResponseJSON {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTTransferResponseJSON[];
}
interface AptosGetNFTTransfersByCreatorsResponseInput {
readonly cursor: string;
readonly hasNextPage: boolean;
readonly result: AptosNFTTransferResponseInput[] | AptosNFTTransferResponse[];
}
declare class AptosGetNFTTransfersByCreatorsResponse {
static create(input: AptosGetNFTTransfersByCreatorsResponseInput | AptosGetNFTTransfersByCreatorsResponse): AptosGetNFTTransfersByCreatorsResponse;
static fromJSON(json: AptosGetNFTTransfersByCre