@moveindustries/ts-sdk 5.1.4

package/src/api/movement.ts

@@ -0,0 +1,171 @@
+// Copyright © Move Industries
+// SPDX-License-Identifier: Apache-2.0
+
+import { Account } from "./account";
+import { AccountAbstraction } from "./account/abstraction";
+import { ANS } from "./ans";
+import { Coin } from "./coin";
+import { DigitalAsset } from "./digitalAsset";
+import { Faucet } from "./faucet";
+import { FungibleAsset } from "./fungibleAsset";
+import { General } from "./general";
+import { Keyless } from "./keyless";
+import { MovementConfig } from "./movementConfig";
+import { MovementObject } from "./object";
+import { Staking } from "./staking";
+import { Table } from "./table";
+import { Transaction } from "./transaction";
+
+/**
+ * The main entry point for interacting with the Movement APIs,
+ * providing access to various functionalities organized into
+ * distinct namespaces.
+ *
+ * To utilize the SDK, instantiate a new Movement object to gain
+ * access to the complete range of SDK features.
+ *
+ * @example
+ * ```typescript
+ * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+ *
+ * async function runExample() {
+ *     // Create a configuration for connecting to the Movement testnet
+ *     const config = new MovementConfig({ network: Network.TESTNET });
+ *
+ *     // Initialize the Movement client with the configuration
+ *     const movement = new Movement(config);
+ *
+ *     console.log("Movement client initialized:", aptos);
+ * }
+ * runExample().catch(console.error);
+ * ```
+ * @group Client
+ */
+export class Movement {
+  readonly config: MovementConfig;
+
+  readonly account: Account;
+
+  readonly ans: ANS;
+
+  readonly coin: Coin;
+
+  readonly digitalAsset: DigitalAsset;
+
+  readonly faucet: Faucet;
+
+  readonly fungibleAsset: FungibleAsset;
+
+  readonly general: General;
+
+  readonly staking: Staking;
+
+  readonly transaction: Transaction;
+
+  readonly table: Table;
+
+  readonly keyless: Keyless;
+
+  readonly object: MovementObject;
+
+  /**
+   * Initializes a new instance of the Movement client with the provided configuration settings.
+   * This allows you to interact with various Movement functionalities such as accounts, transactions, and events.
+   *
+   * @param settings - Configuration settings for the Movement client.
+   *
+   * @example
+   * ```typescript
+   * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+   *
+   * async function runExample() {
+   *     // Create a new Movement client with default settings
+   *     const config = new MovementConfig({ network: Network.TESTNET }); // Specify your own settings if needed
+   *     const movement = new Movement(config);
+   *
+   *     console.log("Movement client initialized:", aptos);
+   * }
+   * runExample().catch(console.error);
+   * ```
+   * @group Client
+   */
+  constructor(config?: MovementConfig) {
+    this.config = config ?? new MovementConfig();
+    this.account = new Account(this.config);
+    this.abstraction = new AccountAbstraction(this.config);
+    this.ans = new ANS(this.config);
+    this.coin = new Coin(this.config);
+    this.digitalAsset = new DigitalAsset(this.config);
+    this.faucet = new Faucet(this.config);
+    this.fungibleAsset = new FungibleAsset(this.config);
+    this.general = new General(this.config);
+    this.staking = new Staking(this.config);
+    this.transaction = new Transaction(this.config);
+    this.table = new Table(this.config);
+    this.keyless = new Keyless(this.config);
+    this.object = new MovementObject(this.config);
+  }
+
+  setIgnoreTransactionSubmitter(ignore: boolean) {
+    this.config.setIgnoreTransactionSubmitter(ignore);
+  }
+}
+
+// extends Movement interface so all the methods and properties
+// from the other classes will be recognized by typescript.
+export interface Movement
+  extends Account,
+  ANS,
+  Coin,
+  DigitalAsset,
+  Event,
+  Faucet,
+  FungibleAsset,
+  General,
+  Keyless,
+  Staking,
+  Table,
+  MovementObject,
+  Omit<Transaction, "build" | "simulate" | "submit" | "batch"> { }
+
+/**
+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
+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}
+
+Here, we combine any subclass and the Movement class.
+ * @group Client
+*/
+function applyMixin(targetClass: any, baseClass: any, baseClassProp: string) {
+  // Mixin instance methods
+  Object.getOwnPropertyNames(baseClass.prototype).forEach((propertyName) => {
+    const propertyDescriptor = Object.getOwnPropertyDescriptor(baseClass.prototype, propertyName);
+    if (!propertyDescriptor) return;
+
+    // Define new method that calls through baseClassProp
+    Object.defineProperty(targetClass.prototype, propertyName, {
+      value: function (...args: any[]) {
+        return (this as any)[baseClassProp][propertyName](...args);
+      },
+      writable: propertyDescriptor.writable,
+      configurable: propertyDescriptor.configurable,
+      enumerable: propertyDescriptor.enumerable,
+    });
+  });
+}
+
+applyMixin(Movement, Account, "account");
+applyMixin(Movement, AccountAbstraction, "abstraction");
+applyMixin(Movement, ANS, "ans");
+applyMixin(Movement, Coin, "coin");
+applyMixin(Movement, DigitalAsset, "digitalAsset");
+applyMixin(Movement, Event, "event");
+applyMixin(Movement, Faucet, "faucet");
+applyMixin(Movement, FungibleAsset, "fungibleAsset");
+applyMixin(Movement, General, "general");
+applyMixin(Movement, Staking, "staking");
+applyMixin(Movement, Transaction, "transaction");
+applyMixin(Movement, Table, "table");
+applyMixin(Movement, Keyless, "keyless");
+applyMixin(Movement, MovementObject, "object");

package/src/api/movementConfig.ts

@@ -0,0 +1,334 @@
+// Copyright © Move Industries
+// SPDX-License-Identifier: Apache-2.0
+
+import movementClient from "@moveindustries/movement-client";
+import {
+  Client,
+  ClientConfig,
+  FaucetConfig,
+  FullNodeConfig,
+  IndexerConfig,
+  MovementSettings,
+  PluginConfig,
+  TransactionGenerationConfig,
+  TransactionSubmitter,
+} from "../types";
+import {
+  Network,
+  NetworkToFaucetAPI,
+  NetworkToIndexerAPI,
+  NetworkToNodeAPI,
+  NetworkToPepperAPI,
+  NetworkToProverAPI,
+} from "../utils/apiEndpoints";
+import { DEFAULT_MAX_GAS_AMOUNT, DEFAULT_TXN_EXP_SEC_FROM_NOW, MovementApiType } from "../utils/const";
+
+/**
+ * Represents the configuration settings for an Movement SDK client instance.
+ * This class allows customization of various endpoints and client settings.
+ *
+ * @example
+ * ```typescript
+ * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+ *
+ * async function runExample() {
+ *     // Create a configuration for connecting to the Movement testnet
+ *     const config = new MovementConfig({ network: Network.TESTNET });
+ *
+ *     // Initialize the Movement client with the configuration
+ *     const movement = new Movement(config);
+ *
+ *     console.log("Movement client initialized:", aptos);
+ * }
+ * runExample().catch(console.error);
+ * ```
+ * @group Client
+ */
+export class MovementConfig {
+  /**
+   * The Network that this SDK is associated with. Defaults to DEVNET
+   * @group Client
+   */
+  readonly network: Network;
+
+  /**
+   * The client instance the SDK uses. Defaults to `@moveindustries/movement-client
+   * @group Client
+   */
+  readonly client: Client;
+
+  /**
+   * The optional hardcoded fullnode URL to send requests to instead of using the network
+   * @group Client
+   */
+  readonly fullnode?: string;
+
+  /**
+   * The optional hardcoded faucet URL to send requests to instead of using the network
+   * @group Client
+   */
+  readonly faucet?: string;
+
+  /**
+   * The optional hardcoded pepper service URL to send requests to instead of using the network
+   * @group Client
+   */
+  readonly pepper?: string;
+
+  /**
+   * The optional hardcoded prover service URL to send requests to instead of using the network
+   * @group Client
+   */
+  readonly prover?: string;
+
+  /**
+   * The optional hardcoded indexer URL to send requests to instead of using the network
+   * @group Client
+   */
+  readonly indexer?: string;
+
+  /**
+   * Optional client configurations
+   * @group Client
+   */
+  readonly clientConfig?: ClientConfig;
+
+  /**
+   * Optional specific Fullnode configurations
+   * @group Client
+   */
+  readonly fullnodeConfig?: FullNodeConfig;
+
+  /**
+   * Optional specific Indexer configurations
+   * @group Client
+   */
+  readonly indexerConfig?: IndexerConfig;
+
+  /**
+   * Optional specific Faucet configurations
+   * @group Client
+   */
+  readonly faucetConfig?: FaucetConfig;
+
+  /**
+   * Optional specific Transaction Generation configurations
+   * @group Client
+   */
+  readonly transactionGenerationConfig?: TransactionGenerationConfig;
+
+  /**
+   * Optional plugin config to override client behavior.
+   * @group Client
+   */
+  private pluginConfig?: PluginConfig;
+
+  /**
+   * Initializes an instance of the Movement client with the specified settings.
+   * This allows users to configure various aspects of the client, such as network and endpoints.
+   *
+   * @param settings - Optional configuration settings for the Movement client.
+   * @param settings.network - The network to connect to, defaults to `Network.DEVNET`.
+   * @param settings.fullnode - The fullnode endpoint to use for requests.
+   * @param settings.faucet - The faucet endpoint for obtaining test tokens.
+   * @param settings.pepper - The pepper used for transaction signing.
+   * @param settings.prover - The prover endpoint for transaction verification.
+   * @param settings.indexer - The indexer endpoint for querying blockchain data.
+   * @param settings.client - Custom client settings, defaults to a standard Movement client.
+   * @param settings.clientConfig - Additional configuration for the client.
+   * @param settings.fullnodeConfig - Additional configuration for the fullnode.
+   * @param settings.indexerConfig - Additional configuration for the indexer.
+   * @param settings.faucetConfig - Additional configuration for the faucet.
+   *
+   * @example
+   * ```typescript
+   * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+   *
+   * async function runExample() {
+   *     // Create a new Movement client with default settings
+   *     const config = new MovementConfig({ network: Network.TESTNET }); // Specify the network
+   *     const movement = new Movement(config);
+   *
+   *     console.log("Movement client initialized:", aptos);
+   * }
+   * runExample().catch(console.error);
+   * ```
+   * @group Client
+   */
+  constructor(settings?: MovementSettings) {
+    // If there are any endpoint overrides, they are custom networks, keep that in mind
+    if (settings?.fullnode || settings?.indexer || settings?.faucet || settings?.pepper || settings?.prover) {
+      if (settings?.network === Network.CUSTOM) {
+        console.info("Note: using CUSTOM network will require queries to lookup ChainId");
+      } else if (!settings?.network) {
+        throw new Error("Custom endpoints require a network to be specified");
+      }
+    }
+
+    this.network = settings?.network ?? Network.DEVNET;
+    this.fullnode = settings?.fullnode;
+    this.faucet = settings?.faucet;
+    this.pepper = settings?.pepper;
+    this.prover = settings?.prover;
+    this.indexer = settings?.indexer;
+    this.client = settings?.client ?? { provider: movementClient };
+    this.clientConfig = settings?.clientConfig ?? {};
+    this.fullnodeConfig = settings?.fullnodeConfig ?? {};
+    this.indexerConfig = settings?.indexerConfig ?? {};
+    this.faucetConfig = settings?.faucetConfig ?? {};
+    this.transactionGenerationConfig = settings?.transactionGenerationConfig ?? {};
+    this.pluginConfig = settings?.pluginSettings
+      ? {
+        ...settings.pluginSettings,
+        IGNORE_TRANSACTION_SUBMITTER: false,
+      }
+      : undefined;
+  }
+
+  /**
+   * Returns the URL endpoint to send the request to based on the specified API type.
+   * If a custom URL was provided in the configuration, that URL is returned. Otherwise, the URL endpoint is derived from the network.
+   *
+   * @param apiType - The type of Movement API to get the URL for. This can be one of the following: FULLNODE, FAUCET, INDEXER, PEPPER, PROVER.
+   *
+   * @example
+   * ```typescript
+   * import { Movement, MovementConfig, Network, MovementApiType } from "@moveindustries/ts-sdk";
+   *
+   * const config = new MovementConfig({ network: Network.TESTNET });
+   * const movement = new Movement(config);
+   *
+   * async function runExample() {
+   *   // Getting the request URL for the FULLNODE API
+   *   const url = config.getRequestUrl(MovementApiType.FULLNODE);
+   *   console.log("Request URL for FULLNODE:", url);
+   * }
+   * runExample().catch(console.error);
+   * ```
+   * @group Client
+   */
+  getRequestUrl(apiType: MovementApiType): string {
+    switch (apiType) {
+      case MovementApiType.FULLNODE:
+        if (this.fullnode !== undefined) return this.fullnode;
+        if (this.network === Network.CUSTOM) throw new Error("Please provide a custom full node url");
+        return NetworkToNodeAPI[this.network];
+      case MovementApiType.FAUCET:
+        if (this.faucet !== undefined) return this.faucet;
+        if (this.network === Network.MAINNET) {
+          throw new Error("There is no mainnet faucet");
+        }
+        if (this.network === Network.CUSTOM) throw new Error("Please provide a custom faucet url");
+        return NetworkToFaucetAPI[this.network];
+      case MovementApiType.INDEXER:
+        if (this.indexer !== undefined) return this.indexer;
+        if (this.network === Network.CUSTOM) throw new Error("Please provide a custom indexer url");
+        return NetworkToIndexerAPI[this.network];
+      case MovementApiType.PEPPER:
+        if (this.pepper !== undefined) return this.pepper;
+        if (this.network === Network.CUSTOM) throw new Error("Please provide a custom pepper service url");
+        return NetworkToPepperAPI[this.network];
+      case MovementApiType.PROVER:
+        if (this.prover !== undefined) return this.prover;
+        if (this.network === Network.CUSTOM) throw new Error("Please provide a custom prover service url");
+        return NetworkToProverAPI[this.network];
+      default:
+        throw Error(`apiType ${apiType} is not supported`);
+    }
+  }
+
+  /**
+   * Checks if the provided URL is a known pepper service endpoint.
+   *
+   * @param url - The URL to check against the known pepper service endpoints.
+   *
+   * @example
+   * ```typescript
+   * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+   *
+   * const config = new MovementConfig({ network: Network.TESTNET });
+   * const movement = new Movement(config);
+   *
+   * async function runExample() {
+   *     const url = "https://example.pepper.service"; // replace with a real pepper service URL
+   *
+   *     // Check if the URL is a known pepper service endpoint
+   *     const isPepperService = config.isPepperServiceRequest(url);
+   *
+   *     console.log(`Is the URL a known pepper service? ${isPepperService}`);
+   * }
+   * runExample().catch(console.error);
+   * ```
+   * @group Client
+   */
+  isPepperServiceRequest(url: string): boolean {
+    return NetworkToPepperAPI[this.network] === url;
+  }
+
+  /**
+   * Checks if the provided URL is a known prover service endpoint.
+   *
+   * @param url - The URL to check against known prover service endpoints.
+   * @returns A boolean indicating whether the URL is a known prover service endpoint.
+   *
+   * @example
+   * ```typescript
+   * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+   *
+   * const config = new MovementConfig({ network: Network.TESTNET });
+   * const movement = new Movement(config);
+   *
+   * // Check if the URL is a known prover service endpoint
+   * const url = "https://prover.testnet.movement.dev"; // replace with a real URL if needed
+   * const isProver = config.isProverServiceRequest(url);
+   *
+   * console.log(`Is the URL a known prover service? ${isProver}`);
+   * ```
+   * @group Client
+   */
+  isProverServiceRequest(url: string): boolean {
+    return NetworkToProverAPI[this.network] === url;
+  }
+
+  getDefaultMaxGasAmount(): number {
+    return this.transactionGenerationConfig?.defaultMaxGasAmount ?? DEFAULT_MAX_GAS_AMOUNT;
+  }
+
+  getDefaultTxnExpirySecFromNow(): number {
+    return this.transactionGenerationConfig?.defaultTxnExpirySecFromNow ?? DEFAULT_TXN_EXP_SEC_FROM_NOW;
+  }
+
+  /**
+   * If you have set a custom transaction submitter, you can use this to determine
+   * whether to use it or not. For example, to stop using the transaction submitter:
+   *
+   * @example
+   * ```
+   * movement.config.setIgnoreTransactionSubmitter(true);
+   * ```
+   *
+   * @group Client
+   */
+  setIgnoreTransactionSubmitter(ignore: boolean) {
+    if (this.pluginConfig) {
+      this.pluginConfig.IGNORE_TRANSACTION_SUBMITTER = ignore;
+    }
+  }
+
+  /**
+   * If a custom transaction submitter has been specified in the PluginConfig and
+   * IGNORE_TRANSACTION_SUBMITTER is false, this will return a transaction submitter
+   * that should be used instead of the default transaction submission behavior.
+   */
+  getTransactionSubmitter(): TransactionSubmitter | undefined {
+    if (this.pluginConfig === undefined) {
+      return undefined;
+    }
+
+    if (this.pluginConfig.IGNORE_TRANSACTION_SUBMITTER === true) {
+      return undefined;
+    }
+
+    return this.pluginConfig.TRANSACTION_SUBMITTER;
+  }
+}

package/src/api/object.ts

@@ -0,0 +1,90 @@
+// Copyright © Move Industries
+// SPDX-License-Identifier: Apache-2.0
+
+import { AccountAddressInput } from "../core";
+import { getObjectDataByObjectAddress } from "../internal/object";
+import { AnyNumber, GetObjectDataQueryResponse, OrderByArg, PaginationArgs } from "../types";
+import { ProcessorType } from "../utils";
+import { MovementConfig } from "./movementConfig";
+import { waitForIndexerOnVersion } from "./utils";
+
+/**
+ * A class to query all `Object` related queries on Movement.
+ * @group Object
+ */
+export class MovementObject {
+  /**
+   * Creates an instance of the Movement client with the provided configuration.
+   * This allows interaction with the Movement blockchain using the specified settings.
+   *
+   * @param config - The configuration settings for the Movement client.
+   * @param config.network - The network to connect to (e.g., mainnet, testnet).
+   * @param config.nodeUrl - The URL of the Movement node to connect to.
+   * @param config.faucetUrl - The URL of the faucet for funding accounts (optional).
+   *
+   * @example
+   * ```typescript
+   * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+   *
+   * async function runExample() {
+   *     // Create a configuration for the Movement client
+   *     const config = new MovementConfig({
+   *         network: Network.TESTNET, // Specify the desired network
+   *         nodeUrl: "https://testnet.movement.dev", // Replace with your node URL
+   *     });
+   *
+   *     // Create an instance of the Movement client
+   *     const movement = new Movement(config);
+   *
+   *     console.log("Movement client created successfully", aptos);
+   * }
+   * runExample().catch(console.error);
+   * ```
+   * @group Object
+   */
+  constructor(readonly config: MovementConfig) { }
+
+  /**
+   * Fetches the object data based on the specified object address.
+   *
+   * @param args.objectAddress - The object address to retrieve data for.
+   * @param args.minimumLedgerVersion - Optional minimum ledger version to wait for.
+   * @param args.options - Optional configuration options for pagination and ordering.
+   *
+   * @returns The object data corresponding to the provided address.
+   *
+   * @example
+   * ```typescript
+   * import { Movement, MovementConfig, Network } from "@moveindustries/ts-sdk";
+   *
+   * const config = new MovementConfig({ network: Network.TESTNET });
+   * const movement = new Movement(config);
+   *
+   * async function runExample() {
+   *   // Fetching object data by object address
+   *   const objectData = await movement.getObjectDataByObjectAddress({
+   *     objectAddress: "0x1", // replace with a real object address
+   *   });
+   *
+   *   console.log(objectData);
+   * }
+   * runExample().catch(console.error);
+   * ```
+   * @group Object
+   */
+  async getObjectDataByObjectAddress(args: {
+    objectAddress: AccountAddressInput;
+    minimumLedgerVersion?: AnyNumber;
+    options?: PaginationArgs & OrderByArg<GetObjectDataQueryResponse[0]>;
+  }): Promise<GetObjectDataQueryResponse[0]> {
+    await waitForIndexerOnVersion({
+      config: this.config,
+      minimumLedgerVersion: args.minimumLedgerVersion,
+      processorType: ProcessorType.OBJECT_PROCESSOR,
+    });
+    return getObjectDataByObjectAddress({
+      movementConfig: this.config,
+      ...args,
+    });
+  }
+}