support custom client

CHANGELOG.md

@@ -7,6 +7,7 @@ All notable changes to the Aptos TypeScript SDK will be captured in this file. T
 - [`Breaking`] Changed all instances of `arguments` to `functionArguments` to avoid the reserved keyword in `strict` mode.
 - Support publish move module API function
 - Fix client config not being added to the request
+- Support to config a custom client instance
 
 ## 0.0.0 (2023-10-18)
 

examples/typescript/custom_client.ts

@@ -0,0 +1,95 @@
+/**
+ * Example to demostrate how one can config the SDK to use a custom client.
+ *
+ * The SDK by default supports axios client on web environment and go client on node environment
+ * with http2 support.
+ *
+ * Need to provide a function with the signature
+ * `<Req, Res>(requestOptions: ClientRequest<Req>): Promise<ClientResponse<Res>>;`
+ *
+ */
+import { Aptos, AptosConfig, ClientResponse, ClientRequest } from "aptos";
+const superagent = require("superagent");
+
+export async function fetchCustomClient<Req, Res>(requestOptions: ClientRequest<Req>): Promise<ClientResponse<Res>> {
+  const { params, method, url, headers, body } = requestOptions;
+
+  const customHeaders: any = {
+    ...headers,
+    customClient: true,
+  };
+
+  const request = {
+    headers: customHeaders,
+    body: JSON.stringify(body),
+    method,
+  };
+
+  const response = await fetch(`${url}?${params}`, request);
+  const data = await response.json();
+  return {
+    status: response.status,
+    statusText: response.statusText,
+    data,
+    headers: response.headers,
+    config: response,
+    request,
+  };
+}
+
+export async function superagnetCustomClient<Req, Res>(
+  requestOptions: ClientRequest<Req>,
+): Promise<ClientResponse<Res>> {
+  const { params, method, url, headers, body } = requestOptions;
+
+  const customHeaders: any = {
+    ...headers,
+    customClient: true,
+  };
+
+  const request = {
+    headers: customHeaders,
+    body: JSON.stringify(body),
+    method,
+  };
+
+  const response = await superagent.get(`${url}?${params}`, request);
+  return {
+    status: response.status,
+    statusText: response.statusText,
+    data: response.text,
+    headers: response.headers,
+    config: response,
+    request,
+  };
+}
+
+const example = async () => {
+  console.log("This example demostrate how one can config for a custom client ot be used by the SDK");
+
+  async function withSuperagentClient() {
+    const config = new AptosConfig({ client: { provider: superagnetCustomClient } });
+    const aptos = new Aptos(config);
+
+    console.log(`\nclient being used ${config.client.provider.name}`);
+
+    const chainInfo = await aptos.getLedgerInfo();
+    console.log(`${chainInfo}`);
+  }
+
+  async function withFetchClient() {
+    const config = new AptosConfig({ client: { provider: fetchCustomClient } });
+    const aptos = new Aptos(config);
+
+    console.log(`\nclient being used ${config.client.provider.name}`);
+
+    const chainInfo = await aptos.getLedgerInfo();
+    console.log(`${JSON.stringify(chainInfo)}`);
+  }
+
+  // Call the inner functions
+  await withSuperagentClient();
+  await withFetchClient();
+};
+
+example();

examples/typescript/package.json

@@ -8,13 +8,15 @@
     "simple_transfer": "ts-node simple_transfer.ts",
     "mint_nft": "ts-node mint_nft.ts",
     "simple_sponsored_transaction": "ts-node simple_sponsored_transaction.ts",
-    "transfer_coin": "ts-node transfer_coin.ts"
+    "transfer_coin": "ts-node transfer_coin.ts",
+    "custom_client": "ts-node custom_client.ts"
   },
   "keywords": [],
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "aptos": "link:../.."
+    "aptos": "link:../..",
+    "superagent": "^8.1.2"
   },
   "devDependencies": {
     "@types/node": "18.6.2",