@cryptorubic/web3 0.4.1 → 0.4.2

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@cryptorubic/web3",
-  "version": "0.4.1",
+  "version": "0.4.2",
   "scripts": {
     "build": "tsc --project tsconfig.lib.json --outDir ../../dist && cp package.json ../../dist/packages/web3"
   },

package/src/index.d.ts

@@ -23,6 +23,8 @@ export * from './lib/adapter/adapters/models/tonapi-models';
 export * from './lib/adapter/adapters/models/toncenter-types';
 export * from './lib/adapter/adapters/models/approve-adapter';
 export * from './lib/adapter/adapters/models/gas-price';
+export * from './lib/adapter/adapters/models/btc-wallet-provider';
+export * from './lib/adapter/adapters/bitcoin-adapter';
 export * from './lib/utils/web3-pure';
 export * from './lib/utils/models/evm-transaction-config';
 export * from './lib/utils/web3-types/bitcoin-web3-pure';

package/src/index.js

@@ -23,6 +23,8 @@ tslib_1.__exportStar(require("./lib/adapter/adapters/models/tonapi-models"), exp
 tslib_1.__exportStar(require("./lib/adapter/adapters/models/toncenter-types"), exports);
 tslib_1.__exportStar(require("./lib/adapter/adapters/models/approve-adapter"), exports);
 tslib_1.__exportStar(require("./lib/adapter/adapters/models/gas-price"), exports);
+tslib_1.__exportStar(require("./lib/adapter/adapters/models/btc-wallet-provider"), exports);
+tslib_1.__exportStar(require("./lib/adapter/adapters/bitcoin-adapter"), exports);
 // utils aka web3pure
 tslib_1.__exportStar(require("./lib/utils/web3-pure"), exports);
 tslib_1.__exportStar(require("./lib/utils/models/evm-transaction-config"), exports);

package/src/lib/adapter/adapters/bitcoin-adapter.d.ts

@@ -0,0 +1,14 @@
+import { BitcoinBlockchainName, BlockchainName, HttpClient, ICustomLogger, Token } from '@cryptorubic/core';
+import BigNumber from 'bignumber.js';
+import { AbstractAdapter } from './abstract-adapter';
+import { BasicTransactionOptions } from './models/basic-transaction-options';
+import { BtcWallet } from './models/btc-wallet-provider';
+export declare class BitcoinAdapter extends AbstractAdapter<BtcWallet, BtcWallet, BitcoinBlockchainName> {
+    private readonly httpClient;
+    constructor(httpClient: HttpClient, logger?: ICustomLogger);
+    getBalance(userAddress: string): Promise<BigNumber>;
+    callForTokensInfo(tokenAddresses: string[] | ReadonlyArray<string>): Promise<Token<BlockchainName>[]>;
+    read<T>(args: unknown): Promise<T>;
+    write(args: unknown): Promise<string>;
+    transfer(recipient: string, amount: string, fromAddress: string, memo?: string, options?: BasicTransactionOptions): Promise<string>;
+}

package/src/lib/adapter/adapters/bitcoin-adapter.js

@@ -0,0 +1,65 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.BitcoinAdapter = void 0;
+const core_1 = require("@cryptorubic/core");
+const bignumber_js_1 = require("bignumber.js");
+const abstract_adapter_1 = require("./abstract-adapter");
+class BitcoinAdapter extends abstract_adapter_1.AbstractAdapter {
+    constructor(httpClient, logger) {
+        super(core_1.BLOCKCHAIN_NAME.BITCOIN, logger);
+        this.httpClient = httpClient;
+    }
+    async getBalance(userAddress) {
+        const url = `https://api.blockcypher.com/v1/btc/main/addrs/${userAddress}/balance`;
+        const response = await this.httpClient.get(url);
+        return new bignumber_js_1.default(response.final_balance);
+    }
+    async callForTokensInfo(tokenAddresses) {
+        return [core_1.nativeTokensList[core_1.BLOCKCHAIN_NAME.BITCOIN]];
+    }
+    read(args) {
+        throw new Error('Not implemented');
+    }
+    write(args) {
+        throw new Error('Not implemented');
+    }
+    async transfer(recipient, amount, fromAddress, memo, options) {
+        const hashPromise = new Promise((resolve, reject) => {
+            this.wallet.request({
+                method: 'transfer',
+                params: [
+                    {
+                        feeRate: 10,
+                        from: fromAddress,
+                        recipient,
+                        amount: {
+                            amount,
+                            decimals: 8,
+                        },
+                        ...(memo && { memo }),
+                    },
+                ],
+            }, (error, txHash) => {
+                if (error) {
+                    reject(error);
+                }
+                else {
+                    options?.onTransactionHash?.(txHash);
+                    resolve(txHash);
+                }
+            });
+        });
+        try {
+            const hash = await hashPromise;
+            if (typeof hash === 'string') {
+                // const statusData = this.getSrcStatusRecursive(srcTxHash, BLOCKCHAIN_NAME.BITCOIN, 300_000);
+                return hash;
+            }
+            throw new Error();
+        }
+        catch {
+            throw new Error('Failed to transfer funds');
+        }
+    }
+}
+exports.BitcoinAdapter = BitcoinAdapter;

package/src/lib/adapter/adapters/constants/uni-v3-permit-abi.d.ts

@@ -0,0 +1,2 @@
+import { Abi } from 'viem';
+export declare const UNI_V3_PERMIT_2_ABI: Abi;

package/src/lib/adapter/adapters/constants/uni-v3-permit-abi.js

@@ -0,0 +1,72 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.UNI_V3_PERMIT_2_ABI = void 0;
+exports.UNI_V3_PERMIT_2_ABI = [
+    {
+        inputs: [
+            {
+                internalType: 'address',
+                name: 'owner',
+                type: 'address',
+            },
+            {
+                internalType: 'address',
+                name: 'token',
+                type: 'address',
+            },
+            {
+                internalType: 'address',
+                name: 'spender',
+                type: 'address',
+            },
+        ],
+        name: 'allowance',
+        outputs: [
+            {
+                internalType: 'uint160',
+                name: 'amount',
+                type: 'uint160',
+            },
+            {
+                internalType: 'uint48',
+                name: 'expiration',
+                type: 'uint48',
+            },
+            {
+                internalType: 'uint48',
+                name: 'nonce',
+                type: 'uint48',
+            },
+        ],
+        stateMutability: 'view',
+        type: 'function',
+    },
+    {
+        inputs: [
+            {
+                internalType: 'address',
+                name: 'token',
+                type: 'address',
+            },
+            {
+                internalType: 'address',
+                name: 'spender',
+                type: 'address',
+            },
+            {
+                internalType: 'uint160',
+                name: 'amount',
+                type: 'uint160',
+            },
+            {
+                internalType: 'uint48',
+                name: 'expiration',
+                type: 'uint48',
+            },
+        ],
+        name: 'approve',
+        outputs: [],
+        stateMutability: 'nonpayable',
+        type: 'function',
+    },
+];

package/src/lib/adapter/adapters/evm-adapter.d.ts

@@ -18,7 +18,7 @@ export declare class EvmAdapter extends AbstractAdapter<PublicActions & PublicCl
     multicallByContract<T>(contracts: MulticallParameters, allowErrors?: boolean): Promise<MulticallResponse<T>[]>;
     multicallByAddress<T>(address: string, abi: Abi, method: string, methodArgs?: unknown[][], allowErrors?: boolean): Promise<MulticallResponse<T>[]>;
     static encodeMethodCall(contractAddress: string, contractAbi: Abi, method: string, parameters?: unknown[], value?: string): EvmTransactionConfig;
-    simulateTransaction(config: EvmTransactionConfig, from: string): Promise<string>;
+    simulateTransaction(config: EvmTransactionConfig, from: string, timeout?: number): Promise<string>;
     callForTokensInfo(tokenAddresses: string[] | ReadonlyArray<string>): Promise<Token<EvmBlockchainName>[]>;
     getGasPrice(): Promise<string>;
     checkEnoughBalance(token: TokenAmount | PriceTokenAmount, walletAddress: string, amount?: BigNumber): Promise<boolean>;
@@ -33,6 +33,9 @@ export declare class EvmAdapter extends AbstractAdapter<PublicActions & PublicCl
     encodeApprove(tokenAddress: string, spenderAddress: string, amount?: string): EvmTransactionConfig;
     needApprove(token: TokenAmount, contractAddress: string, walletAddress: string, amount: string): Promise<boolean>;
     approve(fromAddress: string, tokenAddress: string, spenderAddress: string, amount?: string): Promise<string>;
+    needPermit2Approve(token: TokenAmount, permit2Address: string, walletAddress: string, spenderAddress: string): Promise<boolean>;
+    encodePermit2Approve(tokenAddress: string, spenderAddress: string, permit2Address: string, expiration: string, amount: string): EvmTransactionConfig;
+    approveOnPermit2(fromAddress: string, tokenAddress: string, permit2Address: string, spenderAddress: string, deadline?: BigNumber, amount?: BigNumber): Promise<string>;
     /**
      * Calculates EIP-1559 specific gas details.
      * @see {@link https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-provider/src.ts/index.ts#L235}

package/src/lib/adapter/adapters/evm-adapter.js

@@ -9,6 +9,7 @@ const core_1 = require("@cryptorubic/core");
 const bignumber_js_1 = require("bignumber.js");
 const web3_pure_1 = require("../../utils/web3-pure");
 const possible_errors_1 = require("./constants/possible-errors");
+const uni_v3_permit_abi_1 = require("./constants/uni-v3-permit-abi");
 class EvmAdapter extends abstract_adapter_1.AbstractAdapter {
     async needPreswapAction(token, contractAddress, walletAddress, amount) {
         return this.needApprove(token, contractAddress, walletAddress, amount);
@@ -137,7 +138,7 @@ class EvmAdapter extends abstract_adapter_1.AbstractAdapter {
             throw err;
         }
     }
-    async simulateTransaction(config, from) {
+    async simulateTransaction(config, from, timeout = 15000) {
         try {
             const callParams = {
                 account: from,
@@ -145,8 +146,11 @@ class EvmAdapter extends abstract_adapter_1.AbstractAdapter {
                 to: config.to,
                 ...(config.value && { value: BigInt(config.value) }),
             };
-            const gasLimitWei = await this.public.estimateGas(callParams);
-            return gasLimitWei.toString();
+            const gasLimitWei = await Promise.race([
+                this.public.estimateGas(callParams),
+                new Promise((_, reject) => setTimeout(() => reject('Timeout'), timeout)),
+            ]);
+            return gasLimitWei?.toString();
         }
         catch (err) {
             this.logger?.customError('Error while simulating transaction', err);
@@ -262,6 +266,26 @@ class EvmAdapter extends abstract_adapter_1.AbstractAdapter {
         const config = this.encodeApprove(tokenAddress, spenderAddress, amount);
         return this.write(fromAddress, config.to, config.value, config.data);
     }
+    async needPermit2Approve(token, permit2Address, walletAddress, spenderAddress) {
+        const res = await this.read(permit2Address, uni_v3_permit_abi_1.UNI_V3_PERMIT_2_ABI, 'allowance', [walletAddress, token.address, spenderAddress]);
+        const [amount, expiration, _nonce] = res;
+        return (token.weiAmount.gt(amount) ||
+            new bignumber_js_1.default(Date.now()).gt(Number(expiration) * 1000));
+    }
+    encodePermit2Approve(tokenAddress, spenderAddress, permit2Address, expiration, amount) {
+        const tx = EvmAdapter.encodeMethodCall(permit2Address, uni_v3_permit_abi_1.UNI_V3_PERMIT_2_ABI, 'approve', [tokenAddress, spenderAddress, amount, expiration]);
+        return {
+            data: tx.data,
+            value: tx.value,
+            to: tx.to,
+        };
+    }
+    async approveOnPermit2(fromAddress, tokenAddress, permit2Address, spenderAddress, deadline = new bignumber_js_1.default(1000000), amount) {
+        const approveAmount = amount ? amount : new bignumber_js_1.default(2).pow(256).minus(1);
+        const expiration = new bignumber_js_1.default(Date.now()).plus(deadline).toFixed();
+        const tx = this.encodePermit2Approve(tokenAddress, spenderAddress, permit2Address, expiration, approveAmount.toFixed());
+        return this.write(fromAddress, tx.to, tx.value, tx.data);
+    }
     /**
      * Calculates EIP-1559 specific gas details.
      * @see {@link https://github.com/ethers-io/ethers.js/blob/master/packages/abstract-provider/src.ts/index.ts#L235}

package/src/lib/adapter/adapters/models/btc-wallet-provider.d.ts

@@ -0,0 +1,10 @@
+export interface BtcWallet {
+    on: (event: string, callback: (...args: unknown[]) => void) => unknown;
+    request<T>(args: {
+        method: string;
+        params: unknown[];
+    }, fn: (error: Error, txHash: string) => unknown): Promise<{
+        error: null | Error;
+        result: T;
+    }>;
+}

package/src/lib/adapter/adapters/models/btc-wallet-provider.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/lib/adapter/adapters/models/permit2-contract-types.d.ts

@@ -0,0 +1 @@
+export type Permit2AllowanceContractResponse = [string, number, number];

package/src/lib/adapter/adapters/models/permit2-contract-types.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/src/lib/adapter/adapters/solana-adapter.js

@@ -34,8 +34,13 @@ class SolanaAdapter extends abstract_adapter_1.AbstractAdapter {
     }
     async simulateTransaction(_config, _from) { }
     async callForTokensInfo(tokenAddresses) {
+        const nativeToken = core_1.nativeTokensList[core_1.BLOCKCHAIN_NAME.SOLANA];
         const nativeTokenIndex = tokenAddresses.findIndex((address) => web3_pure_1.Web3Pure.isNativeAddress(core_1.CHAIN_TYPE.SOLANA, address));
         const filteredTokenAddresses = tokenAddresses.filter((_, index) => index !== nativeTokenIndex);
+        // only native token in tokenAddresses
+        if (!filteredTokenAddresses.length) {
+            return [nativeToken];
+        }
         const mints = filteredTokenAddresses.map((address) => new web3_js_1.PublicKey(address));
         const tokenSdk = new utl_sdk_1.Client();
         const tokensMint = await tokenSdk.fetchMints(mints);
@@ -51,8 +56,7 @@ class SolanaAdapter extends abstract_adapter_1.AbstractAdapter {
         if (nativeTokenIndex === -1) {
             return tokens;
         }
-        const blockchainNativeToken = core_1.nativeTokensList[core_1.BLOCKCHAIN_NAME.SOLANA];
-        tokens.splice(nativeTokenIndex, 0, blockchainNativeToken);
+        tokens.splice(nativeTokenIndex, 0, nativeToken);
         return tokens;
     }
 }

package/src/lib/adapter/blockchain-adapter-factory.service.d.ts

@@ -2,10 +2,11 @@ import { SolanaAdapter } from './adapters/solana-adapter';
 import { TronAdapter } from './adapters/tron-adapter';
 import { AbstractAdapter } from './adapters/abstract-adapter';
 import { WalletProvider } from './constants/models/wallet-provider';
-import { BlockchainName, EvmBlockchainName, SolanaBlockchainName, TronBlockchainName, ICustomLogger, HttpClient, TonBlockchainName } from '@cryptorubic/core';
+import { BlockchainName, EvmBlockchainName, SolanaBlockchainName, TronBlockchainName, ICustomLogger, HttpClient, TonBlockchainName, BitcoinBlockchainName } from '@cryptorubic/core';
 import { TonAdapter } from './adapters/ton-adapter';
 import { TonAdapterConfig } from './adapters/models/ton-adapter-config';
 import { EvmAdapter } from './adapters/evm-adapter';
+import { BitcoinAdapter } from './adapters/bitcoin-adapter';
 export declare class BlockchainAdapterFactoryService {
     private readonly rpcList;
     private readonly createLogger?;
@@ -19,6 +20,7 @@ export declare class BlockchainAdapterFactoryService {
     getAdapter(blockchain: EvmBlockchainName): EvmAdapter;
     getAdapter(blockchain: TronBlockchainName): TronAdapter;
     getAdapter(blockchain: TonBlockchainName): TonAdapter;
+    getAdapter(blockchain: BitcoinBlockchainName): BitcoinAdapter;
     private createStorage;
     private createAdapter;
     connectWallet(walletProvider: WalletProvider): void;

package/src/lib/adapter/blockchain-adapter-factory.service.js

@@ -8,6 +8,7 @@ const viem_1 = require("viem");
 const core_1 = require("@cryptorubic/core");
 const ton_adapter_1 = require("./adapters/ton-adapter");
 const evm_adapter_1 = require("./adapters/evm-adapter");
+const bitcoin_adapter_1 = require("./adapters/bitcoin-adapter");
 class BlockchainAdapterFactoryService {
     constructor(rpcList, createLogger, httpClient, tonParams) {
         this.rpcList = rpcList;
@@ -46,6 +47,7 @@ class BlockchainAdapterFactoryService {
             return [blockchain, null];
         });
         const tonAdapter = this.createAdapter(core_1.BLOCKCHAIN_NAME.TON, []);
+        const btcAdapter = this.createAdapter(core_1.BLOCKCHAIN_NAME.BITCOIN, []);
         adapters.push(tonAdapter
             ? [core_1.BLOCKCHAIN_NAME.TON, tonAdapter]
             : [core_1.BLOCKCHAIN_NAME.TON, null]);
@@ -85,6 +87,9 @@ class BlockchainAdapterFactoryService {
             this.tonParams?.tonClientConfig) {
             return new ton_adapter_1.TonAdapter(this.httpClient, this.tonParams, this.createLogger?.(`TON_ADAPTER`));
         }
+        if (blockchain === core_1.BLOCKCHAIN_NAME.BITCOIN && this.httpClient) {
+            return new bitcoin_adapter_1.BitcoinAdapter(this.httpClient, this.createLogger?.(`BTC_ADAPTER`));
+        }
         return null;
     }
     connectWallet(walletProvider) {
@@ -117,6 +122,12 @@ class BlockchainAdapterFactoryService {
             store.wallet = walletProvider[core_1.CHAIN_TYPE.TON].core;
             store.walletAddress = walletProvider[core_1.CHAIN_TYPE.TON].address;
         }
+        if (walletProvider?.[core_1.CHAIN_TYPE.BITCOIN]?.core &&
+            this.adapterStore?.[core_1.BLOCKCHAIN_NAME.BITCOIN]) {
+            const store = this.adapterStore[core_1.BLOCKCHAIN_NAME.BITCOIN];
+            store.wallet = walletProvider[core_1.CHAIN_TYPE.BITCOIN].core;
+            store.walletAddress = walletProvider[core_1.CHAIN_TYPE.BITCOIN].address;
+        }
     }
 }
 exports.BlockchainAdapterFactoryService = BlockchainAdapterFactoryService;

package/src/lib/adapter/constants/models/wallet-provider.d.ts

@@ -1,6 +1,7 @@
 import { CHAIN_TYPE } from '@cryptorubic/core';
 import { SolanaWeb3 } from './solana-web3';
 import { TronWeb } from 'tronweb';
+import { BtcWallet } from '../../adapters/models/btc-wallet-provider';
 export interface WalletProviderCore<T = any> {
     /**
      * Core provider.
@@ -17,6 +18,7 @@ export type EvmWalletProviderCore = WalletProviderCore<{
 export type TronWalletProviderCore = WalletProviderCore<typeof TronWeb>;
 export type SolanaWalletProviderCore = WalletProviderCore<SolanaWeb3>;
 export type TonWaleltProviderCore = WalletProviderCore<unknown>;
+export type BitcoinWalletProviderCore = WalletProviderCore<BtcWallet>;
 /**
  * Stores wallet core and information about current user, used to make `send` transactions.
  */
@@ -25,6 +27,7 @@ interface IWalletProvider {
     readonly [CHAIN_TYPE.TRON]?: TronWalletProviderCore;
     readonly [CHAIN_TYPE.SOLANA]?: SolanaWalletProviderCore;
     readonly [CHAIN_TYPE.TON]?: TonWaleltProviderCore;
+    readonly [CHAIN_TYPE.BITCOIN]?: BitcoinWalletProviderCore;
 }
 export type WalletProvider = Partial<IWalletProvider>;
 export {};

package/src/lib/adapter/constants/viem-blockchain-mapping.js

@@ -65,7 +65,7 @@ exports.viemBlockchainMapping = {
     [core_1.BLOCKCHAIN_NAME.ROOTSTOCK]: chain_configs_1.viemConfig[core_1.BLOCKCHAIN_NAME.ROOTSTOCK],
     [core_1.BLOCKCHAIN_NAME.MODE]: chains_1.mode,
     [core_1.BLOCKCHAIN_NAME.ZK_FAIR]: chains_1.zkFair,
-    [core_1.BLOCKCHAIN_NAME.ZK_LINK]: chain_configs_1.viemConfig[core_1.BLOCKCHAIN_NAME.ZK_LINK],
+    [core_1.BLOCKCHAIN_NAME.ZK_LINK]: chains_1.zkLinkNova,
     [core_1.BLOCKCHAIN_NAME.XLAYER]: chain_configs_1.viemConfig[core_1.BLOCKCHAIN_NAME.XLAYER], // viem xLayer config without multicall address
     [core_1.BLOCKCHAIN_NAME.BAHAMUT]: chain_configs_1.viemConfig[core_1.BLOCKCHAIN_NAME.BAHAMUT],
     [core_1.BLOCKCHAIN_NAME.BITLAYER]: chain_configs_1.viemConfig[core_1.BLOCKCHAIN_NAME.BITLAYER],