@hinkal/common 0.2.11 → 0.2.12

package/data-structures/volatile-helper/VolatileHelper.d.mts

@@ -1,57 +0,0 @@
-import { BigNumber, BigNumberish, BytesLike, Contract } from 'ethers';
-import { VolatileAction } from '../../types/hinkal.types';
-import { ContractType } from '../../types/ethereum-network.types';
-import { DecodedTx } from '../../types/transactions.types';
-import { ExternalActionData, ExternalActionId } from '../../types/external-action.types';
-export type EncodeVolatileActionMetadataProp = {
-    volatileAmounts: PromiseOrValue<BigNumberish[]>;
-    withdrawRecipient: PromiseOrValue<string>;
-    redirectActionId: PromiseOrValue<BigNumberish>;
-    redirectMetadata: PromiseOrValue<BytesLike>;
-    actionType: PromiseOrValue<BigNumberish>;
-};
-export type PromiseOrValue<T> = T | Promise<T>;
-export declare class VolatileHelper {
-    static getVolatileTokenAction(chainId: number): Contract;
-    static getVolatileTokenAddress: (chainId: number, shareAddress: string) => Promise<any>;
-    static getShareTokenAddress: (chainId: number, volatileAddress: string) => Promise<string | undefined>;
-    static getVolatileTokenBalance: (chainId: number, shareTokenAddress: string, shareValue: bigint, blockNumber?: number) => Promise<bigint>;
-    static getShareTokenBalance: (chainId: number, volatileTokenAddress: string, volatileValue: bigint) => Promise<bigint>;
-    static processVolatileData: (chainId: number, actionType: VolatileAction, erc20Addresses: string[], amountChanges: bigint[]) => Promise<{
-        erc20Addresses: string[];
-        amountChanges: bigint[];
-        onChainCreation: boolean[];
-    }>;
-    static decodeVolatileMetadata: (externalActionMetadata: string) => {
-        volatileAmounts: BigNumber[];
-        redirectActionId: BigNumber;
-        volatileAction: VolatileAction | undefined;
-    };
-    static encodeVolatileActionMetadata: ({ actionType, volatileAmounts, withdrawRecipient, redirectActionId, redirectMetadata, }: Partial<EncodeVolatileActionMetadataProp>) => string;
-    static getVolotileMetadata: (actionType: VolatileAction, volatileAmounts: bigint[], recipientAddress?: string, baseExternalActionId?: ExternalActionId | 0n, baseExternalActionMetadata?: string) => {
-        actionType: VolatileAction.Deposit;
-        volatileAmounts: bigint[];
-        withdrawRecipient?: undefined;
-        redirectActionId?: undefined;
-        redirectMetadata?: undefined;
-    } | {
-        actionType: VolatileAction.Withdraw;
-        volatileAmounts: bigint[];
-        withdrawRecipient: string;
-        redirectActionId?: undefined;
-        redirectMetadata?: undefined;
-    } | {
-        actionType: VolatileAction.Swap;
-        volatileAmounts: bigint[];
-        redirectActionId: bigint;
-        redirectMetadata: string;
-        withdrawRecipient?: undefined;
-    };
-    static getVolatileExternalData: <T extends {
-        getContractWithFetcher: (contract: ContractType, contractAddress?: string) => Contract;
-    }>(hinkal: T, actionType: VolatileAction, originalAmountChanges: bigint[], recipientAddress?: string, baseExternalActionId?: ExternalActionId | 0n, baseExternalActionMetadata?: string) => Promise<ExternalActionData>;
-    static decodeExternalActionId: (decodedTx: DecodedTx | DecodedTx<string, string>) => {
-        isVolatile: boolean;
-        redirectActionId: BigNumber | undefined;
-    };
-}

package/data-structures/volatile-helper/index.d.mts

@@ -1 +0,0 @@
-export * from './VolatileHelper';

package/error-handling/customErrors/ErrorWithAmount.d.mts

@@ -1,4 +0,0 @@
-export declare class ErrorWithAmount extends Error {
-    amount: number;
-    constructor(providedAmount: number, message: string);
-}

package/error-handling/customErrors/FeeOverTransactionValueError.d.mts

@@ -1,9 +0,0 @@
-import { ERC20Token } from '../../types';
-export interface FeeOverTransactionValueErrorData {
-    totalFeeWEI: bigint;
-    feeUnit: ERC20Token | undefined;
-}
-export declare class FeeOverTransactionValueError extends Error {
-    data: FeeOverTransactionValueErrorData;
-    constructor(data: FeeOverTransactionValueErrorData);
-}

package/error-handling/customErrors/customErrors.helpers.d.mts

@@ -1,5 +0,0 @@
-import { ErrorCategory } from '../types';
-import { FeeOverTransactionValueError } from './FeeOverTransactionValueError';
-export declare const getGenericFeeOverTransactionValueErrorMessage: (error: FeeOverTransactionValueError, type?: ErrorCategory) => string;
-/** If the error is a known gas err type, rethrow it, otherwise throw a new Error */
-export declare const rethrowKnownGasErrorIfPossible: (err: unknown, fallbackErrorMsg: string) => never;

package/error-handling/customErrors/index.d.mts

@@ -1,3 +0,0 @@
-export * from './ErrorWithAmount';
-export * from './FeeOverTransactionValueError';
-export * from './customErrors.helpers';

package/error-handling/error-codes.constants.d.mts

@@ -1,181 +0,0 @@
-export declare const transactionErrorCodes: {
-    SOME_ERROR: string;
-    TOO_HIGH_AMOUNT: string;
-    INSUFFICIENT_FUNDS: string;
-    INSUFFICIENT_FUNDS_WITHDRAW: string;
-    INSUFFICIENT_FUNDS_TRANSFER: string;
-    INSUFFICIENT_FUNDS_TO_TRANSACT: string;
-    INSUFFICIENT_FUNDS_GAS: string;
-    NOT_ENOUGH_TOKENS: string;
-    TRANSACTION_NOT_CONFIRMED: string;
-    RPC_PROVIDER_LIMIT_ERROR: string;
-    RELAYER_NOT_AVAILABLE: string;
-    TRANSACTION_TIMEOUT: string;
-    CONNECT_ERROR: string;
-    CONNECT_ERROR2: string;
-    USER_REJECTED_TX: string;
-    USER_REJECTED_SIGN: string;
-    USER_REJECTED_TRANSACTION: string;
-    USER_REJECTED_SIGN2: string;
-    SIGNING_FAILED: string;
-    SIGNATURE_UNSUPPORTED_CHAINS: string;
-    SIGNATURE_UNSUPPORTED_CHAINS2: string;
-    SIGNATURE_REQUEST_EXPIRED: string;
-    SIGNATURE_UNSUPPORTED_PERSONAL_SIGN: string;
-    USER_DISAPPROVED_REQUESTED_METHODS: string;
-    INVALID_AUTHORIZATION: string;
-    INVALID_NULLIFIER: string;
-    SANCTIONED_ADDRESS: string;
-    INVALID_AMOUNT: string;
-    RECIPIENT_FORMAT_INCORRECT: string;
-    INVALID_TOKEN: string;
-    STATE_TO_UPDATE: string;
-    HAS_TOKEN: string;
-    INVALID_RECEIVER: string;
-    INVALID_RELAYER: string;
-    INVALID_RELAYER_FEE: string;
-    TIMESTAMP_STALE: string;
-    INVALID_ZKP: string;
-    NO_TRANSACTIONS_TO_CERTIFY: string;
-    UNSUPPORTED_NETWORK: string;
-    SIG_BY_OWNER: string;
-    AMOUNT_EMPTY: string;
-    UNVERIFIED_USER: string;
-    RELAYER_ISSUE: string;
-    RELAYER_GAS_ESTIMATE: string;
-    RECEIVER_EMPTY: string;
-    NOT_ETHEREUM_ADDRESS: string;
-    NOT_SHIELDED_ADDRESS: string;
-    VALID_ETHEREUM_ADDRESS: string;
-    METAMASK_NOT_INSTALLED: string;
-    VIABLE_TX: string;
-    TRANSACTION_REPLACED: string;
-    TRANSACTION_REPLACED2: string;
-    TRANSACTION_CANCELED: string;
-    NONCE_HIGH: string;
-    WALLET_CONNECT_MATCHING_KEYS: string;
-    UNKNOWN_PROVIDER: string;
-    SAFE_ERC: string;
-    SAFE_ERC_APPROVE: string;
-    SWAP_RELAYER_MIN: string;
-    LOW_LEVEL_CALL: string;
-    INTEGRAL_CURVE_ZERO: string;
-    ODOS_FETCH: string;
-    PENDLE_SWAP_FAILED_BELOW_THRESHOLD: string;
-    PENDLE_SWAP_TOKENS_UNSUPPORTED: string;
-    PENDLE_SWAP_TOKENS_UNSUPPORTED2: string;
-    PENDLE_MINIMUM_AMOUNT_NOT_REACHED: string;
-    SLIPPAGE_LIMIT: string;
-    SLIPPAGE_LIMIT_1: string;
-    QUOTE_EXPIRED: string;
-    REVERT_NO_STRING: string;
-    UNISWAP_NOT_ENOUGH_LIQUIDITY: string;
-    CONNECTION_FAILED: string;
-    FAILED_TO_SWITCH_NETWORKS: string;
-    INVALID_FROM: string;
-    INVALID_TO: string;
-    Invalid_Password: string;
-    INTERNAL_ERROR: string;
-    INVALID_MERKLE_ROOT: string;
-    ACCESS_TOKEN_INVALID_HASH: string;
-    MERLE_TREE_SNARK: string;
-    DECIMALS_LIMIT: string;
-    MERKLE_TREE_INCOMPLETE: string;
-    FAIL_ESTIMATE_GAS: string;
-    ODOS_SWAP_FAILED: string;
-    ONEINCH_SWAP_FAILED: string;
-    GAS_ESTIMATION_ERROR: string;
-    GAS_ESTIMATE_INCORRECT_PARAMETERS: string;
-    CONNECTIVITY_ERROR: string;
-    TRANSACTION_FAILED: string;
-    NO_UNISWAP_PRICE: string;
-    NO_ODOS_PRICE: string;
-    NO_ONEINCH_PRICE: string;
-    FEES_OVER_TRANSACTION_VALUE: string;
-    GAS_STATION_NOT_AVAILABLE: string;
-    INBALANCE_IN_TOKEN: string;
-    BALANCE_EQUATION_FAILED: string;
-    TOKEN_ADD_ERROR: string;
-    CANNOT_ESTIMATE_GAS: string;
-    NETWORK_ERROR: string;
-    MAX_FEE_GAS_ERROR: string;
-    CORS_ERROR: string;
-    CANNOT_ESTIMATE_GAS2: string;
-    NO_RESPONSE_PRIVATE: string;
-    TRY_AGAIN_AFTER_TRANSACTION: string;
-    ALREADY_SUBSCRIBED: string;
-    PREFERRED_TOKEN_OR_ADDRESS_MISSING: string;
-    SNAPSHOT_FILE_NOT_FOUND: string;
-    API_KEY_DOES_NOT_MATCH: string;
-    SAME_ADDRESS_FORBIDDEN: string;
-    NOT_VALID_ETHEREUM_ADDRESS: string;
-    MUST_STAKE_AT_LEAST_ONE_ETH: string;
-    OUT_OF_MEMORY: string;
-    OUT_OF_MEMORY2: string;
-    OUT_OF_MEMORY3: string;
-    UNKNOWN: string;
-    WC_NO_MATCHING_KEY: string;
-    CANNOT_CERTIFY_FOR_PAST_WEEK: string;
-    ACTIVE_CODE_INVALID: string;
-    REFERRE_CANT_USE_OWN: string;
-    USER_HAS_ACTIVE_CODE: string;
-    SAME_REFERRAL_CODE: string;
-    ALREADY_EXISTING_REFERRAL_CODE: string;
-    CYCLICAL_REFERRALS_FORBIDDEN: string;
-    WRONG_RECEIVING_TOKEN: string;
-    INVALID_RECEIVING_ADDRESS: string;
-    USER_IS_UNRANKED: string;
-    MULTI_VERIFICATION_FAILED: string;
-};
-export declare const UserFriendlyErrorCodes: {
-    USER_REJECTED_TRANSACTION: string;
-    SOME_ERROR: string;
-    TOO_HIGH_AMOUNT: string;
-    WC_NO_MATCHING_KEY: string;
-    RPC_PROVIDER_LIMIT_ERROR: string;
-    INSUFFICIENT_FUNDS_GAS: string;
-    INVALID_NULLIFIER: string;
-    STATE_TO_UPDATE: string;
-    INVALID_ZKP: string;
-    NONCE_HIGH: string;
-    UNKNOWN_PROVIDER: string;
-    TRANSACTION_REPLACED: string;
-    TRANSACTION_REPLACED2: string;
-    TRANSACTION_TIMEOUT: string;
-    SAFE_ERC: string;
-    SAFE_ERC_APPROVE: string;
-    INTEGRAL_CURVE_ZERO: string;
-    LOW_LEVEL_CALL: string;
-    ODOS_FETCH: string;
-    ODOS_SWAP_FAILED: string;
-    ONEINCH_SWAP_FAILED: string;
-    PENDLE_SWAP_FAILED_BELOW_THRESHOLD: string;
-    PENDLE_SWAP_FAILED: string;
-    PENDLE_SWAP_TOKENS_UNSUPPORTED: string;
-    PENDLE_SWAP_TOKENS_UNSUPPORTED2: string;
-    PENDLE_MINIMUM_AMOUNT_NOT_REACHED: string;
-    CONNECT_ERROR2: string;
-    WALLET_CONNECT_MATCHING_KEYS: string;
-    SIGNATURE_UNSUPPORTED_CHAINS: string;
-    SIGNATURE_UNSUPPORTED_CHAINS2: string;
-    SIGNATURE_UNSUPPORTED_PERSONAL_SIGN: string;
-    REVERT_NO_STRING: string;
-    INVALID_MERKLE_ROOT: string;
-    MERLE_TREE_SNARK: string;
-    MAX_FEE_GAS_ERROR: string;
-    MERKLE_TREE_INCOMPLETE: string;
-    CORS_ERROR: string;
-    NETWORK_ERROR: string;
-    CONNECTIVITY_ERROR: string;
-    INBALANCE_IN_TOKEN: string;
-    BALANCE_EQUATION_FAILED: string;
-    SLIPPAGE_LIMIT_1: string;
-    CANNOT_ESTIMATE_GAS: string;
-    CANNOT_ESTIMATE_GAS2: string;
-    GAS_STATION_NOT_AVAILABLE: string;
-    TIMESTAMP_STALE: string;
-    ALREADY_SUBSCRIBED: string;
-    OUT_OF_MEMORY: string;
-    OUT_OF_MEMORY2: string;
-    OUT_OF_MEMORY3: string;
-};

package/error-handling/get-error.message.d.mts

@@ -1,3 +0,0 @@
-import { ErrorCategory } from './types';
-export declare const extractMessage: (maybeError: unknown) => string | undefined;
-export declare const getErrorMessage: (error: unknown, type?: ErrorCategory) => string;

package/error-handling/handleErrorRestore.d.mts

@@ -1,2 +0,0 @@
-import { IHinkal } from '../data-structures/Hinkal/IHinkal';
-export declare function checkErrorForSnapshotRestore(err: unknown, hinkal: IHinkal): Promise<unknown>;

package/error-handling/index.d.mts

@@ -1,7 +0,0 @@
-export * from './customErrors/FeeOverTransactionValueError';
-export * from './customErrors/customErrors.helpers';
-export * from './error-codes.constants';
-export * from './get-error.message';
-export * from './handleErrorRestore';
-export * from './logError';
-export * from './types';

package/error-handling/logError.d.mts

@@ -1 +0,0 @@
-export declare const logError: (...logErr: unknown[]) => void;

package/error-handling/types.d.mts

@@ -1,5 +0,0 @@
-export declare enum ErrorCategory {
-    DEPOSIT = "DEPOSIT",
-    SWAP = "SWAP",
-    WITHDRAW = "WITHDRAW"
-}

package/externalABIs/BUSD.d.mts

@@ -1,38 +0,0 @@
-export declare const abi: ({
-    inputs: never[];
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-    name?: undefined;
-    constant?: undefined;
-    outputs?: undefined;
-} | {
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    payable?: undefined;
-    stateMutability?: undefined;
-    constant?: undefined;
-    outputs?: undefined;
-} | {
-    constant: boolean;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        name: string;
-        type: string;
-    }[];
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-})[];

package/externalABIs/DAI.d.mts

@@ -1,45 +0,0 @@
-export declare const abi: ({
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-    name?: undefined;
-    constant?: undefined;
-    outputs?: undefined;
-} | {
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    payable?: undefined;
-    stateMutability?: undefined;
-    constant?: undefined;
-    outputs?: undefined;
-} | {
-    constant: boolean;
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-})[];

package/externalABIs/ERC20.d.mts

@@ -1 +0,0 @@
-export { abi as ERC20ABI } from '@openzeppelin/contracts/build/contracts/IERC20Metadata.json';

package/externalABIs/SanctionsList.d.mts

@@ -1,35 +0,0 @@
-export declare const abi: ({
-    inputs: never[];
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-    name?: undefined;
-    outputs?: undefined;
-} | {
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    stateMutability?: undefined;
-    outputs?: undefined;
-} | {
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-})[];

package/externalABIs/USDC.d.mts

@@ -1,28 +0,0 @@
-export declare const abi: ({
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    outputs?: undefined;
-    stateMutability?: undefined;
-} | {
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-})[];

package/externalABIs/USDR.d.mts

@@ -1,28 +0,0 @@
-export declare const abi: ({
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    outputs?: undefined;
-    stateMutability?: undefined;
-} | {
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-})[];

package/externalABIs/USDR3CRV.d.mts

@@ -1,49 +0,0 @@
-export declare const abi: ({
-    name: string;
-    inputs: {
-        name: string;
-        type: string;
-        indexed: boolean;
-    }[];
-    anonymous: boolean;
-    type: string;
-    stateMutability?: undefined;
-    outputs?: undefined;
-    gas?: undefined;
-} | {
-    stateMutability: string;
-    type: string;
-    inputs: never[];
-    outputs: never[];
-    name?: undefined;
-    anonymous?: undefined;
-    gas?: undefined;
-} | {
-    stateMutability: string;
-    type: string;
-    name: string;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    outputs: {
-        name: string;
-        type: string;
-    }[];
-    gas: string;
-    anonymous?: undefined;
-} | {
-    stateMutability: string;
-    type: string;
-    name: string;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    outputs: {
-        name: string;
-        type: string;
-    }[];
-    anonymous?: undefined;
-    gas?: undefined;
-})[];

package/externalABIs/USDT.d.mts

@@ -1,41 +0,0 @@
-export declare const abi: ({
-    constant: boolean;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        name: string;
-        type: string;
-    }[];
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-} | {
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    constant?: undefined;
-    name?: undefined;
-    outputs?: undefined;
-    anonymous?: undefined;
-} | {
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    constant?: undefined;
-    outputs?: undefined;
-    payable?: undefined;
-    stateMutability?: undefined;
-})[];

package/externalABIs/WETH.d.mts

@@ -1,38 +0,0 @@
-export declare const abi: ({
-    constant: boolean;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        name: string;
-        type: string;
-    }[];
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-} | {
-    payable: boolean;
-    stateMutability: string;
-    type: string;
-    constant?: undefined;
-    inputs?: undefined;
-    name?: undefined;
-    outputs?: undefined;
-    anonymous?: undefined;
-} | {
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    constant?: undefined;
-    outputs?: undefined;
-    payable?: undefined;
-    stateMutability?: undefined;
-})[];

package/externalABIs/amToken.d.mts

@@ -1,28 +0,0 @@
-export declare const abi: ({
-    anonymous: boolean;
-    inputs: {
-        indexed: boolean;
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    type: string;
-    outputs?: undefined;
-    stateMutability?: undefined;
-} | {
-    inputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    name: string;
-    outputs: {
-        internalType: string;
-        name: string;
-        type: string;
-    }[];
-    stateMutability: string;
-    type: string;
-    anonymous?: undefined;
-})[];

package/externalABIs/crvFRAX.d.mts

@@ -1,38 +0,0 @@
-export declare const crvFRAXABI: ({
-    name: string;
-    inputs: {
-        name: string;
-        type: string;
-        indexed: boolean;
-    }[];
-    anonymous: boolean;
-    type: string;
-    stateMutability?: undefined;
-    outputs?: undefined;
-    gas?: undefined;
-} | {
-    stateMutability: string;
-    type: string;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    outputs: never[];
-    name?: undefined;
-    anonymous?: undefined;
-    gas?: undefined;
-} | {
-    stateMutability: string;
-    type: string;
-    name: string;
-    inputs: {
-        name: string;
-        type: string;
-    }[];
-    outputs: {
-        name: string;
-        type: string;
-    }[];
-    gas: number;
-    anonymous?: undefined;
-})[];