@moveindustries/ts-sdk 5.1.4

package/src/client/core.ts

@@ -0,0 +1,120 @@
+// Copyright © Move Industries
+// SPDX-License-Identifier: Apache-2.0
+
+import { MovementConfig } from "../api/movementConfig";
+import { MovementApiError } from "../errors";
+import { AnyNumber, Client, ClientRequest, ClientResponse, MimeType, MovementRequest, MovementResponse } from "../types";
+import { MovementApiType } from "../utils";
+import { VERSION } from "../version";
+
+/**
+ * Sends a request using the specified options and returns the response.
+ *
+ * @param options - The options for the request.
+ * @param options.url - The URL to send the request to.
+ * @param options.method - The HTTP method to use for the request.
+ * @param options.body - The body of the request.
+ * @param options.contentType - The content type of the request.
+ * @param options.params - The query parameters to include in the request.
+ * @param options.overrides - Additional overrides for the request.
+ * @param options.overrides.HEADERS - Custom headers to include in the request.
+ * @param options.overrides.AUTH_TOKEN - The authorization token for the request.
+ * @param options.overrides.API_KEY - The API key for the request.
+ * @param options.originMethod - The origin method for the request.
+ * @param client - The client used to make the request.
+ *
+ * @returns The response from the request.
+ * @group Implementation
+ * @category Client
+ */
+export async function request<Req, Res>(options: ClientRequest<Req>, client: Client): Promise<ClientResponse<Res>> {
+  const { url, method, body, contentType, params, overrides, originMethod } = options;
+  const headers: Record<string, string | AnyNumber | boolean | undefined> = {
+    ...overrides?.HEADERS,
+    "x-aptos-client": `aptos-typescript-sdk/${VERSION}`,
+    "content-type": contentType ?? MimeType.JSON,
+    "x-aptos-typescript-sdk-origin-method": originMethod,
+  };
+
+  if (overrides?.AUTH_TOKEN) {
+    headers.Authorization = `Bearer ${overrides?.AUTH_TOKEN}`;
+  }
+  if (overrides?.API_KEY) {
+    headers.Authorization = `Bearer ${overrides?.API_KEY}`;
+  }
+
+  /*
+   * make a call using the @moveindustries/movement-client package
+   * {@link https://www.npmjs.com/package/@moveindustries/movement-client}
+   */
+  return client.provider<Req, Res>({
+    url,
+    method,
+    body,
+    params,
+    headers,
+    overrides,
+  });
+}
+
+/**
+ * The main function to use when making an API request, returning the response or throwing an MovementApiError on failure.
+ *
+ * @param movementRequestOpts - Options for the Movement request, including the URL and path.
+ * @param movementConfig - The configuration information for the SDK client instance.
+ * @param apiType - The type of API being accessed, which determines how the response is handled.
+ * @returns The response from the API request or throws an MovementApiError if the request fails.
+ * @group Implementation
+ * @category Client
+ */
+export async function aptosRequest<Req extends {}, Res extends {}>(
+  movementRequestOpts: MovementRequest,
+  movementConfig: MovementConfig,
+  apiType: MovementApiType,
+): Promise<MovementResponse<Req, Res>> {
+  const { url, path } = movementRequestOpts;
+  const fullUrl = path ? `${url}/${path}` : url;
+  const clientResponse = await request<Req, Res>({ ...movementRequestOpts, url: fullUrl }, movementConfig.client);
+
+  const movementResponse: MovementResponse<Req, Res> = {
+    status: clientResponse.status,
+    statusText: clientResponse.statusText ?? "No status text provided",
+    data: clientResponse.data,
+    headers: clientResponse.headers,
+    config: clientResponse.config,
+    request: clientResponse.request,
+    url: fullUrl,
+  };
+
+  // Handle case for `Unauthorized` error (i.e. API_KEY error)
+  if (movementResponse.status === 401) {
+    throw new MovementApiError({ apiType, aptosRequest: movementRequestOpts, movementResponse });
+  }
+
+  // to support both fullnode and indexer responses,
+  // check if it is an indexer query, and adjust response.data
+  if (apiType === MovementApiType.INDEXER) {
+    const indexerResponse = movementResponse.data as any;
+    // Handle Indexer general errors
+    if (indexerResponse.errors) {
+      throw new MovementApiError({
+        apiType,
+        aptosRequest: movementRequestOpts,
+        movementResponse,
+      });
+    }
+    movementResponse.data = indexerResponse.data as Res;
+  } else if (apiType === MovementApiType.PEPPER || apiType === MovementApiType.PROVER) {
+    if (movementResponse.status >= 400) {
+      throw new MovementApiError({ apiType, aptosRequest: movementRequestOpts, movementResponse });
+    }
+  }
+
+  if (movementResponse.status >= 200 && movementResponse.status < 300) {
+    return movementResponse;
+  }
+
+  // We have to explicitly check for all request types, because if the error is a non-indexer error, but
+  // comes from an indexer request (e.g. 404), we'll need to mention it appropriately
+  throw new MovementApiError({ apiType, aptosRequest: movementRequestOpts, movementResponse });
+}

package/src/client/get.ts

@@ -0,0 +1,262 @@
+import { MovementConfig } from "../api/movementConfig";
+import { AnyNumber, ClientConfig, MimeType, MovementResponse } from "../types";
+import { MovementApiType } from "../utils/const";
+import { aptosRequest } from "./core";
+
+/**
+ * Options for making a GET request, including configuration for the API client.
+ * @group Implementation
+ * @category Client
+ */
+export type GetRequestOptions = {
+  /**
+   * The config for the API client
+   * @group Implementation
+   * @category Client
+   */
+  movementConfig: MovementConfig;
+  /**
+   * The type of API endpoint to call e.g. fullnode, indexer, etc
+   * @group Implementation
+   * @category Client
+   */
+  type: MovementApiType;
+  /**
+   * The name of the API method
+   * @group Implementation
+   * @category Client
+   */
+  originMethod: string;
+  /**
+   * The URL path to the API method
+   * @group Implementation
+   * @category Client
+   */
+  path: string;
+  /**
+   * The content type of the request body
+   * @group Implementation
+   * @category Client
+   */
+  contentType?: MimeType;
+  /**
+   * The accepted content type of the response of the API
+   * @group Implementation
+   * @category Client
+   */
+  acceptType?: MimeType;
+  /**
+   * The query parameters for the request
+   * @group Implementation
+   * @category Client
+   */
+  params?: Record<string, string | AnyNumber | boolean | undefined>;
+  /**
+   * Specific client overrides for this request to override movementConfig
+   * @group Implementation
+   * @category Client
+   */
+  overrides?: ClientConfig;
+};
+
+/**
+ * Options for making a request to the Movement API, excluding the "type" field.
+ * @group Implementation
+ * @category Client
+ */
+export type GetAptosRequestOptions = Omit<GetRequestOptions, "type">;
+
+/**
+ * Executes a GET request to retrieve data based on the provided options.
+ *
+ * @param options - The options for the GET request.
+ * @param options.movementConfig - The configuration object for Movement requests.
+ * @param options.overrides - Optional overrides for the request configuration.
+ * @param options.params - Query parameters to include in the request.
+ * @param options.contentType - The content type of the request.
+ * @param options.acceptType - The accepted response type.
+ * @param options.path - The specific path for the request.
+ * @param options.originMethod - The original method of the request.
+ * @param options.type - The type of request being made.
+ * @returns The response from the GET request.
+ * @group Implementation
+ * @category Client
+ */
+export async function get<Req extends {}, Res extends {}>(
+  options: GetRequestOptions,
+): Promise<MovementResponse<Req, Res>> {
+  const { movementConfig, overrides, params, contentType, acceptType, path, originMethod, type } = options;
+  const url = movementConfig.getRequestUrl(type);
+
+  return aptosRequest<Req, Res>(
+    {
+      url,
+      method: "GET",
+      originMethod,
+      path,
+      contentType,
+      acceptType,
+      params,
+      overrides: {
+        ...movementConfig.clientConfig,
+        ...overrides,
+      },
+    },
+    movementConfig,
+    options.type,
+  );
+}
+
+/**
+ * Retrieves data from the Movement full node using the provided options.
+ *
+ * @param options - The options for the request to the Movement full node.
+ * @param options.movementConfig - Configuration settings specific to the Movement client and full node.
+ * @param options.movementConfig.clientConfig - The client configuration settings.
+ * @param options.movementConfig.fullnodeConfig - The full node configuration settings.
+ * @param options.overrides - Additional overrides for the request.
+ * @param options.type - The type of API request being made.
+ *
+ * @returns A promise that resolves with the response from the Movement full node.
+ * @group Implementation
+ * @category Client
+ */
+export async function getAptosFullNode<Req extends {}, Res extends {}>(
+  options: GetAptosRequestOptions,
+): Promise<MovementResponse<Req, Res>> {
+  const { movementConfig } = options;
+
+  return get<Req, Res>({
+    ...options,
+    type: MovementApiType.FULLNODE,
+    overrides: {
+      ...movementConfig.clientConfig,
+      ...movementConfig.fullnodeConfig,
+      ...options.overrides,
+      HEADERS: { ...movementConfig.clientConfig?.HEADERS, ...movementConfig.fullnodeConfig?.HEADERS },
+    },
+  });
+}
+
+/**
+ * Makes a GET request to the Movement Pepper service to retrieve data.
+ *
+ * @param options - The options for the request.
+ * @param options.param1 - Description of param1.
+ * @param options.param2 - Description of param2.
+ * @returns MovementResponse - The response from the Movement Pepper service.
+ * @group Implementation
+ * @category Client
+ */
+export async function getAptosPepperService<Req extends {}, Res extends {}>(
+  options: GetAptosRequestOptions,
+): Promise<MovementResponse<Req, Res>> {
+  return get<Req, Res>({ ...options, type: MovementApiType.PEPPER });
+}
+
+/**
+ * This function is a helper for paginating using a function wrapping an API
+ * @group Implementation
+ * @category Client
+ */
+export async function paginateWithCursor<Req extends Record<string, any>, Res extends Array<{}>>(
+  options: GetAptosRequestOptions,
+): Promise<Res> {
+  const out: Res = new Array(0) as Res;
+  let cursor: string | undefined;
+  const requestParams = options.params as { start?: string; limit?: number };
+  do {
+    // eslint-disable-next-line no-await-in-loop
+    const response = await get<Req, Res>({
+      type: MovementApiType.FULLNODE,
+      movementConfig: options.movementConfig,
+      originMethod: options.originMethod,
+      path: options.path,
+      params: requestParams,
+      overrides: options.overrides,
+    });
+    /**
+     * the cursor is a "state key" from the API perspective. Client
+     * should not need to "care" what it represents but just use it
+     * to query the next chunk of data.
+     * @group Implementation
+     * @category Client
+     */
+    cursor = response.headers["x-aptos-cursor"];
+    // Now that we have the cursor (if any), we remove the headers before
+    // adding these to the output of this function.
+    delete response.headers;
+    out.push(...response.data);
+    requestParams.start = cursor;
+  } while (cursor !== null && cursor !== undefined);
+  return out;
+}
+
+/// This function is a helper for paginating using a function wrapping an API using offset instead of start
+export async function paginateWithObfuscatedCursor<Req extends Record<string, any>, Res extends Array<{}>>(
+  options: GetAptosRequestOptions,
+): Promise<Res> {
+  const out: Res = new Array(0) as Res;
+  let cursor: string | undefined;
+  const requestParams = options.params as { start?: string; limit?: number };
+  const totalLimit = requestParams.limit;
+  do {
+    // eslint-disable-next-line no-await-in-loop
+    const { response, cursor: newCursor } = await getPageWithObfuscatedCursor<Req, Res>({ ...options });
+
+    /**
+     * the cursor is a "state key" from the API perspective. Client
+     * should not need to "care" what it represents but just use it
+     * to query the next chunk of data.
+     */
+    cursor = newCursor;
+    out.push(...response.data);
+    if (options?.params) {
+      options.params.start = cursor;
+    }
+
+    // Re-evaluate length
+    if (totalLimit !== undefined) {
+      const newLimit = totalLimit - out.length;
+      if (newLimit <= 0) {
+        break;
+      }
+      requestParams.limit = newLimit;
+    }
+  } while (cursor !== null && cursor !== undefined);
+  return out;
+}
+
+export async function getPageWithObfuscatedCursor<Req extends Record<string, any>, Res extends Array<{}>>(
+  options: GetAptosRequestOptions,
+): Promise<{ response: MovementResponse<Req, Res>; cursor: string | undefined }> {
+  let cursor: string | undefined;
+  let requestParams: { start?: string; limit?: number } = {};
+
+  // Drop any other values
+  // TODO: Throw error if cursor is not a string
+  if (typeof options.params?.cursor === "string") {
+    requestParams.start = options.params.cursor;
+  }
+  if (typeof options.params?.limit === "number") {
+    requestParams.limit = options.params.limit;
+  }
+
+  // eslint-disable-next-line no-await-in-loop
+  const response = await get<Req, Res>({
+    type: MovementApiType.FULLNODE,
+    movementConfig: options.movementConfig,
+    originMethod: options.originMethod,
+    path: options.path,
+    params: requestParams,
+    overrides: options.overrides,
+  });
+
+  /**
+   * the cursor is a "state key" from the API perspective. Client
+   * should not need to "care" what it represents but just use it
+   * to query the next chunk of data.
+   */
+  cursor = response.headers["x-aptos-cursor"];
+  return { response, cursor };
+}

package/src/client/index.ts

@@ -0,0 +1,7 @@
+// Copyright © Move Industries
+// SPDX-License-Identifier: Apache-2.0
+
+export * from "./core";
+export * from "./get";
+export * from "./post";
+

package/src/client/post.ts

@@ -0,0 +1,245 @@
+// Copyright © Move Industries
+// SPDX-License-Identifier: Apache-2.0
+
+import { MovementConfig } from "../api/movementConfig";
+import { AnyNumber, ClientConfig, MimeType, MovementResponse } from "../types";
+import { MovementApiType } from "../utils/const";
+import { aptosRequest } from "./core";
+
+/**
+ * Options for making a POST request, including the API client configuration.
+ * @group Implementation
+ * @category Client
+ */
+export type PostRequestOptions = {
+  /**
+   * The config for the API client
+   * @group Implementation
+   * @category Client
+   */
+  movementConfig: MovementConfig;
+  /**
+   * The type of API endpoint to call e.g. fullnode, indexer, etc
+   * @group Implementation
+   * @category Client
+   */
+  type: MovementApiType;
+  /**
+   * The name of the API method
+   * @group Implementation
+   * @category Client
+   */
+  originMethod: string;
+  /**
+   * The URL path to the API method
+   * @group Implementation
+   * @category Client
+   */
+  path: string;
+  /**
+   * The content type of the request body
+   * @group Implementation
+   * @category Client
+   */
+  contentType?: MimeType;
+  /**
+   * The accepted content type of the response of the API
+   * @group Implementation
+   * @category Client
+   */
+  acceptType?: MimeType;
+  /**
+   * The query parameters for the request
+   * @group Implementation
+   * @category Client
+   */
+  params?: Record<string, string | AnyNumber | boolean | undefined>;
+  /**
+   * The body of the request, should match the content type of the request
+   * @group Implementation
+   * @category Client
+   */
+  body?: any;
+  /**
+   * Specific client overrides for this request to override movementConfig
+   * @group Implementation
+   * @category Client
+   */
+  overrides?: ClientConfig;
+};
+
+/**
+ * Options for posting a request to Movement, excluding the type field.
+ * @group Implementation
+ * @category Client
+ */
+export type PostAptosRequestOptions = Omit<PostRequestOptions, "type">;
+
+/**
+ * Executes a POST request to the specified URL with the provided options.
+ *
+ * @param options - The options for the POST request.
+ * @param options.type - The type of the request.
+ * @param options.originMethod - The original method that initiated the request.
+ * @param options.path - The path for the request.
+ * @param options.body - The body content to be sent with the request.
+ * @param options.acceptType - The type of response expected from the server.
+ * @param options.contentType - The content type of the request body.
+ * @param options.params - Additional parameters to include in the request.
+ * @param options.movementConfig - Configuration settings for the Movement request.
+ * @param options.overrides - Any overrides for the default request behavior.
+ * @returns The response from the POST request.
+ * @group Implementation
+ * @category Client
+ */
+export async function post<Req extends {}, Res extends {}>(
+  options: PostRequestOptions,
+): Promise<MovementResponse<Req, Res>> {
+  const { type, originMethod, path, body, acceptType, contentType, params, movementConfig, overrides } = options;
+  const url = movementConfig.getRequestUrl(type);
+
+  return aptosRequest<Req, Res>(
+    {
+      url,
+      method: "POST",
+      originMethod,
+      path,
+      body,
+      contentType,
+      acceptType,
+      params,
+      overrides,
+    },
+    movementConfig,
+    options.type,
+  );
+}
+
+/**
+ * Sends a request to the Movement full node using the specified options.
+ * This function allows you to interact with the Movement blockchain by sending requests to the full node.
+ *
+ * @param options - The options for the request.
+ * @param options.movementConfig - Configuration settings for the Movement client.
+ * @param options.movementConfig.clientConfig - Client-specific configuration settings.
+ * @param options.movementConfig.fullnodeConfig - Full node-specific configuration settings.
+ * @param options.overrides - Additional overrides for the request.
+ * @group Implementation
+ * @category Client
+ */
+export async function postAptosFullNode<Req extends {}, Res extends {}>(
+  options: PostAptosRequestOptions,
+): Promise<MovementResponse<Req, Res>> {
+  const { movementConfig } = options;
+
+  return post<Req, Res>({
+    ...options,
+    type: MovementApiType.FULLNODE,
+    overrides: {
+      ...movementConfig.clientConfig,
+      ...movementConfig.fullnodeConfig,
+      ...options.overrides,
+      HEADERS: { ...movementConfig.clientConfig?.HEADERS, ...movementConfig.fullnodeConfig?.HEADERS },
+    },
+  });
+}
+
+/**
+ * Sends a request to the Movement indexer with the specified options.
+ * This function allows you to interact with the Movement indexer and customize the request using various configurations.
+ *
+ * @param options - The options for the request to the Movement indexer.
+ * @param options.movementConfig - Configuration settings specific to the Movement client and indexer.
+ * @param options.movementConfig.clientConfig - The client configuration settings.
+ * @param options.movementConfig.indexerConfig - The indexer configuration settings.
+ * @param options.overrides - Additional overrides for the request.
+ * @param options.overrides.HEADERS - Custom headers to include in the request.
+ * @group Implementation
+ * @category Client
+ */
+export async function postAptosIndexer<Req extends {}, Res extends {}>(
+  options: PostAptosRequestOptions,
+): Promise<MovementResponse<Req, Res>> {
+  const { movementConfig } = options;
+
+  return post<Req, Res>({
+    ...options,
+    type: MovementApiType.INDEXER,
+    overrides: {
+      ...movementConfig.clientConfig,
+      ...movementConfig.indexerConfig,
+      ...options.overrides,
+      HEADERS: { ...movementConfig.clientConfig?.HEADERS, ...movementConfig.indexerConfig?.HEADERS },
+    },
+  });
+}
+
+/**
+ * Sends a request to the Movement faucet to obtain test tokens.
+ * This function modifies the provided configuration to ensure that the API_KEY is not included in the request.
+ *
+ * @param options - The options for the request.
+ * @param options.movementConfig - The configuration settings for the Movement client.
+ * @param options.movementConfig.clientConfig - The client-specific configuration settings.
+ * @param options.movementConfig.clientConfig.HEADERS - Optional headers to include in the request.
+ * @param options.movementConfig.faucetConfig - The configuration settings specific to the faucet.
+ * @param options.overrides - Additional overrides for the request configuration.
+ * @group Implementation
+ * @category Client
+ */
+export async function postAptosFaucet<Req extends {}, Res extends {}>(
+  options: PostAptosRequestOptions,
+): Promise<MovementResponse<Req, Res>> {
+  const { movementConfig } = options;
+  // Faucet does not support API_KEY
+  // Create a new object with the desired modification
+  const modifiedMovementConfig = {
+    ...movementConfig,
+    clientConfig: { ...movementConfig.clientConfig },
+  };
+  // Delete API_KEY config
+  delete modifiedMovementConfig?.clientConfig?.API_KEY;
+
+  return post<Req, Res>({
+    ...options,
+    type: MovementApiType.FAUCET,
+    overrides: {
+      ...modifiedMovementConfig.clientConfig,
+      ...modifiedMovementConfig.faucetConfig,
+      ...options.overrides,
+      HEADERS: { ...modifiedMovementConfig.clientConfig?.HEADERS, ...modifiedMovementConfig.faucetConfig?.HEADERS },
+    },
+  });
+}
+
+/**
+ * Makes a post request to the pepper service.
+ *
+ * @param options - The options for the request.
+ * @param options.url - The URL to which the request is sent.
+ * @param options.headers - The headers to include in the request.
+ * @param options.body - The body of the request.
+ * @returns A promise that resolves to the response from the pepper service.
+ * @group Implementation
+ * @category Client
+ */
+export async function postAptosPepperService<Req extends {}, Res extends {}>(
+  options: PostAptosRequestOptions,
+): Promise<MovementResponse<Req, Res>> {
+  return post<Req, Res>({ ...options, type: MovementApiType.PEPPER });
+}
+
+/**
+ * Sends a request to the Movement proving service with the specified options.
+ *
+ * @param options - The options for the request to the Movement proving service.
+ * @param options.type - The type of the request, which should be set to MovementApiType.PROVER.
+ * @param options.data - The data to be included in the request.
+ * @group Implementation
+ * @category Client
+ */
+export async function postAptosProvingService<Req extends {}, Res extends {}>(
+  options: PostAptosRequestOptions,
+): Promise<MovementResponse<Req, Res>> {
+  return post<Req, Res>({ ...options, type: MovementApiType.PROVER });
+}

package/src/core/account/index.ts

@@ -0,0 +1 @@
+export * from "./utils";