@hinkal/react-native 0.3.1

package/common/src/data-structures/Hinkal/IHinkal.d.ts

@@ -0,0 +1,112 @@
+import { FeeStructure, LoginMessageMode } from '../../types/hinkal.types';
+import { ContractType, EthereumNetwork } from '../../types/ethereum-network.types';
+import { EncryptedOutputWithSign } from '../../types/commitments.types';
+import { ExternalActionId } from '../../types/external-action.types';
+import { IMultiThreadedUtxoUtils } from '../../types/IMultiThreadedUtxoUtils';
+import { ERC20Token, PrivateRecipientInfo, TokenBalance, TokenChanges } from '../../types/token.types';
+import { ethers } from 'ethers';
+import { Types as TronWebTypes, TronWeb } from 'tronweb';
+import { UserKeys } from '../crypto-keys/keys';
+import { IProviderAdapter } from '../provider-adapter/IProviderAdapter';
+import { ClientCommitmentsSnapshotService, ClientNullifierSnapshotService, ClientSolanaCommitmentsSnapshotService, ClientSolanaNullifierSnapshotService } from '../snapshot';
+import { MerkleTree } from '../merkle-tree';
+import { IAPI } from '../../API/API';
+import { ICacheDevice } from '../../types/ICacheDevice';
+import { StealthAddressStructure, TypedData } from '../../types/circom-data.types';
+import { SubAccount } from '../../types/proxy.types';
+import { AdminTransactionType } from '../../types/admin.types';
+import { Idl, Program } from '@coral-xyz/anchor';
+import { PublicKey } from '@solana/web3.js';
+import { BridgeRecipient } from '../../types/bridging-tx.types';
+import { NearBridgeParams, NearBridgeResult } from '../../types/near-intents.types';
+import { PrivateBalancesState } from '../../types/balances.types';
+import { Utxo } from '../utxo/Utxo';
+import { ScheduledTransactionByIdResponse } from '../../API/scheduled-transactions-calls';
+import { DepositAndSendExtendedResult } from '../../types/scheduled-transactions.types';
+import { Mutex } from 'async-mutex';
+export interface IHinkal<ConnectorType = unknown> {
+    userKeys: UserKeys;
+    readonly signingMessage: string;
+    readonly privateTransferSigningMessage: string;
+    readonly allowParallelBalanceLocalDecryption: boolean;
+    merkleTreeHinkalByChain: Record<number, MerkleTree<bigint>>;
+    nullifiersByChain: Record<number, Set<string>>;
+    encryptedOutputsByChain: Record<number, EncryptedOutputWithSign[]>;
+    commitmentsSnapshotServiceByChain: Record<number, ClientCommitmentsSnapshotService | ClientSolanaCommitmentsSnapshotService | undefined>;
+    nullifierSnapshotServiceByChain: Record<number, ClientNullifierSnapshotService | ClientSolanaNullifierSnapshotService | undefined>;
+    generateProofRemotely: boolean;
+    utxoUtils: IMultiThreadedUtxoUtils;
+    cacheDevice: ICacheDevice;
+    balanceFetchingMutexByChain: Map<number, Mutex>;
+    getBalances(chainId: number, passedShieldedPrivateKey: string, passedShieldedPublicKey: string, ethAddress: string, resetCacheBefore?: boolean, updateTokensListBefore?: boolean): Promise<Map<string, TokenBalance>>;
+    getTotalBalance(chainId: number, userKeys?: UserKeys, ethAddress?: string, resetCacheBefore?: boolean, updateTokensListBefore?: boolean, useBlockedUtxos?: boolean): Promise<TokenBalance[]>;
+    getStuckShieldedBalances(chainId: number, userKeys?: UserKeys, ethAddress?: string, resetCacheBefore?: boolean, updateTokensListBefore?: boolean): Promise<TokenBalance[]>;
+    privateBalancesWithUSD: PrivateBalancesState;
+    onPrivateBalancesWithUSDChange(callback: (state: PrivateBalancesState) => void): () => void;
+    getSupportedChains(): number[];
+    getEthereumAddress(): Promise<string>;
+    getEthereumAddressByChain(chainId: number): Promise<string>;
+    getHinkalTreeRootHash(chainId: number): Promise<bigint>;
+    resetMerkleTreesIfNecessary(chainIdsToCheck?: number[]): Promise<void>;
+    resetMerkle(chainIds?: number[]): Promise<void>;
+    getRandomRelay(chainId: number, markAsPending?: boolean): Promise<string | undefined>;
+    getGasPrice(chainId: number): Promise<bigint>;
+    getAPI(): IAPI;
+    snapshotsClearInterval(): void;
+    destroy(): Promise<void>;
+    getRecipientInfo(): string;
+    deposit(erc20Tokens: ERC20Token[], amountChanges: bigint[], preEstimateGas?: boolean, returnTxData?: boolean): Promise<ethers.TransactionResponse | ethers.TransactionRequest | string | TronWebTypes.Transaction<TronWebTypes.TriggerSmartContract>>;
+    depositForOther(erc20Tokens: ERC20Token[], amountChanges: bigint[], recepinetInfo: string, preEstimateGas?: boolean, returnTxData?: boolean, action?: AdminTransactionType): Promise<ethers.TransactionResponse | ethers.TransactionRequest | string | TronWebTypes.Transaction<TronWebTypes.TriggerSmartContract>>;
+    claimUtxo(erc20Token: ERC20Token, utxo: Utxo, feeStructureOverride?: FeeStructure, claimableSignature?: string): Promise<string>;
+    depositAndWithdraw(erc20Token: ERC20Token, recipientAmounts: bigint[], recipientAddresses: string[], txCompletionTime?: number, feeStructureOverride?: FeeStructure, ref?: string, action?: AdminTransactionType, dashboardAccountId?: string, preEstimateGas?: boolean): Promise<DepositAndSendExtendedResult>;
+    depositAndBridge(erc20Token: ERC20Token, recipientBridges: BridgeRecipient[], txCompletionTime?: number, feeStructureOverride?: FeeStructure, ref?: string, action?: AdminTransactionType, dashboardAccountId?: string, preEstimateGas?: boolean): Promise<DepositAndSendExtendedResult>;
+    checkSendTransactionStatus(scheduleId: string): Promise<ScheduledTransactionByIdResponse>;
+    nearDepositAndBridge(erc20Token: ERC20Token, recipientAmounts: bigint[], recipientAddresses: string[], params: NearBridgeParams, txCompletionTime?: number, feeStructureOverride?: FeeStructure, ref?: string, action?: AdminTransactionType, dashboardAccountId?: string): Promise<NearBridgeResult>;
+    prooflessDeposit(erc20Tokens: ERC20Token[], amountChanges: bigint[], stealthAddressStructures?: StealthAddressStructure[], action?: AdminTransactionType, returnTxData?: boolean): Promise<string | ethers.TransactionRequest | TronWebTypes.Transaction<TronWebTypes.TriggerSmartContract>>;
+    prooflessDepositWithPublicFee(erc20Token: ERC20Token, amounts: bigint[], stealthAddressStructures: StealthAddressStructure[], feeAmount: bigint, action?: AdminTransactionType): Promise<string>;
+    getSolanaProgram(idl: Idl): Program;
+    getSolanaPublicKey(): PublicKey;
+    depositSolana(amount: bigint, token: ERC20Token): Promise<string>;
+    depositSolanaForOther(amount: bigint, token: ERC20Token, recipientInfo: string, returnTxData?: boolean, action?: AdminTransactionType): Promise<string>;
+    transfer(erc20Tokens: ERC20Token[], amountChanges: bigint[], recipientAddress: string, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType): Promise<string>;
+    withdraw(erc20Tokens: ERC20Token[], deltaAmounts: bigint[], recipientAddress: string, isRelayerOff: boolean, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType): Promise<ethers.TransactionResponse | string>;
+    withdrawStuckUtxos(erc20Token: ERC20Token, recipientAddress: string): Promise<string[]>;
+    swap(erc20Tokens: ERC20Token[], deltaAmounts: bigint[], externalActionId: ExternalActionId, swapData: string, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType): Promise<string>;
+    getProviderAdapter(chainId?: number): IProviderAdapter;
+    getTronWeb(): TronWeb;
+    getSigningMessage(mode?: LoginMessageMode): string;
+    signHinkalMessage(mode?: LoginMessageMode): Promise<string>;
+    signSolanaLedgerMessage(): Promise<{
+        signature: string;
+        txMessageForSolanaLedger: string;
+    }>;
+    initUserKeys(mode?: LoginMessageMode): Promise<void>;
+    initUserKeysWithSignature(signature: string): void;
+    initUserKeysFromSeedPhrases(seedPhrases: string[]): Promise<void>;
+    initUserKeysWithEnclaveSignature(signInMode?: LoginMessageMode): Promise<string | undefined>;
+    storeAndGetInitialSignature(authSignature: string, isSolanaLedger?: boolean, txMessageForSolanaLedger?: string): Promise<string>;
+    initProviderAdapter(connector: ConnectorType, providerAdapter: IProviderAdapter<ConnectorType>): Promise<void>;
+    disconnectFromConnector(): Promise<void>;
+    resetProviderAdapters(): Promise<void>;
+    setListeners(providerAdapter: IProviderAdapter): Promise<void>;
+    waitForTransaction(chainId: number, transactionHash: string, confirmations?: number): Promise<boolean>;
+    getContract(chainId: number, contractType: ContractType, contractAddress?: string): ethers.Contract;
+    getContractWithSigner(chainId: number, contractType: ContractType, contractAddress?: string): ethers.Contract;
+    getContractWithFetcher(chainId: number, contractType: ContractType, contractAddress?: string): ethers.Contract;
+    getContractWithFetcherByChainId(chainId: number, contractType: ContractType, contractAddress?: string): ethers.Contract;
+    isSelectedNetworkSupported(chainId: number): boolean;
+    switchNetwork(network: EthereumNetwork): Promise<unknown>;
+    monitorConnectedAddress(chainId: number): Promise<void>;
+    isPermitterAvailable(chainId: number): boolean;
+    signMessage(message: string): Promise<string>;
+    signTypedData(domain: ethers.TypedDataDomain, types: Record<string, ethers.TypedDataField[]>, value: Record<string, unknown>): Promise<string>;
+    signWithSubAccount(chainId: number, messageToSign: string | undefined, typedData: TypedData | undefined, subAccount: SubAccount): Promise<string>;
+    actionPrivateWallet(chainId: number, erc20Tokens: ERC20Token[], deltaAmounts: bigint[], onChainCreation: boolean[], ops: string[], emporiumTokenChanges: TokenChanges<bigint>[], subAccount?: SubAccount, feeToken?: string, feeStructureOverride?: FeeStructure, relayOverride?: string, autoDepositBack?: boolean, maxGasInDollar?: string, action?: AdminTransactionType, privateRecipientInfo?: PrivateRecipientInfo): Promise<string>;
+    actionReceive(erc20Tokens: ERC20Token[], deltaAmounts: bigint[], feeTokens?: string, feeStructureOverride?: FeeStructure, subAccount?: SubAccount, action?: AdminTransactionType): Promise<string>;
+    proxySwap(erc20Tokens: ERC20Token[], deltaAmounts: bigint[], externalActionId: ExternalActionId, swapData: string, isTheSameChainSwap: boolean, subAccount: SubAccount, feeToken?: string, feeStructureOverride?: FeeStructure, autoDepositBack?: boolean, maxGasInDollar?: string, action?: AdminTransactionType): Promise<string>;
+    proxyToPrivate(erc20Tokens: ERC20Token[], deltaAmountsBase: bigint[], subAccount: SubAccount, recipientInfo: string, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType): Promise<string>;
+    proxySend(erc20Tokens: ERC20Token[], amounts: bigint[], subAccount: SubAccount, recipientAddress: string, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType): Promise<string>;
+    multiSendPrivateRecipients(erc20Tokens: ERC20Token[], amounts: bigint[], extendedRecipientInfos?: string[]): Promise<string>;
+    areMerkleTreeUpdatesDisabled(): boolean;
+    updateMerkleTreeUpdates(value: boolean): void;
+}

package/common/src/data-structures/Hinkal/handleAutoDepositBack.cjs

@@ -0,0 +1 @@
+const e=require(`../../constants/chains.constants.cjs`),t=require(`../../functions/utils/caseInsensitive.utils.cjs`),n=require(`../../error-handling/error-codes.constants.cjs`),r=require(`../../functions/web3/etherFunctions.cjs`),i=require(`../../functions/utils/time.utils.cjs`),a=require(`../../error-handling/customErrors/ErrorWithTx.cjs`),o=require(`../../types/external-action.types.cjs`),s=require(`../../types/transactions.types.cjs`),c=require(`../../types/admin.types.cjs`),l=require(`../../types/activities.types.cjs`),u=require(`../../types/transaction.types.cjs`),d=require(`../../types/offscreen.types.cjs`);require(`../../types/index.cjs`);const f=require(`../../error-handling/logger.cjs`),ee=require(`../../API/API.cjs`),p=require(`../../functions/utils/erc20tokenFunctions.cjs`),m=require(`../../error-handling/get-error.message.cjs`);require(`../../error-handling/index.cjs`);const h=require(`../../functions/pre-transaction/getVolatileTransferAmount.cjs`),g=require(`../../functions/utils/create-provider.cjs`),_=require(`../../functions/pre-transaction/getFeeStructure.cjs`),v=require(`../../functions/utils/convertEmporiumOpToCallInfo.cjs`),y=require(`../../functions/utils/postToOffscreen.cjs`),b=require(`../../functions/utils/fees.utils.cjs`),x=require(`../../functions/private-wallet/emporium.helpers.cjs`),S=require(`../../functions/auto-deposit-back-helpers/get-tokens-to-deposit-back.cjs`),C=require(`../../functions/auto-deposit-back-helpers/get-gas-token-records.cjs`),w=require(`../../functions/auto-deposit-back-helpers/select-gas-token.cjs`),T=require(`../../functions/auto-deposit-back-helpers/update-hinkal.cjs`);require(`../../functions/index.cjs`);const E=require(`../IndexedDB/activity-db.cjs`);require(`../IndexedDB/index.cjs`);var D=3*1e3,O=13*1e3,k=async(k,A,j,M,N,P,F,I)=>{if(!j||F.length===0)return;let L;try{let a=g.createJsonRpcProvider(A);await i.waitLittle(A===e.chainIds.ethMainnet?O:D);let u=await S.getTokensToDepositBack(F,N,j,a);if(!u.length){y.postToOffscreen(d.MessagesFromOffscreen.AutoShieldTxStatus,{message:n.transactionErrorCodes.AUTO_SHIELD_SKIPPED});return}let f=(await p.getErc20TokensBySymbolsFromAPI(await b.getGasTokenSymbols(A),A)).filter(e=>e!==void 0),{prices:m}=await ee.API.getTokenPrices(A,f.map(e=>e.erc20TokenAddress)),R=new Map(m.map((e,t)=>[f[t].erc20TokenAddress.toLowerCase(),e])),z=u.map(({token:e})=>e),B=u.map(({balance:e})=>e),V=z.map(({erc20TokenAddress:e})=>e),H=x.createTransaferEmporiumOpsBatch(k,A,V,await h.modifyVolatileTokenAmountChanges(A,z,B,j)),U=await _.getFeeStructure(A,N,V,o.ExternalActionId.Emporium,H.map(e=>v.convertEmporiumOpToCallInfo(e,j,A))),{flatFee:W}=U??{},G=await p.getErc20TokenFromAPI(A,U.feeToken);if(!G)return;let K=r.getAmountInToken(G,W),q=(R.get(G.erc20TokenAddress.toLowerCase())??0)*Number(K),J=await w.selectGasToken(N,q,A,z,H,await C.getGasTokenRecords(f,A,k,j,a,R),U,V,j);if(!J)return;let{feeToken:Y,feeStructure:X}=J??{};if(P&&Number(P)<q){y.postToOffscreen(d.MessagesFromOffscreen.AutoShieldTxStatus,{message:n.gasErrorCodes.GAS_PRICE_EXCEEDS_AUTOSHIELD_LIMIT});return}let Z=z.findIndex(e=>t.caseInsensitiveEqual(e.erc20TokenAddress,Y));Z!==-1&&(B[Z]-=X?.flatFee??0n);let{hinkalAddress:Q}=e.networkRegistry[A].contractData,$={activityType:l.ActivityTypes.AUTO_SHIELD,chainId:A,from:j,to:Q,gasInDollar:q.toString(),tokensReceive:z.map((e,t)=>({amount:r.getAmountInToken(e,B[t]),token:e}))};L=await E.activityStorage.saveTxRequest($),y.postToOffscreen(d.MessagesFromOffscreen.AutoShieldTxStatus,{status:s.TransactionStatus.Loading}),T.updateHinkal(A,k,I.inputNullifiers?.flat(),I.outCommitments?.flat(),I.encryptedOutputs?.flat());let te={id:0,success:!0,txHash:await k.actionReceive(z,B,Y,X,M,c.AdminTransactionType.AutoShield)};await E.activityStorage.updatePendingTransactions(te,L),y.postToOffscreen(d.MessagesFromOffscreen.AutoShieldTxStatus,{status:s.TransactionStatus.Confirmed,activityRequest:$})}catch(e){let t;e instanceof a.ErrorWithRelayerTransaction&&(t=e.txHash);let n={error:e,id:0,success:!1,...t?{erroredTx:t}:{}};L&&await E.activityStorage.updatePendingTransactions(n,L),y.postToOffscreen(d.MessagesFromOffscreen.AutoShieldTxStatus,{status:s.TransactionStatus.Failed,error:m.getErrorMessageFromTransactionRequest(e,u.TransactionRequestType.ReceiveFromShieldedAccount)}),f.Logger.error(`Error in auto deposit back:`,e)}};exports.handleAutoDepositBack=k;

package/common/src/data-structures/Hinkal/handleAutoDepositBack.d.ts

@@ -0,0 +1,3 @@
+import { IHinkal } from './IHinkal';
+import { CircomDataType, SubAccount, TokenChanges } from '../../types';
+export declare const handleAutoDepositBack: (hinkal: IHinkal, chainId: number, walletAddress: string | undefined, subAccount: SubAccount, feeToken: string | undefined, maxGasInDollar: string | undefined, emporiumTokenChanges: TokenChanges<bigint>[], circomData: CircomDataType) => Promise<void>;

package/common/src/data-structures/Hinkal/handleAutoDepositBack.mjs

@@ -0,0 +1,93 @@
+import { chainIds as e, networkRegistry as t } from "../../constants/chains.constants.mjs";
+import { caseInsensitiveEqual as n } from "../../functions/utils/caseInsensitive.utils.mjs";
+import { gasErrorCodes as ee, transactionErrorCodes as r } from "../../error-handling/error-codes.constants.mjs";
+import { getAmountInToken as i } from "../../functions/web3/etherFunctions.mjs";
+import { waitLittle as a } from "../../functions/utils/time.utils.mjs";
+import { ErrorWithRelayerTransaction as o } from "../../error-handling/customErrors/ErrorWithTx.mjs";
+import { ExternalActionId as s } from "../../types/external-action.types.mjs";
+import { TransactionStatus as c } from "../../types/transactions.types.mjs";
+import { AdminTransactionType as l } from "../../types/admin.types.mjs";
+import { ActivityTypes as u } from "../../types/activities.types.mjs";
+import { TransactionRequestType as d } from "../../types/transaction.types.mjs";
+import { MessagesFromOffscreen as f } from "../../types/offscreen.types.mjs";
+import "../../types/index.mjs";
+import { Logger as p } from "../../error-handling/logger.mjs";
+import { API as te } from "../../API/API.mjs";
+import { getErc20TokenFromAPI as m, getErc20TokensBySymbolsFromAPI as h } from "../../functions/utils/erc20tokenFunctions.mjs";
+import { getErrorMessageFromTransactionRequest as g } from "../../error-handling/get-error.message.mjs";
+import "../../error-handling/index.mjs";
+import { modifyVolatileTokenAmountChanges as _ } from "../../functions/pre-transaction/getVolatileTransferAmount.mjs";
+import { createJsonRpcProvider as v } from "../../functions/utils/create-provider.mjs";
+import { getFeeStructure as y } from "../../functions/pre-transaction/getFeeStructure.mjs";
+import { convertEmporiumOpToCallInfo as b } from "../../functions/utils/convertEmporiumOpToCallInfo.mjs";
+import { postToOffscreen as x } from "../../functions/utils/postToOffscreen.mjs";
+import { getGasTokenSymbols as S } from "../../functions/utils/fees.utils.mjs";
+import { createTransaferEmporiumOpsBatch as C } from "../../functions/private-wallet/emporium.helpers.mjs";
+import { getTokensToDepositBack as w } from "../../functions/auto-deposit-back-helpers/get-tokens-to-deposit-back.mjs";
+import { getGasTokenRecords as T } from "../../functions/auto-deposit-back-helpers/get-gas-token-records.mjs";
+import { selectGasToken as E } from "../../functions/auto-deposit-back-helpers/select-gas-token.mjs";
+import { updateHinkal as D } from "../../functions/auto-deposit-back-helpers/update-hinkal.mjs";
+import "../../functions/index.mjs";
+import { activityStorage as O } from "../IndexedDB/activity-db.mjs";
+import "../IndexedDB/index.mjs";
+//#region common/src/data-structures/Hinkal/handleAutoDepositBack.ts
+var k = 3 * 1e3, ne = 13 * 1e3, A = async (A, j, M, N, P, F, I, L) => {
+	if (!M || I.length === 0) return;
+	let R;
+	try {
+		let o = v(j);
+		await a(j === e.ethMainnet ? ne : k);
+		let d = await w(I, P, M, o);
+		if (!d.length) {
+			x(f.AutoShieldTxStatus, { message: r.AUTO_SHIELD_SKIPPED });
+			return;
+		}
+		let p = (await h(await S(j), j)).filter((e) => e !== void 0), { prices: g } = await te.getTokenPrices(j, p.map((e) => e.erc20TokenAddress)), z = new Map(g.map((e, t) => [p[t].erc20TokenAddress.toLowerCase(), e])), B = d.map(({ token: e }) => e), V = d.map(({ balance: e }) => e), H = B.map(({ erc20TokenAddress: e }) => e), U = C(A, j, H, await _(j, B, V, M)), W = await y(j, P, H, s.Emporium, U.map((e) => b(e, M, j))), { flatFee: G } = W ?? {}, K = await m(j, W.feeToken);
+		if (!K) return;
+		let q = i(K, G), J = (z.get(K.erc20TokenAddress.toLowerCase()) ?? 0) * Number(q), Y = await E(P, J, j, B, U, await T(p, j, A, M, o, z), W, H, M);
+		if (!Y) return;
+		let { feeToken: X, feeStructure: Z } = Y ?? {};
+		if (F && Number(F) < J) {
+			x(f.AutoShieldTxStatus, { message: ee.GAS_PRICE_EXCEEDS_AUTOSHIELD_LIMIT });
+			return;
+		}
+		let Q = B.findIndex((e) => n(e.erc20TokenAddress, X));
+		Q !== -1 && (V[Q] -= Z?.flatFee ?? 0n);
+		let { hinkalAddress: re } = t[j].contractData, $ = {
+			activityType: u.AUTO_SHIELD,
+			chainId: j,
+			from: M,
+			to: re,
+			gasInDollar: J.toString(),
+			tokensReceive: B.map((e, t) => ({
+				amount: i(e, V[t]),
+				token: e
+			}))
+		};
+		R = await O.saveTxRequest($), x(f.AutoShieldTxStatus, { status: c.Loading }), D(j, A, L.inputNullifiers?.flat(), L.outCommitments?.flat(), L.encryptedOutputs?.flat());
+		let ie = {
+			id: 0,
+			success: !0,
+			txHash: await A.actionReceive(B, V, X, Z, N, l.AutoShield)
+		};
+		await O.updatePendingTransactions(ie, R), x(f.AutoShieldTxStatus, {
+			status: c.Confirmed,
+			activityRequest: $
+		});
+	} catch (e) {
+		let t;
+		e instanceof o && (t = e.txHash);
+		let n = {
+			error: e,
+			id: 0,
+			success: !1,
+			...t ? { erroredTx: t } : {}
+		};
+		R && await O.updatePendingTransactions(n, R), x(f.AutoShieldTxStatus, {
+			status: c.Failed,
+			error: g(e, d.ReceiveFromShieldedAccount)
+		}), p.error("Error in auto deposit back:", e);
+	}
+};
+//#endregion
+export { A as handleAutoDepositBack };

package/common/src/data-structures/Hinkal/hinkalActionReceive.cjs

@@ -0,0 +1 @@
+const e=require(`../../types/external-action.types.cjs`),t=require(`../../functions/utils/token-check.utils.cjs`),n=require(`../../functions/pre-transaction/getVolatileTransferAmount.cjs`),r=require(`../AccountActions/AccountActions.cjs`),i=require(`../../functions/pre-transaction/getFeeStructure.cjs`),a=require(`../../functions/utils/convertEmporiumOpToCallInfo.cjs`),o=require(`../../functions/private-wallet/emporium.helpers.cjs`);var s=async(s,c,l,u,d,f,p)=>{if(!f)throw Error(`hinkalActionReceive: subAccount should be provided`);if(!u)throw Error(`Fee token is required in hinkalActionReceive`);let m=t.validateAndGetChainId(c),h=r.AccountActions.getAddressFromSubAccount(m,f);if(!h)throw Error(`Public account address is not available`);let g=c.map(e=>e.erc20TokenAddress),_=await n.modifyVolatileTokenAmountChanges(m,c,l,h),v=o.createTransaferEmporiumOpsBatch(s,m,g,_),y=d??await i.getFeeStructure(m,u,g,e.ExternalActionId.Emporium,v.map(e=>a.convertEmporiumOpToCallInfo(e,h,m))),b=c.map((e,t)=>({token:e,amount:-1n*_[t]}));return s.actionPrivateWallet(m,c,_,_.map(()=>!1),v,b,f,u,y,void 0,void 0,void 0,p,void 0)};exports.hinkalActionReceive=s;

package/common/src/data-structures/Hinkal/hinkalActionReceive.d.ts

@@ -0,0 +1,7 @@
+import { IHinkal } from './IHinkal';
+import { FeeStructure } from '../../types/hinkal.types';
+import { ERC20Token } from '../../types/token.types';
+import { SubAccount } from '../../types/proxy.types';
+import { AdminTransactionType } from '../../types/admin.types';
+export declare const hinkalActionReceive: (hinkal: IHinkal, erc20Tokens: ERC20Token[], deltaAmountsBase: bigint[], // should be positive
+feeToken?: string, feeStructureOverride?: FeeStructure, subAccount?: SubAccount, action?: AdminTransactionType) => Promise<string>;

package/common/src/data-structures/Hinkal/hinkalActionReceive.mjs

@@ -0,0 +1,21 @@
+import { ExternalActionId as e } from "../../types/external-action.types.mjs";
+import { validateAndGetChainId as t } from "../../functions/utils/token-check.utils.mjs";
+import { modifyVolatileTokenAmountChanges as n } from "../../functions/pre-transaction/getVolatileTransferAmount.mjs";
+import { AccountActions as r } from "../AccountActions/AccountActions.mjs";
+import { getFeeStructure as i } from "../../functions/pre-transaction/getFeeStructure.mjs";
+import { convertEmporiumOpToCallInfo as a } from "../../functions/utils/convertEmporiumOpToCallInfo.mjs";
+import { createTransaferEmporiumOpsBatch as o } from "../../functions/private-wallet/emporium.helpers.mjs";
+//#region common/src/data-structures/Hinkal/hinkalActionReceive.ts
+var s = async (s, c, l, u, d, f, p) => {
+	if (!f) throw Error("hinkalActionReceive: subAccount should be provided");
+	if (!u) throw Error("Fee token is required in hinkalActionReceive");
+	let m = t(c), h = r.getAddressFromSubAccount(m, f);
+	if (!h) throw Error("Public account address is not available");
+	let g = c.map((e) => e.erc20TokenAddress), _ = await n(m, c, l, h), v = o(s, m, g, _), y = d ?? await i(m, u, g, e.Emporium, v.map((e) => a(e, h, m))), b = c.map((e, t) => ({
+		token: e,
+		amount: -1n * _[t]
+	}));
+	return s.actionPrivateWallet(m, c, _, _.map(() => !1), v, b, f, u, y, void 0, void 0, void 0, p, void 0);
+};
+//#endregion
+export { s as hinkalActionReceive };

package/common/src/data-structures/Hinkal/hinkalClaimUtxo.cjs

@@ -0,0 +1 @@
+const e=require(`../../constants/chains.constants.cjs`),t=require(`../../constants/protocol.constants.cjs`),n=require(`../../functions/utils/caseInsensitive.utils.cjs`),r=require(`../../error-handling/error-codes.constants.cjs`),i=require(`../crypto-keys/keys.cjs`),a=require(`../../functions/utils/time.utils.cjs`),o=require(`../utxo/Utxo.cjs`),s=require(`../../types/external-action.types.cjs`),c=require(`../../functions/utils/tron.utils.cjs`),l=require(`../../functions/utils/token-check.utils.cjs`),u=require(`../../functions/pre-transaction/outputUtxoProcessing.cjs`),d=require(`../../functions/pre-transaction/getFeeStructure.cjs`),f=require(`../../functions/snarkjs/constructGeneralZkProof.cjs`),p=require(`../../functions/web3/functionCalls/transactCallRelayer.cjs`);var m=async(m,h,g,_,v)=>{let y=l.validateAndGetChainId([h]),b=e.isTronLike(y),x=h.erc20TokenAddress,S=c.addressToHexFormat(await m.getEthereumAddressByChain(y));if(!n.caseInsensitiveEqual(x,g.erc20TokenAddress))throw Error(`Off-chain UTXO token mismatch`);let C=v?new i.UserKeys(v):new i.UserKeys(g.nullifyingKey,g.nullifyingKey);if(!g.nullifyingKey&&!v)throw Error(`Claimable UTXO nullifyingKey is missing`);let w=C.getShieldedPrivateKey();if(g.nullifyingKey&&g.nullifyingKey!==w)throw Error(`Claimable UTXO key mismatch`);let T=m.getRecipientInfo(),E=o.Utxo.createFrom(g,{nullifyingKey:w}),D=new o.Utxo({amount:0n,erc20TokenAddress:E.erc20TokenAddress,mintAddress:E.mintAddress,nullifyingKey:w,...E.isNewStyle?{spendingPublicKey:C.getSpendingKeyPair().pubSpendingBJJPoint,isNewStyle:!0}:{isNewStyle:!1}}),O=_??await d.getFeeStructure(y,x,[x],s.ExternalActionId.Transact);if(!n.caseInsensitiveEqual(O.feeToken,x))throw Error(`Claim fee token mismatch: fee must be paid from claimed UTXO token`);let k=O.variableRate>0n?O.variableRate:t.HINKAL_PRIVATE_SEND_VARIABLE_RATE;if(E.amount<=O.flatFee)throw Error(r.transactionErrorCodes.INSUFFICIENT_FUNDS_TO_TRANSACT);let A=E.amount-O.flatFee,j=A*k/10000n,M=A-j;if(M<=0n)throw Error(r.transactionErrorCodes.RECIPIENT_AMOUNT_INVALID);let N={feeToken:O.feeToken,flatFee:O.flatFee+j,variableRate:0n},P=[-E.amount],F=await m.getRandomRelay(y,!0);if(!F)throw Error(r.transactionErrorCodes.RELAYER_NOT_AVAILABLE);let I={externalActionId:0n,externalAddress:F??S,externalActionMetadata:`0x00`},L=[[E,D]],R=[],z=a.getCurrentTimeInSeconds().toString(),{outputUtxos:B}=u.outputUtxoProcessing(C,L[0],P[0],z,!0,T,M);R.push(B);let{zkCallData:V,circomData:H,dimData:U,commitmentValidationData:W}=await f.constructZkProof(m.merkleTreeHinkalByChain[y],L,R,C,I.externalActionId,I.externalAddress,I.externalActionMetadata,m.generateProofRemotely,N,F,y);return p.transactCallRelayer(y,V,U,H,W,void 0,void 0,void 0,await c.reorderZkCallData(b,V,U,H))};exports.hinkalClaimUtxo=m;

package/common/src/data-structures/Hinkal/hinkalClaimUtxo.d.ts

@@ -0,0 +1,5 @@
+import { ERC20Token } from '../../types/token.types';
+import { IHinkal } from './IHinkal';
+import { FeeStructure } from '../../types/hinkal.types';
+import { Utxo } from '../utxo/Utxo';
+export declare const hinkalClaimUtxo: (hinkal: IHinkal, erc20Token: ERC20Token, utxo: Utxo, feeStructureOverride?: FeeStructure, claimableSignature?: string) => Promise<string>;

package/common/src/data-structures/Hinkal/hinkalClaimUtxo.mjs

@@ -0,0 +1,54 @@
+import { isTronLike as e } from "../../constants/chains.constants.mjs";
+import { HINKAL_PRIVATE_SEND_VARIABLE_RATE as t } from "../../constants/protocol.constants.mjs";
+import { caseInsensitiveEqual as n } from "../../functions/utils/caseInsensitive.utils.mjs";
+import { transactionErrorCodes as r } from "../../error-handling/error-codes.constants.mjs";
+import { UserKeys as i } from "../crypto-keys/keys.mjs";
+import { getCurrentTimeInSeconds as a } from "../../functions/utils/time.utils.mjs";
+import { Utxo as o } from "../utxo/Utxo.mjs";
+import { ExternalActionId as s } from "../../types/external-action.types.mjs";
+import { addressToHexFormat as c, reorderZkCallData as l } from "../../functions/utils/tron.utils.mjs";
+import { validateAndGetChainId as u } from "../../functions/utils/token-check.utils.mjs";
+import { outputUtxoProcessing as d } from "../../functions/pre-transaction/outputUtxoProcessing.mjs";
+import { getFeeStructure as f } from "../../functions/pre-transaction/getFeeStructure.mjs";
+import { constructZkProof as p } from "../../functions/snarkjs/constructGeneralZkProof.mjs";
+import { transactCallRelayer as m } from "../../functions/web3/functionCalls/transactCallRelayer.mjs";
+//#region common/src/data-structures/Hinkal/hinkalClaimUtxo.ts
+var h = async (h, g, _, v, y) => {
+	let b = u([g]), x = e(b), S = g.erc20TokenAddress, C = c(await h.getEthereumAddressByChain(b));
+	if (!n(S, _.erc20TokenAddress)) throw Error("Off-chain UTXO token mismatch");
+	let w = y ? new i(y) : new i(_.nullifyingKey, _.nullifyingKey);
+	if (!_.nullifyingKey && !y) throw Error("Claimable UTXO nullifyingKey is missing");
+	let T = w.getShieldedPrivateKey();
+	if (_.nullifyingKey && _.nullifyingKey !== T) throw Error("Claimable UTXO key mismatch");
+	let E = h.getRecipientInfo(), D = o.createFrom(_, { nullifyingKey: T }), O = new o({
+		amount: 0n,
+		erc20TokenAddress: D.erc20TokenAddress,
+		mintAddress: D.mintAddress,
+		nullifyingKey: T,
+		...D.isNewStyle ? {
+			spendingPublicKey: w.getSpendingKeyPair().pubSpendingBJJPoint,
+			isNewStyle: !0
+		} : { isNewStyle: !1 }
+	}), k = v ?? await f(b, S, [S], s.Transact);
+	if (!n(k.feeToken, S)) throw Error("Claim fee token mismatch: fee must be paid from claimed UTXO token");
+	let A = k.variableRate > 0n ? k.variableRate : t;
+	if (D.amount <= k.flatFee) throw Error(r.INSUFFICIENT_FUNDS_TO_TRANSACT);
+	let j = D.amount - k.flatFee, M = j * A / 10000n, N = j - M;
+	if (N <= 0n) throw Error(r.RECIPIENT_AMOUNT_INVALID);
+	let P = {
+		feeToken: k.feeToken,
+		flatFee: k.flatFee + M,
+		variableRate: 0n
+	}, F = [-D.amount], I = await h.getRandomRelay(b, !0);
+	if (!I) throw Error(r.RELAYER_NOT_AVAILABLE);
+	let L = {
+		externalActionId: 0n,
+		externalAddress: I ?? C,
+		externalActionMetadata: "0x00"
+	}, R = [[D, O]], z = [], B = a().toString(), { outputUtxos: V } = d(w, R[0], F[0], B, !0, E, N);
+	z.push(V);
+	let { zkCallData: H, circomData: U, dimData: W, commitmentValidationData: G } = await p(h.merkleTreeHinkalByChain[b], R, z, w, L.externalActionId, L.externalAddress, L.externalActionMetadata, h.generateProofRemotely, P, I, b);
+	return m(b, H, W, U, G, void 0, void 0, void 0, await l(x, H, W, U));
+};
+//#endregion
+export { h as hinkalClaimUtxo };

package/common/src/data-structures/Hinkal/hinkalDeposit.cjs

@@ -0,0 +1 @@
+const e=require(`../../constants/chains.constants.cjs`),t=require(`../../constants/protocol.constants.cjs`),n=require(`../../types/hinkal.types.cjs`),r=require(`../../error-handling/error-codes.constants.cjs`),i=require(`../../functions/utils/time.utils.cjs`),a=require(`../utxo/Utxo.cjs`),o=require(`../../functions/utils/addresses.cjs`),s=require(`../../functions/utils/tron.utils.cjs`),c=require(`../../functions/utils/token-check.utils.cjs`),l=require(`../../functions/web3/events/getShieldedBalance.cjs`),u=require(`../../functions/pre-transaction/outputUtxoProcessing.cjs`),d=require(`../../functions/pre-transaction/constructAdminData.cjs`),f=require(`../../functions/utils/tronSimulation.utils.cjs`),p=require(`../../functions/snarkjs/constructGeneralZkProof.cjs`),m=require(`../../functions/web3/functionCalls/waitForErc20Approvals.cjs`),h=require(`../../functions/web3/functionCalls/transactCallDirect.cjs`),g=require(`../../API/admin-calls.cjs`);var _=async(e,t)=>({externalActionData:{externalActionId:0n,externalAddress:s.addressToHexFormat(await e.getEthereumAddressByChain(t)),externalActionMetadata:`0x00`},contractTransaction:void 0,contractToApprove:void 0}),v=async(e,t,n,r)=>{let a=[...await l.addPaddingToUtxos(e,t,n,r)],o=[],s=i.getCurrentTimeInSeconds().toString();for(let t=0;t<n.length;t+=1){let{outputUtxos:n}=u.outputUtxoProcessing(e.userKeys,a[t],r[t],s);o.push(n)}return{inputUtxosArray:a,outputUtxosArray:o}},y=async(n,r,i,a,o,c,l,u=!0,d=!1)=>{let p=n.getTronWeb(),{hinkalAddress:h,hinkalABI:g}=e.networkRegistry[r].contractData;if(!g)throw Error(`Hinkal ABI not found`);let _=s.evmHexToTronBase58Address(h),v=await n.getEthereumAddressByChain(r),{totalTrxValue:y,tokensNeedingApproval:b}=s.splitTronTokensByNative(i,a),{a:x,b:S,c:C}=s.parseZkCalldata(o),w=await s.reorderZkCallData(!0,o,l,c,!1);if(!w)throw Error(`Tron proof signature not found`);let T=[w.v,w.r,w.s],E=[l.tokenNumber,l.nullifierAmount,l.outputAmount],D=s.circomDataToArray(c),O=y>0n?Number(y):0;if(d){let e=s.createTronCallData(g,`transact`,[T,x,S,C,E,D]),{transaction:n}=await p.transactionBuilder.triggerSmartContract(_,``,{feeLimit:t.TRON_DEFAULT_FEE_LIMIT_SUN,callValue:O,input:e},[],v);return n}await s.approveTronTokens(p,v,_,b),b.size>0&&await m.waitForTronErc20Approvals(p,v,_,Array.from(b.entries()).map(([e,t])=>({tokenAddress:e,requiredAmount:t}))),u&&(await f.simulateTronTransaction(r,_,`transact`,g,[T,x,S,C,E,D],v,y>0n?y:void 0),await s.assertTronSufficientBalance(p,r,_,v,s.createTronCallData(g,`transact`,[T,x,S,C,E,D]),y));let k=await p.contract(g,_).transact(T,x,S,C,E,D).send({feeLimit:t.TRON_DEFAULT_FEE_LIMIT_SUN,callValue:O}),A=typeof k==`string`?k:k?.txid??k?.transaction?.txID;if(!A)throw Error(`Tron deposit failed (missing txid)`);return A},b=async(r,i,a,o=!0,s=!1)=>{let l=c.validateAndGetChainId(i),u=e.isTronLike(l),d=i.map(e=>e.erc20TokenAddress),[{externalActionData:f,contractTransaction:m,contractToApprove:g},{inputUtxosArray:b,outputUtxosArray:x}]=await Promise.all([_(r,l),v(r,l,d,a)]),{zkCallData:S,circomData:C,dimData:w}=await p.constructZkProof(r.merkleTreeHinkalByChain[l],b,x,r.userKeys,f.externalActionId,f.externalAddress,f.externalActionMetadata,r.generateProofRemotely,n.zeroFeeStructure,t.zeroAddress,l);return u?await y(r,l,i,a,S,C,w,o,s):await h.transactCallDirect(r,l,a,i,S,C,w,g,m,o,s)},x=async(i,s,l,u,f=!0,m=!1,v)=>{let b=c.validateAndGetChainId(s),x=e.isTronLike(b),S=s.map(e=>e.erc20TokenAddress),[C,w,T,,E]=u.split(`,`);if(!o.isValidPrivateAddress(u))throw Error(r.transactionErrorCodes.RECIPIENT_FORMAT_INCORRECT);let D=S.map(e=>[new a.Utxo({amount:0n,erc20TokenAddress:e,nullifyingKey:i.userKeys.getShieldedPrivateKey(),spendingPublicKey:i.userKeys.getSpendingKeyPair().pubSpendingBJJPoint,isNewStyle:!0}),new a.Utxo({amount:0n,erc20TokenAddress:e,nullifyingKey:i.userKeys.getShieldedPrivateKey(),spendingPublicKey:i.userKeys.getSpendingKeyPair().pubSpendingBJJPoint,isNewStyle:!0})]),O=S.map((e,t)=>[new a.Utxo({amount:l[t],erc20TokenAddress:e,H0:[BigInt(w),BigInt(T)],stealthAddress:C,encryptionKey:E,isNewStyle:!0})]),{externalActionData:k,contractTransaction:A,contractToApprove:j}=await _(i,b),{zkCallData:M,circomData:N,dimData:P}=await p.constructZkProof(i.merkleTreeHinkalByChain[b],D,O,i.userKeys,k.externalActionId,k.externalAddress,k.externalActionMetadata,i.generateProofRemotely,n.zeroFeeStructure,t.zeroAddress,b);if(x)return await y(i,b,s,l,M,N,P,f,m);let F=await h.transactCallDirect(i,b,l,s,M,N,P,j,A,f,m);return g.emitTxPublicData(d.constructAdminData(v,b,S,l,await i.getEthereumAddress())),F};exports.hinkalDeposit=b,exports.hinkalDepositForOther=x;

package/common/src/data-structures/Hinkal/hinkalDeposit.d.ts

@@ -0,0 +1,6 @@
+import { ethers } from 'ethers';
+import { Types as TronWebTypes } from 'tronweb';
+import { IHinkal } from './IHinkal';
+import { AdminTransactionType, ERC20Token } from '../../types';
+export declare const hinkalDeposit: (hinkal: IHinkal, erc20Tokens: ERC20Token[], amountChanges: bigint[], preEstimateGas?: boolean, returnTxData?: boolean) => Promise<ethers.TransactionResponse | ethers.TransactionRequest | string | TronWebTypes.Transaction<TronWebTypes.TriggerSmartContract>>;
+export declare const hinkalDepositForOther: (hinkal: IHinkal, erc20Tokens: ERC20Token[], amountChanges: bigint[], recipientInfo: string, preEstimateGas?: boolean, returnTxData?: boolean, action?: AdminTransactionType) => Promise<ethers.TransactionResponse | ethers.TransactionRequest | string | TronWebTypes.Transaction<TronWebTypes.TriggerSmartContract>>;

package/common/src/data-structures/Hinkal/hinkalDeposit.mjs

@@ -0,0 +1,121 @@
+import { isTronLike as e, networkRegistry as t } from "../../constants/chains.constants.mjs";
+import { TRON_DEFAULT_FEE_LIMIT_SUN as n, zeroAddress as r } from "../../constants/protocol.constants.mjs";
+import { zeroFeeStructure as i } from "../../types/hinkal.types.mjs";
+import { transactionErrorCodes as a } from "../../error-handling/error-codes.constants.mjs";
+import { getCurrentTimeInSeconds as o } from "../../functions/utils/time.utils.mjs";
+import { Utxo as s } from "../utxo/Utxo.mjs";
+import { isValidPrivateAddress as c } from "../../functions/utils/addresses.mjs";
+import { addressToHexFormat as l, approveTronTokens as u, assertTronSufficientBalance as d, circomDataToArray as f, createTronCallData as p, evmHexToTronBase58Address as m, parseZkCalldata as h, reorderZkCallData as g, splitTronTokensByNative as _ } from "../../functions/utils/tron.utils.mjs";
+import { validateAndGetChainId as v } from "../../functions/utils/token-check.utils.mjs";
+import { addPaddingToUtxos as y } from "../../functions/web3/events/getShieldedBalance.mjs";
+import { outputUtxoProcessing as b } from "../../functions/pre-transaction/outputUtxoProcessing.mjs";
+import { constructAdminData as x } from "../../functions/pre-transaction/constructAdminData.mjs";
+import { simulateTronTransaction as S } from "../../functions/utils/tronSimulation.utils.mjs";
+import { constructZkProof as C } from "../../functions/snarkjs/constructGeneralZkProof.mjs";
+import { waitForTronErc20Approvals as w } from "../../functions/web3/functionCalls/waitForErc20Approvals.mjs";
+import { transactCallDirect as T } from "../../functions/web3/functionCalls/transactCallDirect.mjs";
+import { emitTxPublicData as E } from "../../API/admin-calls.mjs";
+//#region common/src/data-structures/Hinkal/hinkalDeposit.ts
+var D = async (e, t) => ({
+	externalActionData: {
+		externalActionId: 0n,
+		externalAddress: l(await e.getEthereumAddressByChain(t)),
+		externalActionMetadata: "0x00"
+	},
+	contractTransaction: void 0,
+	contractToApprove: void 0
+}), O = async (e, t, n, r) => {
+	let i = [...await y(e, t, n, r)], a = [], s = o().toString();
+	for (let t = 0; t < n.length; t += 1) {
+		let { outputUtxos: n } = b(e.userKeys, i[t], r[t], s);
+		a.push(n);
+	}
+	return {
+		inputUtxosArray: i,
+		outputUtxosArray: a
+	};
+}, k = async (e, r, i, a, o, s, c, l = !0, v = !1) => {
+	let y = e.getTronWeb(), { hinkalAddress: b, hinkalABI: x } = t[r].contractData;
+	if (!x) throw Error("Hinkal ABI not found");
+	let C = m(b), T = await e.getEthereumAddressByChain(r), { totalTrxValue: E, tokensNeedingApproval: D } = _(i, a), { a: O, b: k, c: A } = h(o), j = await g(!0, o, c, s, !1);
+	if (!j) throw Error("Tron proof signature not found");
+	let M = [
+		j.v,
+		j.r,
+		j.s
+	], N = [
+		c.tokenNumber,
+		c.nullifierAmount,
+		c.outputAmount
+	], P = f(s), F = E > 0n ? Number(E) : 0;
+	if (v) {
+		let e = p(x, "transact", [
+			M,
+			O,
+			k,
+			A,
+			N,
+			P
+		]), { transaction: t } = await y.transactionBuilder.triggerSmartContract(C, "", {
+			feeLimit: n,
+			callValue: F,
+			input: e
+		}, [], T);
+		return t;
+	}
+	await u(y, T, C, D), D.size > 0 && await w(y, T, C, Array.from(D.entries()).map(([e, t]) => ({
+		tokenAddress: e,
+		requiredAmount: t
+	}))), l && (await S(r, C, "transact", x, [
+		M,
+		O,
+		k,
+		A,
+		N,
+		P
+	], T, E > 0n ? E : void 0), await d(y, r, C, T, p(x, "transact", [
+		M,
+		O,
+		k,
+		A,
+		N,
+		P
+	]), E));
+	let I = await y.contract(x, C).transact(M, O, k, A, N, P).send({
+		feeLimit: n,
+		callValue: F
+	}), L = typeof I == "string" ? I : I?.txid ?? I?.transaction?.txID;
+	if (!L) throw Error("Tron deposit failed (missing txid)");
+	return L;
+}, A = async (t, n, a, o = !0, s = !1) => {
+	let c = v(n), l = e(c), u = n.map((e) => e.erc20TokenAddress), [{ externalActionData: d, contractTransaction: f, contractToApprove: p }, { inputUtxosArray: m, outputUtxosArray: h }] = await Promise.all([D(t, c), O(t, c, u, a)]), { zkCallData: g, circomData: _, dimData: y } = await C(t.merkleTreeHinkalByChain[c], m, h, t.userKeys, d.externalActionId, d.externalAddress, d.externalActionMetadata, t.generateProofRemotely, i, r, c);
+	return l ? await k(t, c, n, a, g, _, y, o, s) : await T(t, c, a, n, g, _, y, p, f, o, s);
+}, j = async (t, n, o, l, u = !0, d = !1, f) => {
+	let p = v(n), m = e(p), h = n.map((e) => e.erc20TokenAddress), [g, _, y, , b] = l.split(",");
+	if (!c(l)) throw Error(a.RECIPIENT_FORMAT_INCORRECT);
+	let S = h.map((e) => [new s({
+		amount: 0n,
+		erc20TokenAddress: e,
+		nullifyingKey: t.userKeys.getShieldedPrivateKey(),
+		spendingPublicKey: t.userKeys.getSpendingKeyPair().pubSpendingBJJPoint,
+		isNewStyle: !0
+	}), new s({
+		amount: 0n,
+		erc20TokenAddress: e,
+		nullifyingKey: t.userKeys.getShieldedPrivateKey(),
+		spendingPublicKey: t.userKeys.getSpendingKeyPair().pubSpendingBJJPoint,
+		isNewStyle: !0
+	})]), w = h.map((e, t) => [new s({
+		amount: o[t],
+		erc20TokenAddress: e,
+		H0: [BigInt(_), BigInt(y)],
+		stealthAddress: g,
+		encryptionKey: b,
+		isNewStyle: !0
+	})]), { externalActionData: O, contractTransaction: A, contractToApprove: j } = await D(t, p), { zkCallData: M, circomData: N, dimData: P } = await C(t.merkleTreeHinkalByChain[p], S, w, t.userKeys, O.externalActionId, O.externalAddress, O.externalActionMetadata, t.generateProofRemotely, i, r, p);
+	if (m) return await k(t, p, n, o, M, N, P, u, d);
+	let F = await T(t, p, o, n, M, N, P, j, A, u, d);
+	return E(x(f, p, h, o, await t.getEthereumAddress())), F;
+};
+//#endregion
+export { A as hinkalDeposit, j as hinkalDepositForOther };

package/common/src/data-structures/Hinkal/hinkalDepositAndBridge.cjs

@@ -0,0 +1 @@
+const e=require(`../../constants/chains.constants.cjs`),t=require(`../../constants/protocol.constants.cjs`),n=require(`../../functions/utils/caseInsensitive.utils.cjs`),r=require(`../../error-handling/error-codes.constants.cjs`),i=require(`../../functions/utils/time.utils.cjs`),a=require(`../utxo/Utxo.cjs`),o=require(`../../types/external-action.types.cjs`),s=require(`../../types/scheduled-transactions.types.cjs`);require(`../../types/index.cjs`);const c=require(`../../functions/utils/addresses.cjs`),l=require(`../../API/API.cjs`),u=require(`../../functions/utils/token-check.utils.cjs`),d=require(`../../functions/utils/erc20tokenFunctions.cjs`),f=require(`../../functions/pre-transaction/constructAdminData.cjs`),p=require(`../../functions/pre-transaction/getFeeStructure.cjs`),m=require(`../../functions/pre-transaction/waitForDepositedUtxosInMerkleTree.cjs`),h=require(`../../constants/addresses.constants.cjs`),g=require(`../../functions/utils/convertEmporiumOpToCallInfo.cjs`),_=require(`../../functions/utils/fees.utils.cjs`);require(`../../functions/utils/index.cjs`);const v=require(`../../functions/private-wallet/emporium.helpers.cjs`),y=require(`../../functions/snarkjs/constructGeneralZkProof.cjs`),b=require(`../../functions/web3/functionCalls/transactCallRelayer.cjs`),x=require(`../../API/deposit-and-withdraw-status-calls.cjs`),S=require(`./hinkalDepositOnChainUtxos.cjs`);require(`../../functions/index.cjs`);var C=async(c,u,d,p,m,g,S,C,w,T,E)=>{if(p.length===0)throw Error(`No recipients to bridge`);let D=d.erc20TokenAddress,{contractData:O}=e.networkRegistry[u],{emporiumAddress:k}=O;if(!k)throw Error(`No Emporium Address`);let A=h.SWAP_ROUTER_ADDRESSES[o.ExternalActionId.Lifi][u];if(!A)throw Error(`LIFI not configured for chain ${u}`);let j=await c.getRandomRelay(u);if(!j)throw Error(r.transactionErrorCodes.RELAYER_NOT_AVAILABLE);let M=await c.getEthereumAddressByChain(u),N=i.getCurrentTimeInSeconds().toString(),P=c.generateProofRemotely?5:1,F=[];for(let e=0;e<p.length;e+=P){let r=p.slice(e,e+P),i=await Promise.all(r.map(async({utxo:e,nativeUtxo:r,bridgeAmount:i,quote:s,temporarySubAccount:p,recipientAddress:h})=>{await l.API.addTemporaryWalletNonce(u,g,p.index);let b=s.nativeFee>0n&&!n.caseInsensitiveEqual(D,t.zeroAddress),x=[D],S=[-e.amount],C=[!1],w=new a.Utxo({amount:0n,erc20TokenAddress:D,nullifyingKey:c.userKeys.getShieldedPrivateKey(),timeStamp:N,...e.isNewStyle?{spendingPublicKey:c.userKeys.getSpendingKeyPair().pubSpendingBJJPoint,isNewStyle:!0}:{isNewStyle:!1}}),E=[[e,w]],O=[[w]];if(b&&r){let e=new a.Utxo({amount:0n,erc20TokenAddress:t.zeroAddress,nullifyingKey:c.userKeys.getShieldedPrivateKey(),timeStamp:N,...r.isNewStyle?{spendingPublicKey:c.userKeys.getSpendingKeyPair().pubSpendingBJJPoint,isNewStyle:!0}:{isNewStyle:!1}});x.push(t.zeroAddress),S.push(-r.amount),C.push(!1),E.push([r,e]),O.push([e])}let P=v.createLifiBridgeOps(c,u,p.ethAddress,A,D,e.amount,i,s),F=await _.calculateModifiedFeeStructure(u,d,i,m),I=f.constructAdminData(T,u,x,[-e.amount],M),[{zkCallData:L,circomData:R,dimData:z,commitmentValidationData:B},V]=await Promise.all([y.constructZkProof(c.merkleTreeHinkalByChain[u],E,O,c.userKeys,o.ExternalActionId.Emporium,k,P,c.generateProofRemotely,F,j??t.zeroAddress,u,C,void 0,void 0,p.privateKey),v.getAuthorizationDataIfNeeded(u,p.privateKey)]);return{zkCallData:L,dimData:z,circomData:R,commitmentValidationData:B,authorizationData:V,recipientAddress:h,adminData:I}}));F.push(...i)}await x.safeUpdateDepositAndWithdrawStatus({id:S,chainId:u,hashedEthereumAddress:g,phase:s.DepositAndWithdrawPhase.BEFORE_SCHEDULE_WITHDRAW});let I=await b.transactCallRelayerBatch(u,F,g,C,w,E);return await x.safeUpdateDepositAndWithdrawStatus({id:S,chainId:u,hashedEthereumAddress:g,phase:s.DepositAndWithdrawPhase.AFTER_SCHEDULE_WITHDRAW,scheduleId:I}),I},w=async(e,r,i,a,s,l,f,_,y=!0)=>{let b=r.erc20TokenAddress,x=u.validateAndGetChainId([r]),w=_?c.hashString(_):void 0,T=c.hashEthereumAddress(await e.getEthereumAddressByChain(x)),E=h.SWAP_ROUTER_ADDRESSES[o.ExternalActionId.Lifi][x];if(!E)throw Error(`LIFI router not configured`);let D;if(s)D=s;else{let n=i[0],r=v.createLifiBridgeOps(e,x,n.temporarySubAccount.ethAddress,E,b,n.bridgeAmount,n.bridgeAmount,n.quote).map(e=>g.convertEmporiumOpToCallInfo(e,n.temporarySubAccount.ethAddress,x));D=await p.getFeeStructure(x,b,[b],o.ExternalActionId.Emporium,r,t.PAY_SEND_VARIABLE_RATE)}let O={feeToken:D.feeToken,flatFee:0n,variableRate:0n},k=i.reduce((e,t)=>e+t.quote.nativeFee,0n)>0n&&!n.caseInsensitiveEqual(b,t.zeroAddress),A=i.map(e=>e.bridgeAmount),j=i.map(e=>e.recipientAddress),{userDepositedUtxos:M,statusId:N,depositTxHash:P}=await S.hinkalDepositOnChainUtxos(e,x,r,A,j,D,T,y),F=[];if(k){let n=await d.getErc20TokenFromAPI(x,t.zeroAddress);if(!n)throw Error(`No native token`);let{userDepositedUtxos:r}=await S.hinkalDepositOnChainUtxos(e,x,n,i.map(e=>e.quote.nativeFee),j,O,T,y);F=r}return await m.waitForDepositedUtxosInMerkleTree(e,x,[...M,...F]),{depositTxHash:P,scheduleId:await C(e,x,r,i.map((e,t)=>({...e,utxo:M[t].utxo,nativeUtxo:k?F[t]?.utxo:void 0})),D,T,N,a,l,f,w)}};exports.hinkalDepositAndBridge=w;

package/common/src/data-structures/Hinkal/hinkalDepositAndBridge.d.ts

@@ -0,0 +1,4 @@
+import { IHinkal } from './IHinkal';
+import { AdminTransactionType, BridgeRecipient, DepositAndSendExtendedResult, ERC20Token } from '../../types';
+import { FeeStructure } from '../../types/hinkal.types';
+export declare const hinkalDepositAndBridge: (hinkal: IHinkal, erc20Token: ERC20Token, recipients: BridgeRecipient[], txCompletionTime?: number, feeStructureOverride?: FeeStructure, ref?: string, action?: AdminTransactionType, dashboardAccountId?: string, preEstimateGas?: boolean) => Promise<DepositAndSendExtendedResult>;

package/common/src/data-structures/Hinkal/hinkalDepositAndBridge.mjs

@@ -0,0 +1,120 @@
+import { networkRegistry as e } from "../../constants/chains.constants.mjs";
+import { PAY_SEND_VARIABLE_RATE as t, zeroAddress as n } from "../../constants/protocol.constants.mjs";
+import { caseInsensitiveEqual as r } from "../../functions/utils/caseInsensitive.utils.mjs";
+import { transactionErrorCodes as i } from "../../error-handling/error-codes.constants.mjs";
+import { getCurrentTimeInSeconds as a } from "../../functions/utils/time.utils.mjs";
+import { Utxo as o } from "../utxo/Utxo.mjs";
+import { ExternalActionId as s } from "../../types/external-action.types.mjs";
+import { DepositAndWithdrawPhase as c } from "../../types/scheduled-transactions.types.mjs";
+import "../../types/index.mjs";
+import { hashEthereumAddress as l, hashString as u } from "../../functions/utils/addresses.mjs";
+import { API as d } from "../../API/API.mjs";
+import { validateAndGetChainId as f } from "../../functions/utils/token-check.utils.mjs";
+import { getErc20TokenFromAPI as p } from "../../functions/utils/erc20tokenFunctions.mjs";
+import { constructAdminData as m } from "../../functions/pre-transaction/constructAdminData.mjs";
+import { getFeeStructure as h } from "../../functions/pre-transaction/getFeeStructure.mjs";
+import { waitForDepositedUtxosInMerkleTree as g } from "../../functions/pre-transaction/waitForDepositedUtxosInMerkleTree.mjs";
+import { SWAP_ROUTER_ADDRESSES as _ } from "../../constants/addresses.constants.mjs";
+import { convertEmporiumOpToCallInfo as v } from "../../functions/utils/convertEmporiumOpToCallInfo.mjs";
+import { calculateModifiedFeeStructure as y } from "../../functions/utils/fees.utils.mjs";
+import "../../functions/utils/index.mjs";
+import { createLifiBridgeOps as b, getAuthorizationDataIfNeeded as x } from "../../functions/private-wallet/emporium.helpers.mjs";
+import { constructZkProof as S } from "../../functions/snarkjs/constructGeneralZkProof.mjs";
+import { transactCallRelayerBatch as C } from "../../functions/web3/functionCalls/transactCallRelayer.mjs";
+import { safeUpdateDepositAndWithdrawStatus as w } from "../../API/deposit-and-withdraw-status-calls.mjs";
+import { hinkalDepositOnChainUtxos as T } from "./hinkalDepositOnChainUtxos.mjs";
+import "../../functions/index.mjs";
+//#region common/src/data-structures/Hinkal/hinkalDepositAndBridge.ts
+var E = async (t, l, u, f, p, h, g, v, T, E, D) => {
+	if (f.length === 0) throw Error("No recipients to bridge");
+	let O = u.erc20TokenAddress, { contractData: k } = e[l], { emporiumAddress: A } = k;
+	if (!A) throw Error("No Emporium Address");
+	let j = _[s.Lifi][l];
+	if (!j) throw Error(`LIFI not configured for chain ${l}`);
+	let M = await t.getRandomRelay(l);
+	if (!M) throw Error(i.RELAYER_NOT_AVAILABLE);
+	let N = await t.getEthereumAddressByChain(l), P = a().toString(), F = t.generateProofRemotely ? 5 : 1, I = [];
+	for (let e = 0; e < f.length; e += F) {
+		let i = f.slice(e, e + F), a = await Promise.all(i.map(async ({ utxo: e, nativeUtxo: i, bridgeAmount: a, quote: c, temporarySubAccount: f, recipientAddress: g }) => {
+			await d.addTemporaryWalletNonce(l, h, f.index);
+			let _ = c.nativeFee > 0n && !r(O, n), v = [O], C = [-e.amount], w = [!1], T = new o({
+				amount: 0n,
+				erc20TokenAddress: O,
+				nullifyingKey: t.userKeys.getShieldedPrivateKey(),
+				timeStamp: P,
+				...e.isNewStyle ? {
+					spendingPublicKey: t.userKeys.getSpendingKeyPair().pubSpendingBJJPoint,
+					isNewStyle: !0
+				} : { isNewStyle: !1 }
+			}), D = [[e, T]], k = [[T]];
+			if (_ && i) {
+				let e = new o({
+					amount: 0n,
+					erc20TokenAddress: n,
+					nullifyingKey: t.userKeys.getShieldedPrivateKey(),
+					timeStamp: P,
+					...i.isNewStyle ? {
+						spendingPublicKey: t.userKeys.getSpendingKeyPair().pubSpendingBJJPoint,
+						isNewStyle: !0
+					} : { isNewStyle: !1 }
+				});
+				v.push(n), C.push(-i.amount), w.push(!1), D.push([i, e]), k.push([e]);
+			}
+			let F = b(t, l, f.ethAddress, j, O, e.amount, a, c), I = await y(l, u, a, p), L = m(E, l, v, [-e.amount], N), [{ zkCallData: R, circomData: z, dimData: B, commitmentValidationData: V }, H] = await Promise.all([S(t.merkleTreeHinkalByChain[l], D, k, t.userKeys, s.Emporium, A, F, t.generateProofRemotely, I, M ?? n, l, w, void 0, void 0, f.privateKey), x(l, f.privateKey)]);
+			return {
+				zkCallData: R,
+				dimData: B,
+				circomData: z,
+				commitmentValidationData: V,
+				authorizationData: H,
+				recipientAddress: g,
+				adminData: L
+			};
+		}));
+		I.push(...a);
+	}
+	await w({
+		id: g,
+		chainId: l,
+		hashedEthereumAddress: h,
+		phase: c.BEFORE_SCHEDULE_WITHDRAW
+	});
+	let L = await C(l, I, h, v, T, D);
+	return await w({
+		id: g,
+		chainId: l,
+		hashedEthereumAddress: h,
+		phase: c.AFTER_SCHEDULE_WITHDRAW,
+		scheduleId: L
+	}), L;
+}, D = async (e, i, a, o, c, d, m, y, x = !0) => {
+	let S = i.erc20TokenAddress, C = f([i]), w = y ? u(y) : void 0, D = l(await e.getEthereumAddressByChain(C)), O = _[s.Lifi][C];
+	if (!O) throw Error("LIFI router not configured");
+	let k;
+	if (c) k = c;
+	else {
+		let n = a[0], r = b(e, C, n.temporarySubAccount.ethAddress, O, S, n.bridgeAmount, n.bridgeAmount, n.quote).map((e) => v(e, n.temporarySubAccount.ethAddress, C));
+		k = await h(C, S, [S], s.Emporium, r, t);
+	}
+	let A = {
+		feeToken: k.feeToken,
+		flatFee: 0n,
+		variableRate: 0n
+	}, j = a.reduce((e, t) => e + t.quote.nativeFee, 0n) > 0n && !r(S, n), M = a.map((e) => e.bridgeAmount), N = a.map((e) => e.recipientAddress), { userDepositedUtxos: P, statusId: F, depositTxHash: I } = await T(e, C, i, M, N, k, D, x), L = [];
+	if (j) {
+		let t = await p(C, n);
+		if (!t) throw Error("No native token");
+		let { userDepositedUtxos: r } = await T(e, C, t, a.map((e) => e.quote.nativeFee), N, A, D, x);
+		L = r;
+	}
+	return await g(e, C, [...P, ...L]), {
+		depositTxHash: I,
+		scheduleId: await E(e, C, i, a.map((e, t) => ({
+			...e,
+			utxo: P[t].utxo,
+			nativeUtxo: j ? L[t]?.utxo : void 0
+		})), k, D, F, o, d, m, w)
+	};
+};
+//#endregion
+export { D as hinkalDepositAndBridge };