@hinkal/common 0.2.10 → 0.2.11

package/externalABIs/index.d.mts

@@ -0,0 +1,323 @@
+import { abi as AmTokenABI } from './amToken';
+import { abi as BUSDABI } from './BUSD';
+import { abi as daiABI } from './DAI';
+import { abi as sanctionsListABI } from './SanctionsList';
+import { abi as USDCABI } from './USDC';
+import { abi as USDRABI } from './USDR';
+import { abi as USDR3CRVABI } from './USDR3CRV';
+import { abi as USDTABI } from './USDT';
+import { abi as WETHABI } from './WETH';
+import lidoStEthAbi from './LidoStEthAbi.json';
+import lidoStMaticAbi from './LidoStMaticAbi.json';
+import lidoWithdrawalQueueERC721Abi from './LidoWithdrawalQueueERC721Abi.json';
+import poLidoNftAbi from './PoLidoNftAbi.json';
+import lidoWstEthAbi from './LidoWstEthAbi.json';
+import lidoStakeManagerAbi from './LidoStakeManagerAbi.json';
+import optimismGasPriceOracleAbi from './OptimismGasPriceOracle.json';
+declare const BeefyVaultABI: ({
+    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;
+})[];
+declare const CurveReadingWrapperABI: ({
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        indexed: boolean;
+    }[];
+    anonymous: boolean;
+    type: string;
+    stateMutability?: undefined;
+    outputs?: undefined;
+} | {
+    stateMutability: string;
+    type: string;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    outputs: never[];
+    name?: undefined;
+    anonymous?: undefined;
+} | {
+    stateMutability: string;
+    type: string;
+    name?: undefined;
+    inputs?: undefined;
+    anonymous?: undefined;
+    outputs?: undefined;
+} | {
+    stateMutability: string;
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    outputs: {
+        name: string;
+        type: string;
+    }[];
+    anonymous?: undefined;
+})[];
+declare const CurveWrappedMainPoolABI: ({
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+        indexed: boolean;
+    }[];
+    anonymous: boolean;
+    type: string;
+    stateMutability?: undefined;
+    outputs?: undefined;
+} | {
+    stateMutability: string;
+    type: string;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    outputs: never[];
+    name?: undefined;
+    anonymous?: undefined;
+} | {
+    stateMutability: string;
+    type: string;
+    name: string;
+    inputs: {
+        name: string;
+        type: string;
+    }[];
+    outputs: {
+        name: string;
+        type: string;
+    }[];
+    anonymous?: undefined;
+})[];
+declare const ERC20ABI: ({
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    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;
+})[];
+declare const quoterV2ABI: ({
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+} | {
+    inputs: {
+        components: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+})[];
+declare const factoryABI: ({
+    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;
+})[];
+declare const ISwapRouterABI: ({
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+    name?: undefined;
+    outputs?: undefined;
+} | {
+    inputs: {
+        components: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+} | {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+} | {
+    stateMutability: string;
+    type: string;
+    inputs?: undefined;
+    name?: undefined;
+    outputs?: undefined;
+})[];
+declare const transactionProverABI: {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+}[];
+declare const BabABI: {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+}[];
+declare const GalxeABI: {
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    name: string;
+    outputs: {
+        components: {
+            internalType: string;
+            name: string;
+            type: string;
+        }[];
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    stateMutability: string;
+    type: string;
+}[];
+export { CurveWrappedMainPoolABI, CurveReadingWrapperABI, quoterV2ABI, factoryABI, AmTokenABI, BeefyVaultABI, ERC20ABI, USDCABI, daiABI, USDRABI, USDR3CRVABI, USDTABI, WETHABI, BUSDABI, sanctionsListABI, lidoStEthAbi, lidoStMaticAbi, lidoWithdrawalQueueERC721Abi, lidoWstEthAbi, poLidoNftAbi, lidoStakeManagerAbi, transactionProverABI, BabABI, GalxeABI, optimismGasPriceOracleAbi, ISwapRouterABI, };

package/externalABIs/swapAbi.d.mts

@@ -0,0 +1,77 @@
+export declare const ERC20ABI: ({
+    inputs: {
+        internalType: string;
+        name: string;
+        type: string;
+    }[];
+    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;
+})[];
+export declare const WETHABI: ({
+    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/functions/index.d.mts

@@ -0,0 +1,14 @@
+export * from './kyc';
+export * from './utils';
+export * from './web3';
+export * from './snarkjs';
+export * from './pre-transaction';
+export * from './protocols';
+export * from './staking';
+export * from './private-wallet';
+export * from './pre-transaction/getFlatFees';
+export * from './pre-transaction/outputUtxoProcessing';
+export * from './utils/requireEnv';
+export * from './utils/resolve-sync.utils';
+export * from './utils/getDataFromTransaction';
+export * from './web3/uniswapAPI';

package/functions/kyc/authentoHelper.d.mts

@@ -0,0 +1,12 @@
+import { IHinkal } from '../../data-structures/Hinkal/IHinkal';
+export declare const AUTHENTO: {
+    verifyMessageText: string;
+    domainName: string;
+    type: {
+        Message: {
+            name: string;
+            type: string;
+        }[];
+    };
+};
+export declare const authentoKycHandler: (hinkal: IHinkal, shortName: string, onboardURL: string) => Promise<void>;

package/functions/kyc/index.d.mts

@@ -0,0 +1,3 @@
+export * from '../web3/functionCalls/accessTokenCalls';
+export * from './passportHelper';
+export * from './openDefaultPassportWindow';

package/functions/kyc/openDefaultPassportWindow.d.mts

@@ -0,0 +1 @@
+export declare const openDefaultPassportWindow: (onboardURL: string, shortName: string, height?: number, width?: number) => void;

package/functions/kyc/passportHelper.d.mts

@@ -0,0 +1,3 @@
+import { Passports } from '../../types/kyc.types';
+import { IHinkal } from '../../data-structures/Hinkal/IHinkal';
+export declare const openPassportWindow: (passport: Passports, hinkal: IHinkal, height?: number, width?: number) => void;

package/functions/kyc/zkMeHelper.d.mts

@@ -0,0 +1,4 @@
+import { IHinkal } from '../../data-structures/Hinkal/IHinkal';
+export declare const zkMeKycHandler: (hinkal: IHinkal, shortName: string, onboardURL: string, params: {
+    merchId: string;
+}) => Promise<void>;

package/functions/pre-transaction/getFlatFees.d.mts

@@ -0,0 +1,12 @@
+import { ERC20Token, ExternalActionId, ValidExternalAction } from '../../types';
+/**
+ * Infer INTERACTION type from given @param externalActionId and @param action
+ * and return `flatFee` along with `feeUnit` - the token corespond with the fee,
+ * `priceOfTransactionInToken`, and `priceOfTransactionInUSD`
+ */
+export declare const getFlatFees: (chainId: number, erc20Addresses: string[], externalActionId: ExternalActionId, amountChanges: bigint[], action?: ValidExternalAction, gasTokenAddress?: string) => Promise<{
+    flatFees: bigint[];
+    priceOfTransactionInToken: bigint | undefined;
+    feeUnit: ERC20Token | undefined;
+    priceOfTransactionInUSD: number | undefined;
+}>;

package/functions/pre-transaction/index.d.mts

@@ -0,0 +1,5 @@
+export * from './interaction-to-action';
+export * from './outputUtxoProcessing';
+export * from './process-gas-estimates';
+export * from './processAmountChanges';
+export * from './getFlatFees';

package/functions/pre-transaction/interaction-to-action.d.mts

@@ -0,0 +1,2 @@
+import { ExternalActionId, INTERACTION, ValidExternalAction } from '../../types';
+export declare const getInteractionFromAction: (externalActionId: ExternalActionId, action?: ValidExternalAction) => INTERACTION;

package/functions/pre-transaction/outputUtxoProcessing.d.mts

@@ -0,0 +1,5 @@
+import { UserKeys } from '../../data-structures/crypto-keys/keys';
+import { Utxo } from '../../data-structures/utxo/Utxo';
+export declare const outputUtxoProcessing: (userKeys: UserKeys, inputUtxos: Utxo[], amountChange: bigint, timeStamp?: string, tokenId?: number) => {
+    outputUtxos: Utxo[];
+};

package/functions/pre-transaction/process-gas-estimates.d.mts

@@ -0,0 +1,5 @@
+import { ERC20Token, ExternalActionId, ValidExternalAction } from '../../types';
+export declare const processGasEstimates: (chainId: number, token: ERC20Token, externalActionId: ExternalActionId, action: ValidExternalAction | undefined, erc20TokenAddressLength: number, gasAmount?: number) => Promise<{
+    priceOfTransactionInUSD: number | undefined;
+    priceOfTransactionInToken: bigint | undefined;
+}>;

package/functions/pre-transaction/processAmountChanges.d.mts

@@ -0,0 +1,12 @@
+import { ERC20Token, ExternalActionId, ValidExternalAction } from '../../types';
+export interface ProcessAmountChangesParam {
+    erc20Addresses: string[];
+    amountChanges: bigint[];
+    flatFees: bigint[];
+    feeUnit?: ERC20Token;
+    externalActionId: ExternalActionId;
+    action?: ValidExternalAction;
+    /** if provided, gas will be estimated using this token */
+    gasTokenAddress?: string;
+}
+export declare const processAmountChanges: ({ erc20Addresses, amountChanges, flatFees, feeUnit, externalActionId, action, gasTokenAddress, }: ProcessAmountChangesParam) => bigint[];

package/functions/private-wallet/emporium.helpers.d.mts

@@ -0,0 +1,5 @@
+import { Contract, ContractTransaction } from 'ethers';
+export declare const emporiumOp: <ContractInstance extends Contract, ContractFunctions extends ContractInstance["functions"], ExactFunction extends { [K in keyof ContractFunctions]: ReturnType<ContractFunctions[K]> extends Promise<ContractTransaction> ? K : never; }[keyof ContractFunctions], FunctionArguments extends Parameters<ContractFunctions[ExactFunction]>>(contract: ContractInstance | string, func?: ExactFunction, args?: FunctionArguments extends [
+] ? [
+] : FunctionArguments, invokeWallet?: boolean, value?: bigint) => string;
+export declare const encodeEmporiumMetadata: (ops: string[], walletSalt?: string) => string;

package/functions/private-wallet/index.d.mts

@@ -0,0 +1,2 @@
+export * from './emporium.helpers';
+export * from './opProducer';

package/functions/private-wallet/opProducer.d.mts

@@ -0,0 +1,5 @@
+export declare enum OpType {
+    Erc20Token = 0,
+    Uniswap = 1
+}
+export declare const produceOp: (opType: OpType, contractAddress: string, func?: string, args?: any[], invokeWallet?: boolean, value?: bigint) => string;

package/functions/protocols/convex.protocols.d.mts

@@ -0,0 +1 @@
+export declare const getCVX: (chainId: number | undefined) => "0x4e3FBD56CD56c3e72c1403e103b45Db9da5B9D2B" | "0x4257ea7637c355f81616050cbb6a9b709fd72683" | "0xb952a807345991bd529fdded05009f5e80fe8f45" | "0x81ab7e0d570b01411fcc4afd3d50ec8c241cb74b";

package/functions/protocols/curve.protocols.d.mts

@@ -0,0 +1 @@
+export declare const getCRV: (chainId: number | undefined) => "0xD533a949740bb3306d119CC777fa900bA034cd52" | "0x0994206dfe8de6ec6920ff4d779b0d950605fb53" | "0x8Ee73c484A26e0A5df2Ee2a4960B789967dd0415" | "0x172370d5Cd63279eFa6d502DAB29171933a610AF" | "0x11cdb42b0eb46d95f990bedd4695a6e3fa034978" | "0x47536F17F4fF30e64A96a7555826b8f9e66ec468";

package/functions/protocols/index.d.mts

@@ -0,0 +1,3 @@
+export * from './curve.protocols';
+export * from './convex.protocols';
+export * from './pendle.helpers';

package/functions/protocols/pendle.helpers.d.mts

@@ -0,0 +1,8 @@
+import { ERC20Token, PendleAsset, PendleAssetType, PendleMarket, PendleSwapType, ValidExternalAction } from '../../types';
+export declare function erc20TokenFromPendleAsset(asset: PendleAsset | undefined): ERC20Token | undefined;
+/** Extract a specific Pendle Asset section from a market */
+export declare function getAssetTypeFromPendleMarket(market: PendleMarket | undefined, selectedMarketAssetType: PendleAssetType | undefined): PendleAsset | undefined;
+export declare const determinePendleSwapType: (market: PendleMarket, inSwapToken: ERC20Token, outSwapToken: ERC20Token) => PendleSwapType | undefined;
+export declare const determinePendleSwapTypeApiRoute: (swapType: PendleSwapType | undefined) => string;
+/** determines which token (by index in a list of tokens) should be used for calcuating gas and */
+export declare const getTokenIndexForPendleFlatFee: (action: ValidExternalAction | undefined, amountChanges: bigint[], erc20Addresses: string[], flatFeeTokenAddressSelectedByUser?: string | undefined) => number;

package/functions/snarkjs/common.snarkjs.d.mts

@@ -0,0 +1,22 @@
+import { Utxo } from '../../data-structures/utxo/Utxo';
+import { UserKeys } from '../../data-structures/crypto-keys/keys';
+import { MerkleTree } from '../../data-structures/merkle-tree';
+import { CircomDataJsonType, CircomDataType, HookDataType, StealthAddressStructure } from '../../types/circom-data.types';
+import { ExternalActionId } from '../../types/external-action.types';
+export declare const buildInNullifiers: (inputUtxos: Utxo[][], onChainCreation: boolean[]) => string[][];
+export declare const buildOutCommitments: (outputUtxos: Utxo[][], onChainCreation: boolean[]) => string[][];
+export declare const calcAmountChanges: (inputUtxos: Utxo[][], outputUtxos: Utxo[][], forCircomData?: boolean) => bigint[];
+export declare const calcEncryptedOutputs: (outputUtxos: Utxo[][], forceZeroAmount: boolean) => string[][];
+export declare const calcCommitmentsSiblingAndSides: (inputUtxos: Utxo[][], merkleTree: MerkleTree<bigint>) => {
+    inCommitmentSiblings: string[][][];
+    inCommitmentSiblingSides: string[][][];
+};
+export declare const calcAccessTokenSiblingsAndSides: (userKeys: UserKeys, merkleTreeAccessToken: MerkleTree<bigint>) => {
+    accessTokenSiblings: string[];
+    accessTokenSiblingSides: string[];
+};
+export declare const serializeCircomData: (circomData: CircomDataType) => CircomDataJsonType;
+export declare const deserializeCircomData: (circomData: CircomDataJsonType) => CircomDataJsonType;
+export declare const createCallDataHash: (publicSignalCount: number, relay: string, externalAddress: string | undefined, externalActionId: bigint | ExternalActionId, externalActionMetadata: string, encryptedOutputs: string[][], flatFees: bigint[], hookData: HookDataType | undefined) => bigint;
+export declare const calcPublicSignalCount: (verifierName: string, erc20TokenAddresses: string[], amountChanges: bigint[], inNullifiers: string[][], outCommitments: string[][], tokenIdsPositive: number) => number;
+export declare const calcStealthAddressStructure: (extraRandomization: bigint, privateKey: string) => StealthAddressStructure;