@cryptorubic/web3 1.0.0-alpha.no-sdk.2 → 1.0.0-alpha.no-sdk.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@cryptorubic/web3",
3
- "version": "1.0.0-alpha.no-sdk.2",
3
+ "version": "1.0.0-alpha.no-sdk.4",
4
4
  "dependencies": {
5
5
  "@ethersproject/bignumber": "^5.8.0",
6
6
  "@mysten/sui": "^1.24.0",
@@ -3,16 +3,15 @@ import BigNumber from 'bignumber.js';
3
3
  import { AbstractAdapter } from '../common/abstract-adapter';
4
4
  import { BtcWallet } from '../models/btc-wallet-provider';
5
5
  import { BasicSendTransactionOptions } from '../models/basic-transaction-options';
6
- import { AbstractAdapterClient } from '../common/client/abstract-adapter-client';
7
6
  import { RubicAppAdaptersFactoryParams } from '../../constants/models/create-factory-params';
8
- import { BitconSendTxParams } from './models/btc-send-tx-params';
7
+ import { BitcoinAdapterClient } from './client/bitcoin-adapter-client';
9
8
  import { Abi } from 'viem';
10
9
  import { Web3PrimitiveType } from '../../../utils/models/primitive-types';
11
10
  import { ContractMulticallResponse } from '../models/web3-public-models/contract-multicall-response';
12
11
  import { MethodData } from '../models/web3-public-models/method-data';
13
12
  export declare class BitcoinAdapter extends AbstractAdapter<BtcWallet, BtcWallet, BitcoinBlockchainName> {
14
13
  private readonly httpClient;
15
- readonly client: AbstractAdapterClient<BtcWallet, BitconSendTxParams, string>;
14
+ readonly client: BitcoinAdapterClient;
16
15
  constructor(httpClient: HttpClient, logger?: ICustomLogger, rubicAppParams?: RubicAppAdaptersFactoryParams);
17
16
  getBalance(userAddress: string): Promise<BigNumber>;
18
17
  getTokensBalances(userAddress: string, tokensAddresses: string[]): Promise<BigNumber[]>;
@@ -1,19 +1,17 @@
1
- import { Abi, MulticallResponse, MulticallParameters, PublicActions, PublicClient, WalletClient, WalletActions, BlockNumber, BlockTag, GetBlockReturnType, TransactionReceipt } from 'viem';
1
+ import { Abi, MulticallResponse, MulticallParameters, PublicActions, PublicClient, WalletClient, WalletActions, BlockNumber, BlockTag, GetBlockReturnType } from 'viem';
2
2
  import { AbstractAdapter } from '../common/abstract-adapter';
3
3
  import { EvmBlockchainName, ICustomLogger, Token, TokenAmount, PriceTokenAmount, HttpClient } from '@cryptorubic/core';
4
4
  import BigNumber from 'bignumber.js';
5
5
  import { EvmAdapterOptions } from '../models/evm-adapter-options';
6
6
  import { EvmTransactionConfig } from '../../../utils/models/evm-transaction-config';
7
- import { EvmSendTxParams } from './models/evm-send-tx-params';
8
- import { AbstractAdapterClient } from '../common/client/abstract-adapter-client';
7
+ import { EvmAdapterClient } from './client/evm-adapter-client';
9
8
  import { RubicAppAdaptersFactoryParams } from '../../constants/models/create-factory-params';
10
- import { ApproveAdapterClient } from '../models/approve-adapter';
11
9
  import { Web3PrimitiveType } from '../../../utils/models/primitive-types';
12
10
  import { ContractMulticallResponse } from '../models/web3-public-models/contract-multicall-response';
13
11
  import { MethodData } from '../models/web3-public-models/method-data';
14
12
  import { GasPrice } from '../models/evm-web3-public-models/gas-price';
15
13
  export declare class EvmAdapter extends AbstractAdapter<PublicActions & PublicClient, WalletClient & WalletActions, EvmBlockchainName> {
16
- readonly client: AbstractAdapterClient<WalletClient & WalletActions, EvmSendTxParams, TransactionReceipt> & ApproveAdapterClient<EvmTransactionConfig>;
14
+ readonly client: EvmAdapterClient;
17
15
  needPreswapAction(token: TokenAmount, contractAddress: string, walletAddress: string, amount: string): Promise<boolean>;
18
16
  handlePreswap(contractAddress: string, walletAddress: string, tokenAmount: TokenAmount): Promise<void>;
19
17
  constructor(httpClient: HttpClient, adapterOptions: EvmAdapterOptions, logger?: ICustomLogger, rubicAppParams?: RubicAppAdaptersFactoryParams);
@@ -33,6 +31,11 @@ export declare class EvmAdapter extends AbstractAdapter<PublicActions & PublicCl
33
31
  multicallByContract<T>(contracts: MulticallParameters, allowErrors?: boolean): Promise<MulticallResponse<T>[]>;
34
32
  multicallByAddress<T>(address: string, abi: Abi, method: string, methodArgs?: unknown[][], allowErrors?: boolean): Promise<MulticallResponse<T>[]>;
35
33
  static encodeMethodCall(contractAddress: string, contractAbi: Abi, method: string, parameters?: unknown[], value?: string): EvmTransactionConfig;
34
+ /**
35
+ * Generate random HEX strings from a given byte size.
36
+ * @param size byte size.
37
+ */
38
+ static randomHex(size: number): string;
36
39
  simulateTransaction(config: EvmTransactionConfig, from: string, timeout?: number): Promise<string>;
37
40
  callForTokensInfo(tokenAddresses: string[] | ReadonlyArray<string>): Promise<Token<EvmBlockchainName>[]>;
38
41
  getGasPrice(): Promise<string>;
@@ -197,6 +197,15 @@ class EvmAdapter extends abstract_adapter_1.AbstractAdapter {
197
197
  throw err;
198
198
  }
199
199
  }
200
+ /**
201
+ * Generate random HEX strings from a given byte size.
202
+ * @param size byte size.
203
+ */
204
+ static randomHex(size) {
205
+ const bytes = new Uint8Array(size);
206
+ crypto.getRandomValues(bytes);
207
+ return (0, viem_1.toHex)(bytes);
208
+ }
200
209
  async simulateTransaction(config, from, timeout = 15000) {
201
210
  try {
202
211
  const callParams = {
@@ -4,16 +4,15 @@ import { HttpClient, ICustomLogger, PriceTokenAmount, SolanaBlockchainName, Toke
4
4
  import BigNumber from 'bignumber.js';
5
5
  import { AbstractAdapter } from '../common/abstract-adapter';
6
6
  import { SolanaRawInstruction } from '../models/solana-web3-types';
7
- import { SolanaSendTxParams } from './models/solana-send-tx-params';
8
7
  import { RubicAppAdaptersFactoryParams } from '../../constants/models/create-factory-params';
9
8
  import { SolanaWeb3 } from '../../constants/models/solana-web3';
10
- import { AbstractAdapterClient } from '../common/client/abstract-adapter-client';
9
+ import { SolanaAdapterClient } from './client/solana-adapter-client';
11
10
  import { Web3PrimitiveType } from '../../../utils/models/primitive-types';
12
11
  import { ContractMulticallResponse } from '../models/web3-public-models/contract-multicall-response';
13
12
  export declare const NATIVE_SOLANA_MINT_ADDRESS = "So11111111111111111111111111111111111111111";
14
13
  export declare class SolanaAdapter extends AbstractAdapter<Connection, SolanaWeb3, SolanaBlockchainName> {
15
14
  private readonly httpClient;
16
- readonly client: AbstractAdapterClient<SolanaWeb3, SolanaSendTxParams, string>;
15
+ readonly client: SolanaAdapterClient;
17
16
  constructor(rpcList: string[], httpClient: HttpClient, logger?: ICustomLogger, rubicAppParams?: RubicAppAdaptersFactoryParams);
18
17
  /**
19
18
  * Gets balance of multiple tokens.
@@ -3,14 +3,13 @@ import { HttpClient, ICustomLogger, PriceTokenAmount, SuiBlockchainName, Token,
3
3
  import { SuiClient } from '@mysten/sui/client';
4
4
  import BigNumber from 'bignumber.js';
5
5
  import { AbstractAdapter } from '../common/abstract-adapter';
6
- import { AbstractAdapterClient } from '../common/client/abstract-adapter-client';
7
6
  import { WalletAdapter } from '@suiet/wallet-sdk';
7
+ import { SuiAdapterClient } from './client/sui-adapter-client';
8
8
  import { RubicAppAdaptersFactoryParams } from '../../constants/models/create-factory-params';
9
- import { SuiSendTxParams } from './models/sui-send-tx-params';
10
9
  import { Web3PrimitiveType } from '../../../utils/models/primitive-types';
11
10
  import { ContractMulticallResponse } from '../models/web3-public-models/contract-multicall-response';
12
11
  export declare class SuiAdapter extends AbstractAdapter<SuiClient, WalletAdapter, SuiBlockchainName> {
13
- readonly client: AbstractAdapterClient<WalletAdapter, SuiSendTxParams, string>;
12
+ readonly client: SuiAdapterClient;
14
13
  constructor(rpcList: string[], httpClient: HttpClient, logger?: ICustomLogger, rubicAppParams?: RubicAppAdaptersFactoryParams);
15
14
  getTokensBalances(userAddress: string, tokensAddresses: string[]): Promise<BigNumber[]>;
16
15
  multicallContractsMethods<Output extends Web3PrimitiveType>(): Promise<ContractMulticallResponse<Output>[][]>;
@@ -5,13 +5,12 @@ import { TonAdapterConfig } from '../models/ton-adapter-config';
5
5
  import BigNumber from 'bignumber.js';
6
6
  import { AbstractAdapter } from '../common/abstract-adapter';
7
7
  import { TonConnectUI } from '@tonconnect/ui';
8
- import { TonSendTxParams } from './models/ton-send-tx-params';
9
- import { AbstractAdapterClient } from '../common/client/abstract-adapter-client';
8
+ import { TonAdapterClient } from './client/ton-adapter-client';
10
9
  import { RubicAppAdaptersFactoryParams } from '../../constants/models/create-factory-params';
11
10
  import { Web3PrimitiveType } from '../../../utils/models/primitive-types';
12
11
  import { ContractMulticallResponse } from '../models/web3-public-models/contract-multicall-response';
13
12
  export declare class TonAdapter extends AbstractAdapter<TonClient, TonConnectUI, TonBlockchainName> {
14
- readonly client: AbstractAdapterClient<TonConnectUI, TonSendTxParams, string>;
13
+ readonly client: TonAdapterClient;
15
14
  private readonly tonApi;
16
15
  constructor(httpClient: HttpClient, config: TonAdapterConfig, logger?: ICustomLogger, rubicAppParams?: RubicAppAdaptersFactoryParams);
17
16
  getTokensBalances(userAddress: string, tokensAddresses: string[]): Promise<BigNumber[]>;
@@ -8,12 +8,10 @@ import { Abi } from 'viem';
8
8
  import { ContractMulticallResponse } from '../../../utils/models/contract-multicall-response';
9
9
  import { TronWeb3PrimitiveType } from '../../../utils/models/primitive-types';
10
10
  import { MethodData } from '../../../utils/models/method-data';
11
- import { AbstractAdapterClient } from '../common/client/abstract-adapter-client';
12
- import { TronSendTxParams } from './models/tron-send-tx-params';
13
11
  import { RubicAppAdaptersFactoryParams } from '../../constants/models/create-factory-params';
14
- import { ApproveAdapterClient } from '../models/approve-adapter';
12
+ import { TronAdapterClient } from './client/tron-adapter-client';
15
13
  export declare class TronAdapter extends AbstractAdapter<TronWeb, TronWeb, TronBlockchainName> {
16
- readonly client: AbstractAdapterClient<TronWeb, TronSendTxParams, string> & ApproveAdapterClient<TronTransactionConfig>;
14
+ readonly client: TronAdapterClient;
17
15
  private readonly multicallAddress;
18
16
  needPreswapAction(): Promise<boolean>;
19
17
  constructor(rpcList: string[], httpClient: HttpClient, logger?: ICustomLogger, rubicAppParams?: RubicAppAdaptersFactoryParams);
@@ -1,8 +1,7 @@
1
1
  import { Abi } from 'viem';
2
2
  import BigNumber from 'bignumber.js';
3
- import { ICustomLogger, Token, TokenAmount, BlockchainName, PriceTokenAmount } from '@cryptorubic/core';
3
+ import { ICustomLogger, Token, TokenAmount, BlockchainName } from '@cryptorubic/core';
4
4
  import { AbstractAdapterClient } from './client/abstract-adapter-client';
5
- import { SupportedTokenField } from '../models/token-models';
6
5
  import { MethodData } from '../models/web3-public-models/method-data';
7
6
  import { ContractMulticallResponse } from '../models/web3-public-models/contract-multicall-response';
8
7
  import { Web3PrimitiveType } from '../../../utils/models/primitive-types';
@@ -15,14 +14,21 @@ export declare abstract class AbstractAdapter<P, W, B extends BlockchainName, Se
15
14
  get public(): P;
16
15
  protected constructor(blockchain: B, logger?: ICustomLogger);
17
16
  abstract getTokensBalances(userAddress: string, tokensAddresses: string[]): Promise<BigNumber[]>;
18
- abstract checkEnoughBalance(token: TokenAmount | PriceTokenAmount, walletAddress: string): Promise<boolean>;
17
+ abstract checkEnoughBalance(token: TokenAmount, walletAddress: string): Promise<boolean>;
19
18
  abstract callForTokensInfo(tokenAddresses: string[] | ReadonlyArray<string>): Promise<Token<BlockchainName>[]>;
20
19
  /**
21
20
  * Gets token info by address.
22
21
  * @param tokenAddress Address of token.
23
22
  * @param tokenFields Token's fields to get.
24
23
  */
25
- callForTokenInfo(tokenAddress: string, tokenFields?: SupportedTokenField[]): Promise<Token<BlockchainName>>;
24
+ callForTokenInfo(tokenAddress: string): Promise<Token<BlockchainName>>;
25
+ /**
26
+ * Checks that user has enough balance.
27
+ * @param userAddress Wallet address, which contains tokens.
28
+ * @param token Token to check balance of.
29
+ * @param requiredAmount Required user balance in Eth units.
30
+ */
31
+ checkBalance(token: Token, requiredAmount: BigNumber, userAddress: string): Promise<void | never>;
26
32
  /**
27
33
  * Uses multicall to make many methods calls in several contracts.
28
34
  * @param contractAbi Target contract abi.
@@ -2,6 +2,8 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.AbstractAdapter = void 0;
4
4
  const viem_1 = require("viem");
5
+ const core_1 = require("@cryptorubic/core");
6
+ const insufficient_funds_error_1 = require("../../../errors/swap/insufficient-funds.error");
5
7
  class AbstractAdapter {
6
8
  set public(value) {
7
9
  this._public = value;
@@ -50,9 +52,21 @@ class AbstractAdapter {
50
52
  * @param tokenAddress Address of token.
51
53
  * @param tokenFields Token's fields to get.
52
54
  */
53
- async callForTokenInfo(tokenAddress, tokenFields = ['decimals', 'symbol', 'name']) {
55
+ async callForTokenInfo(tokenAddress) {
54
56
  return (await this.callForTokensInfo([tokenAddress]))[0];
55
57
  }
58
+ /**
59
+ * Checks that user has enough balance.
60
+ * @param userAddress Wallet address, which contains tokens.
61
+ * @param token Token to check balance of.
62
+ * @param requiredAmount Required user balance in Eth units.
63
+ */
64
+ async checkBalance(token, requiredAmount, userAddress) {
65
+ const enoughBalance = await this.checkEnoughBalance(new core_1.TokenAmount({ ...token, tokenAmount: requiredAmount }), userAddress);
66
+ if (!enoughBalance) {
67
+ throw new insufficient_funds_error_1.InsufficientFundsError(token.symbol);
68
+ }
69
+ }
56
70
  needPreswapAction(token, contractAddress, walletAddress, amount) {
57
71
  return Promise.resolve(false);
58
72
  }
@@ -30,7 +30,7 @@ export interface ApproveAdapterClient<T> extends AbstractAdapterClient<{}, {}, {
30
30
  * Get data for tokens approve
31
31
  * @param tokenAddress erc20 token address
32
32
  * @param spenderAddress spender address
33
- * @param amount amount in non wei
33
+ * @param amount amount in wei
34
34
  */
35
35
  approve(walletAddress: string, tokenAddress: string, spenderAddress: string, amount?: string): Promise<string>;
36
36
  }