@aptos-labs/ts-sdk 0.0.3 → 0.0.5

package/dist/esm/utils/memoize.d.ts

@@ -0,0 +1,20 @@
+/**
+ * A memoize high order function to cache async function response
+ *
+ * @param func An async function to cache the result of
+ * @param key The provided cache key
+ * @param ttlMs time-to-live in milliseconds for cached data
+ * @returns the cached or latest result
+ */
+declare function memoizeAsync<T>(func: (...args: any[]) => Promise<T>, key: string, ttlMs?: number): (...args: any[]) => Promise<T>;
+/**
+ * A memoize high order function to cache function response
+ *
+ * @param func A function to cache the result of
+ * @param key The provided cache key
+ * @param ttlMs time-to-live in milliseconds for cached data
+ * @returns the cached or latest result
+ */
+declare function memoize<T>(func: (...args: any[]) => T, key: string, ttlMs?: number): (...args: any[]) => T;
+
+export { memoize, memoizeAsync };

package/dist/esm/utils/memoize.mjs

@@ -0,0 +1,2 @@
+import{a,b}from"../chunk-AH44UPM4.mjs";import"../chunk-XNFEUXDS.mjs";export{b as memoize,a as memoizeAsync};
+//# sourceMappingURL=memoize.mjs.map

package/dist/esm/utils/memoize.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/dist/esm/version.d.ts

@@ -0,0 +1,8 @@
+/**
+ * The current version of the SDK
+ *
+ * hardcoded for now, we would want to have it injected dynamically
+ */
+declare const VERSION = "0.0.4";
+
+export { VERSION };

package/dist/esm/version.mjs

@@ -0,0 +1,2 @@
+import{a}from"./chunk-FYIFBLHU.mjs";import"./chunk-XNFEUXDS.mjs";export{a as VERSION};
+//# sourceMappingURL=version.mjs.map

package/dist/esm/version.mjs.map

@@ -0,0 +1 @@
+{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}

package/package.json

@@ -10,14 +10,21 @@
     "url": "https://github.com/aptos-labs/aptos-ts-sdk/issues/new/choose"
   },
   "homepage": "https://aptos-labs.github.io/aptos-ts-sdk/",
-  "main": "dist/cjs/index.js",
+  "main": "dist/common/index.js",
   "module": "dist/esm/index.mjs",
   "exports": {
     ".": {
-      "import": "./dist/esm/index.mjs",
-      "require": "./dist/cjs/index.js",
-      "types": "./dist/types/index.d.ts"
-    }
+      "source": "./src/index.ts",
+      "require": {
+        "types": "./dist/common/index.d.ts",
+        "default": "./dist/common/index.js"
+      },
+      "import": {
+        "types": "./dist/esm/index.d.mts",
+        "default": "./dist/esm/index.mjs"
+      }
+    },
+    "./package.json": "./package.json"
   },
   "files": [
     "dist",
@@ -25,14 +32,10 @@
   ],
   "scripts": {
     "build:clean": "rm -rf dist",
-    "build": "pnpm build:clean && pnpm run _build:types && pnpm _build:esm && pnpm _build:cjs && pnpm _build:browser",
-    "_build:browser": "tsup src/index.ts --platform browser --format iife --global-name aptosSDK --minify --out-dir dist/browser",
-    "_build:esm": "tsup src/index.ts --platform node --format esm --dts --out-dir dist/esm",
-    "_build:cjs": "tsup src/index.ts --platform node --format cjs --dts --out-dir dist/cjs",
-    "_build:types": "tsup src/types/index.ts --dts --out-dir dist/types",
+    "build": "pnpm build:clean && tsup",
     "_fmt": "prettier 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.js' 'examples/**/*.ts' '.eslintrc.js'",
     "fmt": "pnpm _fmt --write",
-    "lint": "eslint 'src/**/*.ts' 'tests/**/*.ts'",
+    "lint": "eslint 'src/**/*.ts' 'tests/**/*.ts' 'examples/**/*.ts'",
     "test": "pnpm jest",
     "unit-test": "pnpm jest tests/unit",
     "e2e-test": "pnpm jest tests/e2e",
@@ -43,6 +46,7 @@
     "@aptos-labs/aptos-client": "^0.0.2",
     "@noble/curves": "^1.2.0",
     "@noble/hashes": "1.1.3",
+    "@scure/bip32": "^1.3.2",
     "@scure/bip39": "1.1.0",
     "form-data": "4.0.0",
     "tweetnacl": "1.0.3"
@@ -71,9 +75,9 @@
     "ts-jest": "28.0.8",
     "ts-loader": "9.3.1",
     "ts-node": "10.9.1",
-    "tsup": "6.2.3",
+    "tsup": "7.2.0",
     "typedoc": "^0.23.20",
     "typescript": "4.8.2"
   },
-  "version": "0.0.3"
+  "version": "0.0.5"
 }

package/src/api/account.ts

@@ -2,7 +2,7 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { AptosConfig } from "./aptosConfig";
-import { AccountAddress, PrivateKey, Account as AccountModule } from "../core";
+import { AccountAddress, PrivateKey, Account as AccountModule, AccountAddressInput } from "../core";
 import {
   AccountData,
   GetAccountCoinsDataResponse,
@@ -10,7 +10,6 @@ import {
   GetAccountOwnedObjectsResponse,
   GetAccountOwnedTokensFromCollectionResponse,
   GetAccountOwnedTokensQueryResponse,
-  HexInput,
   LedgerVersion,
   MoveModuleBytecode,
   MoveResource,
@@ -64,7 +63,7 @@ export class Account {
    * }
    * ```
    */
-  async getAccountInfo(args: { accountAddress: HexInput }): Promise<AccountData> {
+  async getAccountInfo(args: { accountAddress: AccountAddressInput }): Promise<AccountData> {
     return getInfo({ aptosConfig: this.config, ...args });
   }
 
@@ -83,7 +82,7 @@ export class Account {
    */
 
   async getAccountModules(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     options?: PaginationArgs & LedgerVersion;
   }): Promise<MoveModuleBytecode[]> {
     return getModules({ aptosConfig: this.config, ...args });
@@ -107,7 +106,7 @@ export class Account {
    * ```
    */
   async getAccountModule(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     moduleName: string;
     options?: LedgerVersion;
   }): Promise<MoveModuleBytecode> {
@@ -127,7 +126,7 @@ export class Account {
    * @returns The account transactions
    */
   async getAccountTransactions(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     options?: PaginationArgs;
   }): Promise<TransactionResponse[]> {
     return getTransactions({
@@ -149,7 +148,7 @@ export class Account {
    * @returns Account resources
    */
   async getAccountResources(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     options?: PaginationArgs & LedgerVersion;
   }): Promise<MoveResource[]> {
     return getResources({ aptosConfig: this.config, ...args });
@@ -174,7 +173,7 @@ export class Account {
    * ```
    */
   async getAccountResource<T extends {} = any>(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     resourceType: MoveStructType;
     options?: LedgerVersion;
   }): Promise<T> {
@@ -191,7 +190,7 @@ export class Account {
    * @returns Promise<AccountAddress> The accountAddress associated with the authentication key
    */
   async lookupOriginalAccountAddress(args: {
-    authenticationKey: HexInput;
+    authenticationKey: AccountAddressInput;
     options?: LedgerVersion;
   }): Promise<AccountAddress> {
     return lookupOriginalAccountAddress({ aptosConfig: this.config, ...args });
@@ -203,7 +202,7 @@ export class Account {
    * @param args.accountAddress The account address
    * @returns Current count of tokens owned by the account
    */
-  async getAccountTokensCount(args: { accountAddress: HexInput }): Promise<number> {
+  async getAccountTokensCount(args: { accountAddress: AccountAddressInput }): Promise<number> {
     return getAccountTokensCount({
       aptosConfig: this.config,
       ...args,
@@ -224,7 +223,7 @@ export class Account {
    * @returns Tokens array with the token data
    */
   async getAccountOwnedTokens(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     options?: {
       tokenStandard?: TokenStandard;
       pagination?: PaginationArgs;
@@ -252,8 +251,8 @@ export class Account {
    * @returns Tokens array with the token data
    */
   async getAccountOwnedTokensFromCollectionAddress(args: {
-    accountAddress: HexInput;
-    collectionAddress: HexInput;
+    accountAddress: AccountAddressInput;
+    collectionAddress: AccountAddressInput;
     options?: {
       tokenStandard?: TokenStandard;
       pagination?: PaginationArgs;
@@ -280,7 +279,7 @@ export class Account {
    * @returns Collections array with the collections data
    */
   async getAccountCollectionsWithOwnedTokens(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     options?: {
       tokenStandard?: TokenStandard;
       pagination?: PaginationArgs;
@@ -299,7 +298,7 @@ export class Account {
    * @param args.accountAddress The account address we want to get the total count for
    * @returns Current count of transactions made by an account
    */
-  async getAccountTransactionsCount(args: { accountAddress: HexInput }): Promise<number> {
+  async getAccountTransactionsCount(args: { accountAddress: AccountAddressInput }): Promise<number> {
     return getAccountTransactionsCount({
       aptosConfig: this.config,
       ...args,
@@ -316,7 +315,7 @@ export class Account {
    * @returns Array with the coins data
    */
   async getAccountCoinsData(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     options?: {
       pagination?: PaginationArgs;
       orderBy?: OrderBy<GetAccountCoinsDataResponse[0]>;
@@ -334,7 +333,7 @@ export class Account {
    * @param args.accountAddress The account address we want to get the total count for
    * @returns Current count of the aggregated count of all account's coins
    */
-  async getAccountCoinsCount(args: { accountAddress: HexInput }): Promise<number> {
+  async getAccountCoinsCount(args: { accountAddress: AccountAddressInput }): Promise<number> {
     return getAccountCoinsCount({ aptosConfig: this.config, ...args });
   }
 
@@ -348,7 +347,7 @@ export class Account {
    * @returns Objects array with the object data
    */
   async getAccountOwnedObjects(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     options?: {
       pagination?: PaginationArgs;
       orderBy?: OrderBy<GetAccountOwnedObjectsResponse[0]>;

package/src/api/ans.ts

@@ -0,0 +1,58 @@
+// Copyright © Aptos Foundation
+// SPDX-License-Identifier: Apache-2.0
+
+import { RegisterNameParameters, getOwnerAddress, registerName } from "../internal/ans";
+import { InputSingleSignerTransaction } from "../transactions/types";
+import { MoveAddressType } from "../types";
+import { AptosConfig } from "./aptosConfig";
+
+/**
+ * A class to handle all `ANS` operations
+ */
+export class ANS {
+  readonly config: AptosConfig;
+
+  constructor(config: AptosConfig) {
+    this.config = config;
+  }
+
+  /**
+   * Retrieve the owner address of a domain name or subdomain name.
+   *
+   * ```ts
+   * getOwnerAddress({name: "test.aptos"})
+   * // Will return the owner address of "test.aptos.apt" or undefined
+   * ```
+   *
+   * @param args.name - A string of the name to retrieve
+   *
+   * @returns MoveAddressType if the name is owned, undefined otherwise
+   */
+  async getOwnerAddress(args: { name: string }): Promise<MoveAddressType | undefined> {
+    return getOwnerAddress({ aptosConfig: this.config, ...args });
+  }
+
+  /**
+   * Registers a new domain or subdomain name
+   *
+   * @param args.sender - The sender account
+   * @param args.name - A string or {domainName: string, subdomainName?: string} of the name to register. This
+   * can be inclusive or exclusive of the .apt suffix.
+   * Examples include: "xyz", "xyz.apt", "xyz.kyc.apt", {domainName: "xyz"}, {domainName: "kyc", subdomainName: "xyz"}.
+   * @param args.expiration  - An object with the expiration policy of the name.
+   * @param args.expiration.policy - 'domain' | 'subdomain:follow-domain' | 'subdomain:independent'
+   * - domain: Years is required and the name will expire after the given number of years.
+   * - subdomain:follow-domain: The name will expire at the same time as the domain name.
+   * - subdomain:independent: The name will expire at the given date.
+   * @param args.transferable  - Determines if the subdomain being minted is soul-bound. Applicable only to subdomains.
+   * @param args.targetAddress optional - The address the domain name will resolve to. If not provided,
+   * the sender's address will be used.
+   * @param args.toAddress optional - The address to send the domain name to. If not provided,
+   * the transaction will be sent to the router.
+   *
+   * @returns InputSingleSignerTransaction
+   */
+  async registerName(args: Omit<RegisterNameParameters, "aptosConfig">): Promise<InputSingleSignerTransaction> {
+    return registerName({ aptosConfig: this.config, ...args });
+  }
+}

package/src/api/aptos.ts

@@ -9,6 +9,7 @@ import { Event } from "./event";
 import { Faucet } from "./faucet";
 import { FungibleAsset } from "./fungibleAsset";
 import { General } from "./general";
+import { ANS } from "./ans";
 import { Staking } from "./staking";
 import { Transaction } from "./transaction";
 import { TransactionSubmission } from "./transactionSubmission";
@@ -25,6 +26,8 @@ export class Aptos {
 
   readonly account: Account;
 
+  readonly ans: ANS;
+
   readonly coin: Coin;
 
   readonly digitalAsset: DigitalAsset;
@@ -46,6 +49,7 @@ export class Aptos {
   constructor(settings?: AptosConfig) {
     this.config = new AptosConfig(settings);
     this.account = new Account(this.config);
+    this.ans = new ANS(this.config);
     this.coin = new Coin(this.config);
     this.digitalAsset = new DigitalAsset(this.config);
     this.event = new Event(this.config);
@@ -68,11 +72,12 @@ export interface Aptos
     General,
     Staking,
     Transaction,
+    ANS,
     TransactionSubmission {}
 
 /**
 In TypeScript, we can’t inherit or extend from more than one class,
-Mixins helps us to get around that by creating a partial classes 
+Mixins helps us to get around that by creating a partial classes
 that we can combine to form a single class that contains all the methods and properties from the partial classes.
 {@link https://www.typescriptlang.org/docs/handbook/mixins.html#alternative-pattern}
 
@@ -92,6 +97,7 @@ function applyMixin(targetClass: any, baseClass: any, baseClassProp: string) {
 }
 
 applyMixin(Aptos, Account, "account");
+applyMixin(Aptos, ANS, "ans");
 applyMixin(Aptos, Coin, "coin");
 applyMixin(Aptos, DigitalAsset, "digitalAsset");
 applyMixin(Aptos, Event, "event");

package/src/api/coin.ts

@@ -2,10 +2,10 @@
 // SPDX-License-Identifier: Apache-2.0
 
 import { AptosConfig } from "./aptosConfig";
-import { Account } from "../core";
+import { Account, AccountAddressInput } from "../core";
 import { transferCoinTransaction } from "../internal/coin";
 import { InputSingleSignerTransaction, InputGenerateTransactionOptions } from "../transactions/types";
-import { AnyNumber, HexInput, MoveStructType } from "../types";
+import { AnyNumber, MoveStructType } from "../types";
 
 /**
  * A class to handle all `Coin` operations
@@ -29,7 +29,7 @@ export class Coin {
    */
   async transferCoinTransaction(args: {
     sender: Account;
-    recipient: HexInput;
+    recipient: AccountAddressInput;
     amount: AnyNumber;
     coinType?: MoveStructType;
     options?: InputGenerateTransactionOptions;

package/src/api/digitalAsset.ts

@@ -7,13 +7,12 @@ import {
   GetOwnedTokensResponse,
   GetTokenActivityResponse,
   GetTokenDataResponse,
-  HexInput,
   OrderBy,
   PaginationArgs,
   TokenStandard,
 } from "../types";
 import { AptosConfig } from "./aptosConfig";
-import { Account } from "../core";
+import { Account, AccountAddressInput } from "../core";
 import { InputGenerateTransactionOptions, InputSingleSignerTransaction } from "../transactions/types";
 import {
   CreateCollectionOptions,
@@ -86,7 +85,7 @@ export class DigitalAsset {
    * @returns GetCollectionDataResponse response type
    */
   async getCollectionData(args: {
-    creatorAddress: HexInput;
+    creatorAddress: AccountAddressInput;
     collectionName: string;
     options?: {
       tokenStandard?: TokenStandard;
@@ -107,7 +106,7 @@ export class DigitalAsset {
    * @returns the collection id
    */
   async getCollectionId(args: {
-    creatorAddress: HexInput;
+    creatorAddress: AccountAddressInput;
     collectionName: string;
     options?: {
       tokenStandard?: TokenStandard;
@@ -144,7 +143,7 @@ export class DigitalAsset {
    * @param args.tokenAddress The address of the token
    * @returns GetTokenDataResponse containing relevant data to the token.
    */
-  async getTokenData(args: { tokenAddress: HexInput }): Promise<GetTokenDataResponse> {
+  async getTokenData(args: { tokenAddress: AccountAddressInput }): Promise<GetTokenDataResponse> {
     return getTokenData({ aptosConfig: this.config, ...args });
   }
 
@@ -154,7 +153,9 @@ export class DigitalAsset {
    * @param args.tokenAddress The address of the token
    * @returns GetCurrentTokenOwnershipResponse containing relevant ownership data of the token.
    */
-  async getCurrentTokenOwnership(args: { tokenAddress: HexInput }): Promise<GetCurrentTokenOwnershipResponse> {
+  async getCurrentTokenOwnership(args: {
+    tokenAddress: AccountAddressInput;
+  }): Promise<GetCurrentTokenOwnershipResponse> {
     return getCurrentTokenOwnership({ aptosConfig: this.config, ...args });
   }
 
@@ -165,7 +166,7 @@ export class DigitalAsset {
    * @returns GetOwnedTokensResponse containing ownership data of the tokens belonging to the ownerAddresss.
    */
   async getOwnedTokens(args: {
-    ownerAddress: HexInput;
+    ownerAddress: AccountAddressInput;
     options?: {
       pagination?: PaginationArgs;
       orderBy?: OrderBy<GetOwnedTokensResponse[0]>;
@@ -181,7 +182,7 @@ export class DigitalAsset {
    * @returns GetTokenActivityResponse containing relevant activity data to the token.
    */
   async getTokenActivity(args: {
-    tokenAddress: HexInput;
+    tokenAddress: AccountAddressInput;
     options?: {
       pagination?: PaginationArgs;
       orderBy?: OrderBy<GetTokenActivityResponse[0]>;

package/src/api/event.ts

@@ -3,8 +3,9 @@
 
 import { AptosConfig } from "./aptosConfig";
 import { getAccountEventsByCreationNumber, getAccountEventsByEventType, getEvents } from "../internal/event";
-import { AnyNumber, GetEventsResponse, HexInput, MoveStructType, OrderBy, PaginationArgs } from "../types";
+import { AnyNumber, GetEventsResponse, MoveStructType, OrderBy, PaginationArgs } from "../types";
 import { EventsBoolExp } from "../types/generated/types";
+import { AccountAddressInput } from "../core";
 
 /**
  * A class to query all `Event` Aptos related queries
@@ -25,7 +26,7 @@ export class Event {
    * @returns Promise<GetEventsResponse>
    */
   async getAccountEventsByCreationNumber(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     creationNumber: AnyNumber;
   }): Promise<GetEventsResponse> {
     return getAccountEventsByCreationNumber({ aptosConfig: this.config, ...args });
@@ -40,7 +41,7 @@ export class Event {
    * @returns Promise<GetEventsResponse>
    */
   async getAccountEventsByEventType(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     eventType: MoveStructType;
     options?: {
       pagination?: PaginationArgs;

package/src/api/faucet.ts

@@ -3,7 +3,8 @@
 
 import { AptosConfig } from "./aptosConfig";
 import { fundAccount } from "../internal/faucet";
-import { HexInput, WaitForTransactionOptions } from "../types";
+import { WaitForTransactionOptions } from "../types";
+import { AccountAddressInput } from "../core";
 
 /**
  * A class to query all `Faucet` related queries on Aptos.
@@ -25,7 +26,7 @@ export class Faucet {
    * @returns Transaction hash of the transaction that funded the account
    */
   async fundAccount(args: {
-    accountAddress: HexInput;
+    accountAddress: AccountAddressInput;
     amount: number;
     options?: WaitForTransactionOptions;
   }): Promise<string> {

package/src/api/general.ts

@@ -114,8 +114,8 @@ export class General {
    *
    * @returns Table item value rendered in JSON
    */
-  async getTableItem(args: { handle: string; data: TableItemRequest; options?: LedgerVersion }): Promise<any> {
-    return getTableItem({ aptosConfig: this.config, ...args });
+  async getTableItem<T>(args: { handle: string; data: TableItemRequest; options?: LedgerVersion }): Promise<T> {
+    return getTableItem<T>({ aptosConfig: this.config, ...args });
   }
 
   /**

package/src/api/staking.ts

@@ -7,7 +7,8 @@ import {
   getNumberOfDelegators,
   getNumberOfDelegatorsForAllPools,
 } from "../internal/staking";
-import { GetDelegatedStakingActivitiesResponse, GetNumberOfDelegatorsResponse, HexInput, OrderBy } from "../types";
+import { GetDelegatedStakingActivitiesResponse, GetNumberOfDelegatorsResponse, OrderBy } from "../types";
+import { AccountAddressInput } from "../core";
 
 /**
  * A class to query all `Staking` related queries on Aptos.
@@ -25,7 +26,7 @@ export class Staking {
    * @param args.poolAddress Pool address
    * @returns The number of delegators for the given pool
    */
-  async getNumberOfDelegators(args: { poolAddress: HexInput }): Promise<number> {
+  async getNumberOfDelegators(args: { poolAddress: AccountAddressInput }): Promise<number> {
     return getNumberOfDelegators({ aptosConfig: this.config, ...args });
   }
 
@@ -50,8 +51,8 @@ export class Staking {
    * @returns GetDelegatedStakingActivitiesResponse response type
    */
   async getDelegatedStakingActivities(args: {
-    delegatorAddress: HexInput;
-    poolAddress: HexInput;
+    delegatorAddress: AccountAddressInput;
+    poolAddress: AccountAddressInput;
   }): Promise<GetDelegatedStakingActivitiesResponse> {
     return getDelegatedStakingActivities({ aptosConfig: this.config, ...args });
   }