@toruslabs/ethereum-controllers 4.1.0

package/dist/types/utils/constants.d.ts

@@ -0,0 +1,81 @@
+import { EthereumProviderConfig } from "./interfaces";
+export declare const LOCALHOST = "localhost";
+export declare const CONTRACT_TYPE_ETH = "eth";
+export declare const CONTRACT_TYPE_ERC20 = "erc20";
+export declare const CONTRACT_TYPE_ERC721 = "erc721";
+export declare const CONTRACT_TYPE_ERC1155 = "erc1155";
+export declare const ERC1155_INTERFACE_ID = "0xd9b67a26";
+export declare const ERC721_INTERFACE_ID = "0x80ac58cd";
+export declare const ERC721_METADATA_INTERFACE_ID = "0x5b5e139f";
+export declare const ERC721_ENUMERABLE_INTERFACE_ID = "0x780e9d63";
+export declare const MAINNET_CHAIN_ID = "0x1";
+export declare const POLYGON_CHAIN_ID = "0x89";
+export declare const BSC_MAINNET_CHAIN_ID = "0x38";
+export declare const AVALANCHE_MAINNET_CHAIN_ID = "0xa86a";
+export declare const XDAI_CHAIN_ID = "0x64";
+export declare const ARBITRUM_MAINNET_CHAIN_ID = "0xa4b1";
+export declare const OPTIMISM_MAINNET_CHAIN_ID = "0xa";
+export declare const CELO_MAINNET_CHAIN_ID = "0xa4ec";
+export declare const GOERLI_CHAIN_ID = "0x5";
+export declare const SEPOLIA_CHAIN_ID = "0xaa36a7";
+export declare const POLYGON_MUMBAI_CHAIN_ID = "0x13881";
+export declare const BSC_TESTNET_CHAIN_ID = "0x61";
+export declare const AVALANCHE_TESTNET_CHAIN_ID = "0xa869";
+export declare const ARBITRUM_TESTNET_CHAIN_ID = "0x66eeb";
+export declare const OPTIMISM_TESTNET_CHAIN_ID = "0x1a4";
+export declare const SUPPORTED_NETWORKS: Record<string, EthereumProviderConfig>;
+export declare const METHOD_TYPES: {
+    readonly GET_ACCOUNTS: "eth_accounts";
+    readonly ETH_TRANSACTION: "eth_sendTransaction";
+    readonly ETH_REQUEST_ACCOUNTS: "eth_requestAccounts";
+    readonly ETH_SEND_RAW_TRANSACTION: "eth_sendRawTransaction";
+    readonly ETH_SIGN: "eth_sign";
+    readonly ETH_SIGN_TYPED_DATA: "eth_signTypedData";
+    readonly ETH_SIGN_TYPED_DATA_V3: "eth_signTypedData_v3";
+    readonly ETH_SIGN_TYPED_DATA_V4: "eth_signTypedData_v4";
+    readonly PERSONAL_SIGN: "personal_sign";
+    readonly ETH_GET_TRANSACTION_COUNT: "eth_getTransactionCount";
+    readonly ETH_GET_TRANSACTION_BY_HASH: "eth_getTransactionByHash";
+    readonly ETH_GET_ENCRYPTION_PUBLIC_KEY: "eth_getEncryptionPublicKey";
+    readonly ETH_DECRYPT: "eth_decrypt";
+    readonly ETH_GET_TRANSACTION_RECEIPT: "eth_getTransactionReceipt";
+    readonly WATCH_ASSET: "wallet_watchAsset";
+    readonly ETH_GET_BLOCK_BY_HASH: "eth_getBlockByHash";
+    readonly ETH_GET_CODE: "eth_getCode";
+    readonly ETH_GET_GAS_PRICE: "eth_gasPrice";
+};
+export declare const TRANSACTION_ENVELOPE_TYPES: {
+    readonly LEGACY: "0x0";
+    readonly ACCESS_LIST: "0x1";
+    readonly FEE_MARKET: "0x2";
+};
+export declare const GAS_ESTIMATE_TYPES: {
+    readonly FEE_MARKET: "fee-market";
+    readonly LEGACY: "legacy";
+    readonly ETH_GASPRICE: "eth_gasPrice";
+    readonly NONE: "none";
+};
+export declare const CHAIN_ID_TO_GAS_LIMIT_BUFFER_MAP: Record<string, number>;
+export declare const OLD_ERC721_LIST: Record<string, {
+    name?: string;
+    logo?: string;
+    erc20?: boolean;
+    symbol?: string;
+    decimals?: number;
+}>;
+export declare const TEST_CHAINS: string[];
+export declare const ETHERSCAN_SUPPORTED_CHAINS: string[];
+export declare const SIMPLEHASH_SUPPORTED_CHAINS: string[];
+export declare const COINGECKO_SUPPORTED_CURRENCIES: Set<string>;
+export declare const COINGECKO_PLATFORMS_CHAIN_CODE_MAP: Record<string, {
+    platform: string;
+    currency: string;
+}>;
+export declare const MessageStatus: {
+    readonly UNAPPROVED: "unapproved";
+    readonly SIGNED: "signed";
+    readonly PENDING: "pending";
+    readonly APPROVED: "approved";
+    readonly REJECTED: "rejected";
+    readonly FAILED: "failed";
+};

package/dist/types/utils/contractAddresses.d.ts

@@ -0,0 +1 @@
+export declare const SINGLE_CALL_BALANCES_ADDRESSES: Record<string, string>;

package/dist/types/utils/conversionUtils.d.ts

@@ -0,0 +1,42 @@
+import BigNumber from "bignumber.js";
+type NumericBase = "hex" | "dec" | "BN";
+type EthDenomination = "WEI" | "GWEI" | "ETH";
+type ConverterOptions = {
+    value: BigNumber | string;
+    fromNumericBase: NumericBase;
+    fromDenomination: EthDenomination;
+    fromCurrency: string;
+    toNumericBase: NumericBase;
+    toDenomination: EthDenomination;
+    toCurrency: string;
+    numberOfDecimals: number;
+    conversionRate: number;
+    invertConversionRate: boolean;
+    roundDown?: number;
+};
+export declare const conversionUtil: (value: BigNumber | string, { fromCurrency, toCurrency, fromNumericBase, toNumericBase, fromDenomination, toDenomination, numberOfDecimals, conversionRate, invertConversionRate, }: Omit<ConverterOptions, "value">) => string | 0 | BigNumber;
+export declare const getBigNumber: (value: any, base: any) => BigNumber;
+export declare const addCurrencies: (a: any, b: any, options?: Record<string, unknown>) => string | BigNumber;
+export declare const subtractCurrencies: (a: any, b: any, options?: Record<string, unknown>) => string | BigNumber;
+export declare const multiplyCurrencies: (a: any, b: any, options?: Record<string, unknown>) => string | BigNumber;
+export declare const conversionGreaterThan: ({ ...firstProps }: ConverterOptions, { ...secondProps }: ConverterOptions) => any;
+export declare const conversionLessThan: ({ ...firstProps }: ConverterOptions, { ...secondProps }: ConverterOptions) => any;
+export declare const conversionMax: ({ ...firstProps }: {
+    [x: string]: any;
+}, { ...secondProps }: {
+    [x: string]: any;
+}) => any;
+export declare const conversionGTE: ({ ...firstProps }: {
+    [x: string]: any;
+}, { ...secondProps }: {
+    [x: string]: any;
+}) => any;
+export declare const conversionLTE: ({ ...firstProps }: {
+    [x: string]: any;
+}, { ...secondProps }: {
+    [x: string]: any;
+}) => any;
+export declare const toNegative: (n: any, options?: {}) => string | BigNumber;
+export declare const decGWEIToHexWEI: (decGWEI: BigNumber) => BigNumber;
+export declare const hexWEIToDecGWEI: (decGWEI: BigNumber | string) => BigNumber;
+export {};

package/dist/types/utils/helpers.d.ts

@@ -0,0 +1,24 @@
+import { TransactionStatus } from "@toruslabs/base-controllers";
+import { SafeEventEmitterProvider } from "@toruslabs/openlogin-jrpc";
+import { FormattedTransactionActivity, TransactionPayload } from "./interfaces";
+export declare function getEtherScanHashLink(txHash: string, chainId: string): string;
+export declare const formatPastTx: (x: TransactionPayload, lowerCaseSelectedAddress?: string) => FormattedTransactionActivity;
+/**
+ * Ref - https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactionreceipt
+ */
+export declare const getEthTxStatus: (hash: string, provider: SafeEventEmitterProvider) => Promise<TransactionStatus | undefined>;
+export declare function formatDate(inputDate: string): string;
+export declare function formatTime(time: number): string;
+export declare const idleTimeTracker: {
+    checkIfIdle: () => boolean;
+};
+export declare function isAddressByChainId(address: string, _chainId: string): boolean;
+export declare function toChecksumAddressByChainId(address: string, chainId: string): string;
+export declare const GAS_LIMITS: {
+    SIMPLE: string;
+    BASE_TOKEN_ESTIMATE: string;
+};
+export declare function bnLessThan(a: string | number, b: string | number): boolean;
+export declare const getIpfsEndpoint: (path: string) => string;
+export declare function sanitizeNftMetdataUrl(url: string): string;
+export declare function getChainType(chainId: string): "mainnet" | "testnet" | "custom";

package/dist/types/utils/interfaces.d.ts

@@ -0,0 +1,384 @@
+import { AccessList } from "@ethereumjs/common";
+import { SignTypedDataVersion } from "@metamask/eth-sig-util";
+import { AddressPreferences, BaseBlockTrackerState, NetworkConfig, NetworkState, PaymentTransaction, PopupWhitelabelData, ProviderConfig, TRANSACTION_TYPE, TransactionMeta, TransactionStatus, User } from "@toruslabs/base-controllers";
+import { Json } from "@toruslabs/openlogin-jrpc";
+import { MutexInterface } from "async-mutex";
+import { MessageStatus, METHOD_TYPES, TRANSACTION_ENVELOPE_TYPES } from "./constants";
+export type CustomTokenInfo = {
+    tokenAddress: string;
+    name: string;
+    chainId: string;
+    erc20: boolean;
+    symbol: string;
+    decimals: string;
+    balance?: string;
+    customTokenId?: string;
+    isEtherScan?: boolean;
+    logo?: string;
+};
+export type CustomNftItemInfo = {
+    image: string;
+    name: string;
+    tokenBalance: string;
+    description: string;
+    tokenId: string;
+    video?: string;
+    decimals?: string;
+    customNftId?: string;
+};
+export type NftStandardType = "erc721" | "erc1155";
+export type CustomNftInfo = {
+    contractAddress: string;
+    contractName: string;
+    contractSymbol: string;
+    contractImage?: string;
+    contractSupply?: string;
+    contractFallbackLogo?: string;
+    nftStandard: NftStandardType;
+    contractDescription?: string;
+    chainId: string;
+    assets: CustomNftItemInfo[];
+};
+export interface EthereumBlock {
+    blockHash: string;
+    idempotencyKey: string;
+    timestamp: string;
+    baseFeePerGas: string;
+    gasLimit: string;
+}
+export interface UserRequestApprovalParams {
+    windowId?: string;
+    origin?: string;
+}
+export interface BaseRequestParams {
+    /**
+     * Unique id for each request
+     */
+    id: string;
+    /**
+     * Address to send this transaction from.
+     */
+    from: string;
+    /**
+     * Domain requested from
+     */
+    origin?: string;
+}
+export interface MessageParams extends BaseRequestParams {
+    data: string;
+}
+export type MessageStatusType = (typeof MessageStatus)[keyof typeof MessageStatus];
+export interface AbstractMessage {
+    id: string;
+    time: number;
+    status: MessageStatusType;
+    /**
+     * JRPC method for which sig request is made
+     */
+    type: string;
+    rawSig?: string;
+    metadata?: Json;
+    error?: string;
+}
+export interface Message extends AbstractMessage {
+    messageParams: MessageParams;
+}
+export type SignTypedDataMessageV3V4 = {
+    types: Record<string, unknown>;
+    domain: Record<string, unknown>;
+    primaryType: string;
+    message: unknown;
+};
+export interface TypedMessageParams extends BaseRequestParams {
+    data: Record<string, unknown>[] | string | SignTypedDataMessageV3V4;
+    version?: SignTypedDataVersion;
+}
+export interface TypedMessage extends AbstractMessage {
+    messageParams: TypedMessageParams;
+}
+export type TRANSACTION_ENVELOPE_TYPES_TYPE = (typeof TRANSACTION_ENVELOPE_TYPES)[keyof typeof TRANSACTION_ENVELOPE_TYPES];
+export interface TransactionParams extends BaseRequestParams {
+    /**
+     * Network ID as per EIP-155.
+     */
+    chainId?: string;
+    /**
+     * Data to pass with this transaction.
+     */
+    data?: string;
+    /**
+     * Error message for gas estimation failure.
+     */
+    estimateGasError?: string;
+    /**
+     * Estimated base fee for this transaction.
+     */
+    estimatedBaseFee?: string;
+    /**
+     * Gas to send with this transaction.
+     */
+    gas?: string;
+    /**
+     * Price of gas with this transaction.
+     */
+    gasPrice?: string;
+    /**
+     * Gas used in the transaction.
+     */
+    gasUsed?: string;
+    /**
+     * Maximum fee per gas for this transaction.
+     */
+    maxFeePerGas?: string;
+    /**
+     * Maximum priority fee per gas for this transaction.
+     */
+    maxPriorityFeePerGas?: string;
+    /**
+     * Unique number to prevent replay attacks.
+     */
+    nonce?: string;
+    /**
+     * Address to send this transaction to.
+     */
+    to?: string;
+    /**
+     * Value associated with this transaction.
+     */
+    value?: string;
+    /**
+     * EIP 2930
+     */
+    accessList?: AccessList;
+    /**
+     * Custom Nonce passed by the user
+     */
+    customNonceValue?: string;
+    /**
+     * Transaction envelope type
+     */
+    type?: TRANSACTION_ENVELOPE_TYPES_TYPE;
+    /**
+     * Max Gas to send with this transaction.
+     */
+    gasLimit?: string;
+}
+export type Nonce = {
+    name: string;
+    nonce: number;
+    details: {
+        startPoint?: number;
+        highest?: number;
+        block?: EthereumBlock;
+        baseCount?: number;
+    };
+};
+export type NonceDetails = {
+    params: {
+        highestLocallyConfirmed: number;
+        nextNetworkNonce: number;
+        highestSuggested: number;
+    };
+    local: Nonce;
+    network: Nonce;
+};
+/**
+ * Ref - https://ethereum.org/en/developers/docs/apis/json-rpc/#eth_gettransactionreceipt
+ */
+export interface TransactionReceipt {
+    transactionHash: string;
+    transactionIndex: string;
+    blockNumber: string;
+    blockHash: string;
+    from: string;
+    to: string | null;
+    cumulativeGasUsed: string;
+    effectiveGasPrice: string;
+    gasUsed: string;
+    contractAddress: string | null;
+    logs: unknown[];
+    logsBloom: string;
+    type: TRANSACTION_ENVELOPE_TYPES_TYPE;
+    root?: string;
+    status?: "0x0" | "0x1";
+}
+export type BlockTag = "earliest" | "finalized" | "safe" | "latest" | "pending";
+export type BlockParams = string | BlockTag;
+export interface TransactionRPCMeta {
+    v: string;
+    r: string;
+    s: string;
+    to: string | null;
+    gas: string;
+    from: string;
+    hash: string;
+    nonce: string;
+    input: string;
+    value: string;
+    accessList?: string[];
+    blockHash: string | null;
+    blockNumber: string | null;
+    transactionIndex: string | null;
+    maxFeePerGas?: string;
+    maxPriorityFeePerGas?: string;
+    gasPrice?: string;
+    type: TRANSACTION_ENVELOPE_TYPES_TYPE;
+    chainID?: string;
+}
+export type PollingBlockTrackerState = BaseBlockTrackerState<EthereumBlock>;
+export interface EthereumProviderConfig extends ProviderConfig {
+    isErc20?: boolean;
+    tokenAddress?: string;
+    isTestNet?: boolean;
+}
+export interface EthereumNetworkState extends NetworkState {
+    providerConfig: EthereumProviderConfig;
+}
+export interface EthereumNetworkConfig extends NetworkConfig {
+    providerConfig: EthereumProviderConfig;
+}
+export type CustomNetworkPayload = Partial<EthereumProviderConfig> & Pick<EthereumProviderConfig, "chainId" | "displayName" | "rpcTarget" | "ticker">;
+export interface CustomNetworks {
+    id: number;
+    created_at: Date;
+    updated_at: Date;
+    network_name: string;
+    public_address: string;
+    chain_id: string;
+    type: string;
+    rpc_url: string;
+    deleted: boolean;
+    symbol?: string;
+    block_explorer_url?: string;
+    is_test_net?: boolean;
+}
+export interface EthereumUser extends User {
+    customNetworks: CustomNetworks[];
+}
+export interface ContractParams {
+    erc20?: boolean;
+    erc721?: boolean;
+    erc1155?: boolean;
+    isSpecial?: boolean;
+    symbol?: string;
+    logo?: string;
+    decimals?: number;
+}
+export interface DappSuggestedGasFees {
+    gasPrice?: string;
+    maxPriorityFeePerGas?: string;
+    maxFeePerGas?: string;
+    gas?: string;
+}
+export interface EthereumTransactionMeta extends TransactionMeta<TransactionParams> {
+    r?: string;
+    s?: string;
+    v?: string;
+    type: string;
+    txReceipt?: TransactionReceipt;
+    history: Record<string, unknown>[];
+    accessList?: string[];
+    firstRetryBlockNumber?: string;
+    retryCount?: number;
+    simulationFails?: Record<string, unknown>;
+    loadingDefaults?: boolean;
+    transactionCategory?: TRANSACTION_TYPE;
+    nonceDetails?: NonceDetails;
+    methodParams?: unknown[];
+    dappSuggestedGasFees?: DappSuggestedGasFees;
+}
+export interface TransactionPayload {
+    created_at: Date;
+    from: string;
+    to: string;
+    total_amount: string;
+    currency_amount: string;
+    selected_currency: string;
+    status?: TransactionStatus;
+    network: string;
+    transaction_hash: string;
+    transaction_category: string;
+    gas: string;
+    gasPrice: string;
+    nonce: string;
+    type: string;
+    type_name: string;
+    type_image_link: string;
+    symbol: string;
+    is_cancel: boolean;
+    contract_address?: string;
+    from_aa_address?: string;
+}
+export interface FetchedTransaction extends TransactionPayload {
+    id: string;
+}
+export interface FetchCommonTransaction extends PaymentTransaction {
+    etherscanLink?: string | null;
+}
+export interface FormattedTransactionActivity {
+    id: string;
+    date: string;
+    from: string;
+    from_aa_address?: string;
+    slicedFrom: string;
+    to: string;
+    slicedTo: string;
+    action: string;
+    totalAmount: string;
+    totalAmountString: string;
+    currencyAmount: string;
+    currencyAmountString: string;
+    amount: string;
+    status: TransactionStatus;
+    etherscanLink: string;
+    ethRate: string;
+    currencyUsed: string;
+    networkType: string;
+    type: string;
+    type_name: string;
+    type_image_link: string;
+    transaction_hash: string;
+    isEtherscan?: boolean;
+    transaction_category: string;
+    input?: string;
+    contract_address?: string;
+    token_id?: string;
+    nonce: string;
+    is_cancel: boolean;
+    gas: string;
+    gasPrice: string;
+    hasCancel?: boolean;
+    cancelDateInitiated?: string;
+    cancelGas?: string;
+    cancelGasPrice?: string;
+}
+export interface ExtendedAddressPreferences extends AddressPreferences {
+    fetchedPastTx?: FetchedTransaction[];
+    formattedPastTransactions?: FormattedTransactionActivity[];
+    paymentTx: FetchCommonTransaction[];
+    customNetworks: CustomNetworks[];
+}
+export interface ProviderChangeChannelEventData {
+    newNetwork: EthereumProviderConfig;
+    whitelabelData: PopupWhitelabelData;
+    origin: string;
+    currentChainId: string;
+}
+export interface NonceLockRes {
+    nextNonce: number;
+    nonceDetails: NonceDetails;
+    releaseLock: MutexInterface.Releaser;
+}
+export type METHOD_TYPES_TYPE = (typeof METHOD_TYPES)[keyof typeof METHOD_TYPES];
+export interface EncryptionPublicKeyParams extends BaseRequestParams {
+    data: string;
+}
+export interface EncryptionPublicKey extends AbstractMessage {
+    messageParams: EncryptionPublicKeyParams;
+}
+export interface DecryptMessageParams extends BaseRequestParams {
+    data: string;
+}
+export interface DecryptMessage extends AbstractMessage {
+    messageParams: DecryptMessageParams;
+}

package/package.json

@@ -0,0 +1,71 @@
+{
+  "name": "@toruslabs/ethereum-controllers",
+  "version": "4.1.0",
+  "homepage": "https://github.com/torusresearch/controllers#readme",
+  "license": "ISC",
+  "main": "dist/ethereumControllers.cjs.js",
+  "module": "dist/ethereumControllers.esm.js",
+  "unpkg": "dist/ethereumControllers.umd.min.js",
+  "jsdelivr": "dist/ethereumControllers.umd.min.js",
+  "types": "dist/types/index.d.ts",
+  "author": "Torus Labs",
+  "scripts": {
+    "test": "mocha --config ../../.mocharc.json test/**/*.ts",
+    "test-debugger": "mocha --config ../../.mocharc.json --inspect-brk test/**/*.ts",
+    "dev": "rimraf dist/ && cross-env NODE_ENV=development torus-scripts start",
+    "build": "rimraf dist/ && cross-env NODE_ENV=production torus-scripts build",
+    "lint": "eslint --fix 'src/**/*.ts'",
+    "prepack": "npm run build",
+    "pre-commit": "lint-staged --cwd ."
+  },
+  "dependencies": {
+    "@ethereumjs/common": "^4.0.0",
+    "@ethereumjs/tx": "^5.0.0",
+    "@ethereumjs/util": "^9.0.0",
+    "@metamask/eth-sig-util": "^7.0.0",
+    "@metamask/rpc-errors": "^6.0.0",
+    "@toruslabs/base-controllers": "^4.1.0",
+    "@toruslabs/http-helpers": "^5.0.0",
+    "@toruslabs/openlogin-jrpc": "^5.1.0",
+    "async-mutex": "^0.4.0",
+    "bignumber.js": "^9.1.2",
+    "bn.js": "^5.2.1",
+    "ethers": "^6.7.1",
+    "fast-json-patch": "^3.1.1",
+    "jsonschema": "^1.4.1",
+    "lodash": "^4.17.21",
+    "loglevel": "^1.8.1"
+  },
+  "peerDependencies": {
+    "@babel/runtime": "7.x"
+  },
+  "files": [
+    "dist",
+    "src"
+  ],
+  "lint-staged": {
+    "!(*d).ts": [
+      "eslint --cache --fix",
+      "prettier --write"
+    ]
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/torusresearch/controllers.git"
+  },
+  "bugs": {
+    "url": "https://github.com/torusresearch/controllers/issues"
+  },
+  "engines": {
+    "node": ">=16.18.1",
+    "npm": ">=8.x"
+  },
+  "keywords": [],
+  "publishConfig": {
+    "access": "public"
+  },
+  "gitHead": "13b57afe21257c71e11d4e019fca62d517bfdc54",
+  "devDependencies": {
+    "ganache": "^7.9.1"
+  }
+}