@hinkal/common 0.2.18 → 0.2.19

package/data-structures/Hinkal/Hinkal.d.ts

@@ -1,11 +1,10 @@
 import { ethers } from 'ethers';
-import { type ApprovedUtxo, ApprovedUtxoWithInteractionAddress, FeeStructure, HinkalConfig, type ParsedInLogicMetadata } from '../../types/hinkal.types';
-import { type ContractMetadata, ContractType, EthereumNetwork } from '../../types/ethereum-network.types';
+import { type ApprovedUtxo, ApprovedUtxoWithInteractionAddress, FeeStructure, HinkalConfig } from '../../types/hinkal.types';
+import { ContractType, EthereumNetwork } from '../../types/ethereum-network.types';
 import type { EncryptedOutputWithSign } from '../../types/commitments.types';
 import { ExternalActionId } from '../../types/external-action.types';
 import { type IMultiThreadedUtxoUtils } from '../../types/IMultiThreadedUtxoUtils';
 import { type RelayerTransaction } from '../../types/relayer.types';
-import { type SignatureData } from '../../types/crypto.types';
 import type { ERC20Token, PrivateRecipientInfo, TokenBalance, TokenChanges } from '../../types/token.types';
 import { UserKeys } from '../crypto-keys/keys';
 import { type IProviderAdapter } from '../provider-adapter/IProviderAdapter';
@@ -24,15 +23,15 @@ export declare class Hinkal<ConnectorType> implements IHinkal {
     userKeys: UserKeys;
     readonly signingMessage: string;
     readonly privateTransferSigningMessage: string;
-    merkleTreeHinkal: MerkleTree<bigint>;
-    merkleTreeAccessToken: MerkleTree<bigint>;
-    nullifiers: Set<string>;
-    encryptedOutputs: EncryptedOutputWithSign[];
-    approvals: Map<string, ApprovedUtxo[]>;
-    commitmentsSnapshotService?: ClientCommitmentsSnapshotService | ClientSolanaCommitmentsSnapshotService;
-    nullifierSnapshotService?: ClientNullifierSnapshotService | ClientSolanaNullifierSnapshotService;
-    accessTokenSnapshotService?: ClientAccessTokenSnapshotService | ClientSolanaAccessTokenSnapshotService;
-    approvalsSnapshotService?: ClientApprovalsSnapshotService;
+    merkleTreeHinkalByChain: Record<number, MerkleTree<bigint>>;
+    merkleTreeAccessTokenByChain: Record<number, MerkleTree<bigint>>;
+    nullifiersByChain: Record<number, Set<string>>;
+    encryptedOutputsByChain: Record<number, EncryptedOutputWithSign[]>;
+    approvalsByChain: Record<number, Map<string, ApprovedUtxo[]>>;
+    commitmentsSnapshotServiceByChain: Record<number, ClientCommitmentsSnapshotService | ClientSolanaCommitmentsSnapshotService | undefined>;
+    nullifierSnapshotServiceByChain: Record<number, ClientNullifierSnapshotService | ClientSolanaNullifierSnapshotService | undefined>;
+    accessTokenSnapshotServiceByChain: Record<number, ClientAccessTokenSnapshotService | ClientSolanaAccessTokenSnapshotService | undefined>;
+    approvalsSnapshotServiceByChain: Record<number, ClientApprovalsSnapshotService | undefined>;
     utxoUtils: IMultiThreadedUtxoUtils;
     cacheDevice: ICacheDevice;
     generateProofRemotely: boolean;
@@ -41,23 +40,18 @@ export declare class Hinkal<ConnectorType> implements IHinkal {
     initProviderAdapter(connector: ConnectorType, providerAdapter: IProviderAdapter<ConnectorType>): Promise<void>;
     initUserKeys(isPrivateTransfer?: boolean): Promise<void>;
     initUserKeysWithPassword(password: string): Promise<void>;
-    resetMerkle(): Promise<void>;
+    resetMerkle(chainIds?: number[]): Promise<void>;
     getProviderAdapter(): IProviderAdapter<ConnectorType>;
-    waitForTransaction(transactionHash: string, confirmations?: number): Promise<boolean>;
-    getContractMetadata(contractType: ContractType, chainId?: number): ContractMetadata;
-    getContract(contractType: ContractType, contractAddress?: undefined, chainId?: number): ethers.Contract;
+    waitForTransaction(chainId: number, transactionHash: string, confirmations?: number): Promise<boolean>;
+    getContract(chainId: number, contractType: ContractType, contractAddress?: undefined): ethers.Contract;
     getContractWithFetcherByChainId(chainId: number, contractType: ContractType, contractAddress?: undefined): ethers.Contract;
     signMessage(message: string): Promise<string>;
     signTypedData(domain: ethers.TypedDataDomain, types: Record<string, ethers.TypedDataField[]>, value: Record<string, unknown>): Promise<string>;
-    signWithSubAccount(messageToSign: string | undefined, typedData: TypedData | undefined, subAccount: SubAccount): Promise<string>;
-    getContractWithSigner(contract: ContractType, contractAddress?: string): ethers.Contract;
-    getContractWithFetcher(contract: ContractType, contractAddress?: string): ethers.Contract;
-    getContractWithFetcherForEthereum(contract: ContractType, address: string): ethers.Contract;
-    isSelectedNetworkSupported(): boolean;
+    signWithSubAccount(chainId: number, messageToSign: string | undefined, typedData: TypedData | undefined, subAccount: SubAccount): Promise<string>;
+    getContractWithSigner(chainId: number, contractType: ContractType, contractAddress?: string): ethers.Contract;
+    getContractWithFetcher(chainId: number, contractType: ContractType, contractAddress?: string): ethers.Contract;
+    isSelectedNetworkSupported(chainId: number): boolean;
     switchNetwork(network: EthereumNetwork): Promise<void>;
-    switchAccount(signer: ethers.Signer): Promise<void>;
-    getCurrentChainId(): number;
-    getSelectedNetwork(): EthereumNetwork | undefined;
     isPermitterAvailable(): boolean;
     connectAndPatchProvider(connector: ConnectorType): Promise<number>;
     disconnectFromConnector(): Promise<void>;
@@ -67,49 +61,40 @@ export declare class Hinkal<ConnectorType> implements IHinkal {
     private onChainChanged;
     monitorConnectedAddress(): Promise<void>;
     getBalances(chainId: number, passedShieldedPrivateKey: string, passedShieldedPublicKey: string, ethAddress: string, resetCacheBefore?: boolean, updateTokensListBefore?: boolean, useBlockedUtxos?: boolean): Promise<Map<string, TokenBalance>>;
-    getApprovedBalances(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, _ethAddress?: string): Promise<TokenBalance[]>;
+    getApprovedBalances(chainId: number, 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, _ethAddress?: string): Promise<TokenBalance[]>;
     getSupportedPassportLinks(): string[];
-    checkAccessToken(): Promise<boolean>;
-    mintHinkalAccessToken(signatureData: SignatureData, fromWallet?: boolean): Promise<ethers.ContractTransaction>;
-    getHinkalTreeRootHash(): Promise<any>;
-    getAccessTokenTreeRootHash(): Promise<any>;
+    checkAccessToken(chainId: number): Promise<boolean>;
+    getHinkalTreeRootHash(chainId: number): Promise<any>;
+    getAccessTokenTreeRootHash(chainId: number): Promise<any>;
     resetMerkleTreesIfNecessary(): Promise<void>;
     getEventsFromHinkal(): Promise<void>;
     getEthereumAddress(): Promise<string>;
-    getRandomRelay(markAsPending?: boolean): Promise<string | undefined>;
-    getGasPrice(): Promise<bigint>;
+    getRandomRelay(chainId: number, markAsPending?: boolean): Promise<string | undefined>;
+    getGasPrice(chainId: number): Promise<bigint>;
     getAPI(): IAPI;
-    resetCache(): void;
     snapshotsClearInterval(): void;
-    checkTokenRegistry(erc20Addresses: string[], amountChanges: bigint[]): Promise<boolean>;
+    checkTokenRegistry(chainId: number, erc20Addresses: string[], amountChanges: bigint[]): Promise<boolean>;
     getRecipientInfo(): string;
-    getInteractionApprovals(interactionAddress: string): Promise<ApprovedUtxo[]>;
-    getApprovedUtxos(resetCacheBefore?: boolean): ApprovedUtxoWithInteractionAddress[];
-    getApprovedUtxosForToken(erc20Address: string, resetCacheBefore?: boolean): ApprovedUtxoWithInteractionAddress[];
-    getMyApprovalAmountForInteraction(interactionAddress: string, tokenAddress: string): bigint;
-    checkExistingApprovalFromHinkal(erc20Address: string, interactionAddress: string): Promise<bigint>;
-    getBufferEntry(approveTo: string, tokenAddress: string, inHinkalAddress: bigint): Promise<bigint>;
+    getApprovedUtxos(chainId: number, resetCacheBefore?: boolean): ApprovedUtxoWithInteractionAddress[];
+    getApprovedUtxosForToken(erc20Address: string, chainId: number, resetCacheBefore?: boolean): ApprovedUtxoWithInteractionAddress[];
     deposit(erc20Tokens: ERC20Token[], amountChanges: bigint[]): Promise<ethers.ContractTransaction>;
     depositForOther(erc20Tokens: ERC20Token[], amountChanges: bigint[], recipientInfo: string): Promise<ethers.ContractTransaction>;
     depositAndWithdraw(erc20Token: ERC20Token, recipientAmounts: bigint[], recipientAddresses: string[], txCompletionTime?: number, feeStructureOverride?: FeeStructure): Promise<string>;
     prooflessDeposit(erc20Tokens: ERC20Token[], amountChanges: bigint[], stealthAddressStructures?: StealthAddressStructure[]): Promise<ethers.ContractTransaction>;
     getSolanaProgram(idl: Idl): Program;
     getSolanaPublicKey(): PublicKey;
-    depositSolana(amount: bigint, mintAddress: string): Promise<string>;
-    depositSolanaForOther(amount: bigint, mintAddress: string, recipientInfo: string): Promise<string>;
-    solanaMultiPaymentDeposit(amounts: bigint[], mintAddress: string): Promise<string>;
+    depositSolana(amount: bigint, token: ERC20Token): Promise<string>;
+    depositSolanaForOther(amount: bigint, token: ERC20Token, recipientInfo: string): Promise<string>;
+    solanaMultiPaymentDeposit(amounts: bigint[], token: ERC20Token): Promise<string>;
     transfer(erc20Tokens: ERC20Token[], amountChanges: bigint[], recipientAddress: string, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType, onlyGasEstimate?: boolean): Promise<RelayerTransaction | bigint>;
     withdraw(erc20Tokens: ERC20Token[], deltaAmounts: bigint[], recipientAddress: string, isRelayerOff: boolean, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType, onlyGasEstimate?: boolean): Promise<ethers.ContractTransaction | RelayerTransaction | bigint>;
     withdrawStuckUtxos(erc20Token: ERC20Token, recipientAddress: string): Promise<RelayerTransaction[]>;
     swap(erc20Tokens: ERC20Token[], deltaAmounts: bigint[], externalActionId: ExternalActionId, swapData: string, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType, onlyGasEstimate?: boolean, withPrivateMempool?: boolean): Promise<RelayerTransaction | bigint>;
     swapSolana(erc20Tokens: ERC20Token[], deltaAmounts: bigint[], swapData: string, feeToken?: string, feeStructureOverride?: FeeStructure, onlyGasEstimate?: boolean): Promise<RelayerTransaction>;
     actionReceive(erc20Tokens: ERC20Token[], deltaAmounts: bigint[], feeToken?: string, feeStructureOverride?: FeeStructure, subAccount?: SubAccount, action?: AdminTransactionType, onlyGasEstimate?: boolean): Promise<RelayerTransaction | bigint>;
-    actionFundApproveAndTransact(tokenChanges: TokenChanges<bigint>[], subAccount: SubAccount, spenderAddress?: string, to?: string, callDataString?: string, value?: bigint, feeToken?: string, feeStructureOverride?: FeeStructure, autoDepositBack?: boolean, maxGasInDollar?: string, action?: AdminTransactionType, onlyGasEstimate?: boolean): Promise<RelayerTransaction | bigint>;
-    actionPrivateWallet(erc20Addresses: string[], 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, onlyGasEstimate?: boolean): Promise<RelayerTransaction | bigint>;
-    approve(erc20Addresses: string[], amount: bigint, approveTo: string, feeToken?: string, feeStructureOverride?: FeeStructure, onlyGasEstimate?: boolean): Promise<RelayerTransaction | bigint>;
-    hinkalInsideTransact(erc20Addresses: string[], deltaChanges: bigint[], approvalChanges: bigint[], externalAddress: string, externalActionMetadata: string, parsedInLogicMetadata: ParsedInLogicMetadata, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType, onlyGasEstimate?: boolean): Promise<RelayerTransaction | bigint>;
+    actionPrivateWallet(chainId: number, erc20Addresses: string[], 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, onlyGasEstimate?: boolean): Promise<RelayerTransaction | bigint>;
     proxySwap(erc20Tokens: ERC20Token[], deltaAmounts: bigint[], externalActionId: ExternalActionId, swapData: string, isTheSameChainSwap: boolean, subAccount: SubAccount, feeToken?: string, feeStructureOverride?: FeeStructure, autoDepositBack?: boolean, maxGasInDollar?: string, action?: AdminTransactionType, onlyGasEstimate?: boolean): Promise<RelayerTransaction | bigint>;
     proxyToPrivate(erc20Tokens: ERC20Token[], deltaAmountsBase: bigint[], subAccount: SubAccount, recipientInfo: string, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType, onlyGasEstimate?: boolean): Promise<RelayerTransaction | bigint>;
     proxySend(erc20Tokens: ERC20Token[], amounts: bigint[], subAccount: SubAccount, recipientAddress: string, feeToken?: string, feeStructureOverride?: FeeStructure, action?: AdminTransactionType, onlyGasEstimate?: boolean): Promise<RelayerTransaction | bigint>;