@across-protocol/sdk 4.3.138 → 4.3.139-alpha.2

package/dist/types/src/caching/IPFS/PinataIPFSClient.d.ts

@@ -1,38 +0,0 @@
-import { CachingMechanismInterface } from "../../interfaces";
-import { Struct } from "superstruct";
-import winston from "winston";
-/**
- * A client for interacting with the IPFS. This is a wrapper around the IPFS API.
- * This client also is a part of the caching mechanism interface.
- * @see https://docs.ipfs.io/reference/http/api/
- */
-export declare class PinataIPFSClient implements CachingMechanismInterface {
-    /**
-     * The IPFS client instance
-     */
-    private client;
-    /**
-     * Public IPFS gateway URL to retrieve the content from
-     */
-    private publicGatewayURL;
-    /**
-     * An optional logger for logging messages
-     */
-    private logger?;
-    constructor(projectId: string, projectSecret: string, publicGatewayURL: string, logger?: winston.Logger);
-    /**
-     * Calls to a public IPFS gateway to retrieve a value.
-     * @param key The key to retrieve.
-     * @param _structValidator An optional struct validator to validate the retrieved value. If the value does not match the struct, null is returned.
-     * @returns The value if it exists, otherwise null.
-     */
-    get<ObjectType>(key?: string, _structValidator?: Struct<unknown, unknown>): Promise<ObjectType | null>;
-    /**
-     * Stores a value in the IPFS and returns the CID of the value stored.
-     * @param key An optional key to store the value with. This is purely in the metadata of the CID.
-     * @param value The value to store.
-     * @returns The CID of the value stored.
-     */
-    set<T>(key: string, value: T): Promise<string | undefined>;
-}
-//# sourceMappingURL=PinataIPFSClient.d.ts.map

package/dist/types/src/caching/IPFS/PinataIPFSClient.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"PinataIPFSClient.d.ts","sourceRoot":"","sources":["../../../../../src/caching/IPFS/PinataIPFSClient.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,yBAAyB,EAAE,MAAM,kBAAkB,CAAC;AAC7D,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,OAAO,MAAM,SAAS,CAAC;AAI9B;;;;GAIG;AACH,qBAAa,gBAAiB,YAAW,yBAAyB;IAChE;;OAEG;IACH,OAAO,CAAC,MAAM,CAAe;IAE7B;;OAEG;IACH,OAAO,CAAC,gBAAgB,CAAS;IAEjC;;OAEG;IACH,OAAO,CAAC,MAAM,CAAC,CAAiB;gBAEb,SAAS,EAAE,MAAM,EAAE,aAAa,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,EAAE,MAAM,CAAC,EAAE,OAAO,CAAC,MAAM;IAM9G;;;;;OAKG;IACG,GAAG,CAAC,UAAU,EAAE,GAAG,CAAC,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,MAAM,CAAC,OAAO,EAAE,OAAO,CAAC,GAAG,OAAO,CAAC,UAAU,GAAG,IAAI,CAAC;IAkC5G;;;;;OAKG;IACH,GAAG,CAAC,CAAC,EAAE,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC,GAAG,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;CAW3D"}

package/dist/types/src/caching/IPFS/index.d.ts

@@ -1,2 +0,0 @@
-export * from "./PinataIPFSClient";
-//# sourceMappingURL=index.d.ts.map

package/dist/types/src/caching/IPFS/index.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../src/caching/IPFS/index.ts"],"names":[],"mappings":"AAAA,cAAc,oBAAoB,CAAC"}

package/dist/types/src/utils/IPFSUtils.d.ts

@@ -1,25 +0,0 @@
-import PinataClient from "@pinata/sdk";
-/**
- * Build an IPFS client for interacting with the IPFS API
- * @param APIKey The project ID
- * @param secretAPIKey The project secret
- * @returns An IPFS client for interacting with Pinata
- */
-export declare function buildIPFSClient(APIKey: string, secretAPIKey: string): PinataClient;
-/**
- * Retrieves a value from an IPFS gateway
- * @param contentHash The content hash of the value to retrieve
- * @param publicGatewayURL The URL of the public IPFS gateway to use
- * @returns The value retrieved from the IPFS gateway
- * @throws Error if the value could not be retrieved
- */
-export declare function retrieveValueFromIPFS(contentHash: string, publicGatewayURL: string): Promise<string>;
-/**
- * Pins a value to the IPFS network
- * @param key A key to use for pinning the value. This is a metadata field.
- * @param content The value to pin
- * @param client The IPFS client to use
- * @returns The content hash of the pinned value
- */
-export declare function storeValueInIPFS(key: string, content: string, client: PinataClient): Promise<string>;
-//# sourceMappingURL=IPFSUtils.d.ts.map

package/dist/types/src/utils/IPFSUtils.d.ts.map

@@ -1 +0,0 @@
-{"version":3,"file":"IPFSUtils.d.ts","sourceRoot":"","sources":["../../../../src/utils/IPFSUtils.ts"],"names":[],"mappings":"AAAA,OAAO,YAAY,MAAM,aAAa,CAAC;AAGvC;;;;;GAKG;AACH,wBAAgB,eAAe,CAAC,MAAM,EAAE,MAAM,EAAE,YAAY,EAAE,MAAM,GAAG,YAAY,CAElF;AAED;;;;;;GAMG;AACH,wBAAgB,qBAAqB,CAAC,WAAW,EAAE,MAAM,EAAE,gBAAgB,EAAE,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,CAQpG;AAED;;;;;;GAMG;AACH,wBAAsB,gBAAgB,CAAC,GAAG,EAAE,MAAM,EAAE,OAAO,EAAE,MAAM,EAAE,MAAM,EAAE,YAAY,GAAG,OAAO,CAAC,MAAM,CAAC,CAO1G"}

package/scripts/build-bigint-buffer.js

@@ -1,49 +0,0 @@
-/**
- * Build Script for bigint-buffer Native Module
- * 
- * Purpose:
- * This script handles the native compilation of the bigint-buffer module, which provides
- * high-performance BigInt <-> Buffer conversions using native C++ code.
- * 
- * Why JavaScript and not TypeScript or an embedded shell script:
- * 1. This is a build script that runs during package installation (postinstall)
- * 2. Using TypeScript would require the TypeScript compiler or ts-node to be available during installation
- * 3. Plain JavaScript ensures this script can run immediately without compilation
- * 4. This script is operating system agnostic, so it can be run on any platform that supports Node.js
- */
-
-const { execSync } = require('child_process');
-const { existsSync } = require('fs');
-const path = require('path');
-
-try {
-  // Check if the bigint-buffer module exists in node_modules
-  // Using path.join for cross-platform compatibility (Windows/Unix)
-  const bigintBufferPath = path.join(process.cwd(), 'node_modules/bigint-buffer');
-  
-  // Skip if module isn't installed
-  if (!existsSync(bigintBufferPath)) {
-    console.log('Skipping bigint-buffer build: folder not found');
-    process.exit(0);
-  }
-
-  // Verify node-gyp (native module build tool) is available
-  // node-gyp is required to compile the C++ code in bigint-buffer
-  try {
-    execSync('command -v node-gyp', { stdio: 'ignore' });
-  } catch {
-    console.log('Skipping bigint-buffer build: node-gyp not found');
-    process.exit(0);
-  }
-
-  // Change to the module directory and run the native build
-  // node-gyp configure: Creates platform-specific build files
-  // node-gyp build: Compiles the native code
-  process.chdir(bigintBufferPath);
-  execSync('node-gyp configure', { stdio: 'inherit' });
-  execSync('node-gyp build', { stdio: 'inherit' });
-} catch (error) {
-  // Proper error handling for build failures
-  console.error('Error building bigint-buffer:', error);
-  process.exit(1);
-} 

package/src/caching/IPFS/PinataIPFSClient.ts

@@ -1,92 +0,0 @@
-import { buildIPFSClient, retrieveValueFromIPFS, storeValueInIPFS } from "../../utils/IPFSUtils";
-import { CachingMechanismInterface } from "../../interfaces";
-import { Struct } from "superstruct";
-import winston from "winston";
-import PinataClient from "@pinata/sdk";
-import { jsonReviverWithBigNumbers, jsonReplacerWithBigNumbers, formattedLog } from "../../utils";
-
-/**
- * A client for interacting with the IPFS. This is a wrapper around the IPFS API.
- * This client also is a part of the caching mechanism interface.
- * @see https://docs.ipfs.io/reference/http/api/
- */
-export class PinataIPFSClient implements CachingMechanismInterface {
-  /**
-   * The IPFS client instance
-   */
-  private client: PinataClient;
-
-  /**
-   * Public IPFS gateway URL to retrieve the content from
-   */
-  private publicGatewayURL: string;
-
-  /**
-   * An optional logger for logging messages
-   */
-  private logger?: winston.Logger;
-
-  public constructor(projectId: string, projectSecret: string, publicGatewayURL: string, logger?: winston.Logger) {
-    this.client = buildIPFSClient(projectId, projectSecret);
-    this.publicGatewayURL = publicGatewayURL;
-    this.logger = logger;
-  }
-
-  /**
-   * Calls to a public IPFS gateway to retrieve a value.
-   * @param key The key to retrieve.
-   * @param _structValidator An optional struct validator to validate the retrieved value. If the value does not match the struct, null is returned.
-   * @returns The value if it exists, otherwise null.
-   */
-  async get<ObjectType>(key?: string, _structValidator?: Struct<unknown, unknown>): Promise<ObjectType | null> {
-    if (!key) {
-      return null;
-    }
-    formattedLog(this.logger, {
-      level: "debug",
-      message: `Retrieving value from IPFS with key ${key}`,
-      at: {
-        location: "IPFSClient",
-        function: "get",
-      },
-    });
-
-    const arrivedResult = await retrieveValueFromIPFS(key, this.publicGatewayURL);
-    if (!arrivedResult) {
-      return null;
-    }
-    const revivedResult = JSON.parse(arrivedResult, jsonReviverWithBigNumbers);
-
-    if (_structValidator && !_structValidator.is(revivedResult)) {
-      formattedLog(this.logger, {
-        level: "warn",
-        message: `Retrieved value from IPFS with key ${key} does not match the expected type`,
-        at: {
-          location: "IPFSClient",
-          function: "get",
-        },
-      });
-      return null;
-    }
-
-    return revivedResult as ObjectType;
-  }
-
-  /**
-   * Stores a value in the IPFS and returns the CID of the value stored.
-   * @param key An optional key to store the value with. This is purely in the metadata of the CID.
-   * @param value The value to store.
-   * @returns The CID of the value stored.
-   */
-  set<T>(key: string, value: T): Promise<string | undefined> {
-    formattedLog(this.logger, {
-      level: "debug",
-      message: `Setting value from IPFS with key ${key}`,
-      at: {
-        location: "IPFSClient",
-        function: "setWithReturnID",
-      },
-    });
-    return storeValueInIPFS(key, JSON.stringify(value, jsonReplacerWithBigNumbers), this.client);
-  }
-}

package/src/caching/IPFS/index.ts

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

package/src/utils/IPFSUtils.ts

@@ -1,45 +0,0 @@
-import PinataClient from "@pinata/sdk";
-import { fetchWithTimeout } from "./FetchUtils";
-
-/**
- * Build an IPFS client for interacting with the IPFS API
- * @param APIKey The project ID
- * @param secretAPIKey The project secret
- * @returns An IPFS client for interacting with Pinata
- */
-export function buildIPFSClient(APIKey: string, secretAPIKey: string): PinataClient {
-  return new PinataClient(APIKey, secretAPIKey);
-}
-
-/**
- * Retrieves a value from an IPFS gateway
- * @param contentHash The content hash of the value to retrieve
- * @param publicGatewayURL The URL of the public IPFS gateway to use
- * @returns The value retrieved from the IPFS gateway
- * @throws Error if the value could not be retrieved
- */
-export function retrieveValueFromIPFS(contentHash: string, publicGatewayURL: string): Promise<string> {
-  return fetchWithTimeout<string>(
-    `${publicGatewayURL}/ipfs/${contentHash}`,
-    {},
-    { Accept: "text/plain" },
-    undefined,
-    "text"
-  );
-}
-
-/**
- * Pins a value to the IPFS network
- * @param key A key to use for pinning the value. This is a metadata field.
- * @param content The value to pin
- * @param client The IPFS client to use
- * @returns The content hash of the pinned value
- */
-export async function storeValueInIPFS(key: string, content: string, client: PinataClient): Promise<string> {
-  const result = await client.pinJSONToIPFS(JSON.parse(content), {
-    pinataMetadata: {
-      name: key,
-    },
-  });
-  return result.IpfsHash;
-}