@upcoming/multichain-library 0.5.2 → 0.6.0

package/README.md

@@ -61,7 +61,10 @@ In both cases, `options` is:
 ```ts
 amount: string | bigint
 originPrivateKey: `0x${string}`
-originAddress: `0x${string}`
 to: `0x${string}`
 nonce?: number
 ```
+
+## BZZ helpers
+
+-   `approveGnosisBzz(options: ApproveGnosisBzzOptions): Promise<string>`

package/dist/Constants.d.ts

@@ -2,6 +2,7 @@ import { FixedPointNumber } from 'cafe-utility';
 export declare const Constants: {
     nullAddress: `0x${string}`;
     bzzGnosisAddress: `0x${string}`;
+    postageStampGnosisAddress: `0x${string}`;
     ethereumChainId: number;
     gnosisChainId: number;
     daiDustAmount: FixedPointNumber;

package/dist/Constants.js

@@ -5,6 +5,7 @@ const cafe_utility_1 = require("cafe-utility");
 exports.Constants = {
     nullAddress: '0x0000000000000000000000000000000000000000',
     bzzGnosisAddress: '0xdbf3ea6f5bee45c02255b2c26a16f300502f68da',
+    postageStampGnosisAddress: '0x45a1502382541Cd610CC9068e88727426b696293',
     ethereumChainId: 1,
     gnosisChainId: 100,
     daiDustAmount: cafe_utility_1.FixedPointNumber.fromDecimalString('0.01', 18)

package/dist/GnosisBzzApprove.d.ts

@@ -0,0 +1,9 @@
+import { RollingValueProvider } from 'cafe-utility';
+import { MultichainLibrarySettings } from './Settings';
+export interface ApproveGnosisBzzOptions {
+    amount: string | bigint;
+    originPrivateKey: `0x${string}`;
+    spender: `0x${string}`;
+    nonce?: number;
+}
+export declare function approveGnosisBzz(options: ApproveGnosisBzzOptions, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<`0x${string}`>;

package/dist/GnosisBzzApprove.js

@@ -0,0 +1,44 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.approveGnosisBzz = approveGnosisBzz;
+const cafe_utility_1 = require("cafe-utility");
+const viem_1 = require("viem");
+const accounts_1 = require("viem/accounts");
+const chains_1 = require("viem/chains");
+const Constants_1 = require("./Constants");
+const GasPriceSelector_1 = require("./GasPriceSelector");
+const GnosisBzzAbi_1 = require("./GnosisBzzAbi");
+const GnosisTransactionCount_1 = require("./GnosisTransactionCount");
+async function approveGnosisBzz(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)(jsonRpcProvider.current())
+    });
+    for (let i = 0; i < 4; i++) {
+        try {
+            const hash = await client.writeContract({
+                account,
+                abi: GnosisBzzAbi_1.GnosisBzzABI,
+                address: Constants_1.Constants.bzzGnosisAddress,
+                functionName: 'approve',
+                args: [options.spender, BigInt(options.amount)],
+                gas: 100000n,
+                gasPrice: (0, GasPriceSelector_1.selectGasPrice)(i),
+                type: 'legacy',
+                chain: chains_1.gnosis,
+                nonce: options.nonce ?? (await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(account.address, settings, jsonRpcProvider))
+            });
+            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 write contract after multiple attempts due to low fees.');
+}

package/dist/GnosisBzzTransfer.d.ts

@@ -3,7 +3,6 @@ import { MultichainLibrarySettings } from './Settings';
 export interface TransferGnosisBzzOptions {
     amount: string | bigint;
     originPrivateKey: `0x${string}`;
-    originAddress: `0x${string}`;
     to: `0x${string}`;
     nonce?: number;
 }

package/dist/GnosisBzzTransfer.js

@@ -27,7 +27,7 @@ async function transferGnosisBzz(options, settings, jsonRpcProvider) {
                 gasPrice: (0, GasPriceSelector_1.selectGasPrice)(i),
                 type: 'legacy',
                 chain: chains_1.gnosis,
-                nonce: options.nonce ?? (await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(options.originAddress, settings, jsonRpcProvider))
+                nonce: options.nonce ?? (await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(account.address, settings, jsonRpcProvider))
             });
             return hash;
         }

package/dist/GnosisNativeTransfer.d.ts

@@ -3,7 +3,6 @@ import { MultichainLibrarySettings } from './Settings';
 export interface TransferGnosisNativeOptions {
     amount: string | bigint;
     originPrivateKey: `0x${string}`;
-    originAddress: `0x${string}`;
     to: `0x${string}`;
     nonce?: number;
 }

package/dist/GnosisNativeTransfer.js

@@ -19,13 +19,13 @@ async function transferGnosisNative(options, settings, jsonRpcProvider) {
             const serializedTransaction = await account.signTransaction({
                 chain: Constants_1.Constants.gnosisChainId,
                 chainId: Constants_1.Constants.gnosisChainId,
-                account: options.originAddress,
+                account: account.address,
                 gas: 21000n,
                 gasPrice: (0, GasPriceSelector_1.selectGasPrice)(i),
                 type: 'legacy',
                 to: options.to,
                 value: BigInt(options.amount),
-                nonce: options.nonce ?? (await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(options.originAddress, settings, jsonRpcProvider))
+                nonce: options.nonce ?? (await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(account.address, settings, jsonRpcProvider))
             });
             const hash = await client.sendRawTransaction({ serializedTransaction });
             return hash;

package/dist/GnosisPostageStampAbi.d.ts

@@ -0,0 +1,15 @@
+export declare const GnosisPostageStampABI: {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+}[];

package/dist/GnosisPostageStampAbi.js

@@ -0,0 +1,49 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.GnosisPostageStampABI = void 0;
+exports.GnosisPostageStampABI = [
+    {
+        inputs: [
+            {
+                internalType: 'address',
+                name: '_owner',
+                type: 'address'
+            },
+            {
+                internalType: 'uint256',
+                name: '_initialBalancePerChunk',
+                type: 'uint256'
+            },
+            {
+                internalType: 'uint8',
+                name: '_depth',
+                type: 'uint8'
+            },
+            {
+                internalType: 'uint8',
+                name: '_bucketDepth',
+                type: 'uint8'
+            },
+            {
+                internalType: 'bytes32',
+                name: '_nonce',
+                type: 'bytes32'
+            },
+            {
+                internalType: 'bool',
+                name: '_immutable',
+                type: 'bool'
+            }
+        ],
+        name: 'createBatch',
+        outputs: [
+            {
+                internalType: 'bytes32',
+                name: '',
+                type: 'bytes32'
+            }
+        ],
+        stateMutability: 'nonpayable',
+        type: 'function'
+    }
+];

package/dist/GnosisPostageStampCreateBatch.d.ts

@@ -0,0 +1,13 @@
+import { RollingValueProvider } from 'cafe-utility';
+import { MultichainLibrarySettings } from './Settings';
+export interface CreateBatchGnosisOptions {
+    originPrivateKey: `0x${string}`;
+    owner: `0x${string}`;
+    depth: number;
+    amount: string | bigint;
+    bucketDepth: 16;
+    batchNonce: string;
+    immutable: boolean;
+    nonce?: number;
+}
+export declare function createBatchGnosis(options: CreateBatchGnosisOptions, settings: MultichainLibrarySettings, jsonRpcProvider: RollingValueProvider<string>): Promise<`0x${string}`>;

package/dist/GnosisPostageStampCreateBatch.js

@@ -0,0 +1,76 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.createBatchGnosis = createBatchGnosis;
+const cafe_utility_1 = require("cafe-utility");
+const viem_1 = require("viem");
+const accounts_1 = require("viem/accounts");
+const chains_1 = require("viem/chains");
+const Constants_1 = require("./Constants");
+const Fetch_1 = require("./Fetch");
+const GasPriceSelector_1 = require("./GasPriceSelector");
+const GnosisPostageStampAbi_1 = require("./GnosisPostageStampAbi");
+const GnosisTransactionCount_1 = require("./GnosisTransactionCount");
+async function createBatchGnosis(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)(jsonRpcProvider.current())
+    });
+    for (let i = 0; i < 4; i++) {
+        try {
+            const hash = await client.writeContract({
+                account,
+                abi: GnosisPostageStampAbi_1.GnosisPostageStampABI,
+                address: Constants_1.Constants.postageStampGnosisAddress,
+                functionName: 'createBatch',
+                args: [
+                    options.owner,
+                    BigInt(options.amount),
+                    options.depth,
+                    options.bucketDepth,
+                    options.batchNonce,
+                    options.immutable
+                ],
+                gas: 1000000n,
+                gasPrice: (0, GasPriceSelector_1.selectGasPrice)(i),
+                type: 'legacy',
+                chain: chains_1.gnosis,
+                nonce: options.nonce ?? (await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(account.address, settings, jsonRpcProvider))
+            });
+            const payload = { jsonrpc: '2.0', id: 1, method: 'eth_getTransactionReceipt', params: [hash] };
+            for (let j = 0; j < 4; j++) {
+                try {
+                    await cafe_utility_1.System.sleepMillis(cafe_utility_1.Dates.seconds(5));
+                    const response = await (0, Fetch_1.durableFetch)(jsonRpcProvider, settings, 'POST', payload);
+                    const data = await response.json();
+                    const object = cafe_utility_1.Types.asObject(data);
+                    if (object.result !== null) {
+                        const result = cafe_utility_1.Types.asObject(object.result);
+                        const logs = cafe_utility_1.Types.asArray(result.logs).map(x => cafe_utility_1.Types.asObject(x));
+                        const event = logs.find(x => cafe_utility_1.Types.asString(x.address).toLowerCase() ===
+                            Constants_1.Constants.postageStampGnosisAddress.toLowerCase());
+                        if (event) {
+                            const topics = cafe_utility_1.Types.asArray(event.topics);
+                            if (topics[1]) {
+                                return cafe_utility_1.Types.asHexString(topics[1]);
+                            }
+                        }
+                    }
+                }
+                catch (error) {
+                    console.error(error);
+                }
+            }
+            throw Error('Failed to fetch transaction receipt after multiple attempts.');
+        }
+        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 write contract after multiple attempts due to low fees.');
+}

package/dist/GnosisPostageStampStoragePrice.d.ts

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

package/dist/GnosisPostageStampStoragePrice.js

@@ -0,0 +1,24 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getStoragePriceGnosis = getStoragePriceGnosis;
+const cafe_utility_1 = require("cafe-utility");
+const Fetch_1 = require("./Fetch");
+async function getStoragePriceGnosis(settings, jsonRpcProvider) {
+    const payload = {
+        jsonrpc: '2.0',
+        id: 1,
+        method: 'eth_call',
+        params: [
+            {
+                to: '0x47eef336e7fe5bed98499a4696bce8f28c1b0a8b', // price oracle
+                data: '0x9d1b464a00000000000000000000000047eef336e7fe5bed98499a4696bce8f28c1b0a8b'
+            },
+            'latest'
+        ]
+    };
+    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 });
+    return BigInt(price);
+}

package/dist/GnosisSwap.d.ts

@@ -3,13 +3,11 @@ import { MultichainLibrarySettings } from './Settings';
 export interface GnosisSwapAutoOptions {
     amount: string | bigint;
     originPrivateKey: `0x${string}`;
-    originAddress: `0x${string}`;
     to: `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}`;
     gas: bigint | string | number;
     gasPrice: bigint | string | number;
     to: `0x${string}`;

package/dist/GnosisSwap.js

@@ -9,10 +9,10 @@ const Constants_1 = require("./Constants");
 const GnosisTransactionCount_1 = require("./GnosisTransactionCount");
 const SushiSwap_1 = require("./SushiSwap");
 async function swapOnGnosisAuto(options, settings, jsonRpcProvider) {
-    const quote = await (0, SushiSwap_1.getSushiSwapQuote)(options.amount.toString(), options.originAddress, options.to, settings);
+    const account = (0, accounts_1.privateKeyToAccount)(options.originPrivateKey);
+    const quote = await (0, SushiSwap_1.getSushiSwapQuote)(options.amount.toString(), account.address, options.to, settings);
     return swapOnGnosisCustom({
         originPrivateKey: options.originPrivateKey,
-        originAddress: options.originAddress,
         gas: (BigInt(quote.tx.gas) * 5n) / 4n, // add 25% buffer
         gasPrice: BigInt(quote.tx.gasPrice),
         to: quote.tx.to,
@@ -27,14 +27,14 @@ async function swapOnGnosisCustom(options, settings, jsonRpcProvider) {
         .signTransaction({
         chain: Constants_1.Constants.gnosisChainId,
         chainId: Constants_1.Constants.gnosisChainId,
-        account: options.originAddress,
+        account: account.address,
         gas: (BigInt(options.gas) * 5n) / 4n, // add 25% buffer
         gasPrice: BigInt(options.gasPrice),
         type: 'legacy',
         to: options.to,
         value: BigInt(options.value),
         data: options.data,
-        nonce: await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(options.originAddress, settings, jsonRpcProvider)
+        nonce: await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(account.address, settings, jsonRpcProvider)
     })
         .then(signedTx => client.sendRawTransaction({ serializedTransaction: signedTx }));
 }

package/dist/MultiGnosisNativeTransfer.d.ts

@@ -3,7 +3,6 @@ import { MultichainLibrarySettings } from './Settings';
 export interface MultiTransferGnosisNativeOptions {
     amount: string | bigint;
     originPrivateKey: `0x${string}`;
-    originAddress: `0x${string}`;
     to: `0x${string}`[];
     nonce?: number;
 }

package/dist/MultiGnosisNativeTransfer.js

@@ -1,18 +1,19 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.multiTransferGnosisNative = multiTransferGnosisNative;
+const accounts_1 = require("viem/accounts");
 const GnosisNativeTransfer_1 = require("./GnosisNativeTransfer");
 const GnosisTransactionCount_1 = require("./GnosisTransactionCount");
 async function multiTransferGnosisNative(options, settings, jsonRpcProvider) {
+    const account = (0, accounts_1.privateKeyToAccount)(options.originPrivateKey);
     const transactions = [];
     const errors = [];
-    let nonce = options.nonce ?? (await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(options.originAddress, settings, jsonRpcProvider));
+    let nonce = options.nonce ?? (await (0, GnosisTransactionCount_1.getGnosisTransactionCount)(account.address, settings, jsonRpcProvider));
     for (const address of options.to) {
         try {
             const transaction = await (0, GnosisNativeTransfer_1.transferGnosisNative)({
                 amount: options.amount,
                 originPrivateKey: options.originPrivateKey,
-                originAddress: options.originAddress,
                 to: address,
                 nonce: nonce++
             }, settings, jsonRpcProvider);

package/dist/index.d.ts

@@ -1,7 +1,9 @@
 import { FixedPointNumber, RollingValueProvider } from 'cafe-utility';
 import { Constants } from './Constants';
+import { ApproveGnosisBzzOptions } from './GnosisBzzApprove';
 import { TransferGnosisBzzOptions } from './GnosisBzzTransfer';
 import { TransferGnosisNativeOptions } from './GnosisNativeTransfer';
+import { CreateBatchGnosisOptions } from './GnosisPostageStampCreateBatch';
 import { GnosisSwapAutoOptions, GnosisSwapCustomOptions } from './GnosisSwap';
 import { MultiTransferGnosisNativeOptions, MultiTransferGnosisNativeResult } from './MultiGnosisNativeTransfer';
 import { MultichainLibrarySettings } from './Settings';
@@ -21,6 +23,9 @@ export declare class MultichainLibrary {
     transferGnosisNative(options: TransferGnosisNativeOptions): Promise<`0x${string}`>;
     multiTransferGnosisNative(options: MultiTransferGnosisNativeOptions): Promise<MultiTransferGnosisNativeResult>;
     transferGnosisBzz(options: TransferGnosisBzzOptions): Promise<`0x${string}`>;
+    approveGnosisBzz(options: ApproveGnosisBzzOptions): Promise<`0x${string}`>;
+    createBatchGnosis(options: CreateBatchGnosisOptions): Promise<`0x${string}`>;
+    getStoragePriceGnosis(): Promise<bigint>;
     waitForGnosisBzzBalanceToIncrease(address: string, initialBalance: bigint): Promise<void>;
     waitForGnosisNativeBalanceToDecrease(address: `0x${string}`, initialBalance: bigint): Promise<void>;
     waitForGnosisNativeBalanceToIncrease(address: `0x${string}`, initialBalance: bigint): Promise<void>;

package/dist/index.js

@@ -3,10 +3,13 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.MultichainLibrary = void 0;
 const cafe_utility_1 = require("cafe-utility");
 const Constants_1 = require("./Constants");
+const GnosisBzzApprove_1 = require("./GnosisBzzApprove");
 const GnosisBzzBalance_1 = require("./GnosisBzzBalance");
 const GnosisBzzTransfer_1 = require("./GnosisBzzTransfer");
 const GnosisNativeBalance_1 = require("./GnosisNativeBalance");
 const GnosisNativeTransfer_1 = require("./GnosisNativeTransfer");
+const GnosisPostageStampCreateBatch_1 = require("./GnosisPostageStampCreateBatch");
+const GnosisPostageStampStoragePrice_1 = require("./GnosisPostageStampStoragePrice");
 const GnosisSwap_1 = require("./GnosisSwap");
 const GnosisTransactionCount_1 = require("./GnosisTransactionCount");
 const MultiGnosisNativeTransfer_1 = require("./MultiGnosisNativeTransfer");
@@ -47,6 +50,15 @@ class MultichainLibrary {
     transferGnosisBzz(options) {
         return (0, GnosisBzzTransfer_1.transferGnosisBzz)(options, this.settings, this.jsonRpcProvider);
     }
+    approveGnosisBzz(options) {
+        return (0, GnosisBzzApprove_1.approveGnosisBzz)(options, this.settings, this.jsonRpcProvider);
+    }
+    createBatchGnosis(options) {
+        return (0, GnosisPostageStampCreateBatch_1.createBatchGnosis)(options, this.settings, this.jsonRpcProvider);
+    }
+    getStoragePriceGnosis() {
+        return (0, GnosisPostageStampStoragePrice_1.getStoragePriceGnosis)(this.settings, this.jsonRpcProvider);
+    }
     waitForGnosisBzzBalanceToIncrease(address, initialBalance) {
         return (0, Waiter_1.waitForGnosisBzzBalanceToIncrease)(address, initialBalance, this.settings, this.jsonRpcProvider);
     }

package/package.json

@@ -1,7 +1,7 @@
 {
     "name": "@upcoming/multichain-library",
     "private": false,
-    "version": "0.5.2",
+    "version": "0.6.0",
     "main": "dist/index.js",
     "types": "dist/index.d.ts",
     "exports": {