@upcoming/multichain-library 0.7.3 → 0.9.0

package/README.md

@@ -20,11 +20,16 @@ const library = new MultichainLibrary(settings)
 
 `settings` is optional, supporting:
 
--   `gnosisJsonRpc`
--   `fetchTimeoutMillis`
+-   `gnosisJsonRpc`: `string[]`
+-   `fetchTimeoutMillis`: `number`
 
 # Functions
 
+## Transaction helpers
+
+-   `getGnosisTransaction(txHash: string): Promise<GnosisTransaction>`
+-   `getGnosisTransactionReceipt(txHash: string): Promise<GnosisTransactionReceipt>`
+
 ## Nonce helpers
 
 -   `getGnosisTransactionCount(address: string): Promise<number>`
@@ -44,6 +49,7 @@ const library = new MultichainLibrary(settings)
 -   `waitForGnosisBzzBalanceToIncrease(address: string, initialBalance: bigint): Promise<void>`
 -   `waitForGnosisNativeBalanceToDecrease(address: string, initialBalance: bigint): Promise<void>`
 -   `waitForGnosisNativeBalanceToIncrease(address: string, initialBalance: bigint): Promise<void>`
+-   `waitForGnosisTransactionReceipt(txHash: string): Promise<void>`
 
 ## SushiSwap helpers
 
@@ -56,15 +62,18 @@ const library = new MultichainLibrary(settings)
 -   `transferGnosisBzz(options: GnosisBzzTransferOptions): Promise<string>`
 -   `transferGnosisNative(options: GnosisNativeTransferOptions): Promise<string>`
 
-In both cases, `options` is:
+In both cases, `options` is an object:
 
 ```ts
-amount: string | bigint
-originPrivateKey: `0x${string}`
-to: `0x${string}`
-nonce?: number
+{
+    amount: string | bigint
+    originPrivateKey: `0x${string}`
+    to: `0x${string}`
+    nonce?: number
+}
 ```
 
 ## BZZ helpers
 
 -   `approveGnosisBzz(options: ApproveGnosisBzzOptions): Promise<string>`
+-   `createBatchGnosis(options: CreateBatchGnosisOptions): Promise<CreateBatchResult>`

package/dist/GnosisTransaction.d.ts

@@ -12,3 +12,17 @@ export interface GnosisTransaction {
     gasPrice: `0x${string}`;
 }
 export declare function getGnosisTransaction(transactionHash: `0x${string}`, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<GnosisTransaction>;
+export interface GnosisTransactionReceipt {
+    blockHash: `0x${string}`;
+    blockNumber: `0x${string}`;
+    cumulativeGasUsed: `0x${string}`;
+    effectiveGasPrice: `0x${string}`;
+    from: `0x${string}`;
+    gasUsed: `0x${string}`;
+    status: `0x${string}`;
+    to: `0x${string}`;
+    transactionHash: `0x${string}`;
+    transactionIndex: `0x${string}`;
+    type: `0x${string}`;
+}
+export declare function getGnosisTransactionReceipt(transactionHash: `0x${string}`, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<GnosisTransactionReceipt>;

package/dist/GnosisTransaction.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getGnosisTransaction = getGnosisTransaction;
+exports.getGnosisTransactionReceipt = getGnosisTransactionReceipt;
 const cafe_utility_1 = require("cafe-utility");
 const Fetch_1 = require("./Fetch");
 async function getGnosisTransaction(transactionHash, settings, jsonRpcProvider) {
@@ -11,3 +12,11 @@ async function getGnosisTransaction(transactionHash, settings, jsonRpcProvider)
     const result = cafe_utility_1.Types.asObject(object.result);
     return result;
 }
+async function getGnosisTransactionReceipt(transactionHash, settings, jsonRpcProvider) {
+    const payload = { jsonrpc: '2.0', id: 1, method: 'eth_getTransactionReceipt', params: [transactionHash] };
+    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 result = cafe_utility_1.Types.asObject(object.result);
+    return result;
+}

package/dist/Waiter.d.ts

@@ -1,5 +1,6 @@
 import { RollingValueProvider } from 'cafe-utility';
 import { MultichainLibrarySettings } from './Settings';
+export declare function waitForGnosisTransactionReceipt(transactionHash: `0x${string}`, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): 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

@@ -1,11 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.waitForGnosisTransactionReceipt = waitForGnosisTransactionReceipt;
 exports.waitForGnosisBzzBalanceToIncrease = waitForGnosisBzzBalanceToIncrease;
 exports.waitForGnosisNativeBalanceToDecrease = waitForGnosisNativeBalanceToDecrease;
 exports.waitForGnosisNativeBalanceToIncrease = waitForGnosisNativeBalanceToIncrease;
 const cafe_utility_1 = require("cafe-utility");
 const GnosisBzzBalance_1 = require("./GnosisBzzBalance");
 const GnosisNativeBalance_1 = require("./GnosisNativeBalance");
+const GnosisTransaction_1 = require("./GnosisTransaction");
+async function waitForGnosisTransactionReceipt(transactionHash, settings, jsonRpcProvider) {
+    await cafe_utility_1.System.waitFor(async () => {
+        const result = await (0, GnosisTransaction_1.getGnosisTransactionReceipt)(transactionHash, settings, jsonRpcProvider);
+        const status = parseInt(result.status);
+        if (status === 0) {
+            console.log('Transaction receipt indicates possible failure:', result);
+        }
+        return status === 1;
+    }, { attempts: 10, waitMillis: cafe_utility_1.Dates.seconds(10) });
+}
 async function waitForGnosisBzzBalanceToIncrease(address, initialBalance, settings, jsonRpcProvider) {
     await cafe_utility_1.System.waitFor(async () => {
         try {

package/dist/index.d.ts

@@ -5,12 +5,14 @@ import { TransferGnosisBzzOptions } from './GnosisBzzTransfer';
 import { TransferGnosisNativeOptions } from './GnosisNativeTransfer';
 import { CreateBatchGnosisOptions, CreateBatchResult } from './GnosisPostageStampCreateBatch';
 import { GnosisSwapAutoOptions, GnosisSwapCustomOptions } from './GnosisSwap';
-import { GnosisTransaction } from './GnosisTransaction';
+import { GnosisTransaction, GnosisTransactionReceipt } from './GnosisTransaction';
 import { MultiTransferGnosisNativeOptions, MultiTransferGnosisNativeResult } from './MultiGnosisNativeTransfer';
 import { MultichainLibrarySettings } from './Settings';
 import { SushiResponse } from './SushiSwap';
 export { MultichainLibrarySettings } from './Settings';
 export { SushiResponse } from './SushiSwap';
+export { xBZZ } from './xBZZ';
+export { xDAI } from './xDAI';
 export declare class MultichainLibrary {
     settings: MultichainLibrarySettings;
     jsonRpcProvider: RollingValueProvider<string>;
@@ -18,6 +20,7 @@ export declare class MultichainLibrary {
     constructor(settings?: Partial<MultichainLibrarySettings>);
     updateSettings(settings: Partial<MultichainLibrarySettings>): void;
     getGnosisTransaction(transactionHash: `0x${string}`): Promise<GnosisTransaction>;
+    getGnosisTransactionReceipt(transactionHash: `0x${string}`): Promise<GnosisTransactionReceipt>;
     getGnosisBzzBalance(address: string): Promise<FixedPointNumber>;
     getGnosisNativeBalance(address: `0x${string}`): Promise<FixedPointNumber>;
     getTokenPrice(tokenAddress: `0x${string}`, chainId: number): Promise<number>;
@@ -31,6 +34,7 @@ export declare class MultichainLibrary {
     waitForGnosisBzzBalanceToIncrease(address: string, initialBalance: bigint): Promise<void>;
     waitForGnosisNativeBalanceToDecrease(address: `0x${string}`, initialBalance: bigint): Promise<void>;
     waitForGnosisNativeBalanceToIncrease(address: `0x${string}`, initialBalance: bigint): Promise<void>;
+    waitForGnosisTransactionReceipt(txHash: `0x${string}`): Promise<void>;
     swapOnGnosisAuto(options: GnosisSwapAutoOptions): Promise<`0x${string}`>;
     swapOnGnosisCustom(options: GnosisSwapCustomOptions): Promise<`0x${string}`>;
     getGnosisTransactionCount(address: `0x${string}`): Promise<number>;

package/dist/index.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.MultichainLibrary = void 0;
+exports.MultichainLibrary = exports.xDAI = exports.xBZZ = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const Constants_1 = require("./Constants");
 const GnosisBzzApprove_1 = require("./GnosisBzzApprove");
@@ -18,6 +18,10 @@ const Settings_1 = require("./Settings");
 const SushiSwap_1 = require("./SushiSwap");
 const TokenPrice_1 = require("./TokenPrice");
 const Waiter_1 = require("./Waiter");
+var xBZZ_1 = require("./xBZZ");
+Object.defineProperty(exports, "xBZZ", { enumerable: true, get: function () { return xBZZ_1.xBZZ; } });
+var xDAI_1 = require("./xDAI");
+Object.defineProperty(exports, "xDAI", { enumerable: true, get: function () { return xDAI_1.xDAI; } });
 class MultichainLibrary {
     settings;
     jsonRpcProvider;
@@ -33,6 +37,9 @@ class MultichainLibrary {
     getGnosisTransaction(transactionHash) {
         return (0, GnosisTransaction_1.getGnosisTransaction)(transactionHash, this.settings, this.jsonRpcProvider);
     }
+    getGnosisTransactionReceipt(transactionHash) {
+        return (0, GnosisTransaction_1.getGnosisTransactionReceipt)(transactionHash, this.settings, this.jsonRpcProvider);
+    }
     getGnosisBzzBalance(address) {
         return (0, GnosisBzzBalance_1.getGnosisBzzBalance)(address, this.settings, this.jsonRpcProvider);
     }
@@ -72,6 +79,9 @@ class MultichainLibrary {
     waitForGnosisNativeBalanceToIncrease(address, initialBalance) {
         return (0, Waiter_1.waitForGnosisNativeBalanceToIncrease)(address, initialBalance, this.settings, this.jsonRpcProvider);
     }
+    waitForGnosisTransactionReceipt(txHash) {
+        return (0, Waiter_1.waitForGnosisTransactionReceipt)(txHash, this.settings, this.jsonRpcProvider);
+    }
     swapOnGnosisAuto(options) {
         return (0, GnosisSwap_1.swapOnGnosisAuto)(options, this.settings, this.jsonRpcProvider);
     }

package/dist/xBZZ.d.ts

@@ -0,0 +1,7 @@
+import { FixedPointNumber } from 'cafe-utility';
+export declare class xBZZ extends FixedPointNumber {
+    static DECIMALS: number;
+    static fromDecimalString(decimalString: string): FixedPointNumber;
+    static fromFloat(value: number): FixedPointNumber;
+    constructor(value: bigint | number | string);
+}

package/dist/xBZZ.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.xBZZ = void 0;
+const cafe_utility_1 = require("cafe-utility");
+class xBZZ extends cafe_utility_1.FixedPointNumber {
+    static DECIMALS = 16;
+    static fromDecimalString(decimalString) {
+        return cafe_utility_1.FixedPointNumber.fromDecimalString(decimalString, xBZZ.DECIMALS);
+    }
+    static fromFloat(value) {
+        return cafe_utility_1.FixedPointNumber.fromFloat(value, xBZZ.DECIMALS);
+    }
+    constructor(value) {
+        super(value, xBZZ.DECIMALS);
+    }
+}
+exports.xBZZ = xBZZ;

package/dist/xDAI.d.ts

@@ -0,0 +1,7 @@
+import { FixedPointNumber } from 'cafe-utility';
+export declare class xDAI extends FixedPointNumber {
+    static DECIMALS: number;
+    static fromDecimalString(decimalString: string): FixedPointNumber;
+    static fromFloat(value: number): FixedPointNumber;
+    constructor(value: bigint | number | string);
+}

package/dist/xDAI.js

@@ -0,0 +1,17 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.xDAI = void 0;
+const cafe_utility_1 = require("cafe-utility");
+class xDAI extends cafe_utility_1.FixedPointNumber {
+    static DECIMALS = 18;
+    static fromDecimalString(decimalString) {
+        return cafe_utility_1.FixedPointNumber.fromDecimalString(decimalString, xDAI.DECIMALS);
+    }
+    static fromFloat(value) {
+        return cafe_utility_1.FixedPointNumber.fromFloat(value, xDAI.DECIMALS);
+    }
+    constructor(value) {
+        super(value, xDAI.DECIMALS);
+    }
+}
+exports.xDAI = xDAI;

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@upcoming/multichain-library",
     "private": false,
-    "version": "0.7.3",
+    "version": "0.9.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "exports": {
@@ -19,7 +19,7 @@
     "license": "ISC",
     "description": "",
     "dependencies": {
-        "cafe-utility": "^33.4.0",
+        "cafe-utility": "^33.7.0",
         "viem": "^2.45.1"
     },
     "devDependencies": {