@alephium/web3 0.5.1 → 0.5.2

package/dist/src/api/explorer-provider.d.ts

@@ -9,7 +9,7 @@ export declare class ExplorerProvider {
     readonly tokens: ExplorerApi<string>['tokens'];
     readonly charts: ExplorerApi<string>['charts'];
     readonly utils: ExplorerApi<string>['utils'];
-    constructor(baseUrl: string, apiKey?: string);
+    constructor(baseUrl: string, apiKey?: string, customFetch?: typeof fetch);
     constructor(provider: ExplorerProvider);
     constructor(handler: ApiRequestHandler);
     request: (args: ApiRequestArguments) => Promise<any>;

package/dist/src/api/explorer-provider.js

@@ -20,23 +20,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ExplorerProvider = void 0;
 const types_1 = require("./types");
 const api_explorer_1 = require("./api-explorer");
-function initializeExplorerApi(baseUrl, apiKey) {
+const utils_1 = require("./utils");
+function initializeExplorerApi(baseUrl, apiKey, customFetch) {
     const explorerApi = new api_explorer_1.Api({
         baseUrl: baseUrl,
         baseApiParams: { secure: true },
-        securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {})
+        securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {}),
+        customFetch: customFetch ?? utils_1.DEFAULT_THROTTLE_FETCH
     });
     explorerApi.setSecurityData(apiKey ?? null);
     return explorerApi;
 }
 class ExplorerProvider {
-    constructor(param0, apiKey) {
+    constructor(param0, apiKey, customFetch) {
         this.request = (args) => {
             return (0, types_1.request)(this, args);
         };
         let explorerApi;
         if (typeof param0 === 'string') {
-            explorerApi = initializeExplorerApi(param0, apiKey);
+            explorerApi = initializeExplorerApi(param0, apiKey, customFetch);
         }
         else if (typeof param0 === 'function') {
             explorerApi = new ExplorerProvider('https://1.2.3.4:0');

package/dist/src/api/index.d.ts

@@ -3,3 +3,4 @@ export * from './explorer-provider';
 export * as node from './api-alephium';
 export * as explorer from './api-explorer';
 export * from './types';
+export * from './utils';

package/dist/src/api/index.js

@@ -49,3 +49,4 @@ __exportStar(require("./explorer-provider"), exports);
 exports.node = __importStar(require("./api-alephium"));
 exports.explorer = __importStar(require("./api-explorer"));
 __exportStar(require("./types"), exports);
+__exportStar(require("./utils"), exports);

package/dist/src/api/node-provider.d.ts

@@ -12,7 +12,7 @@ export declare class NodeProvider {
     readonly utils: NodeApi<string>['utils'];
     readonly miners: NodeApi<string>['miners'];
     readonly events: NodeApi<string>['events'];
-    constructor(baseUrl: string, apiKey?: string);
+    constructor(baseUrl: string, apiKey?: string, customFetch?: typeof fetch);
     constructor(provider: NodeProvider);
     constructor(handler: ApiRequestHandler);
     request: (args: ApiRequestArguments) => Promise<any>;

package/dist/src/api/node-provider.js

@@ -20,23 +20,25 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.NodeProvider = void 0;
 const types_1 = require("./types");
 const api_alephium_1 = require("./api-alephium");
-function initializeNodeApi(baseUrl, apiKey) {
+const utils_1 = require("./utils");
+function initializeNodeApi(baseUrl, apiKey, customFetch) {
     const nodeApi = new api_alephium_1.Api({
         baseUrl: baseUrl,
         baseApiParams: { secure: true },
-        securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {})
+        securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {}),
+        customFetch: customFetch ?? utils_1.DEFAULT_THROTTLE_FETCH
     });
     nodeApi.setSecurityData(apiKey ?? null);
     return nodeApi;
 }
 class NodeProvider {
-    constructor(param0, apiKey) {
+    constructor(param0, apiKey, customFetch) {
         this.request = (args) => {
             return (0, types_1.request)(this, args);
         };
         let nodeApi;
         if (typeof param0 === 'string') {
-            nodeApi = initializeNodeApi(param0, apiKey);
+            nodeApi = initializeNodeApi(param0, apiKey, customFetch);
         }
         else if (typeof param0 === 'function') {
             nodeApi = new NodeProvider('https://1.2.3.4:0');

package/dist/src/api/utils.d.ts

@@ -1,6 +1,12 @@
+import 'cross-fetch/polyfill';
 export declare function convertHttpResponse<T>(response: {
     data: T;
     error?: {
         detail: string;
     };
 }): T;
+export declare function retryFetch(...fetchParams: Parameters<typeof fetch>): ReturnType<typeof fetch>;
+export declare function throttledFetch(ratePerSec: number): typeof fetch;
+export declare const RETRY_LIMIT_WHEN_429 = 3;
+export declare const DEFAULT_RATE_LIMIT = 3;
+export declare const DEFAULT_THROTTLE_FETCH: typeof fetch;

package/dist/src/api/utils.js

@@ -17,13 +17,43 @@ You should have received a copy of the GNU Lesser General Public License
 along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.convertHttpResponse = void 0;
+exports.DEFAULT_THROTTLE_FETCH = exports.DEFAULT_RATE_LIMIT = exports.RETRY_LIMIT_WHEN_429 = exports.throttledFetch = exports.retryFetch = exports.convertHttpResponse = void 0;
+require("cross-fetch/polyfill");
+const utils_1 = require("../utils");
+const async_sema_1 = require("async-sema");
 function convertHttpResponse(response) {
     if (response.error) {
-        throw new Error(`[Node API Error] - ${response.error.detail}`);
+        throw new Error(`[API Error] - ${response.error.detail}`);
     }
     else {
         return response.data;
     }
 }
 exports.convertHttpResponse = convertHttpResponse;
+async function retryFetch(...fetchParams) {
+    const retry = async (retryCount) => {
+        const response = await fetch(...fetchParams);
+        if (response.status === 429 && retryCount < exports.RETRY_LIMIT_WHEN_429) {
+            const nextCount = retryCount + 1;
+            await (0, utils_1.sleep)(nextCount * 500);
+            return await retry(nextCount);
+        }
+        else {
+            return response;
+        }
+    };
+    return retry(0);
+}
+exports.retryFetch = retryFetch;
+function throttledFetch(ratePerSec) {
+    const limit = (0, async_sema_1.RateLimit)(ratePerSec);
+    const customFetch = async (...fetchParams) => {
+        await limit();
+        return retryFetch(...fetchParams);
+    };
+    return customFetch;
+}
+exports.throttledFetch = throttledFetch;
+exports.RETRY_LIMIT_WHEN_429 = 3;
+exports.DEFAULT_RATE_LIMIT = 3;
+exports.DEFAULT_THROTTLE_FETCH = throttledFetch(exports.DEFAULT_RATE_LIMIT);

package/dist/src/global.d.ts

@@ -1,7 +1,7 @@
 import { ExplorerProvider, NodeProvider } from './api';
 export declare function setCurrentNodeProvider(provider: NodeProvider): void;
-export declare function setCurrentNodeProvider(baseUrl: string, apiKey?: string): void;
+export declare function setCurrentNodeProvider(baseUrl: string, apiKey?: string, customFetch?: typeof fetch): void;
 export declare function getCurrentNodeProvider(): NodeProvider;
 export declare function setCurrentExplorerProvider(provider: ExplorerProvider): void;
-export declare function setCurrentExplorerProvider(baseUrl: string, apiKey?: string): void;
+export declare function setCurrentExplorerProvider(baseUrl: string, apiKey?: string, customFetch?: typeof fetch): void;
 export declare function getCurrentExplorerProvider(): ExplorerProvider | undefined;

package/dist/src/global.js

@@ -20,9 +20,9 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCurrentExplorerProvider = exports.setCurrentExplorerProvider = exports.getCurrentNodeProvider = exports.setCurrentNodeProvider = void 0;
 const api_1 = require("./api");
 let _currentNodeProvider = undefined;
-function setCurrentNodeProvider(provider, apiKey) {
+function setCurrentNodeProvider(provider, apiKey, customFetch) {
     if (typeof provider == 'string') {
-        _currentNodeProvider = new api_1.NodeProvider(provider, apiKey);
+        _currentNodeProvider = new api_1.NodeProvider(provider, apiKey, customFetch);
     }
     else {
         _currentNodeProvider = provider;
@@ -37,9 +37,9 @@ function getCurrentNodeProvider() {
 }
 exports.getCurrentNodeProvider = getCurrentNodeProvider;
 let _currentExplorerProvider = undefined;
-function setCurrentExplorerProvider(provider, apiKey) {
+function setCurrentExplorerProvider(provider, apiKey, customFetch) {
     if (typeof provider == 'string') {
-        _currentExplorerProvider = new api_1.ExplorerProvider(provider, apiKey);
+        _currentExplorerProvider = new api_1.ExplorerProvider(provider, apiKey, customFetch);
     }
     else {
         _currentExplorerProvider = provider;

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

@@ -22,7 +22,7 @@ export declare function contractIdFromTx(txId: string, outputIndex: number): str
 export declare function subContractId(parentContractId: string, pathInHex: string, group: number): string;
 export declare function stringToHex(str: string): string;
 export declare function hexToString(str: string): string;
-export declare function timeout(ms: number): Promise<void>;
+export declare function sleep(ms: number): Promise<void>;
 declare type _Eq<X, Y> = (<T>() => T extends X ? 1 : 2) extends <T>() => T extends Y ? 1 : 2 ? true : false;
 export declare type Eq<X, Y> = _Eq<{
     [P in keyof X]: X[P];

package/dist/src/utils/utils.js

@@ -20,7 +20,7 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.assertType = exports.timeout = exports.hexToString = exports.stringToHex = exports.subContractId = exports.contractIdFromTx = exports.addressFromContractId = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.groupOfPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.isHexString = exports.xorByte = exports.signatureDecode = exports.encodeHexSignature = exports.encodeSignature = void 0;
+exports.assertType = exports.sleep = exports.hexToString = exports.stringToHex = exports.subContractId = exports.contractIdFromTx = exports.addressFromContractId = exports.addressFromPublicKey = exports.publicKeyFromPrivateKey = exports.groupOfPrivateKey = exports.binToHex = exports.hexToBinUnsafe = exports.tokenIdFromAddress = exports.contractIdFromAddress = exports.groupOfAddress = exports.isHexString = exports.xorByte = exports.signatureDecode = exports.encodeHexSignature = exports.encodeSignature = void 0;
 const elliptic_1 = require("elliptic");
 const bn_js_1 = __importDefault(require("bn.js"));
 const blakejs_1 = __importDefault(require("blakejs"));
@@ -222,10 +222,10 @@ function hexToString(str) {
     return buffer_1.Buffer.from(str, 'hex').toString();
 }
 exports.hexToString = hexToString;
-function timeout(ms) {
+function sleep(ms) {
     return new Promise((resolve) => setTimeout(resolve, ms));
 }
-exports.timeout = timeout;
+exports.sleep = sleep;
 // eslint-disable-next-line @typescript-eslint/no-empty-function, @typescript-eslint/no-unused-vars
 function assertType() { }
 exports.assertType = assertType;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@alephium/web3",
-  "version": "0.5.1",
+  "version": "0.5.2",
   "description": "A JS/TS library to interact with the Alephium platform",
   "license": "GPL",
   "main": "dist/src/index.js",
@@ -41,6 +41,7 @@
   "type": "commonjs",
   "dependencies": {
     "@noble/secp256k1": "1.7.1",
+    "async-sema": "^3.1.1",
     "base-x": "4.0.0",
     "blakejs": "1.2.1",
     "buffer": "^6.0.3",

package/src/api/explorer-provider.ts

@@ -18,12 +18,14 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 
 import { ApiRequestArguments, ApiRequestHandler, forwardRequests, request } from './types'
 import { Api as ExplorerApi } from './api-explorer'
+import { DEFAULT_THROTTLE_FETCH } from './utils'
 
-function initializeExplorerApi(baseUrl: string, apiKey?: string): ExplorerApi<string> {
+function initializeExplorerApi(baseUrl: string, apiKey?: string, customFetch?: typeof fetch): ExplorerApi<string> {
   const explorerApi = new ExplorerApi<string>({
     baseUrl: baseUrl,
     baseApiParams: { secure: true },
-    securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {})
+    securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {}),
+    customFetch: customFetch ?? DEFAULT_THROTTLE_FETCH
   })
   explorerApi.setSecurityData(apiKey ?? null)
   return explorerApi
@@ -39,13 +41,13 @@ export class ExplorerProvider {
   readonly charts: ExplorerApi<string>['charts']
   readonly utils: ExplorerApi<string>['utils']
 
-  constructor(baseUrl: string, apiKey?: string)
+  constructor(baseUrl: string, apiKey?: string, customFetch?: typeof fetch)
   constructor(provider: ExplorerProvider)
   constructor(handler: ApiRequestHandler)
-  constructor(param0: string | ExplorerProvider | ApiRequestHandler, apiKey?: string) {
+  constructor(param0: string | ExplorerProvider | ApiRequestHandler, apiKey?: string, customFetch?: typeof fetch) {
     let explorerApi: ExplorerProvider
     if (typeof param0 === 'string') {
-      explorerApi = initializeExplorerApi(param0, apiKey)
+      explorerApi = initializeExplorerApi(param0, apiKey, customFetch)
     } else if (typeof param0 === 'function') {
       explorerApi = new ExplorerProvider('https://1.2.3.4:0')
       forwardRequests(explorerApi, param0 as ApiRequestHandler)

package/src/api/index.ts

@@ -21,3 +21,4 @@ export * from './explorer-provider'
 export * as node from './api-alephium'
 export * as explorer from './api-explorer'
 export * from './types'
+export * from './utils'

package/src/api/node-provider.ts

@@ -18,12 +18,14 @@ along with the library. If not, see <http://www.gnu.org/licenses/>.
 
 import { ApiRequestArguments, ApiRequestHandler, forwardRequests, request } from './types'
 import { Api as NodeApi } from './api-alephium'
+import { DEFAULT_THROTTLE_FETCH } from './utils'
 
-function initializeNodeApi(baseUrl: string, apiKey?: string): NodeApi<string> {
+function initializeNodeApi(baseUrl: string, apiKey?: string, customFetch?: typeof fetch): NodeApi<string> {
   const nodeApi = new NodeApi<string>({
     baseUrl: baseUrl,
     baseApiParams: { secure: true },
-    securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {})
+    securityWorker: (accessToken) => (accessToken !== null ? { headers: { 'X-API-KEY': `${accessToken}` } } : {}),
+    customFetch: customFetch ?? DEFAULT_THROTTLE_FETCH
   })
   nodeApi.setSecurityData(apiKey ?? null)
   return nodeApi
@@ -42,13 +44,13 @@ export class NodeProvider {
   readonly miners: NodeApi<string>['miners']
   readonly events: NodeApi<string>['events']
 
-  constructor(baseUrl: string, apiKey?: string)
+  constructor(baseUrl: string, apiKey?: string, customFetch?: typeof fetch)
   constructor(provider: NodeProvider)
   constructor(handler: ApiRequestHandler)
-  constructor(param0: string | NodeProvider | ApiRequestHandler, apiKey?: string) {
+  constructor(param0: string | NodeProvider | ApiRequestHandler, apiKey?: string, customFetch?: typeof fetch) {
     let nodeApi: NodeProvider
     if (typeof param0 === 'string') {
-      nodeApi = initializeNodeApi(param0, apiKey)
+      nodeApi = initializeNodeApi(param0, apiKey, customFetch)
     } else if (typeof param0 === 'function') {
       nodeApi = new NodeProvider('https://1.2.3.4:0')
       forwardRequests(nodeApi, param0 as ApiRequestHandler)

package/src/api/utils.ts

@@ -16,10 +16,41 @@ You should have received a copy of the GNU Lesser General Public License
 along with the library. If not, see <http://www.gnu.org/licenses/>.
 */
 
+import 'cross-fetch/polyfill'
+import { sleep } from '../utils'
+import { RateLimit } from 'async-sema'
+
 export function convertHttpResponse<T>(response: { data: T; error?: { detail: string } }): T {
   if (response.error) {
-    throw new Error(`[Node API Error] - ${response.error.detail}`)
+    throw new Error(`[API Error] - ${response.error.detail}`)
   } else {
     return response.data
   }
 }
+
+export async function retryFetch(...fetchParams: Parameters<typeof fetch>): ReturnType<typeof fetch> {
+  const retry = async (retryCount: number): ReturnType<typeof fetch> => {
+    const response = await fetch(...fetchParams)
+    if (response.status === 429 && retryCount < RETRY_LIMIT_WHEN_429) {
+      const nextCount = retryCount + 1
+      await sleep(nextCount * 500)
+      return await retry(nextCount)
+    } else {
+      return response
+    }
+  }
+  return retry(0)
+}
+
+export function throttledFetch(ratePerSec: number): typeof fetch {
+  const limit = RateLimit(ratePerSec)
+  const customFetch = async (...fetchParams: Parameters<typeof fetch>): ReturnType<typeof fetch> => {
+    await limit()
+    return retryFetch(...fetchParams)
+  }
+  return customFetch
+}
+
+export const RETRY_LIMIT_WHEN_429 = 3
+export const DEFAULT_RATE_LIMIT = 3
+export const DEFAULT_THROTTLE_FETCH = throttledFetch(DEFAULT_RATE_LIMIT)

package/src/global.ts

@@ -21,10 +21,14 @@ import { ExplorerProvider, NodeProvider } from './api'
 let _currentNodeProvider: NodeProvider | undefined = undefined
 
 export function setCurrentNodeProvider(provider: NodeProvider): void
-export function setCurrentNodeProvider(baseUrl: string, apiKey?: string): void
-export function setCurrentNodeProvider(provider: NodeProvider | string, apiKey?: string): void {
+export function setCurrentNodeProvider(baseUrl: string, apiKey?: string, customFetch?: typeof fetch): void
+export function setCurrentNodeProvider(
+  provider: NodeProvider | string,
+  apiKey?: string,
+  customFetch?: typeof fetch
+): void {
   if (typeof provider == 'string') {
-    _currentNodeProvider = new NodeProvider(provider, apiKey)
+    _currentNodeProvider = new NodeProvider(provider, apiKey, customFetch)
   } else {
     _currentNodeProvider = provider
   }
@@ -40,10 +44,14 @@ export function getCurrentNodeProvider(): NodeProvider {
 let _currentExplorerProvider: ExplorerProvider | undefined = undefined
 
 export function setCurrentExplorerProvider(provider: ExplorerProvider): void
-export function setCurrentExplorerProvider(baseUrl: string, apiKey?: string): void
-export function setCurrentExplorerProvider(provider: ExplorerProvider | string, apiKey?: string): void {
+export function setCurrentExplorerProvider(baseUrl: string, apiKey?: string, customFetch?: typeof fetch): void
+export function setCurrentExplorerProvider(
+  provider: ExplorerProvider | string,
+  apiKey?: string,
+  customFetch?: typeof fetch
+): void {
   if (typeof provider == 'string') {
-    _currentExplorerProvider = new ExplorerProvider(provider, apiKey)
+    _currentExplorerProvider = new ExplorerProvider(provider, apiKey, customFetch)
   } else {
     _currentExplorerProvider = provider
   }

package/src/utils/utils.ts

@@ -227,7 +227,7 @@ export function hexToString(str: string): string {
   return Buffer.from(str, 'hex').toString()
 }
 
-export function timeout(ms: number): Promise<void> {
+export function sleep(ms: number): Promise<void> {
   return new Promise((resolve) => setTimeout(resolve, ms))
 }