@upcoming/multichain-library 0.1.1 → 0.2.0

package/README.md

@@ -0,0 +1,52 @@
+# Multichain Library
+
+This repository contains a collection of cross-environment functions that are helpful for building swap and token transfer logic.
+
+# Getting Started
+
+## Installation
+
+```
+npm install @upcoming/multichain-library
+```
+
+## Usage
+
+Create an instance of the library:
+
+```ts
+const library = new MultichainLibrary(settings)
+```
+
+`settings` is optional, supporting:
+
+-   `gnosisJsonRpc`
+-   `fetchTimeoutMillis`
+
+# Functions
+
+## Nonce helpers
+
+-   `getGnosisTransactionCount(address: string): Promise<number>`
+
+## Balance getters
+
+-   `getGnosisBzzBalance(address: string): Promise<FixedPointNumber>`
+-   `getGnosisNativeBalance(address: string): Promise<FixedPointNumber>`
+
+## Price getters
+
+-   `getTokenPrice(tokenAddress: string, chainId: number): Promise<number>`
+-   `getGnosisBzzTokenPrice(): Promise<number>`
+
+## Waiters
+
+-   `waitForGnosisBzzBalanceToIncrease(address: string, initialBalance: bigint): Promise<void>`
+-   `waitForGnosisNativeBalanceToDecrease(address: string, initialBalance: bigint): Promise<void>`
+-   `waitForGnosisNativeBalanceToIncrease(address: string, initialBalance: bigint): Promise<void>`
+
+## SushiSwap helpers
+
+-   `getSushiSwapQuote(amount: string, sender: string, recipient: string): Promise<SushiResponse>`
+-   `swapOnGnosisCustom(options: GnosisSwapCustomOptions): Promise<string>`
+-   `swapOnGnosisAuto(options: GnosisSwapAutoOptions): Promise<string>`

package/dist/Fetch.d.ts

@@ -0,0 +1,3 @@
+import { RollingValueProvider } from 'cafe-utility';
+import { MultichainLibrarySettings } from './Settings';
+export declare function durableFetch(jsonRpcProvider: RollingValueProvider<string>, settings: MultichainLibrarySettings, method: 'GET' | 'POST', body?: unknown): Promise<Response>;

package/dist/Fetch.js

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.durableFetch = durableFetch;
+const cafe_utility_1 = require("cafe-utility");
+async function durableFetch(jsonRpcProvider, settings, method, body) {
+    const response = await cafe_utility_1.System.withRetries(async () => {
+        const response = await fetch(jsonRpcProvider.current(), {
+            method,
+            headers: { 'Content-Type': 'application/json' },
+            body: body ? JSON.stringify(body) : undefined,
+            signal: AbortSignal.timeout(settings.fetchTimeoutMillis)
+        });
+        return response;
+    }, 5, cafe_utility_1.Dates.seconds(1), cafe_utility_1.Dates.seconds(5), console.error, () => jsonRpcProvider.next());
+    return response;
+}

package/dist/GnosisBzzBalance.d.ts

@@ -1,3 +1,3 @@
-import { FixedPointNumber } from 'cafe-utility';
+import { FixedPointNumber, RollingValueProvider } from 'cafe-utility';
 import { MultichainLibrarySettings } from './Settings';
-export declare function getGnosisBzzBalance(address: string, settings: MultichainLibrarySettings): Promise<FixedPointNumber>;
+export declare function getGnosisBzzBalance(address: string, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<FixedPointNumber>;

package/dist/GnosisBzzBalance.js

@@ -3,7 +3,8 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.getGnosisBzzBalance = getGnosisBzzBalance;
 const cafe_utility_1 = require("cafe-utility");
 const Constants_1 = require("./Constants");
-async function getGnosisBzzBalance(address, settings) {
+const Fetch_1 = require("./Fetch");
+async function getGnosisBzzBalance(address, settings, jsonRpcProvider) {
     address = address.toLowerCase();
     if (address.startsWith('0x')) {
         address = address.slice(2);
@@ -21,12 +22,7 @@ async function getGnosisBzzBalance(address, settings) {
             'latest'
         ]
     };
-    const response = await fetch(settings.gnosisJsonRpc, {
-        method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify(payload),
-        signal: AbortSignal.timeout(settings.fetchTimeoutMillis)
-    });
+    const response = await (0, Fetch_1.durableFetch)(jsonRpcProvider, settings, 'POST', payload);
     const data = await response.json();
     const object = cafe_utility_1.Types.asObject(data);
     const balance = cafe_utility_1.Types.asHexString(object.result, { strictPrefix: true, uneven: true });

package/dist/GnosisNativeBalance.d.ts

@@ -1,3 +1,3 @@
-import { FixedPointNumber } from 'cafe-utility';
+import { FixedPointNumber, RollingValueProvider } from 'cafe-utility';
 import { MultichainLibrarySettings } from './Settings';
-export declare function getGnosisNativeBalance(address: `0x${string}`, settings: MultichainLibrarySettings): Promise<FixedPointNumber>;
+export declare function getGnosisNativeBalance(address: `0x${string}`, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<FixedPointNumber>;

package/dist/GnosisNativeBalance.js

@@ -2,14 +2,10 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getGnosisNativeBalance = getGnosisNativeBalance;
 const cafe_utility_1 = require("cafe-utility");
-async function getGnosisNativeBalance(address, settings) {
+const Fetch_1 = require("./Fetch");
+async function getGnosisNativeBalance(address, settings, jsonRpcProvider) {
     const payload = { jsonrpc: '2.0', id: 1, method: 'eth_getBalance', params: [address, 'latest'] };
-    const response = await fetch(settings.gnosisJsonRpc, {
-        method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify(payload),
-        signal: AbortSignal.timeout(settings.fetchTimeoutMillis)
-    });
+    const response = await (0, Fetch_1.durableFetch)(jsonRpcProvider, settings, 'POST', payload);
     const data = await response.json();
     const object = cafe_utility_1.Types.asObject(data);
     const price = cafe_utility_1.Types.asHexString(object.result, { strictPrefix: true, uneven: true });

package/dist/GnosisNativeTransfer.d.ts

@@ -1,3 +1,4 @@
+import { RollingValueProvider } from 'cafe-utility';
 import { MultichainLibrarySettings } from './Settings';
 export interface TransferGnosisNativeOptions {
     amount: string | bigint;
@@ -5,4 +6,4 @@ export interface TransferGnosisNativeOptions {
     originAddress: `0x${string}`;
     to: `0x${string}`;
 }
-export declare function transferGnosisNative(options: TransferGnosisNativeOptions, settings: MultichainLibrarySettings): Promise<`0x${string}`>;
+export declare function transferGnosisNative(options: TransferGnosisNativeOptions, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<`0x${string}`>;

package/dist/GnosisNativeTransfer.js

@@ -7,23 +7,36 @@ const accounts_1 = require("viem/accounts");
 const chains_1 = require("viem/chains");
 const Constants_1 = require("./Constants");
 const GnosisTransactionCount_1 = require("./GnosisTransactionCount");
-async function transferGnosisNative(options, settings) {
+async function transferGnosisNative(options, settings, jsonRpcProvider) {
     const account = (0, accounts_1.privateKeyToAccount)(options.originPrivateKey);
     const client = (0, viem_1.createWalletClient)({
         chain: chains_1.gnosis,
-        transport: (0, viem_1.http)(settings.gnosisJsonRpc)
+        transport: (0, viem_1.http)(jsonRpcProvider.current())
     });
-    return account
-        .signTransaction({
-        chain: Constants_1.Constants.gnosisChainId,
-        chainId: Constants_1.Constants.gnosisChainId,
-        account: options.originAddress,
-        gas: BigInt(21000),
-        gasPrice: BigInt(cafe_utility_1.Numbers.make('1 gwei')),
-        type: 'legacy',
-        to: options.to,
-        value: BigInt(options.amount),
-        nonce: await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(options.originAddress, settings)
-    })
-        .then(signedTx => client.sendRawTransaction({ serializedTransaction: signedTx }));
+    for (let i = 1; i <= 5; i++) {
+        try {
+            const serializedTransaction = await account.signTransaction({
+                chain: Constants_1.Constants.gnosisChainId,
+                chainId: Constants_1.Constants.gnosisChainId,
+                account: options.originAddress,
+                gas: BigInt(21000),
+                gasPrice: BigInt(cafe_utility_1.Numbers.make(`${i} gwei`)),
+                type: 'legacy',
+                to: options.to,
+                value: BigInt(options.amount),
+                nonce: await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(options.originAddress, settings, jsonRpcProvider)
+            });
+            const hash = await client.sendRawTransaction({ serializedTransaction });
+            return hash;
+        }
+        catch (error) {
+            if (cafe_utility_1.Objects.errorMatches(error, 'FeeTooLow')) {
+                await cafe_utility_1.System.sleepMillis(cafe_utility_1.Dates.seconds(2));
+            }
+            else {
+                throw error;
+            }
+        }
+    }
+    throw Error('Failed to send transaction after multiple attempts due to low fees.');
 }

package/dist/GnosisSwap.d.ts

@@ -1,3 +1,4 @@
+import { RollingValueProvider } from 'cafe-utility';
 import { MultichainLibrarySettings } from './Settings';
 export interface GnosisSwapAutoOptions {
     amount: string | bigint;
@@ -5,7 +6,7 @@ export interface GnosisSwapAutoOptions {
     originAddress: `0x${string}`;
     to: `0x${string}`;
 }
-export declare function swapOnGnosisAuto(options: GnosisSwapAutoOptions, settings: MultichainLibrarySettings): Promise<`0x${string}`>;
+export declare function swapOnGnosisAuto(options: GnosisSwapAutoOptions, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<`0x${string}`>;
 export interface GnosisSwapCustomOptions {
     originPrivateKey: `0x${string}`;
     originAddress: `0x${string}`;
@@ -15,4 +16,4 @@ export interface GnosisSwapCustomOptions {
     value: bigint | string | number;
     data: `0x${string}`;
 }
-export declare function swapOnGnosisCustom(options: GnosisSwapCustomOptions, settings: MultichainLibrarySettings): Promise<`0x${string}`>;
+export declare function swapOnGnosisCustom(options: GnosisSwapCustomOptions, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<`0x${string}`>;

package/dist/GnosisSwap.js

@@ -8,7 +8,7 @@ const chains_1 = require("viem/chains");
 const Constants_1 = require("./Constants");
 const GnosisTransactionCount_1 = require("./GnosisTransactionCount");
 const SushiSwap_1 = require("./SushiSwap");
-async function swapOnGnosisAuto(options, settings) {
+async function swapOnGnosisAuto(options, settings, jsonRpcProvider) {
     const quote = await (0, SushiSwap_1.getSushiSwapQuote)(options.amount.toString(), options.originAddress, options.to, settings);
     return swapOnGnosisCustom({
         originPrivateKey: options.originPrivateKey,
@@ -18,11 +18,11 @@ async function swapOnGnosisAuto(options, settings) {
         to: quote.tx.to,
         value: BigInt(quote.tx.value),
         data: quote.tx.data
-    }, settings);
+    }, settings, jsonRpcProvider);
 }
-async function swapOnGnosisCustom(options, settings) {
+async function swapOnGnosisCustom(options, settings, jsonRpcProvider) {
     const account = (0, accounts_1.privateKeyToAccount)(options.originPrivateKey);
-    const client = (0, viem_1.createWalletClient)({ chain: chains_1.gnosis, transport: (0, viem_1.http)(settings.gnosisJsonRpc) });
+    const client = (0, viem_1.createWalletClient)({ chain: chains_1.gnosis, transport: (0, viem_1.http)(jsonRpcProvider.current()) });
     return account
         .signTransaction({
         chain: Constants_1.Constants.gnosisChainId,
@@ -34,7 +34,7 @@ async function swapOnGnosisCustom(options, settings) {
         to: options.to,
         value: BigInt(options.value),
         data: options.data,
-        nonce: await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(options.originAddress, settings)
+        nonce: await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(options.originAddress, settings, jsonRpcProvider)
     })
         .then(signedTx => client.sendRawTransaction({ serializedTransaction: signedTx }));
 }

package/dist/GnosisTransactionCount.d.ts

@@ -1,2 +1,3 @@
+import { RollingValueProvider } from 'cafe-utility';
 import { MultichainLibrarySettings } from './Settings';
-export declare function getGnosisTransactionCount(address: string, settings: MultichainLibrarySettings): Promise<number>;
+export declare function getGnosisTransactionCount(address: string, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<number>;

package/dist/GnosisTransactionCount.js

@@ -2,7 +2,8 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getGnosisTransactionCount = getGnosisTransactionCount;
 const cafe_utility_1 = require("cafe-utility");
-async function getGnosisTransactionCount(address, settings) {
+const Fetch_1 = require("./Fetch");
+async function getGnosisTransactionCount(address, settings, jsonRpcProvider) {
     address = address.toLowerCase();
     if (address.startsWith('0x')) {
         address = address.slice(2);
@@ -13,12 +14,7 @@ async function getGnosisTransactionCount(address, settings) {
         method: 'eth_getTransactionCount',
         params: [`0x${address}`, 'latest']
     };
-    const response = await fetch(settings.gnosisJsonRpc, {
-        method: 'POST',
-        headers: { 'Content-Type': 'application/json' },
-        body: JSON.stringify(payload),
-        signal: AbortSignal.timeout(settings.fetchTimeoutMillis)
-    });
+    const response = await (0, Fetch_1.durableFetch)(jsonRpcProvider, settings, 'POST', payload);
     const data = await response.json();
     const object = cafe_utility_1.Types.asObject(data);
     const count = cafe_utility_1.Types.asHexString(object.result, { strictPrefix: true, uneven: true });

package/dist/Settings.d.ts

@@ -1,8 +1,8 @@
 export interface MultichainLibrarySettings {
-    gnosisJsonRpc: string;
+    gnosisJsonRpcProviders: string[];
     fetchTimeoutMillis: number;
 }
 export declare function getDefaultMultichainLibrarySettings(): {
-    gnosisJsonRpc: string;
+    gnosisJsonRpcProviders: string[];
     fetchTimeoutMillis: number;
 };

package/dist/Settings.js

@@ -4,7 +4,7 @@ exports.getDefaultMultichainLibrarySettings = getDefaultMultichainLibrarySetting
 const cafe_utility_1 = require("cafe-utility");
 function getDefaultMultichainLibrarySettings() {
     return {
-        gnosisJsonRpc: 'https://xdai.fairdatasociety.org/',
-        fetchTimeoutMillis: cafe_utility_1.Dates.seconds(10)
+        gnosisJsonRpcProviders: ['https://rpc.gnosischain.com', 'https://xdai.fairdatasociety.org'],
+        fetchTimeoutMillis: cafe_utility_1.Dates.seconds(12)
     };
 }

package/dist/Waiter.d.ts

@@ -1,4 +1,5 @@
+import { RollingValueProvider } from 'cafe-utility';
 import { MultichainLibrarySettings } from './Settings';
-export declare function waitForGnosisBzzBalanceToIncrease(address: string, initialBalance: bigint, settings: MultichainLibrarySettings): Promise<void>;
-export declare function waitForGnosisNativeBalanceToDecrease(address: `0x${string}`, initialBalance: bigint, settings: MultichainLibrarySettings): Promise<void>;
-export declare function waitForGnosisNativeBalanceToIncrease(address: `0x${string}`, initialBalance: bigint, settings: MultichainLibrarySettings): Promise<void>;
+export declare function waitForGnosisBzzBalanceToIncrease(address: string, initialBalance: bigint, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<void>;
+export declare function waitForGnosisNativeBalanceToDecrease(address: `0x${string}`, initialBalance: bigint, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<void>;
+export declare function waitForGnosisNativeBalanceToIncrease(address: `0x${string}`, initialBalance: bigint, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<void>;

package/dist/Waiter.js

@@ -6,10 +6,10 @@ exports.waitForGnosisNativeBalanceToIncrease = waitForGnosisNativeBalanceToIncre
 const cafe_utility_1 = require("cafe-utility");
 const GnosisBzzBalance_1 = require("./GnosisBzzBalance");
 const GnosisNativeBalance_1 = require("./GnosisNativeBalance");
-async function waitForGnosisBzzBalanceToIncrease(address, initialBalance, settings) {
+async function waitForGnosisBzzBalanceToIncrease(address, initialBalance, settings, jsonRpcProvider) {
     await cafe_utility_1.System.waitFor(async () => {
         try {
-            const balance = await (0, GnosisBzzBalance_1.getGnosisBzzBalance)(address, settings);
+            const balance = await (0, GnosisBzzBalance_1.getGnosisBzzBalance)(address, settings, jsonRpcProvider);
             return balance.value > initialBalance;
         }
         catch (error) {
@@ -18,10 +18,10 @@ async function waitForGnosisBzzBalanceToIncrease(address, initialBalance, settin
         }
     }, { attempts: 20, waitMillis: cafe_utility_1.Dates.seconds(15) });
 }
-async function waitForGnosisNativeBalanceToDecrease(address, initialBalance, settings) {
+async function waitForGnosisNativeBalanceToDecrease(address, initialBalance, settings, jsonRpcProvider) {
     await cafe_utility_1.System.waitFor(async () => {
         try {
-            const balance = await (0, GnosisNativeBalance_1.getGnosisNativeBalance)(address, settings);
+            const balance = await (0, GnosisNativeBalance_1.getGnosisNativeBalance)(address, settings, jsonRpcProvider);
             return balance.value < initialBalance;
         }
         catch (error) {
@@ -30,10 +30,10 @@ async function waitForGnosisNativeBalanceToDecrease(address, initialBalance, set
         }
     }, { attempts: 20, waitMillis: cafe_utility_1.Dates.seconds(15) });
 }
-async function waitForGnosisNativeBalanceToIncrease(address, initialBalance, settings) {
+async function waitForGnosisNativeBalanceToIncrease(address, initialBalance, settings, jsonRpcProvider) {
     await cafe_utility_1.System.waitFor(async () => {
         try {
-            const balance = await (0, GnosisNativeBalance_1.getGnosisNativeBalance)(address, settings);
+            const balance = await (0, GnosisNativeBalance_1.getGnosisNativeBalance)(address, settings, jsonRpcProvider);
             return balance.value > initialBalance;
         }
         catch (error) {

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { FixedPointNumber } from 'cafe-utility';
+import { FixedPointNumber, RollingValueProvider } from 'cafe-utility';
 import { Constants } from './Constants';
 import { TransferGnosisNativeOptions } from './GnosisNativeTransfer';
 import { GnosisSwapAutoOptions, GnosisSwapCustomOptions } from './GnosisSwap';
@@ -8,6 +8,7 @@ export { MultichainLibrarySettings } from './Settings';
 export { SushiResponse } from './SushiSwap';
 export declare class MultichainLibrary {
     settings: MultichainLibrarySettings;
+    jsonRpcProvider: RollingValueProvider<string>;
     constants: typeof Constants;
     constructor(settings?: Partial<MultichainLibrarySettings>);
     getGnosisBzzBalance(address: string): Promise<FixedPointNumber>;

package/dist/index.js

@@ -14,15 +14,17 @@ const TokenPrice_1 = require("./TokenPrice");
 const Waiter_1 = require("./Waiter");
 class MultichainLibrary {
     settings;
+    jsonRpcProvider;
     constants = Constants_1.Constants;
     constructor(settings) {
         this.settings = cafe_utility_1.Objects.deepMerge2((0, Settings_1.getDefaultMultichainLibrarySettings)(), settings || {});
+        this.jsonRpcProvider = new cafe_utility_1.RollingValueProvider(this.settings.gnosisJsonRpcProviders);
     }
     getGnosisBzzBalance(address) {
-        return (0, GnosisBzzBalance_1.getGnosisBzzBalance)(address, this.settings);
+        return (0, GnosisBzzBalance_1.getGnosisBzzBalance)(address, this.settings, this.jsonRpcProvider);
     }
     getGnosisNativeBalance(address) {
-        return (0, GnosisNativeBalance_1.getGnosisNativeBalance)(address, this.settings);
+        return (0, GnosisNativeBalance_1.getGnosisNativeBalance)(address, this.settings, this.jsonRpcProvider);
     }
     getTokenPrice(tokenAddress, chainId) {
         return (0, TokenPrice_1.getTokenPrice)(tokenAddress, chainId, this.settings);
@@ -31,25 +33,25 @@ class MultichainLibrary {
         return (0, TokenPrice_1.getGnosisBzzTokenPrice)(this.settings);
     }
     transferGnosisNative(options) {
-        return (0, GnosisNativeTransfer_1.transferGnosisNative)(options, this.settings);
+        return (0, GnosisNativeTransfer_1.transferGnosisNative)(options, this.settings, this.jsonRpcProvider);
     }
     waitForGnosisBzzBalanceToIncrease(address, initialBalance) {
-        return (0, Waiter_1.waitForGnosisBzzBalanceToIncrease)(address, initialBalance, this.settings);
+        return (0, Waiter_1.waitForGnosisBzzBalanceToIncrease)(address, initialBalance, this.settings, this.jsonRpcProvider);
     }
     waitForGnosisNativeBalanceToDecrease(address, initialBalance) {
-        return (0, Waiter_1.waitForGnosisNativeBalanceToDecrease)(address, initialBalance, this.settings);
+        return (0, Waiter_1.waitForGnosisNativeBalanceToDecrease)(address, initialBalance, this.settings, this.jsonRpcProvider);
     }
     waitForGnosisNativeBalanceToIncrease(address, initialBalance) {
-        return (0, Waiter_1.waitForGnosisNativeBalanceToIncrease)(address, initialBalance, this.settings);
+        return (0, Waiter_1.waitForGnosisNativeBalanceToIncrease)(address, initialBalance, this.settings, this.jsonRpcProvider);
     }
     swapOnGnosisAuto(options) {
-        return (0, GnosisSwap_1.swapOnGnosisAuto)(options, this.settings);
+        return (0, GnosisSwap_1.swapOnGnosisAuto)(options, this.settings, this.jsonRpcProvider);
     }
     swapOnGnosisCustom(options) {
-        return (0, GnosisSwap_1.swapOnGnosisCustom)(options, this.settings);
+        return (0, GnosisSwap_1.swapOnGnosisCustom)(options, this.settings, this.jsonRpcProvider);
     }
     getGnosisTransactionCount(address) {
-        return (0, GnosisTransactionCount_1.getGnosisTransactionCount)(address, this.settings);
+        return (0, GnosisTransactionCount_1.getGnosisTransactionCount)(address, this.settings, this.jsonRpcProvider);
     }
     getSushiSwapQuote(amount, sender, recipient) {
         return (0, SushiSwap_1.getSushiSwapQuote)(amount, sender, recipient, this.settings);

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@upcoming/multichain-library",
     "private": false,
-    "version": "0.1.1",
+    "version": "0.2.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "exports": {
@@ -18,7 +18,7 @@
     "license": "ISC",
     "description": "",
     "dependencies": {
-        "cafe-utility": "^33.0.0",
+        "cafe-utility": "^33.3.1",
         "viem": "^2.38.2"
     },
     "devDependencies": {