Klaster Protocol is a chain abstraction framework that enables the execution of complex cross-chain transaction bundles with a single user signature. It introduces a Transaction Commitment Layer between users/dApps and multiple blockchain networks, facilitating seamless interaction across different chains.
\n","isPage":false,"text":"\nKlaster Protocol is a chain abstraction framework that enables the execution of complex cross-chain transaction bundles with a single user signature. It introduces a Transaction Commitment Layer between users/dApps and multiple blockchain networks, facilitating seamless interaction across different chains.\n","title":"Overview","titles":["Klaster Protocol Technical Summary"]},"2":{"href":"/protocol#key-concepts","html":"\n","isPage":false,"text":"\n","title":"Key Concepts","titles":["Klaster Protocol Technical Summary"]},"3":{"href":"/protocol#1-itx-interchain-transaction-bundles","html":"\n
\n
Series of (possibly dependent) transactions spanning across multiple chains
\n
Represented as a Merkle Tree of UserOps
\n
Defined by a unique Merkle Root hash (iTx hash)
\n
\n","isPage":false,"text":"\n\nSeries of (possibly dependent) transactions spanning across multiple chains\nRepresented as a Merkle Tree of UserOps\nDefined by a unique Merkle Root hash (iTx hash)\n\n","title":"1. iTx (Interchain Transaction) bundles","titles":["Klaster Protocol Technical Summary","Key Concepts"]},"4":{"href":"/protocol#2-transaction-commitment-layer","html":"\n
\n
Network of Klaster Nodes
\n
Provides execution guarantees
\n
Orchestrates iTx execution across multiple blockchain networks
Standardized ERC-7579 module for smart contract accounts
\n
Enables single signature approval for entire iTx bundles
\n
Compatible with existing smart account wallets
\n
\n","isPage":false,"text":"\n\nStandardized ERC-7579 module for smart contract accounts\nEnables single signature approval for entire iTx bundles\nCompatible with existing smart account wallets\n\n","title":"Smart Accounts - iTx Module","titles":["Klaster Protocol Technical Summary","Core Components"]},"7":{"href":"/protocol#klaster-nodes","html":"\n
Responsibilities:
\n
\n
Estimating iTx fees & responding to quote requests
\n
Committing to iTx execution
\n
Executing fully signed iTx bundles
\n
\n
Node Selection Process:
\n\n
Nodes provide quotes for iTx execution
\n
User/dApp selects best quote based on cost and node reputation
\n
Selected node commits to iTx execution
\n
User signs the iTx bundle
\n
Node executes the iTx bundle
\n\n","isPage":false,"text":"\nResponsibilities:\n\nEstimating iTx fees & responding to quote requests\nCommitting to iTx execution\nExecuting fully signed iTx bundles\n\nNode Selection Process:\n\nNodes provide quotes for iTx execution\nUser/dApp selects best quote based on cost and node reputation\nSelected node commits to iTx execution\nUser signs the iTx bundle\nNode executes the iTx bundle\n\n","title":"Klaster Nodes","titles":["Klaster Protocol Technical Summary","Core Components"]},"8":{"href":"/protocol#meta-paymaster-and-multichain-gas-refunds","html":"\n
\n
Nodes act as Meta Paymasters, accepting payment in one token/chain and executing transactions across multiple chains
\n
Utilizes ERC-4337 EntryPoint for UserOp routing
\n
Implements gas refunds for overpaid transactions
\n
\n","isPage":false,"text":"\n\nNodes act as Meta Paymasters, accepting payment in one token/chain and executing transactions across multiple chains\nUtilizes ERC-4337 EntryPoint for UserOp routing\nImplements gas refunds for overpaid transactions\n\n","title":"Meta Paymaster and Multichain Gas Refunds","titles":["Klaster Protocol Technical Summary","Core Components"]},"9":{"href":"/protocol#optimistic-itx-execution","html":"\n
\n
Nodes determine optimal execution order through simulation
\n
Executes UserOps when simulations yield 0 REVERT opcodes
\n
Incentivized by diminishing success tips
\n
\n","isPage":false,"text":"\n\nNodes determine optimal execution order through simulation\nExecutes UserOps when simulations yield 0 REVERT opcodes\nIncentivized by diminishing success tips\n\n","title":"Optimistic iTx Execution","titles":["Klaster Protocol Technical Summary","Core Components"]},"10":{"href":"/protocol#integration","html":"\n
\n
SDK available for dApp/Wallet developers
\n
Enables efficient building of chain-abstracted applications
\n
Neutral approach, compatible with various bridges and AA wallet providers
\n
\n","isPage":false,"text":"\n\nSDK available for dApp/Wallet developers\nEnables efficient building of chain-abstracted applications\nNeutral approach, compatible with various bridges and AA wallet providers\n\n","title":"Integration","titles":["Klaster Protocol Technical Summary"]},"11":{"href":"/protocol#use-cases","html":"\n
\n
Chain-abstracted versions of existing dApps (e.g., AAVE)
\n
Streamlined checkout flows
\n
Easier onboarding to SocialFi L2/L3 apps
\n
Single-chain dApps attracting users from various chains
\n
\n","isPage":false,"text":"\n\nChain-abstracted versions of existing dApps (e.g., AAVE)\nStreamlined checkout flows\nEasier onboarding to SocialFi L2/L3 apps\nSingle-chain dApps attracting users from various chains\n\n","title":"Use Cases","titles":["Klaster Protocol Technical Summary"]},"12":{"href":"/protocol#security-considerations","html":"\n
\n
Users maintain full control of funds through AA wallets
\n
Nodes can be slashed for failing to execute committed iTx bundles
\n
Security reduced to the security of bridges used for asset transfers between chains
\n
\n","isPage":false,"text":"\n\nUsers maintain full control of funds through AA wallets\nNodes can be slashed for failing to execute committed iTx bundles\nSecurity reduced to the security of bridges used for asset transfers between chains\n\n","title":"Security Considerations","titles":["Klaster Protocol Technical Summary"]},"13":{"href":"/protocol#future-developments","html":"\n
\n
Decentralization phase including slashing and multichain staking
\n
Public node implementation for verification and customization
\n
Potential integration with intent solver networks
\n
","isPage":false,"text":"\n\nDecentralization phase including slashing and multichain staking\nPublic node implementation for verification and customization\nPotential integration with intent solver networks\n","title":"Future Developments","titles":["Klaster Protocol Technical Summary"]},"14":{"href":"/reference#klaster-sdk","html":"\n","isPage":true,"text":"\n","title":"klaster-sdk","titles":[]},"15":{"href":"/reference#classes","html":"\n","isPage":false,"text":"\n","title":"Classes","titles":["klaster-sdk"]},"16":{"href":"/reference#encodingservice","html":"\n
A service for encoding user operations (UserOps) for Smart Contract Accounts in the Klaster ecosystem.
\n
This service provides methods to encode single and batch transactions into UserOps\nthat can be processed by the Klaster Node. It intelligently chooses between single\nand batch encoding to optimize for gas efficiency and ensure atomic execution of\nmultiple transactions when needed.
\n","isPage":false,"text":"\nA service for encoding user operations (UserOps) for Smart Contract Accounts in the Klaster ecosystem.\nThis service provides methods to encode single and batch transactions into UserOps\nthat can be processed by the Klaster Node. It intelligently chooses between single\nand batch encoding to optimize for gas efficiency and ensure atomic execution of\nmultiple transactions when needed.\n","title":"EncodingService","titles":["klaster-sdk","Classes"]},"17":{"href":"/reference#constructors","html":"\n","isPage":false,"text":"\n","title":"Constructors","titles":["klaster-sdk","Classes","EncodingService"]},"18":{"href":"/reference#new-encodingservice","html":"\n
Encodes multiple transactions into a single UserOp for batch execution on a Smart Contract Account.
\n
This method prepares a UserOp that, when executed, will call the 'executeBatch' function\non the Smart Contract Account, allowing multiple transactions to be executed atomically.\nThis can lead to significant gas savings compared to executing transactions individually.
\n","isPage":false,"text":"\n\nstatic encodeBatchCall(txs, chainId, masterWallet, salt): ApiUserOp\n\nEncodes multiple transactions into a single UserOp for batch execution on a Smart Contract Account.\nThis method prepares a UserOp that, when executed, will call the 'executeBatch' function\non the Smart Contract Account, allowing multiple transactions to be executed atomically.\nThis can lead to significant gas savings compared to executing transactions individually.\n","title":"encodeBatchCall()","titles":["klaster-sdk","Classes","EncodingService","Methods"]},"22":{"href":"/reference#parameters","html":"\n
An array of transactions to be encoded for batch execution.
\n
• chainId: number
\n
The ID of the blockchain where the transactions will be executed.
\n
• masterWallet: `0x${string}`
\n
The address of the master wallet from which the Smart Contract Account is derived.
\n
• salt: string
\n
A unique value used in conjunction with the masterWallet to derive the Smart Contract Account address.
\n","isPage":false,"text":"\n• txs: RawTransaction[]\nAn array of transactions to be encoded for batch execution.\n• chainId: number\nThe ID of the blockchain where the transactions will be executed.\n• masterWallet: `0x${string}`\nThe address of the master wallet from which the Smart Contract Account is derived.\n• salt: string\nA unique value used in conjunction with the masterWallet to derive the Smart Contract Account address.\n","title":"Parameters","titles":["klaster-sdk","Classes","EncodingService","Methods","encodeBatchCall()"]},"23":{"href":"/reference#returns-1","html":"\n
A UserOp object representing the batch execution, which can be sent to the Klaster Node for quoting and execution.
\n","isPage":false,"text":"\nApiUserOp\nA UserOp object representing the batch execution, which can be sent to the Klaster Node for quoting and execution.\n","title":"Returns","titles":["klaster-sdk","Classes","EncodingService","Methods","encodeBatchCall()"]},"24":{"href":"/reference#example","html":"\n
Encodes a single transaction into a UserOp for execution on a Smart Contract Account.
\n
This method prepares a UserOp that, when executed, will call the 'execute' function\non the Smart Contract Account derived from the provided masterWallet and salt.
\n","isPage":false,"text":"\n\nstatic encodeUserOpCall(tx, chainId, masterWallet, salt): ApiUserOp\n\nEncodes a single transaction into a UserOp for execution on a Smart Contract Account.\nThis method prepares a UserOp that, when executed, will call the 'execute' function\non the Smart Contract Account derived from the provided masterWallet and salt.\n","title":"encodeUserOpCall()","titles":["klaster-sdk","Classes","EncodingService","Methods"]},"27":{"href":"/reference#parameters-1","html":"\n
The ID of the blockchain where the transaction will be executed.
\n
• masterWallet: `0x${string}`
\n
The address of the master wallet from which the Smart Contract Account is derived.
\n
• salt: string
\n
A unique value used in conjunction with the masterWallet to derive the Smart Contract Account address.
\n","isPage":false,"text":"\n• tx: RawTransaction\nThe transaction to be encoded.\n• chainId: number\nThe ID of the blockchain where the transaction will be executed.\n• masterWallet: `0x${string}`\nThe address of the master wallet from which the Smart Contract Account is derived.\n• salt: string\nA unique value used in conjunction with the masterWallet to derive the Smart Contract Account address.\n","title":"Parameters","titles":["klaster-sdk","Classes","EncodingService","Methods","encodeUserOpCall()"]},"28":{"href":"/reference#returns-2","html":"\n
A UserOp object that can be sent to the Klaster Node for quoting and execution.
\n","isPage":false,"text":"\nApiUserOp\nA UserOp object that can be sent to the Klaster Node for quoting and execution.\n","title":"Returns","titles":["klaster-sdk","Classes","EncodingService","Methods","encodeUserOpCall()"]},"29":{"href":"/reference#example-1","html":"\n
KlasterSDK creates an instance of the SDK used to communicate with\nthe Klaster protocol. It offers typed information for all the types\nused to communicate with the protocol, as well as utility functions\nfor encoding tokens, transactions and accounts.
\n","isPage":false,"text":"\nKlasterSDK creates an instance of the SDK used to communicate with\nthe Klaster protocol. It offers typed information for all the types\nused to communicate with the protocol, as well as utility functions\nfor encoding tokens, transactions and accounts.\n","title":"KlasterSDK","titles":["klaster-sdk","Classes"]},"32":{"href":"/reference#constructors-1","html":"\n","isPage":false,"text":"\n","title":"Constructors","titles":["klaster-sdk","Classes","KlasterSDK"]},"33":{"href":"/reference#new-klastersdk","html":"\n
Automatically fetches a quote and executes the Interchain Transaction (iTx).
\n
This function streamlines the process of executing an iTx by combining the quote\nfetching and execution steps. It automatically handles the flow of getting a quote,\nsigning the iTx hash, and executing the transaction.
\n","isPage":false,"text":"\n\nautoExecute(itx, signHash): Promise<ExecuteResponse>\n\nAutomatically fetches a quote and executes the Interchain Transaction (iTx).\nThis function streamlines the process of executing an iTx by combining the quote\nfetching and execution steps. It automatically handles the flow of getting a quote,\nsigning the iTx hash, and executing the transaction.\n","title":"autoExecute()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"44":{"href":"/reference#parameters-3","html":"\n
The interchain transaction object containing\nthe transactions you wish to execute. This should include all necessary\ninformation for the iTx, such as actions and payment details.
\n
• signHash
\n
A function to sign the iTx hash with a private key.\nThis function should take a hash string (prefixed with '0x') and return\na Promise resolving to the signed hash string.
\n","isPage":false,"text":"\n• itx: InterchainTransaction\nThe interchain transaction object containing\nthe transactions you wish to execute. This should include all necessary\ninformation for the iTx, such as actions and payment details.\n• signHash\nA function to sign the iTx hash with a private key.\nThis function should take a hash string (prefixed with '0x') and return\na Promise resolving to the signed hash string.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"45":{"href":"/reference#returns-4","html":"\n
A promise that resolves to an ExecuteResponse object,\ncontaining the iTx hash of the executed transaction.
\n","isPage":false,"text":"\nPromise<ExecuteResponse>\nA promise that resolves to an ExecuteResponse object,\ncontaining the iTx hash of the executed transaction.\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"46":{"href":"/reference#async","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"47":{"href":"/reference#throws","html":"\n
May throw errors during the quote fetching, signing, or execution phases.\nThese could include network errors, signing failures, or execution issues.
\n","isPage":false,"text":"\nMay throw errors during the quote fetching, signing, or execution phases.\nThese could include network errors, signing failures, or execution issues.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"48":{"href":"/reference#example-2","html":"\n
const itx = {\n actions: [...], // Array of actions to be executed\n paymentInfo: ... // Payment information\n};\n\nconst signHash = async (hash) => {\n // Implement your signing logic here\n return signedHash;\n};\n\ntry {\n const result = await klasterSDK.autoExecute(itx, signHash);\n console.log('iTx executed successfully. Hash:', result.iTxHash);\n} catch (error) {\n console.error('AutoExecute failed:', error);\n}
The signHash function must return a properly signed hash. Ensure you're using\nthe correct signing method (e.g., personalSign) to avoid execution errors.
\n
This function abstracts away the separate steps of quoting and executing,\nmaking it more convenient for straightforward iTx executions.
\n
\n","isPage":false,"text":"\n\nThe signHash function must return a properly signed hash. Ensure you're using\nthe correct signing method (e.g., personalSign) to avoid execution errors.\nThis function abstracts away the separate steps of quoting and executing,\nmaking it more convenient for straightforward iTx executions.\n\n","title":"Remarks","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"50":{"href":"/reference#see","html":"\n
execute - Used internally to execute the transaction.
\n
\n","isPage":false,"text":"\n\ngetQuote - Used internally to fetch the quote.\nexecute - Used internally to execute the transaction.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"51":{"href":"/reference#defined-in-5","html":"\n
Changes the salt value used for deriving ERC4337 multichain smart accounts.
\n
This function updates the activeAccountSalt parameter of the SDK instance. The salt,\nin combination with the connected Externally Owned Account (EOA), is used to\ndeterministically derive ERC4337 compliant multichain smart contract accounts.\nChanging this salt will result in deriving a different smart contract account\nfor all subsequent operations.
\n","isPage":false,"text":"\n\nchangeAccountSalt(salt): void\n\nChanges the salt value used for deriving ERC4337 multichain smart accounts.\nThis function updates the activeAccountSalt parameter of the SDK instance. The salt,\nin combination with the connected Externally Owned Account (EOA), is used to\ndeterministically derive ERC4337 compliant multichain smart contract accounts.\nChanging this salt will result in deriving a different smart contract account\nfor all subsequent operations.\n","title":"changeAccountSalt()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"53":{"href":"/reference#parameters-4","html":"\n
• salt: string
\n
The new salt value to be used for account derivation.\nThis should be a unique string that, when combined with\nthe EOA address, produces a unique smart account address.
\n","isPage":false,"text":"\n• salt: string\nThe new salt value to be used for account derivation.\nThis should be a unique string that, when combined with\nthe EOA address, produces a unique smart account address.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeAccountSalt()"]},"54":{"href":"/reference#returns-5","html":"\n
// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\nklasterSDK.changeAccountSalt('uniqueSaltValue123');
\n","isPage":false,"text":"\n// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\nklasterSDK.changeAccountSalt('uniqueSaltValue123');\n","title":"Example","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeAccountSalt()"]},"56":{"href":"/reference#note","html":"\n
Changing the account salt will affect all future account derivations and operations.\nIt does not affect previously derived accounts or ongoing transactions. Ensure you understand\nthe implications of changing this salt in the context of your application.
\n","isPage":false,"text":"\nChanging the account salt will affect all future account derivations and operations.\nIt does not affect previously derived accounts or ongoing transactions. Ensure you understand\nthe implications of changing this salt in the context of your application.\n","title":"Note","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeAccountSalt()"]},"57":{"href":"/reference#see-1","html":"\n
For more information on ERC4337 and account abstraction, visit:\nAccount Abstraction
\n","isPage":false,"text":"\nFor more information on ERC4337 and account abstraction, visit:\nAccount Abstraction\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeAccountSalt()"]},"58":{"href":"/reference#defined-in-6","html":"\n
Changes the master wallet address used for deriving ERC4337 multichain smart accounts.
\n
This function updates the masterAddress parameter of the SDK instance. The master address,\nin combination with a salt value, is used to deterministically derive ERC4337 compliant\nmultichain smart contract accounts. Changing this address will result in deriving\ndifferent smart contract accounts for all subsequent operations.
\n","isPage":false,"text":"\n\nchangeMasterAddress(wallet): void\n\nChanges the master wallet address used for deriving ERC4337 multichain smart accounts.\nThis function updates the masterAddress parameter of the SDK instance. The master address,\nin combination with a salt value, is used to deterministically derive ERC4337 compliant\nmultichain smart contract accounts. Changing this address will result in deriving\ndifferent smart contract accounts for all subsequent operations.\n","title":"changeMasterAddress()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"60":{"href":"/reference#parameters-5","html":"\n
• wallet: `0x${string}`
\n
The new master wallet address to be used for account derivation.\nThis should be a valid Ethereum address.
\n","isPage":false,"text":"\n• wallet: `0x${string}`\nThe new master wallet address to be used for account derivation.\nThis should be a valid Ethereum address.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeMasterAddress()"]},"61":{"href":"/reference#returns-6","html":"\n
May throw an error if the provided address is invalid.
\n","isPage":false,"text":"\nMay throw an error if the provided address is invalid.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeMasterAddress()"]},"63":{"href":"/reference#example-4","html":"\n
// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\nklasterSDK.changeMasterAddress('0x742d35Cc6634C0532925a3b844Bc454e4438f44e');
\n","isPage":false,"text":"\n// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\nklasterSDK.changeMasterAddress('0x742d35Cc6634C0532925a3b844Bc454e4438f44e');\n","title":"Example","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeMasterAddress()"]},"64":{"href":"/reference#note-1","html":"\n
Changing the master address will affect all future account derivations and operations.\nIt does not affect previously derived accounts or ongoing transactions. Ensure you understand\nthe implications of changing this address in the context of your application.
\n","isPage":false,"text":"\nChanging the master address will affect all future account derivations and operations.\nIt does not affect previously derived accounts or ongoing transactions. Ensure you understand\nthe implications of changing this address in the context of your application.\n","title":"Note","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeMasterAddress()"]},"65":{"href":"/reference#see-2","html":"\n
For more information on ERC4337 and account abstraction, visit:\nAccount Abstraction
\n","isPage":false,"text":"\nFor more information on ERC4337 and account abstraction, visit:\nAccount Abstraction\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeMasterAddress()"]},"66":{"href":"/reference#defined-in-7","html":"\n
A helper function that prepares an ApiPaymentData object for transaction fee payments.
\n
This asynchronous function simplifies the process of creating an ApiPaymentData object,\nwhich is used to specify how transaction fees should be paid on the Klaster Protocol.\nIt combines information from the multichain account, the current SDK configuration,\nand the specified payment token to create a complete payment data structure.
\n","isPage":false,"text":"\n\nencodeTxFee(paymentToken, chainId): Promise<ApiPaymentData>\n\nA helper function that prepares an ApiPaymentData object for transaction fee payments.\nThis asynchronous function simplifies the process of creating an ApiPaymentData object,\nwhich is used to specify how transaction fees should be paid on the Klaster Protocol.\nIt combines information from the multichain account, the current SDK configuration,\nand the specified payment token to create a complete payment data structure.\n","title":"encodeTxFee()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"68":{"href":"/reference#parameters-6","html":"\n
A string representing the symbol of the token being used for\npayments. e.g. ETH, USDC, MATIC, WSTETH, ...
\n
• chainId: number
\n
The chainId of the chain on which you wish to execute the payment.
\n","isPage":false,"text":"\n• paymentToken: PaymentTokenSymbol\nA string representing the symbol of the token being used for\npayments. e.g. ETH, USDC, MATIC, WSTETH, ...\n• chainId: number\nThe chainId of the chain on which you wish to execute the payment.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"69":{"href":"/reference#returns-7","html":"\n
A promise that resolves to an ApiPaymentData object containing:
\n
\n
chainId: The chain ID where the payment will be processed
\n
masterWallet: The address of the master wallet used in the SDK.
\n
salt: The salt used for deriving the multichain account.
\n
token: The address of the token to be used for payment.
\n
\n","isPage":false,"text":"\nPromise<ApiPaymentData>\nA promise that resolves to an ApiPaymentData object containing:\n\nchainId: The chain ID where the payment will be processed\nmasterWallet: The address of the master wallet used in the SDK.\nsalt: The salt used for deriving the multichain account.\ntoken: The address of the token to be used for payment.\n\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"70":{"href":"/reference#async-1","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"71":{"href":"/reference#throws-2","html":"\n
May throw an error if:
\n
\n
There's an issue retrieving the multichain account.
\n
The specified payment token is not found or invalid.
\n
Any other unexpected error occurs during the process.
\n
\n","isPage":false,"text":"\nMay throw an error if:\n\nThere's an issue retrieving the multichain account.\nThe specified payment token is not found or invalid.\nAny other unexpected error occurs during the process.\n\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"72":{"href":"/reference#example-5","html":"\n
// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\ntry {\n const paymentData = await klasterSDK.encodeTxFee('USDC', optimism.id);\n console.log('Payment data:', paymentData);\n} catch (error) {\n console.error('Failed to encode transaction fee:', error);\n}
\n","isPage":false,"text":"\n// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\ntry {\n const paymentData = await klasterSDK.encodeTxFee('USDC', optimism.id);\n console.log('Payment data:', paymentData);\n} catch (error) {\n console.error('Failed to encode transaction fee:', error);\n}\n","title":"Example","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"73":{"href":"/reference#note-2","html":"\n
This function uses the current state of the SDK, including the master wallet address.\nMake sure these are set correctly before calling this function.
\n","isPage":false,"text":"\nThis function uses the current state of the SDK, including the master wallet address.\nMake sure these are set correctly before calling this function.\n","title":"Note","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"74":{"href":"/reference#see-3","html":"\n
getPaymentToken - Used internally to resolve the token address from the ChainTokenPair.
\n
\n","isPage":false,"text":"\n\ngetMultichainAccount - Used internally to fetch the current multichain account.\ngetPaymentToken - Used internally to resolve the token address from the ChainTokenPair.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"75":{"href":"/reference#defined-in-8","html":"\n
Executes the Interchain Transaction (iTx) based on a quote response and signed hash.
\n
This function triggers the execution of an iTx on the Klaster network. Once called\nwith a valid signed hash, the execution becomes irreversible.
\n","isPage":false,"text":"\n\nexecute(response, signedHash): Promise<ExecuteResponse>\n\nExecutes the Interchain Transaction (iTx) based on a quote response and signed hash.\nThis function triggers the execution of an iTx on the Klaster network. Once called\nwith a valid signed hash, the execution becomes irreversible.\n","title":"execute()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"77":{"href":"/reference#parameters-7","html":"\n
The response object returned from calling the quote\nendpoint. This contains necessary information for execution.
\n
• signedHash: string
\n
The iTx hash, signed by the wallet using the personalSign method.
\n","isPage":false,"text":"\n• response: QuoteResponse\nThe response object returned from calling the quote\nendpoint. This contains necessary information for execution.\n• signedHash: string\nThe iTx hash, signed by the wallet using the personalSign method.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"78":{"href":"/reference#returns-8","html":"\n
A promise that resolves to an ExecuteResponse object\ncontaining the iTx hash of the executed transaction.
\n","isPage":false,"text":"\nPromise<ExecuteResponse>\nA promise that resolves to an ExecuteResponse object\ncontaining the iTx hash of the executed transaction.\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"79":{"href":"/reference#async-2","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"80":{"href":"/reference#throws-3","html":"\n
May throw an error if the execution fails, if the signed hash is invalid,\nor if there are network issues.
\n","isPage":false,"text":"\nMay throw an error if the execution fails, if the signed hash is invalid,\nor if there are network issues.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"81":{"href":"/reference#remarks-1","html":"\n
IMPORTANT: The hash must be signed using the personalSign method.\nIf you encounter an "invalid merkle hash" error, ensure you're using the correct\nsigning method. Some libraries may default to a different signing scheme.
\n","isPage":false,"text":"\nIMPORTANT: The hash must be signed using the personalSign method.\nIf you encounter an "invalid merkle hash" error, ensure you're using the correct\nsigning method. Some libraries may default to a different signing scheme.\n","title":"Remarks","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"82":{"href":"/reference#example-6","html":"\n
\n","isPage":false,"text":"\n\ngetQuote - Used to obtain the necessary QuoteResponse.\nhttps://eips.ethereum.org/EIPS/eip-191 - EIP-191 for signed data standard.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"84":{"href":"/reference#defined-in-9","html":"\n
Fetches the multichain ERC4337 account derived from the current masterWallet and salt.
\n
This asynchronous function retrieves the multichain smart contract account that is\ndeterministically derived using the masterWallet and salt parameters set during\nSDK initialization or subsequently updated.
\n
The derived account is compliant with the ERC4337 standard for account abstraction\nand can be used across multiple blockchain networks.
\n","isPage":false,"text":"\n\ngetMultichainAccount(): Promise<MultichainAccount>\n\nFetches the multichain ERC4337 account derived from the current masterWallet and salt.\nThis asynchronous function retrieves the multichain smart contract account that is\ndeterministically derived using the masterWallet and salt parameters set during\nSDK initialization or subsequently updated.\nThe derived account is compliant with the ERC4337 standard for account abstraction\nand can be used across multiple blockchain networks.\n","title":"getMultichainAccount()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"86":{"href":"/reference#returns-9","html":"\n
A promise that resolves to a MultichainAccount object.\nThe object contains:
\n
\n
salt: The current active account salt used for derivation.
\n
address: The derived multichain smart contract account address.
\n
\n","isPage":false,"text":"\nPromise<MultichainAccount>\nA promise that resolves to a MultichainAccount object.\nThe object contains:\n\nsalt: The current active account salt used for derivation.\naddress: The derived multichain smart contract account address.\n\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"87":{"href":"/reference#async-3","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"88":{"href":"/reference#throws-4","html":"\n
May throw an error if there's an issue communicating with the node service\nor if the account derivation fails.
\n","isPage":false,"text":"\nMay throw an error if there's an issue communicating with the node service\nor if the account derivation fails.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"89":{"href":"/reference#example-7","html":"\n
// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\ntry {\n const account = await klasterSDK.getMultichainAccount();\n console.log('Derived account:', account.address);\n console.log('Used salt:', account.salt);\n} catch (error) {\n console.error('Failed to fetch multichain account:', error);\n}
\n","isPage":false,"text":"\n// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\ntry {\n const account = await klasterSDK.getMultichainAccount();\n console.log('Derived account:', account.address);\n console.log('Used salt:', account.salt);\n} catch (error) {\n console.error('Failed to fetch multichain account:', error);\n}\n","title":"Example","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"90":{"href":"/reference#note-3","html":"\n
This function uses the current values of masterWallet and salt. If you need\nto derive a different account, use changeMasterAddress() or changeAccountSalt()\nbefore calling this function.
\n","isPage":false,"text":"\nThis function uses the current values of masterWallet and salt. If you need\nto derive a different account, use changeMasterAddress() or changeAccountSalt()\nbefore calling this function.\n","title":"Note","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"91":{"href":"/reference#see-5","html":"\n
\n","isPage":false,"text":"\n\nchangeMasterAddress - To change the master wallet address.\nchangeAccountSalt - To change the account salt.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"92":{"href":"/reference#defined-in-10","html":"\n
Fetches a quote for the interchain transaction (iTx).
\n
This asynchronous function processes an InterchainTransaction object to obtain a quote\nfrom the Klaster Node. The quote contains the full iTx information as well as the\nrequired payment information for executing the transaction.
\n","isPage":false,"text":"\n\ngetQuote(itx): Promise<QuoteResponse>\n\nFetches a quote for the interchain transaction (iTx).\nThis asynchronous function processes an InterchainTransaction object to obtain a quote\nfrom the Klaster Node. The quote contains the full iTx information as well as the\nrequired payment information for executing the transaction.\n","title":"getQuote()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"94":{"href":"/reference#parameters-8","html":"\n
The full Interchain Transaction object. This object\nshould contain an array of actions and payment information.
\n","isPage":false,"text":"\n• itx: InterchainTransaction\nThe full Interchain Transaction object. This object\nshould contain an array of actions and payment information.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"95":{"href":"/reference#returns-10","html":"\n
A promise that resolves to a QuoteResponse object\ncontaining the full iTx information and required payment details.
\n","isPage":false,"text":"\nPromise<QuoteResponse>\nA promise that resolves to a QuoteResponse object\ncontaining the full iTx information and required payment details.\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"96":{"href":"/reference#async-4","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"97":{"href":"/reference#throws-5","html":"\n
Throws an error if the actions array in the iTx is empty.
\n","isPage":false,"text":"\nThrows an error if the actions array in the iTx is empty.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"98":{"href":"/reference#throws-6","html":"\n
May throw errors from the EncodingService or the node service if there\nare issues encoding the actions or fetching the quote.
\n","isPage":false,"text":"\nMay throw errors from the EncodingService or the node service if there\nare issues encoding the actions or fetching the quote.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"99":{"href":"/reference#example-8","html":"\n
This function uses the current values of masterAddress and activeAccountSalt\nfrom the SDK instance for encoding user operations.
\n","isPage":false,"text":"\nThis function uses the current values of masterAddress and activeAccountSalt\nfrom the SDK instance for encoding user operations.\n","title":"Note","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"101":{"href":"/reference#see-6","html":"\n
\n","isPage":false,"text":"\n\nEncodingService.encodeUserOpCall - Used for encoding single transaction actions.\nEncodingService.encodeBatchCall - Used for encoding multi-transaction actions.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"102":{"href":"/reference#defined-in-11","html":"\n
Transfers ERC20 tokens to the multichain smart contract account and\nexecutes the desired actions across multiple blockchains.
\n
This function performs two main operations:
\n\n
Transfers ERC20 tokens to the smart contract account.
\n
Executes an interchain transaction (iTx) after the transfer is confirmed.
\n\n","isPage":false,"text":"\n\ntransferAndExecute(params): Promise<ExecuteResponse>\n\nTransfers ERC20 tokens to the multichain smart contract account and\nexecutes the desired actions across multiple blockchains.\nThis function performs two main operations:\n\nTransfers ERC20 tokens to the smart contract account.\nExecutes an interchain transaction (iTx) after the transfer is confirmed.\n\n","title":"transferAndExecute()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"104":{"href":"/reference#parameters-9","html":"\n
• params
\n
The parameters object containing transfer and execution instructions.
\n
• params.executeItx
\n
Instructions for executing the interchain transaction.
\n","isPage":false,"text":"\n• params\nThe parameters object containing transfer and execution instructions.\n• params.executeItx\nInstructions for executing the interchain transaction.\n• params.executeItx.iTx: InterchainTransaction\n• params.executeItx.signItxHashAction\n• params.transferToSmartAccount\nInstructions for transferring ERC20 tokens to the smart account.\n• params.transferToSmartAccount.amountToTransfer: bigint\n• params.transferToSmartAccount.chainId: number\n• params.transferToSmartAccount.executeTxAction\n• params.transferToSmartAccount.tokenToTransfer: `0x${string}`\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"105":{"href":"/reference#returns-11","html":"\n
A promise that resolves to the execution response of the iTx.
\n","isPage":false,"text":"\nPromise<ExecuteResponse>\nA promise that resolves to the execution response of the iTx.\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"106":{"href":"/reference#async-5","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"107":{"href":"/reference#throws-7","html":"\n
May throw errors during the token transfer, quote fetching, signing, or execution phases.
\n","isPage":false,"text":"\nMay throw errors during the token transfer, quote fetching, signing, or execution phases.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"108":{"href":"/reference#example-9","html":"\n
The executeTxAction function should handle the actual sending of the transfer transaction to the blockchain.\nConsult the Klaster documentation for details on implementing this with your specific provider.
\n
The signItxHashAction function should handle the signing of the iTx hash.\nEnsure you're using the correct signing method as specified in the Klaster documentation.
\n
This function will wait for the transfer transaction to be accepted before proceeding with the iTx execution.
\n
\n","isPage":false,"text":"\n\nThe executeTxAction function should handle the actual sending of the transfer transaction to the blockchain.\nConsult the Klaster documentation for details on implementing this with your specific provider.\nThe signItxHashAction function should handle the signing of the iTx hash.\nEnsure you're using the correct signing method as specified in the Klaster documentation.\nThis function will wait for the transfer transaction to be accepted before proceeding with the iTx execution.\n\n","title":"Remarks","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"110":{"href":"/reference#see-7","html":"\n
\n
Klaster documentation for detailed information on implementing executeTxAction and signItxHashAction.
\n","isPage":false,"text":"\n\nKlaster documentation for detailed information on implementing executeTxAction and signItxHashAction.\nbuildTransferERC20FromEoaTx - Used internally to construct the transfer transaction.\ngetQuote - Used internally to fetch the quote for the iTx.\nexecute - Used internally to execute the iTx.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"111":{"href":"/reference#defined-in-12","html":"\n
Utility class for generating salt values used in KlasterSDK functions.
\n
Salt values are crucial for deriving unique smart contract accounts within the Klaster ecosystem.\nThis class provides methods to generate salts for different account scenarios.
\n","isPage":false,"text":"\nUtility class for generating salt values used in KlasterSDK functions.\nSalt values are crucial for deriving unique smart contract accounts within the Klaster ecosystem.\nThis class provides methods to generate salts for different account scenarios.\n","title":"SaltUtil","titles":["klaster-sdk","Classes"]},"113":{"href":"/reference#constructors-2","html":"\n","isPage":false,"text":"\n","title":"Constructors","titles":["klaster-sdk","Classes","SaltUtil"]},"114":{"href":"/reference#new-saltutil","html":"\n
Generates a salt for an account at a specific index.
\n
This method allows for deterministic generation of salts for multiple accounts.
\n","isPage":false,"text":"\n\nstatic accountAt(i): string\n\nGenerates a salt for an account at a specific index.\nThis method allows for deterministic generation of salts for multiple accounts.\n","title":"accountAt()","titles":["klaster-sdk","Classes","SaltUtil","Methods"]},"118":{"href":"/reference#parameters-10","html":"\n
• i: number
\n
The index of the account, starting from 0.
\n","isPage":false,"text":"\n• i: number\nThe index of the account, starting from 0.\n","title":"Parameters","titles":["klaster-sdk","Classes","SaltUtil","Methods","accountAt()"]},"119":{"href":"/reference#returns-13","html":"\n
string
\n
A salt value corresponding to the given index.
\n","isPage":false,"text":"\nstring\nA salt value corresponding to the given index.\n","title":"Returns","titles":["klaster-sdk","Classes","SaltUtil","Methods","accountAt()"]},"120":{"href":"/reference#example-10","html":"\n
This method provides flexibility for users who want to use their own salt values.
\n","isPage":false,"text":"\n\nstatic customAccount(salt): string\n\nAllows for the use of a custom salt value.\nThis method provides flexibility for users who want to use their own salt values.\n","title":"customAccount()","titles":["klaster-sdk","Classes","SaltUtil","Methods"]},"123":{"href":"/reference#parameters-11","html":"\n
• salt: string
\n
A custom salt value.
\n","isPage":false,"text":"\n• salt: string\nA custom salt value.\n","title":"Parameters","titles":["klaster-sdk","Classes","SaltUtil","Methods","customAccount()"]},"124":{"href":"/reference#returns-14","html":"\n
string
\n
The provided custom salt value.
\n","isPage":false,"text":"\nstring\nThe provided custom salt value.\n","title":"Returns","titles":["klaster-sdk","Classes","SaltUtil","Methods","customAccount()"]},"125":{"href":"/reference#example-11","html":"\n
When using custom salts, ensure they are unique to avoid account collisions.\nCustom salts should be securely generated and managed to maintain account security.
\n","isPage":false,"text":"\nWhen using custom salts, ensure they are unique to avoid account collisions.\nCustom salts should be securely generated and managed to maintain account security.\n","title":"Remarks","titles":["klaster-sdk","Classes","SaltUtil","Methods","customAccount()"]},"127":{"href":"/reference#defined-in-14","html":"\n
\n","isPage":false,"text":"\n\nstatic firstAccount(): string\n\nGenerates a salt for the first (default) account.\n","title":"firstAccount()","titles":["klaster-sdk","Classes","SaltUtil","Methods"]},"129":{"href":"/reference#returns-15","html":"\n
string
\n
A salt value of "0", representing the first account.
\n","isPage":false,"text":"\nstring\nA salt value of "0", representing the first account.\n","title":"Returns","titles":["klaster-sdk","Classes","SaltUtil","Methods","firstAccount()"]},"130":{"href":"/reference#example-12","html":"\n
Represents the payment data structure for gas costs and transaction fees in the Klaster API.\nThis interface defines the necessary information for processing payments related to\nuser operations on the Klaster network.
\n
ApiPaymentData
\n","isPage":false,"text":"\nRepresents the payment data structure for gas costs and transaction fees in the Klaster API.\nThis interface defines the necessary information for processing payments related to\nuser operations on the Klaster network.\nApiPaymentData\n","title":"ApiPaymentData","titles":["klaster-sdk","Interfaces"]},"134":{"href":"/reference#properties-1","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ApiPaymentData"]},"135":{"href":"/reference#chainid","html":"\n
\n
chainId: number
\n
\n
The ID of the blockchain network on which the payment for\nthe gas cost and transaction fees will be processed. This determines the specific\nblockchain where the payment transaction will occur.
\n","isPage":false,"text":"\n\nchainId: number\n\nThe ID of the blockchain network on which the payment for\nthe gas cost and transaction fees will be processed. This determines the specific\nblockchain where the payment transaction will occur.\n","title":"chainId","titles":["klaster-sdk","Interfaces","ApiPaymentData","Properties"]},"136":{"href":"/reference#defined-in-16","html":"\n
The address of the Externally Owned Account (EOA) from which\nthe Klaster Multichain Smart Account is derived.
\n","isPage":false,"text":"\n\nmasterWallet: `0x${string}`\n\nThe address of the Externally Owned Account (EOA) from which\nthe Klaster Multichain Smart Account is derived.\n","title":"masterWallet","titles":["klaster-sdk","Interfaces","ApiPaymentData","Properties"]},"138":{"href":"/reference#defined-in-17","html":"\n
A unique value used in conjunction with the masterWallet address\nto calculate the Klaster Multichain Smart Account address. This ensures unique account\naddresses for the same EOA.
\n","isPage":false,"text":"\n\nsalt: string\n\nA unique value used in conjunction with the masterWallet address\nto calculate the Klaster Multichain Smart Account address. This ensures unique account\naddresses for the same EOA.\n","title":"salt","titles":["klaster-sdk","Interfaces","ApiPaymentData","Properties"]},"140":{"href":"/reference#defined-in-18","html":"\n
The address of the ERC20 token that will be used to pay for\nthe gas cost and transaction fees associated with the user operation.
\n","isPage":false,"text":"\n\ntoken: string\n\nThe address of the ERC20 token that will be used to pay for\nthe gas cost and transaction fees associated with the user operation.\n","title":"token","titles":["klaster-sdk","Interfaces","ApiPaymentData","Properties"]},"142":{"href":"/reference#defined-in-19","html":"\n
Represents the user operation format expected as input by the Klaster Node API.\nThis interface defines the structure for ERC-4337 compliant user operations\nspecifically tailored for Klaster Multichain Smart Accounts.
\n
ApiUserOp
\n","isPage":false,"text":"\nRepresents the user operation format expected as input by the Klaster Node API.\nThis interface defines the structure for ERC-4337 compliant user operations\nspecifically tailored for Klaster Multichain Smart Accounts.\nApiUserOp\n","title":"ApiUserOp","titles":["klaster-sdk","Interfaces"]},"144":{"href":"/reference#properties-2","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ApiUserOp"]},"145":{"href":"/reference#calldata","html":"\n
\n
callData: string
\n
\n
The encoded function call data to be executed on the blockchain.\nThis represents the actual operation the user wants to perform.
\n","isPage":false,"text":"\n\ncallData: string\n\nThe encoded function call data to be executed on the blockchain.\nThis represents the actual operation the user wants to perform.\n","title":"callData","titles":["klaster-sdk","Interfaces","ApiUserOp","Properties"]},"146":{"href":"/reference#defined-in-20","html":"\n
The maximum amount of gas that can be used for the execution\nof the callData on the target blockchain. This is part of the ERC-4337 specification for\naccount abstraction.
\n","isPage":false,"text":"\n\ncallGasLimit: string\n\nThe maximum amount of gas that can be used for the execution\nof the callData on the target blockchain. This is part of the ERC-4337 specification for\naccount abstraction.\n","title":"callGasLimit","titles":["klaster-sdk","Interfaces","ApiUserOp","Properties"]},"148":{"href":"/reference#defined-in-21","html":"\n
The ID of the blockchain network where the UserOp is to be executed.\nThis determines which network the operation will be sent to.
\n","isPage":false,"text":"\n\nchainId: number\n\nThe ID of the blockchain network where the UserOp is to be executed.\nThis determines which network the operation will be sent to.\n","title":"chainId","titles":["klaster-sdk","Interfaces","ApiUserOp","Properties"]},"150":{"href":"/reference#defined-in-22","html":"\n
The address of the Externally Owned Account (EOA) from which\nthe Klaster Multichain Smart Account is derived.
\n","isPage":false,"text":"\n\nmasterWallet: `0x${string}`\n\nThe address of the Externally Owned Account (EOA) from which\nthe Klaster Multichain Smart Account is derived.\n","title":"masterWallet","titles":["klaster-sdk","Interfaces","ApiUserOp","Properties"]},"152":{"href":"/reference#defined-in-23","html":"\n
A unique value used in conjunction with the masterWallet address\nto calculate the Klaster Multichain Smart Account address. This ensures unique account\naddresses for the same EOA.
\n","isPage":false,"text":"\n\nsalt: string\n\nA unique value used in conjunction with the masterWallet address\nto calculate the Klaster Multichain Smart Account address. This ensures unique account\naddresses for the same EOA.\n","title":"salt","titles":["klaster-sdk","Interfaces","ApiUserOp","Properties"]},"154":{"href":"/reference#defined-in-24","html":"\n
Represents the full ERC-4337 UserOperation standard object format.\nThis interface defines the structure of a user operation as specified in the ERC-4337 standard\nfor account abstraction in Ethereum.
\n
ERC4337UserOp
\n","isPage":false,"text":"\nRepresents the full ERC-4337 UserOperation standard object format.\nThis interface defines the structure of a user operation as specified in the ERC-4337 standard\nfor account abstraction in Ethereum.\nERC4337UserOp\n","title":"ERC4337UserOp","titles":["klaster-sdk","Interfaces"]},"156":{"href":"/reference#properties-3","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ERC4337UserOp"]},"157":{"href":"/reference#calldata-1","html":"\n
\n
callData: string
\n
\n
The data to be passed to the sender during the main execution call.
\n","isPage":false,"text":"\n\ncallData: string\n\nThe data to be passed to the sender during the main execution call.\n","title":"callData","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"158":{"href":"/reference#defined-in-25","html":"\n
\n","isPage":false,"text":"\n\ncallGasLimit: string\n\nThe gas limit for the main execution call.\n","title":"callGasLimit","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"160":{"href":"/reference#defined-in-26","html":"\n
The initialization code for the account if it hasn't been deployed yet. Empty string if the account is already deployed.
\n","isPage":false,"text":"\n\ninitCode: string\n\nThe initialization code for the account if it hasn't been deployed yet. Empty string if the account is already deployed.\n","title":"initCode","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"162":{"href":"/reference#defined-in-27","html":"\n
The maximum total fee per gas the sender is willing to pay (including the priority fee).
\n","isPage":false,"text":"\n\nmaxFeePerGas: string\n\nThe maximum total fee per gas the sender is willing to pay (including the priority fee).\n","title":"maxFeePerGas","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"164":{"href":"/reference#defined-in-28","html":"\n
The maximum priority fee per gas the sender is willing to pay.
\n","isPage":false,"text":"\n\nmaxPriorityFeePerGas: string\n\nThe maximum priority fee per gas the sender is willing to pay.\n","title":"maxPriorityFeePerGas","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"166":{"href":"/reference#defined-in-29","html":"\n
A unique identifier to prevent replay attacks, typically managed by the account itself.
\n","isPage":false,"text":"\n\nnonce: string\n\nA unique identifier to prevent replay attacks, typically managed by the account itself.\n","title":"nonce","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"168":{"href":"/reference#defined-in-30","html":"\n
The address of the paymaster sponsoring the transaction, followed by extra data to send to the paymaster. Empty string if there's no paymaster.
\n","isPage":false,"text":"\n\npaymasterAndData: string\n\nThe address of the paymaster sponsoring the transaction, followed by extra data to send to the paymaster. Empty string if there's no paymaster.\n","title":"paymasterAndData","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"170":{"href":"/reference#defined-in-31","html":"\n
The amount of gas to compensate the bundler for pre-verification execution and calldata.
\n","isPage":false,"text":"\n\npreVerificationGas: string\n\nThe amount of gas to compensate the bundler for pre-verification execution and calldata.\n","title":"preVerificationGas","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"172":{"href":"/reference#defined-in-32","html":"\n
The address of the smart contract account that will make the transaction.
\n","isPage":false,"text":"\n\nsender: `0x${string}`\n\nThe address of the smart contract account that will make the transaction.\n","title":"sender","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"174":{"href":"/reference#defined-in-33","html":"\n
The signature over the entire UserOperation, to be validated during verification.
\n","isPage":false,"text":"\n\nsignature: string\n\nThe signature over the entire UserOperation, to be validated during verification.\n","title":"signature","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"176":{"href":"/reference#defined-in-34","html":"\n
\n","isPage":false,"text":"\n\nverificationGasLimit: string\n\nThe gas limit for the verification step.\n","title":"verificationGasLimit","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"178":{"href":"/reference#defined-in-35","html":"\n
Represents the response model returned by the /execute route of the Klaster Node API.\nThis interface encapsulates the result of initiating the execution of an interchain transaction.
\n
ExecuteResponse
\n","isPage":false,"text":"\nRepresents the response model returned by the /execute route of the Klaster Node API.\nThis interface encapsulates the result of initiating the execution of an interchain transaction.\nExecuteResponse\n","title":"ExecuteResponse","titles":["klaster-sdk","Interfaces"]},"180":{"href":"/reference#properties-4","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ExecuteResponse"]},"181":{"href":"/reference#itxhash","html":"\n
\n
iTxHash: string
\n
\n
The hash of the Klaster Interchain Transaction (iTx) that has been\nsubmitted for execution. This hash serves as a unique identifier for the interchain transaction\nand can be used to track or reference the transaction's status and outcome across multiple chains.
\n","isPage":false,"text":"\n\niTxHash: string\n\nThe hash of the Klaster Interchain Transaction (iTx) that has been\nsubmitted for execution. This hash serves as a unique identifier for the interchain transaction\nand can be used to track or reference the transaction's status and outcome across multiple chains.\n","title":"iTxHash","titles":["klaster-sdk","Interfaces","ExecuteResponse","Properties"]},"182":{"href":"/reference#defined-in-36","html":"\n
Represents the model returned by the Klaster Node API after an Action has been executed.\nThis interface provides detailed information about the execution status and parameters\nof a user operation processed by Klaster.
\n
ExecutedAction
\n","isPage":false,"text":"\nRepresents the model returned by the Klaster Node API after an Action has been executed.\nThis interface provides detailed information about the execution status and parameters\nof a user operation processed by Klaster.\nExecutedAction\n","title":"ExecutedAction","titles":["klaster-sdk","Interfaces"]},"184":{"href":"/reference#properties-5","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ExecutedAction"]},"185":{"href":"/reference#chainid-2","html":"\n
\n
chainId: string
\n
\n
The identifier of the blockchain network on which the userOp is executed.
\n","isPage":false,"text":"\n\nchainId: string\n\nThe identifier of the blockchain network on which the userOp is executed.\n","title":"chainId","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"186":{"href":"/reference#defined-in-37","html":"\n
The callData of the executed action, representing the actual operation performed.
\n","isPage":false,"text":"\n\nexecutionData: string\n\nThe callData of the executed action, representing the actual operation performed.\n","title":"executionData","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"188":{"href":"/reference#defined-in-38","html":"\n
"SUCCESS": The operation was successfully executed.
\n
"FAILED": The operation failed during execution.
\n
"PENDING": The Klaster node is waiting for conditions to be met before execution.\nThis status is part of the Klaster spec and is particularly relevant for multichain actions\nwhere execution conditions on the destination chain may depend on prior token bridging.
\n
\n","isPage":false,"text":"\n\nexecutionStatus: "SUCCESS" | "PENDING" | "FAILED"\n\nThe current status of the UserOp execution:\n\n"SUCCESS": The operation was successfully executed.\n"FAILED": The operation failed during execution.\n"PENDING": The Klaster node is waiting for conditions to be met before execution.\nThis status is part of the Klaster spec and is particularly relevant for multichain actions\nwhere execution conditions on the destination chain may depend on prior token bridging.\n\n","title":"executionStatus","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"190":{"href":"/reference#defined-in-39","html":"\n
The earliest timestamp at which the userOp will be executed on the target blockchain.
\n","isPage":false,"text":"\n\nlowerBoundTimestap: string\n\nThe earliest timestamp at which the userOp will be executed on the target blockchain.\n","title":"lowerBoundTimestap","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"192":{"href":"/reference#defined-in-40","html":"\n
The maximum gas limit allowed for the execution of this userOp.
\n","isPage":false,"text":"\n\nmaxGasLimit: string\n\nThe maximum gas limit allowed for the execution of this userOp.\n","title":"maxGasLimit","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"194":{"href":"/reference#defined-in-41","html":"\n
The latest timestamp by which the userOp will be executed on the target blockchain.
\n","isPage":false,"text":"\n\nupperBoundTimestamp: string\n\nThe latest timestamp by which the userOp will be executed on the target blockchain.\n","title":"upperBoundTimestamp","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"196":{"href":"/reference#defined-in-42","html":"\n
The full ERC-4337 UserOperation object that was executed.
\n","isPage":false,"text":"\n\nuserOp: ERC4337UserOp\n\nThe full ERC-4337 UserOperation object that was executed.\n","title":"userOp","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"198":{"href":"/reference#defined-in-43","html":"\n
The hash of the userOp, serving as a unique identifier for the operation.
\n","isPage":false,"text":"\n\nuserOpHash: string\n\nThe hash of the userOp, serving as a unique identifier for the operation.\n","title":"userOpHash","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"200":{"href":"/reference#defined-in-44","html":"\n
Represents the minimal UserOperation required for a fully described Klaster Interchain Transaction model.\nThis interface defines the structure for actions that can be performed on a single chain within\na Klaster Interchain Transaction.
\n
ITxUserOp
\n","isPage":false,"text":"\nRepresents the minimal UserOperation required for a fully described Klaster Interchain Transaction model.\nThis interface defines the structure for actions that can be performed on a single chain within\na Klaster Interchain Transaction.\nITxUserOp\n","title":"ITxUserOp","titles":["klaster-sdk","Interfaces"]},"202":{"href":"/reference#properties-6","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ITxUserOp"]},"203":{"href":"/reference#chainid-3","html":"\n
\n
chainId: number
\n
\n
The identifier of the blockchain network on which the transaction(s) will be executed.
\n","isPage":false,"text":"\n\nchainId: number\n\nThe identifier of the blockchain network on which the transaction(s) will be executed.\n","title":"chainId","titles":["klaster-sdk","Interfaces","ITxUserOp","Properties"]},"204":{"href":"/reference#defined-in-45","html":"\n
Optional. The earliest timestamp at which the transaction(s) can be executed.
\n","isPage":false,"text":"\n\noptional lowerBoundTime: number\n\nOptional. The earliest timestamp at which the transaction(s) can be executed.\n","title":"lowerBoundTime?","titles":["klaster-sdk","Interfaces","ITxUserOp","Properties"]},"206":{"href":"/reference#defined-in-46","html":"\n
An array of raw transactions to be executed on the specified chain.
\n
\n
If this array contains a single transaction, the 'execute' function will be called on the smart contract account.
\n
If this array contains multiple transactions, the 'batchExecute' function will be called on the smart contract account.
\n
\n","isPage":false,"text":"\n\ntxs: RawTransaction[]\n\nAn array of raw transactions to be executed on the specified chain.\n\nIf this array contains a single transaction, the 'execute' function will be called on the smart contract account.\nIf this array contains multiple transactions, the 'batchExecute' function will be called on the smart contract account.\n\n","title":"txs","titles":["klaster-sdk","Interfaces","ITxUserOp","Properties"]},"208":{"href":"/reference#defined-in-47","html":"\n
Optional. The latest timestamp by which the transaction(s) should be executed.
\n","isPage":false,"text":"\n\noptional upperBoundTime: number\n\nOptional. The latest timestamp by which the transaction(s) should be executed.\n","title":"upperBoundTime?","titles":["klaster-sdk","Interfaces","ITxUserOp","Properties"]},"210":{"href":"/reference#defined-in-48","html":"\n
Represents the response model returned by the /explorer route of the Klaster Node API.\nThis interface provides detailed information about the status and execution details of an interchain transaction.
\n
ItxStatusResponse
\n","isPage":false,"text":"\nRepresents the response model returned by the /explorer route of the Klaster Node API.\nThis interface provides detailed information about the status and execution details of an interchain transaction.\nItxStatusResponse\n","title":"ItxStatusResponse","titles":["klaster-sdk","Interfaces"]},"218":{"href":"/reference#properties-8","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ItxStatusResponse"]},"219":{"href":"/reference#commitment","html":"\n
\n
commitment: string
\n
\n
The cryptographic commitment generated by the Klaster node, guaranteeing\nthe execution of the interchain transaction.
\n","isPage":false,"text":"\n\ncommitment: string\n\nThe cryptographic commitment generated by the Klaster node, guaranteeing\nthe execution of the interchain transaction.\n","title":"commitment","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties"]},"220":{"href":"/reference#defined-in-51","html":"\n
The hash of the Klaster Interchain Transaction (iTx). Serves as a unique identifier\nfor the interchain transaction.
\n","isPage":false,"text":"\n\nitxHash: string\n\nThe hash of the Klaster Interchain Transaction (iTx). Serves as a unique identifier\nfor the interchain transaction.\n","title":"itxHash","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties"]},"222":{"href":"/reference#defined-in-52","html":"\n
The address of the Klaster node that is responsible for executing the interchain transaction.
\n","isPage":false,"text":"\n\nnode: `0x${string}`\n\nThe address of the Klaster node that is responsible for executing the interchain transaction.\n","title":"node","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties"]},"224":{"href":"/reference#defined-in-53","html":"\n
Contains information about the payment for the transaction, including the token\nused and the actual amount quoted for the execution.
\n","isPage":false,"text":"\n\npaymentInfo: ApiPaymentData & object\n\nContains information about the payment for the transaction, including the token\nused and the actual amount quoted for the execution.\n","title":"paymentInfo","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties"]},"226":{"href":"/reference#type-declaration","html":"\n","isPage":false,"text":"\n","title":"Type declaration","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties","paymentInfo"]},"227":{"href":"/reference#tokenamount","html":"\n
An array of ExecutedAction objects, each representing the status and\ndetails of a user operation executed as part of this interchain transaction across different chains.
\n","isPage":false,"text":"\n\nuserOps: ExecutedAction[]\n\nAn array of ExecutedAction objects, each representing the status and\ndetails of a user operation executed as part of this interchain transaction across different chains.\n","title":"userOps","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties"]},"231":{"href":"/reference#defined-in-55","html":"\n
Represents a Klaster Multichain Smart Contract account model.\nThis interface defines the essential properties of a smart contract account\nthat can operate across multiple blockchain networks.
\n
MultichainAccount
\n","isPage":false,"text":"\nRepresents a Klaster Multichain Smart Contract account model.\nThis interface defines the essential properties of a smart contract account\nthat can operate across multiple blockchain networks.\nMultichainAccount\n","title":"MultichainAccount","titles":["klaster-sdk","Interfaces"]},"233":{"href":"/reference#properties-9","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","MultichainAccount"]},"234":{"href":"/reference#address","html":"\n
\n
address: `0x${string}`
\n
\n
The unique address of the multichain smart contract account.\nThis address is (mostly) consistent across all supported blockchain networks, allowing\nfor unified identity and seamless cross-chain operations. Some exceptions to the generated\naddress being consistent are blockchains in the zkSync ecosystem & any other ecosystem where\nthe CREATE2 opcode doesn't behave the same way as on Ethereum mainnet.
\n","isPage":false,"text":"\n\naddress: `0x${string}`\n\nThe unique address of the multichain smart contract account.\nThis address is (mostly) consistent across all supported blockchain networks, allowing\nfor unified identity and seamless cross-chain operations. Some exceptions to the generated\naddress being consistent are blockchains in the zkSync ecosystem & any other ecosystem where\nthe CREATE2 opcode doesn't behave the same way as on Ethereum mainnet.\n","title":"address","titles":["klaster-sdk","Interfaces","MultichainAccount","Properties"]},"235":{"href":"/reference#defined-in-56","html":"\n
A unique value used in the account creation process.\nThe salt, combined with other parameters (such as the owner's address),\nensures that the account address is unique and deterministically generated\nacross all supported chains.
\n","isPage":false,"text":"\n\nsalt: string\n\nA unique value used in the account creation process.\nThe salt, combined with other parameters (such as the owner's address),\nensures that the account address is unique and deterministically generated\nacross all supported chains.\n","title":"salt","titles":["klaster-sdk","Interfaces","MultichainAccount","Properties"]},"237":{"href":"/reference#defined-in-57","html":"\n
Represents the model returned by the Klaster Node API when a user requests a quote for an interchain transaction.\nThis interface provides detailed information about the quote, including the transaction hash,\nnode commitment, and the user operations to be executed across multiple chains.
\n
QuoteResponse
\n","isPage":false,"text":"\nRepresents the model returned by the Klaster Node API when a user requests a quote for an interchain transaction.\nThis interface provides detailed information about the quote, including the transaction hash,\nnode commitment, and the user operations to be executed across multiple chains.\nQuoteResponse\n","title":"QuoteResponse","titles":["klaster-sdk","Interfaces"]},"239":{"href":"/reference#properties-10","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","QuoteResponse"]},"240":{"href":"/reference#commitment-1","html":"\n
\n
commitment: string
\n
\n
The cryptographic commitment generated by the Klaster node.\nThis commitment guarantees the execution of the quoted interchain transaction.
\n","isPage":false,"text":"\n\ncommitment: string\n\nThe cryptographic commitment generated by the Klaster node.\nThis commitment guarantees the execution of the quoted interchain transaction.\n","title":"commitment","titles":["klaster-sdk","Interfaces","QuoteResponse","Properties"]},"241":{"href":"/reference#defined-in-58","html":"\n
The hash of the Klaster Interchain Transaction. This serves\nas a unique identifier for the entire interchain operation.
\n","isPage":false,"text":"\n\nitxHash: `0x${string}`\n\nThe hash of the Klaster Interchain Transaction. This serves\nas a unique identifier for the entire interchain operation.\n","title":"itxHash","titles":["klaster-sdk","Interfaces","QuoteResponse","Properties"]},"243":{"href":"/reference#defined-in-59","html":"\n
The address of the Klaster node that has returned the quote and\ncommitted itself to executing the interchain transaction.
\n","isPage":false,"text":"\n\nnode: `0x${string}`\n\nThe address of the Klaster node that has returned the quote and\ncommitted itself to executing the interchain transaction.\n","title":"node","titles":["klaster-sdk","Interfaces","QuoteResponse","Properties"]},"245":{"href":"/reference#defined-in-60","html":"\n
Contains information about the payment for the\ntransaction, including the token to be used and the chain on which the payment will occur.
\n","isPage":false,"text":"\n\npaymentInfo: ApiPaymentData\n\nContains information about the payment for the\ntransaction, including the token to be used and the chain on which the payment will occur.\n","title":"paymentInfo","titles":["klaster-sdk","Interfaces","QuoteResponse","Properties"]},"247":{"href":"/reference#defined-in-61","html":"\n
An array of all UserOperations across all chains that\nthe node has committed to executing as part of this interchain transaction. Each UserOp\nrepresents a specific action on a particular blockchain within the interchain transaction.
\n","isPage":false,"text":"\n\nuserOps: ERC4337UserOp[]\n\nAn array of all UserOperations across all chains that\nthe node has committed to executing as part of this interchain transaction. Each UserOp\nrepresents a specific action on a particular blockchain within the interchain transaction.\n","title":"userOps","titles":["klaster-sdk","Interfaces","QuoteResponse","Properties"]},"249":{"href":"/reference#defined-in-62","html":"\n
Represents a raw transaction as expected by the execute and batchExecute functions\nof smart contract wallets compliant with the ERC-4337 standard.\nThis interface defines the structure for a single transaction to be executed\nas part of a user operation in account abstraction.
\n
RawTransaction
\n","isPage":false,"text":"\nRepresents a raw transaction as expected by the execute and batchExecute functions\nof smart contract wallets compliant with the ERC-4337 standard.\nThis interface defines the structure for a single transaction to be executed\nas part of a user operation in account abstraction.\nRawTransaction\n","title":"RawTransaction","titles":["klaster-sdk","Interfaces"]},"251":{"href":"/reference#properties-11","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","RawTransaction"]},"252":{"href":"/reference#data","html":"\n
\n
data: string
\n
\n
The input data of the transaction, typically the encoded function\ncall for contract interactions. For simple value transfers, this can be an empty string.
\n","isPage":false,"text":"\n\ndata: string\n\nThe input data of the transaction, typically the encoded function\ncall for contract interactions. For simple value transfers, this can be an empty string.\n","title":"data","titles":["klaster-sdk","Interfaces","RawTransaction","Properties"]},"253":{"href":"/reference#defined-in-63","html":"\n
The maximum amount of gas that can be used for executing\nthis transaction, represented as a bigint. This helps prevent unexpectedly high gas costs.
\n","isPage":false,"text":"\n\ngasLimit: bigint\n\nThe maximum amount of gas that can be used for executing\nthis transaction, represented as a bigint. This helps prevent unexpectedly high gas costs.\n","title":"gasLimit","titles":["klaster-sdk","Interfaces","RawTransaction","Properties"]},"255":{"href":"/reference#defined-in-64","html":"\n
The recipient address of the transaction. This can be a contract\naddress for contract interactions or an EOA for simple transfers.
\n","isPage":false,"text":"\n\nto: `0x${string}`\n\nThe recipient address of the transaction. This can be a contract\naddress for contract interactions or an EOA for simple transfers.\n","title":"to","titles":["klaster-sdk","Interfaces","RawTransaction","Properties"]},"257":{"href":"/reference#defined-in-65","html":"\n
The amount of native currency (e.g., ETH) to be sent with the\ntransaction, represented as a bigint. Use 0n for transactions that don't transfer value.
\n","isPage":false,"text":"\n\nvalue: bigint\n\nThe amount of native currency (e.g., ETH) to be sent with the\ntransaction, represented as a bigint. Use 0n for transactions that don't transfer value.\n","title":"value","titles":["klaster-sdk","Interfaces","RawTransaction","Properties"]},"259":{"href":"/reference#defined-in-66","html":"\n
Represents the symbol of a payment token supported by the system.\nThese symbols correspond to various tokens\nthat can be used for payments across different blockchain networks.
\n","isPage":false,"text":"\n\nPaymentTokenSymbol: "ETH" | "WETH" | "LINK" | "USDC" | "wstETH" | "USDT" | "MATIC" | "WMATIC" | "stMATIC" | "AVAX" | "WAVAX" | "BNB" | "WBNB" | "axlUSDC" | "crUSDC" | "BSC-USD"\n\nRepresents the symbol of a payment token supported by the system.\nThese symbols correspond to various tokens\nthat can be used for payments across different blockchain networks.\n","title":"PaymentTokenSymbol","titles":["klaster-sdk","Type Aliases"]},"277":{"href":"/reference#defined-in-72","html":"\n
Builds a strategy for using tokens across multiple chains to satisfy a given amount.\nEnsures all tokens have the same number of decimals.
\n","isPage":false,"text":"\n\nbuildTokenStrategy(__namedParameters): Promise<TokenStrategy>\n\nBuilds a strategy for using tokens across multiple chains to satisfy a given amount.\nEnsures all tokens have the same number of decimals.\n","title":"buildTokenStrategy()","titles":["klaster-sdk","Functions"]},"280":{"href":"/reference#parameters-12","html":"\n
An array of StrategyItem objects, each containing a chainId and an amount to use from that chain.
\n
null if the total balance across all chains is insufficient to satisfy the requested amount.
\n
\n","isPage":false,"text":"\nPromise<TokenStrategy>\nA promise that resolves to either:\n\nAn array of StrategyItem objects, each containing a chainId and an amount to use from that chain.\nnull if the total balance across all chains is insufficient to satisfy the requested amount.\n\n","title":"Returns","titles":["klaster-sdk","Functions","buildTokenStrategy()"]},"282":{"href":"/reference#throws-8","html":"\n
Throws an error if:
\n
\n
There's an issue fetching balances or decimals
\n
The token addresses are invalid
\n
Tokens across different chains have different numbers of decimals
\n
\n","isPage":false,"text":"\nThrows an error if:\n\nThere's an issue fetching balances or decimals\nThe token addresses are invalid\nTokens across different chains have different numbers of decimals\n\n","title":"Throws","titles":["klaster-sdk","Functions","buildTokenStrategy()"]},"283":{"href":"/reference#example-13","html":"\n
Builds a transaction to transfer ERC20 tokens from an Externally Owned Account (EOA)\nto another account, typically a smart contract account.
\n
This function constructs a RawTransaction object that, when executed, will transfer\nthe specified amount of ERC20 tokens from the sending EOA to the recipient address.\nIt's commonly used to fund smart contract accounts with tokens.
\n","isPage":false,"text":"\n\nbuildTransferERC20FromEoaTx(params): RawTransaction\n\nBuilds a transaction to transfer ERC20 tokens from an Externally Owned Account (EOA)\nto another account, typically a smart contract account.\nThis function constructs a RawTransaction object that, when executed, will transfer\nthe specified amount of ERC20 tokens from the sending EOA to the recipient address.\nIt's commonly used to fund smart contract accounts with tokens.\n","title":"buildTransferERC20FromEoaTx()","titles":["klaster-sdk","Functions"]},"286":{"href":"/reference#parameters-13","html":"\n
• params
\n
The parameters for building the transaction.
\n
• params.amount: bigint
\n
The amount of tokens to transfer, in the token's smallest unit (e.g., wei for ETH-like tokens).
\n
• params.chainId: number
\n
The ID of the blockchain network where the transaction will be executed.
\n
• params.recipient: `0x${string}`
\n
The address of the account receiving the tokens.
\n
• params.token: `0x${string}`
\n
The address of the ERC20 token contract.
\n","isPage":false,"text":"\n• params\nThe parameters for building the transaction.\n• params.amount: bigint\nThe amount of tokens to transfer, in the token's smallest unit (e.g., wei for ETH-like tokens).\n• params.chainId: number\nThe ID of the blockchain network where the transaction will be executed.\n• params.recipient: `0x${string}`\nThe address of the account receiving the tokens.\n• params.token: `0x${string}`\nThe address of the ERC20 token contract.\n","title":"Parameters","titles":["klaster-sdk","Functions","buildTransferERC20FromEoaTx()"]},"287":{"href":"/reference#returns-17","html":"\n
A RawTransaction object ready to be signed and broadcasted.\nThe object includes:
\n
\n
to: The address of the ERC20 token contract.
\n
value: Always 0n for ERC20 transfers.
\n
data: The encoded function call data for the ERC20 'transfer' function.
\n
gasLimit: A predefined gas limit set to 55000 (adjust if necessary for different tokens or networks).
\n
\n","isPage":false,"text":"\nRawTransaction\nA RawTransaction object ready to be signed and broadcasted.\nThe object includes:\n\nto: The address of the ERC20 token contract.\nvalue: Always 0n for ERC20 transfers.\ndata: The encoded function call data for the ERC20 'transfer' function.\ngasLimit: A predefined gas limit set to 55000 (adjust if necessary for different tokens or networks).\n\n","title":"Returns","titles":["klaster-sdk","Functions","buildTransferERC20FromEoaTx()"]},"288":{"href":"/reference#example-14","html":"\n
const txParams = {\n recipient: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',\n amount: BigInt(1000000), // 1 USDC if USDC has 6 decimals\n chainId: 1,\n token: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48' // USDC on Ethereum mainnet\n};\nconst rawTx = buildTransferERC20FromEoaTx(txParams);\n// rawTx can now be signed and sent to the network
\n","isPage":false,"text":"\nconst txParams = {\n recipient: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',\n amount: BigInt(1000000), // 1 USDC if USDC has 6 decimals\n chainId: 1,\n token: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48' // USDC on Ethereum mainnet\n};\nconst rawTx = buildTransferERC20FromEoaTx(txParams);\n// rawTx can now be signed and sent to the network\n","title":"Example","titles":["klaster-sdk","Functions","buildTransferERC20FromEoaTx()"]},"289":{"href":"/reference#defined-in-74","html":"\n
Creates a TokenMapping object from an array of TokenInfo objects.
\n
This function generates a mapping of chain IDs to token addresses, which is used\nin other Klaster SDK functions like getUnifiedBalance. It allows for easy\nspecification of token addresses across multiple chains.
\n","isPage":false,"text":"\n\ncreateTokenMapping(tokens): TokenMapping\n\nCreates a TokenMapping object from an array of TokenInfo objects.\nThis function generates a mapping of chain IDs to token addresses, which is used\nin other Klaster SDK functions like getUnifiedBalance. It allows for easy\nspecification of token addresses across multiple chains.\n","title":"createTokenMapping()","titles":["klaster-sdk","Functions"]},"291":{"href":"/reference#parameters-14","html":"\n
• tokens: TokenInfo[]
\n
An array of TokenInfo objects. Each TokenInfo should contain:
\n
\n
chain: The chain ID (number) where the token is deployed.
\n
address: The address (string) of the token contract on the specified chain.
\n
\n","isPage":false,"text":"\n• tokens: TokenInfo[]\nAn array of TokenInfo objects. Each TokenInfo should contain:\n\nchain: The chain ID (number) where the token is deployed.\naddress: The address (string) of the token contract on the specified chain.\n\n","title":"Parameters","titles":["klaster-sdk","Functions","createTokenMapping()"]},"292":{"href":"/reference#returns-18","html":"\n
TokenMapping
\n
An object where keys are chain IDs and values are token addresses.
\n","isPage":false,"text":"\nTokenMapping\nAn object where keys are chain IDs and values are token addresses.\n","title":"Returns","titles":["klaster-sdk","Functions","createTokenMapping()"]},"293":{"href":"/reference#throws-9","html":"\n
Throws an error if duplicate chain IDs are provided in the input array.
\n","isPage":false,"text":"\nThrows an error if duplicate chain IDs are provided in the input array.\n","title":"Throws","titles":["klaster-sdk","Functions","createTokenMapping()"]},"294":{"href":"/reference#example-15","html":"\n
import { createTokenMapping } from 'klaster-sdk';\n\n// Create a mapping for USDC across multiple chains\nconst usdcMapping = createTokenMapping([\n { chain: 1, address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' }, // Ethereum Mainnet\n { chain: 10, address: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85' }, // Optimism\n { chain: 137, address: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174' } // Polygon\n]);\n\nconsole.log(usdcMapping);\n// Output:\n// {\n// 1: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',\n// 10: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85',\n// 137: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174'\n// }\n\n// This mapping can then be used in other SDK functions:\nconst balance = await getUnifiedBalance({\n mapping: usdcMapping,\n address: '0x...',\n chainConfigs: [...]\n});
\n","isPage":false,"text":"\nimport { createTokenMapping } from 'klaster-sdk';\n \n// Create a mapping for USDC across multiple chains\nconst usdcMapping = createTokenMapping([\n { chain: 1, address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' }, // Ethereum Mainnet\n { chain: 10, address: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85' }, // Optimism\n { chain: 137, address: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174' } // Polygon\n]);\n \nconsole.log(usdcMapping);\n// Output:\n// {\n// 1: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',\n// 10: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85',\n// 137: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174'\n// }\n \n// This mapping can then be used in other SDK functions:\nconst balance = await getUnifiedBalance({\n mapping: usdcMapping,\n address: '0x...',\n chainConfigs: [...]\n});\n","title":"Example","titles":["klaster-sdk","Functions","createTokenMapping()"]},"295":{"href":"/reference#see-8","html":"\n
For using the created mapping, see the documentation for getUnifiedBalance.
\n","isPage":false,"text":"\nFor using the created mapping, see the documentation for getUnifiedBalance.\n","title":"See","titles":["klaster-sdk","Functions","createTokenMapping()"]},"296":{"href":"/reference#defined-in-75","html":"\n
A syntactic helper for creating action objects in the Klaster SDK.
\n
This function combines an array of RawTransactions with a chain ID into an object.\nIt's used to provide a consistent coding style when working with actions in the Klaster SDK.
\n","isPage":false,"text":"\n\nencodeAction(txs, chainId): object\n\nA syntactic helper for creating action objects in the Klaster SDK.\nThis function combines an array of RawTransactions with a chain ID into an object.\nIt's used to provide a consistent coding style when working with actions in the Klaster SDK.\n","title":"encodeAction()","titles":["klaster-sdk","Functions"]},"298":{"href":"/reference#parameters-15","html":"\n
\n","isPage":false,"text":"\n• txs: RawTransaction[]\nAn array of RawTransaction objects.\n• chainId: number\nThe ID of the blockchain for this action.\n","title":"Parameters","titles":["klaster-sdk","Functions","encodeAction()"]},"299":{"href":"/reference#returns-19","html":"\n
object
\n
An object containing the transactions and chain ID.
\n","isPage":false,"text":"\nobject\nAn object containing the transactions and chain ID.\n","title":"Returns","titles":["klaster-sdk","Functions","encodeAction()"]},"300":{"href":"/reference#chainid-4","html":"\n
Encodes bridging data from a token strategy for multiple chains.
\n
This function takes a token strategy (typically generated by buildTokenStrategy) and encodes\nthe necessary data for bridging tokens from multiple source chains to a single destination chain.\nIt uses the provided encodeSingleBridgeData function to generate the specific bridging data for each chain.
\n","isPage":false,"text":"\n\nencodeBridgingDataFromStrategy(options): Promise<object[]>\n\nEncodes bridging data from a token strategy for multiple chains.\nThis function takes a token strategy (typically generated by buildTokenStrategy) and encodes\nthe necessary data for bridging tokens from multiple source chains to a single destination chain.\nIt uses the provided encodeSingleBridgeData function to generate the specific bridging data for each chain.\n","title":"encodeBridgingDataFromStrategy()","titles":["klaster-sdk","Functions"]},"305":{"href":"/reference#parameters-16","html":"\n
• options: EncodeBridgingDataFromStrategyOptions
\n
The options for encoding bridging data.
\n","isPage":false,"text":"\n• options: EncodeBridgingDataFromStrategyOptions\nThe options for encoding bridging data.\n","title":"Parameters","titles":["klaster-sdk","Functions","encodeBridgingDataFromStrategy()"]},"306":{"href":"/reference#returns-20","html":"\n
Promise<object[]>
\n
A promise that resolves to an array of RawTransaction objects,\neach containing the encoded bridging data for a single chain in the strategy.
\n","isPage":false,"text":"\nPromise<object[]>\nA promise that resolves to an array of RawTransaction objects,\neach containing the encoded bridging data for a single chain in the strategy.\n","title":"Returns","titles":["klaster-sdk","Functions","encodeBridgingDataFromStrategy()"]},"307":{"href":"/reference#throws-10","html":"\n
Throws an error if the strategy is null, indicating no feasible strategy exists,\nor if a token address is not found for a chain in the strategy.
\n","isPage":false,"text":"\nThrows an error if the strategy is null, indicating no feasible strategy exists,\nor if a token address is not found for a chain in the strategy.\n","title":"Throws","titles":["klaster-sdk","Functions","encodeBridgingDataFromStrategy()"]},"308":{"href":"/reference#example-17","html":"\n
const tokenMapping = {\n 10: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85', // USDC on Optimism\n 8453: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913' // USDC on Base\n};\n\nconst strategy = [\n { chainId: 10, amount: BigInt("15000") },\n { chainId: 8453, amount: BigInt("5000") }\n];\n\nconst encodeSingleBridgeData = async (\n tokenAddress,\n sourceChainId,\n destinationChainId,\n amount,\n multichainAddress\n) => {\n // Implement your specific bridge encoding logic here\n // This is just a placeholder implementation\n return {\n to: multichainAddress,\n value: //\n gasLimit: //\n data: // Data encoded by your bridge encoding implementation\n };\n};\n\ntry {\n const bridgingData = await encodeBridgingDataFromStrategy({\n strategy,\n tokenMapping,\n destinationChainId: 1, // Ethereum mainnet\n multichainAddress: '0x1234567890123456789012345678901234567890',\n encodeSingleBridgeData\n });\n\n console.log(bridgingData);\n // Output will be an array of RawTransaction objects, one for each chain in the strategy\n} catch (error) {\n console.error('Error encoding bridging data:', error.message);\n}
\n","isPage":false,"text":"\nconst tokenMapping = {\n 10: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85', // USDC on Optimism\n 8453: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913' // USDC on Base\n};\n \nconst strategy = [\n { chainId: 10, amount: BigInt("15000") },\n { chainId: 8453, amount: BigInt("5000") }\n];\n \nconst encodeSingleBridgeData = async (\n tokenAddress,\n sourceChainId,\n destinationChainId,\n amount,\n multichainAddress\n) => {\n // Implement your specific bridge encoding logic here\n // This is just a placeholder implementation\n return {\n to: multichainAddress,\n value: //\n gasLimit: //\n data: // Data encoded by your bridge encoding implementation\n };\n};\n \ntry {\n const bridgingData = await encodeBridgingDataFromStrategy({\n strategy,\n tokenMapping,\n destinationChainId: 1, // Ethereum mainnet\n multichainAddress: '0x1234567890123456789012345678901234567890',\n encodeSingleBridgeData\n });\n \n console.log(bridgingData);\n // Output will be an array of RawTransaction objects, one for each chain in the strategy\n} catch (error) {\n console.error('Error encoding bridging data:', error.message);\n}\n","title":"Example","titles":["klaster-sdk","Functions","encodeBridgingDataFromStrategy()"]},"309":{"href":"/reference#defined-in-77","html":"\n
A syntactic helper for creating InterchainTransaction objects in the Klaster SDK.
\n
This function returns its input unchanged. Its purpose is to provide a consistent\ncoding style when working with the Klaster SDK, allowing for a more fluent and\nreadable way of creating InterchainTransaction objects.
\n","isPage":false,"text":"\n\nencodeItx(itx): InterchainTransaction\n\nA syntactic helper for creating InterchainTransaction objects in the Klaster SDK.\nThis function returns its input unchanged. Its purpose is to provide a consistent\ncoding style when working with the Klaster SDK, allowing for a more fluent and\nreadable way of creating InterchainTransaction objects.\n","title":"encodeItx()","titles":["klaster-sdk","Functions"]},"311":{"href":"/reference#parameters-17","html":"\n
\n","isPage":false,"text":"\n• itx: InterchainTransaction\nThe InterchainTransaction object to be "encoded".\n","title":"Parameters","titles":["klaster-sdk","Functions","encodeItx()"]},"312":{"href":"/reference#returns-21","html":"\n
\n","isPage":false,"text":"\nInterchainTransaction\nThe same InterchainTransaction object, unchanged.\n","title":"Returns","titles":["klaster-sdk","Functions","encodeItx()"]},"313":{"href":"/reference#example-18","html":"\n
A syntactic helper for working with RawTransaction objects in the Klaster SDK.
\n
This function returns its input unchanged. Its purpose is to provide a consistent\ncoding style when working with the Klaster SDK, allowing for a more fluent way\nof handling RawTransaction objects.
\n","isPage":false,"text":"\n\nencodeTx(tx): RawTransaction\n\nA syntactic helper for working with RawTransaction objects in the Klaster SDK.\nThis function returns its input unchanged. Its purpose is to provide a consistent\ncoding style when working with the Klaster SDK, allowing for a more fluent way\nof handling RawTransaction objects.\n","title":"encodeTx()","titles":["klaster-sdk","Functions"]},"316":{"href":"/reference#parameters-18","html":"\n
\n","isPage":false,"text":"\n• tx: RawTransaction\nThe RawTransaction object to be "encoded".\n","title":"Parameters","titles":["klaster-sdk","Functions","encodeTx()"]},"317":{"href":"/reference#returns-22","html":"\n
\n","isPage":false,"text":"\nRawTransaction\nThe same RawTransaction object, unchanged.\n","title":"Returns","titles":["klaster-sdk","Functions","encodeTx()"]},"318":{"href":"/reference#example-19","html":"\n
Fetches the primary Ethereum address from an injected web3 wallet provider (e.g., MetaMask).
\n
This function creates a wallet client using the viem library and the injected Ethereum provider.\nIt then retrieves the list of addresses associated with the wallet and returns the first address.
\n","isPage":false,"text":"\n\nfetchInjectedAddress(): Promise<Address | undefined>\n\nFetches the primary Ethereum address from an injected web3 wallet provider (e.g., MetaMask).\nThis function creates a wallet client using the viem library and the injected Ethereum provider.\nIt then retrieves the list of addresses associated with the wallet and returns the first address.\n","title":"fetchInjectedAddress()","titles":["klaster-sdk","Functions"]},"321":{"href":"/reference#returns-23","html":"\n
Promise<Address | undefined>
\n
A promise that resolves to:
\n
\n
The primary Ethereum address (type Address) if available.
\n
undefined if no addresses are associated with the wallet or if the wallet is locked.
\n
\n","isPage":false,"text":"\nPromise<Address | undefined>\nA promise that resolves to:\n\nThe primary Ethereum address (type Address) if available.\nundefined if no addresses are associated with the wallet or if the wallet is locked.\n\n","title":"Returns","titles":["klaster-sdk","Functions","fetchInjectedAddress()"]},"322":{"href":"/reference#async-6","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Functions","fetchInjectedAddress()"]},"323":{"href":"/reference#function","html":"\n
No injected Ethereum provider is detected (i.e., window.ethereum is undefined).
\n
The user denies permission to access their accounts.
\n
There's an issue connecting to the Ethereum network.
\n
\n","isPage":false,"text":"\nThrows an error if:\n\nNo injected Ethereum provider is detected (i.e., window.ethereum is undefined).\nThe user denies permission to access their accounts.\nThere's an issue connecting to the Ethereum network.\n\n","title":"Throws","titles":["klaster-sdk","Functions","fetchInjectedAddress()"]},"325":{"href":"/reference#example-20","html":"\n
try {\n const address = await fetchInjectedAddress();\n if (address) {\n console.log('Connected wallet address:', address);\n } else {\n console.log('No wallet address found or wallet is locked');\n }\n} catch (error) {\n console.error('Error fetching wallet address:', error);\n}
\n","isPage":false,"text":"\ntry {\n const address = await fetchInjectedAddress();\n if (address) {\n console.log('Connected wallet address:', address);\n } else {\n console.log('No wallet address found or wallet is locked');\n }\n} catch (error) {\n console.error('Error fetching wallet address:', error);\n}\n","title":"Example","titles":["klaster-sdk","Functions","fetchInjectedAddress()"]},"326":{"href":"/reference#requires","html":"\n
This function is designed to work in a browser environment and requires\na web3-enabled browser with an injected Ethereum provider (like MetaMask).\nIt will not work in a Node.js environment or browsers without an Ethereum wallet.
\n","isPage":false,"text":"\nThis function is designed to work in a browser environment and requires\na web3-enabled browser with an injected Ethereum provider (like MetaMask).\nIt will not work in a Node.js environment or browsers without an Ethereum wallet.\n","title":"Note","titles":["klaster-sdk","Functions","fetchInjectedAddress()"]},"329":{"href":"/reference#defined-in-80","html":"\n
Fetches and aggregates token balances across multiple blockchains for a given address.
\n","isPage":false,"text":"\n\ngetUnifiedBalance(params): Promise<UnifiedBalanceResult>\n\nFetches and aggregates token balances across multiple blockchains for a given address.\n","title":"getUnifiedBalance()","titles":["klaster-sdk","Functions"]},"331":{"href":"/reference#parameters-19","html":"\n
• params
\n
The parameters for the function.
\n
• params.address: `0x${string}`
\n
The address for which to fetch the token balances.
\n
• params.chainConfigs: ChainConfig[]
\n
An array of objects, each containing a chainId and an rpcUrl.
\n
• params.mapping: TokenMapping
\n
An object mapping chain IDs to token addresses.
\n","isPage":false,"text":"\n• params\nThe parameters for the function.\n• params.address: `0x${string}`\nThe address for which to fetch the token balances.\n• params.chainConfigs: ChainConfig[]\nAn array of objects, each containing a chainId and an rpcUrl.\n• params.mapping: TokenMapping\nAn object mapping chain IDs to token addresses.\n","title":"Parameters","titles":["klaster-sdk","Functions","getUnifiedBalance()"]},"332":{"href":"/reference#returns-24","html":"\n
Promise<UnifiedBalanceResult>
\n
A promise that resolves to an object containing:
\n
\n
amount: The total balance across all chains as a bigint.
\n
decimals: The number of decimals for the token.
\n
\n","isPage":false,"text":"\nPromise<UnifiedBalanceResult>\nA promise that resolves to an object containing:\n\namount: The total balance across all chains as a bigint.\ndecimals: The number of decimals for the token.\n\n","title":"Returns","titles":["klaster-sdk","Functions","getUnifiedBalance()"]},"333":{"href":"/reference#throws-12","html":"\n
Throws an error in the following cases:
\n
\n
If tokens across different chains have different numbers of decimals.
\n
If no valid tokens are found in the mapping.
\n
\n","isPage":false,"text":"\nThrows an error in the following cases:\n\nIf tokens across different chains have different numbers of decimals.\nIf no valid tokens are found in the mapping.\n\n","title":"Throws","titles":["klaster-sdk","Functions","getUnifiedBalance()"]},"334":{"href":"/reference#example-21","html":"\n
Initializes the Klaster SDK with the provided configuration.
\n
This function serves as the entry point for using the Klaster SDK. It creates and\nreturns a new instance of the KlasterSDK class, configured with the provided options.
\n","isPage":false,"text":"\n\ninitKlaster(config): KlasterSDK\n\nInitializes the Klaster SDK with the provided configuration.\nThis function serves as the entry point for using the Klaster SDK. It creates and\nreturns a new instance of the KlasterSDK class, configured with the provided options.\n","title":"initKlaster()","titles":["klaster-sdk","Functions"]},"337":{"href":"/reference#parameters-20","html":"\n
\n","isPage":false,"text":"\n• config: Config\nThe configuration options for the Klaster SDK.\n","title":"Parameters","titles":["klaster-sdk","Functions","initKlaster()"]},"338":{"href":"/reference#returns-25","html":"\n
\n","isPage":false,"text":"\nKlasterSDK\nA new instance of the KlasterSDK, ready for use.\n","title":"Returns","titles":["klaster-sdk","Functions","initKlaster()"]},"339":{"href":"/reference#example-22","html":"\n
import { initKlaster, Config } from 'klaster-sdk';\n\nconst config: Config = {\n nodeUrl: 'https://klaster-node.example.com',\n masterAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e'\n};\n\nconst klasterSDK = initKlaster(config);\n\n// Now you can use klasterSDK to interact with the Klaster ecosystem
\n","isPage":false,"text":"\nimport { initKlaster, Config } from 'klaster-sdk';\n \nconst config: Config = {\n nodeUrl: 'https://klaster-node.example.com',\n masterAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e'\n};\n \nconst klasterSDK = initKlaster(config);\n \n// Now you can use klasterSDK to interact with the Klaster ecosystem\n","title":"Example","titles":["klaster-sdk","Functions","initKlaster()"]},"340":{"href":"/reference#throws-13","html":"\n
Throws an error if the provided configuration is invalid or if\nthe SDK fails to initialize for any reason.
\n","isPage":false,"text":"\nThrows an error if the provided configuration is invalid or if\nthe SDK fails to initialize for any reason.\n","title":"Throws","titles":["klaster-sdk","Functions","initKlaster()"]},"341":{"href":"/reference#defined-in-82","html":"\n
Resolves a payment token based on its symbol and the chain ID.
\n","isPage":false,"text":"\n\nresolveToken(symbol, chainId): TokenInfo\n\nResolves a payment token based on its symbol and the chain ID.\n","title":"resolveToken()","titles":["klaster-sdk","Functions"]},"343":{"href":"/reference#parameters-21","html":"\n
\n","isPage":false,"text":"\n• symbol: PaymentTokenSymbol\nThe symbol of the payment token to resolve.\n• chainId: number\nThe ID of the blockchain network.\n","title":"Parameters","titles":["klaster-sdk","Functions","resolveToken()"]},"344":{"href":"/reference#returns-26","html":"\n
TokenInfo
\n
A promise that resolves to the token information.
\n","isPage":false,"text":"\nTokenInfo\nA promise that resolves to the token information.\n","title":"Returns","titles":["klaster-sdk","Functions","resolveToken()"]},"345":{"href":"/reference#throws-14","html":"\n
If the token cannot be resolved for the given chain ID.
\n","isPage":false,"text":"\nIf the token cannot be resolved for the given chain ID.\n","title":"Throws","titles":["klaster-sdk","Functions","resolveToken()"]},"346":{"href":"/reference#defined-in-83","html":"\n
Signs a message using the injected Ethereum provider (e.g., MetaMask) in the browser.
\n
This function uses the personal_sign method to create a signature with the user's\nEthereum account. It requires a web3-enabled browser with an injected Ethereum provider.
\n","isPage":false,"text":"\n\nsignWithInjectedWallet(address, message): Promise<string>\n\nSigns a message using the injected Ethereum provider (e.g., MetaMask) in the browser.\nThis function uses the personal_sign method to create a signature with the user's\nEthereum account. It requires a web3-enabled browser with an injected Ethereum provider.\n","title":"signWithInjectedWallet()","titles":["klaster-sdk","Functions"]},"348":{"href":"/reference#parameters-22","html":"\n
• address: `0x${string}`
\n
The Ethereum address to sign the message with. This should\nbe an address that the user controls in their injected wallet.
\n
• message: string
\n
The message to be signed. This will be converted to UTF-8\nand prefixed with "\\x19Ethereum Signed Message:\\n" before signing.
\n","isPage":false,"text":"\n• address: `0x${string}`\nThe Ethereum address to sign the message with. This should\nbe an address that the user controls in their injected wallet.\n• message: string\nThe message to be signed. This will be converted to UTF-8\nand prefixed with "\\x19Ethereum Signed Message:\\n" before signing.\n","title":"Parameters","titles":["klaster-sdk","Functions","signWithInjectedWallet()"]},"349":{"href":"/reference#returns-27","html":"\n
Promise<string>
\n
A promise that resolves to the signature string.\nThe signature is in hexadecimal format.
\n","isPage":false,"text":"\nPromise<string>\nA promise that resolves to the signature string.\nThe signature is in hexadecimal format.\n","title":"Returns","titles":["klaster-sdk","Functions","signWithInjectedWallet()"]},"350":{"href":"/reference#throws-15","html":"\n
Throws an error if the injected Ethereum provider is not available,\nif the user rejects the signature request, or if there's any other\nissue during the signing process.
\n","isPage":false,"text":"\nThrows an error if the injected Ethereum provider is not available,\nif the user rejects the signature request, or if there's any other\nissue during the signing process.\n","title":"Throws","titles":["klaster-sdk","Functions","signWithInjectedWallet()"]},"351":{"href":"/reference#example-23","html":"\n
This function is designed to work in a browser environment and requires\na web3-enabled browser with an injected Ethereum provider (like MetaMask).\nIt will not work in a Node.js environment or browsers without an Ethereum wallet.
\n","isPage":false,"text":"\nThis function is designed to work in a browser environment and requires\na web3-enabled browser with an injected Ethereum provider (like MetaMask).\nIt will not work in a Node.js environment or browsers without an Ethereum wallet.\n","title":"Note","titles":["klaster-sdk","Functions","signWithInjectedWallet()"]},"353":{"href":"/reference#defined-in-84","html":"\n
This will be a zero-to-hero introduction to the Klaster SDK. Here, we will explore all of the main concepts pertaining to\nthe development of chain abstracted apps and flows.
\n
In this tutorial, you will get all the required steps to build a chain abstracted application. If you're interested in what\na chain abstracted application looks like, check out our video on AbstraktAAVE - a chain abstracted implementation of AAVE.
\n\n","isPage":true,"text":"\n\nThis will be a zero-to-hero introduction to the Klaster SDK. Here, we will explore all of the main concepts pertaining to\nthe development of chain abstracted apps and flows.\nIn this tutorial, you will get all the required steps to build a chain abstracted application. If you're interested in what\na chain abstracted application looks like, check out our video on AbstraktAAVE - a chain abstracted implementation of AAVE.\n\nYou can also use the app yourself at:\nhttps://demo-aave.klaster.io\nWhile Klaster works with all major Ethereum SDK providers, such as ethers.js, web3.js and viem - it works best when used\nin conjuction with viem.\n","title":"Zero to Hero Guide: Building a Chain Abstracted Application","titles":[]},"357":{"href":"/zero-to-hero-klaster-guide#install-klaster-and-viem","html":"\n
npm i klaster-sdk viem
\n","isPage":false,"text":"\nnpm i klaster-sdk viem\n","title":"Install Klaster and Viem","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"358":{"href":"/zero-to-hero-klaster-guide#create-a-signer-object","html":"\n
Usign viem, create a signer object - which will be used to sign transactions.
\n
import {\n buildMultichainReadonlyClient,\n buildRpcInfo,\n initKlaster,\n klasterNodeHost,\n loadBicoV2Account,\n} from "klaster-sdk";\nimport { createWalletClient, custom, http } from "viem";\nimport { generatePrivateKey, privateKeyToAccount } from "viem/accounts";\nimport { arbitrum, base, optimism, polygon, scroll } from "viem/chains";\n\n// When in browser environment create a signer\n// which uses the injected wallet (e.g. MetaMask, Rabby, ...)\nconst signer = createWalletClient({\n transport: custom((window as any).ethereum),\n});\n\n// When in non-browser environment you can use private key\n// to sign messages.\nconst privateKey = generatePrivateKey();\nconst signerAccount = privateKeyToAccount(privateKey);\nconst signer = createWalletClient({\n transport: http(),\n});
\n","isPage":false,"text":"\nUsign viem, create a signer object - which will be used to sign transactions.\nimport {\n buildMultichainReadonlyClient,\n buildRpcInfo,\n initKlaster,\n klasterNodeHost,\n loadBicoV2Account,\n} from "klaster-sdk";\nimport { createWalletClient, custom, http } from "viem";\nimport { generatePrivateKey, privateKeyToAccount } from "viem/accounts";\nimport { arbitrum, base, optimism, polygon, scroll } from "viem/chains";\n \n// When in browser environment create a signer\n// which uses the injected wallet (e.g. MetaMask, Rabby, ...)\nconst signer = createWalletClient({\n transport: custom((window as any).ethereum),\n});\n \n// When in non-browser environment you can use private key\n// to sign messages.\nconst privateKey = generatePrivateKey();\nconst signerAccount = privateKeyToAccount(privateKey);\nconst signer = createWalletClient({\n transport: http(),\n});\n","title":"Create a signer object","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"359":{"href":"/zero-to-hero-klaster-guide#initialize-klaster-sdk","html":"\n
To initialize the Klaster SDK, you must provide it with the following information:
\n
\n
Klaster Node URL
\n
ERC4337 Account Provider
\n
\n
You can use multiple account providers (check documentation reference for supported account providers). In this tutorial,\nwe will use the Biconomy account provider:
\n
// Fetch the address from viem. You might need to call signer.requestAddresses()\n// depending on your injected Web3 provider.\nconst [address] = await signer.getAddresses();\n\n// Initializing the Klaster SDK with Biconomy as the smart contract account\n// provider.\nconst klaster = await initKlaster({\n accountInitData: loadBicoV2Account({\n owner: address, // Fetch\n }),\n nodeUrl: klasterNodeHost.default,\n});
\n","isPage":false,"text":"\nTo initialize the Klaster SDK, you must provide it with the following information:\n\nKlaster Node URL\nERC4337 Account Provider\n\nYou can use multiple account providers (check documentation reference for supported account providers). In this tutorial,\nwe will use the Biconomy account provider:\n// Fetch the address from viem. You might need to call signer.requestAddresses()\n// depending on your injected Web3 provider.\nconst [address] = await signer.getAddresses();\n \n// Initializing the Klaster SDK with Biconomy as the smart contract account\n// provider.\nconst klaster = await initKlaster({\n accountInitData: loadBicoV2Account({\n owner: address, // Fetch\n }),\n nodeUrl: klasterNodeHost.default,\n});\n","title":"Initialize Klaster SDK","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"360":{"href":"/zero-to-hero-klaster-guide#initialize-a-multichain-readonly-rpc-client","html":"\n
In order to achieve certain functionality for chain abstraction, such as getting a unified token balance across chains\nor encoding bridging actions - you will need to have a public RPC for every chain you wish to interact with. Do note\nthat this is only a public RPC, you don't need to have the abilty to write to chain - as this is handled by the Klaster nodes.
\n\n
// Build a multichain client by calling the buildMultichainReadonlyClient\n// and passing the buildRpcInfo objects into the array\nconst mcClient = buildMultichainReadonlyClient([\n buildRpcInfo(optimism.id, "<op-rpc-url>"),\n buildRpcInfo(base.id, "<base-rpc-url>"),\n]);
\n
Since this is a tutorial project, we can use the viem default RPCs.
\n\n
// This is a hacky way of doing this, just to get you quickly started\n// with the tutorial. Please don't initialize the client like this in\n// production projects.\nconst mcClient = buildMultichainReadonlyClient(\n [optimism, base, polygon, arbitrum, scroll].map((x) => {\n return {\n chainId: x.id,\n rpcUrl: x.rpcUrls.default.http[0],\n };\n })\n);
\n","isPage":false,"text":"\nIn order to achieve certain functionality for chain abstraction, such as getting a unified token balance across chains\nor encoding bridging actions - you will need to have a public RPC for every chain you wish to interact with. Do note\nthat this is only a public RPC, you don't need to have the abilty to write to chain - as this is handled by the Klaster nodes.\nThis tutorial project will be using Optimism, Base, Polygon, Arbitrum and Scroll as the underlying blockchains\n// Build a multichain client by calling the buildMultichainReadonlyClient\n// and passing the buildRpcInfo objects into the array\nconst mcClient = buildMultichainReadonlyClient([\n buildRpcInfo(optimism.id, "<op-rpc-url>"),\n buildRpcInfo(base.id, "<base-rpc-url>"),\n]);\nSince this is a tutorial project, we can use the viem default RPCs.\nThis is highly discouraged in a production project. Use private RPCs when deploying to production.\n// This is a hacky way of doing this, just to get you quickly started\n// with the tutorial. Please don't initialize the client like this in\n// production projects.\nconst mcClient = buildMultichainReadonlyClient(\n [optimism, base, polygon, arbitrum, scroll].map((x) => {\n return {\n chainId: x.id,\n rpcUrl: x.rpcUrls.default.http[0],\n };\n })\n);\n","title":"Initialize a multichain readonly RPC client","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"361":{"href":"/zero-to-hero-klaster-guide#map-token-deployments-across-multiple-blockchains","html":"\n
As well as working with the Multichain RPC provider, the Klaster SDK works best when provided with MultichainTokenMapping\nobjects. These objects represent mappings of tokens you consider equivalent across various blockchains. One example would\nbe USDC - which is widely deployed by Circle across multiple blockchains.
\n
You can use the Circle Token Deployments to see which address the canonical\nversion of which token is deployed to.
\n
However, nothing limits you to using only offical token deployments. If you consider the axlUSDC to be equivalent to cannonical\nUSDC - you can simply map them together and the Klaster SDK will treat them as if they're the same token. You can provide one\ntoken per chain.
\n\n
// Build a token mapping by calling the buildTokenMapping function and passing instances of\n// deployment object into the array. These represent the chainId → address mappings.\nconst mcUSDC = buildTokenMapping([\n deployment(optimism.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(base.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n]);
\n
The Klaster SDK exposes some multichain tokens by default. These are mcUSDC and mcUSDT. They are available to you\nas exported constants. They expose deployments on a lot of blockchains so it's important that you truncate them before\nusage only to blockchains which you use.
\n\n
// A lambda which intersects the chains available in the\n// token mapping with the ones available in the multichain client.\n// In general, you should not be using this in a production project.\n// Instead, you should create your own tokenmappings by the method shown\n// above.\nconst intersectTokenAndClients = (\n token: MultichainTokenMapping,\n mcClient: MultichainClient\n) => {\n return token.filter((deployment) =>\n mcClient.chainsRpcInfo\n .map((info) => info.chainId)\n .includes(deployment.chainId)\n );\n};\n\n// Store the intersection of the Klaster provided token and the chains your project is using.\nconst mUSDC = intersectTokenAndClients(mcUSDC, mcClient);
\n","isPage":false,"text":"\nAs well as working with the Multichain RPC provider, the Klaster SDK works best when provided with MultichainTokenMapping\nobjects. These objects represent mappings of tokens you consider equivalent across various blockchains. One example would\nbe USDC - which is widely deployed by Circle across multiple blockchains.\nYou can use the Circle Token Deployments to see which address the canonical\nversion of which token is deployed to.\nHowever, nothing limits you to using only offical token deployments. If you consider the axlUSDC to be equivalent to cannonical\nUSDC - you can simply map them together and the Klaster SDK will treat them as if they're the same token. You can provide one\ntoken per chain.\nOne hard requirement for all tokens in a single mapping is that they all must have the same number of decimals.\n// Build a token mapping by calling the buildTokenMapping function and passing instances of\n// deployment object into the array. These represent the chainId → address mappings.\nconst mcUSDC = buildTokenMapping([\n deployment(optimism.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(base.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n]);\nThe Klaster SDK exposes some multichain tokens by default. These are mcUSDC and mcUSDT. They are available to you\nas exported constants. They expose deployments on a lot of blockchains so it's important that you truncate them before\nusage only to blockchains which you use.\nThe default Klaster exported tokens might not fit your project. Please double check the documentation to learn which tokens the Klaster SDK considers to be cannonical and idential to eachother.\n// A lambda which intersects the chains available in the\n// token mapping with the ones available in the multichain client.\n// In general, you should not be using this in a production project.\n// Instead, you should create your own tokenmappings by the method shown\n// above.\nconst intersectTokenAndClients = (\n token: MultichainTokenMapping,\n mcClient: MultichainClient\n) => {\n return token.filter((deployment) =>\n mcClient.chainsRpcInfo\n .map((info) => info.chainId)\n .includes(deployment.chainId)\n );\n};\n \n// Store the intersection of the Klaster provided token and the chains your project is using.\nconst mUSDC = intersectTokenAndClients(mcUSDC, mcClient);\n","title":"Map token deployments across multiple blockchains","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"362":{"href":"/zero-to-hero-klaster-guide#create-a-bridging-plugin","html":"\n
Klaster introduces a concept of Bridging Plugigs. Yoa can think of them as templates, which the Klaster SDK\nuses to encode and execute a bridging action whenever it needs to. Since Klaster is an agnostic protocol and SDK,\nevery function that might require bridging can accept the function of type BridgePlugin as input.
\n
For this tutorial we have prepared a LiFi bridging plugin example.
\n
But in general, what is a Klaster Bridging Plugin?
\n
It's a simple function which provides a data object containing things needed to encode a brdiging transaction such as\nsourceChainId, destinationChainId, sourceToken, destinationToken, amount, etc... and expects an object in return\nwhich tells the Klaster SDK i) which transactions need to be executed ii) how much will be received on destination.
\n
For this tutorial, we can create a LiFi bridging plugin, which will leverage LiFi Aggregation to get us the fastest route\navailable for every transfer. Since Klaster is primarily a user experience oriented framework, the speed of execution is\nparamout!
It's as simple as that! Now - you Klaster SDK has LiFi support 🥳
\n","isPage":false,"text":"\nKlaster introduces a concept of Bridging Plugigs. Yoa can think of them as templates, which the Klaster SDK\nuses to encode and execute a bridging action whenever it needs to. Since Klaster is an agnostic protocol and SDK,\nevery function that might require bridging can accept the function of type BridgePlugin as input.\nFor this tutorial we have prepared a LiFi bridging plugin example.\nBut in general, what is a Klaster Bridging Plugin?\nIt's a simple function which provides a data object containing things needed to encode a brdiging transaction such as\nsourceChainId, destinationChainId, sourceToken, destinationToken, amount, etc... and expects an object in return\nwhich tells the Klaster SDK i) which transactions need to be executed ii) how much will be received on destination.\nFor this tutorial, we can create a LiFi bridging plugin, which will leverage LiFi Aggregation to get us the fastest route\navailable for every transfer. Since Klaster is primarily a user experience oriented framework, the speed of execution is\nparamout!\nFirst, install the LiFi SDK\nnpm i @lifi/sdk\nThen write the plugin:\nimport { getRoutes, RoutesRequest } from "@lifi/sdk";\nimport { Address, batchTx, BridgePlugin, rawTx } from "klaster-sdk";\nimport { Hex } from "viem";\n \nexport const liFiBrigePlugin: BridgePlugin = async (data) => {\n \n const routesRequest: RoutesRequest = {\n fromChainId: data.sourceChainId,\n toChainId: data.destinationChainId,\n fromTokenAddress: data.sourceToken,\n toTokenAddress: data.destinationToken,\n fromAmount: data.amount.toString(),\n options: {\n order: "FASTEST",\n },\n };\n \n const result = await getRoutes(routesRequest);\n const route = result.routes.at(0)\n \n if (!route) {\n throw Error('...');\n }\n \n const routeSteps = route.steps.map(step => {\n if(!step.transactionRequest) { throw Error('...') }\n const { to, gasLimit, data, value} = step.transactionRequest\n if(!to || !gasLimit || !data || !value) { throw Error('...') } \n return rawTx({\n to: to as Address,\n gasLimit: BigInt(gasLimit),\n data: data as Hex,\n value: BigInt(value)\n })\n })\n \n return {\n receivedOnDestination: BigInt(route.toAmountMin),\n txBatch: batchTx(data.sourceChainId, routeSteps)\n }\n};\nIt's as simple as that! Now - you Klaster SDK has LiFi support 🥳\n","title":"Create a Bridging Plugin","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"363":{"href":"/zero-to-hero-klaster-guide#fetching-a-unified-balance","html":"\n
In order to achieve true chain abstraction, the user should be presented with a unified ERC20 balance across\nall of the chains that the app is using.
\n
For example, in the Klaster AbstraktAAVE Demo app, you can see the unified balance:\n
\n
and then the breakdown per chain:
\n\n
In order to achieve this, you can use the Multichain token and Multichain RPC objects from earlier:
\n
const uBalance = await mcClient.getUnifiedErc20Balance({\n tokenMapping: mUSDC,\n account: klaster.account,\n});\n\n// Total balance across all used chains, expressed in base units\nuBalance.balance;\n\n// Breakdown of balances across each separate blockchain\nuBalance.breakdown;\n\n// The decimals of the token. In order for tokenMapping to be created,\n// all instances must have the same number of decimals.\nuBalance.decimals;
\n","isPage":false,"text":"\nIn order to achieve true chain abstraction, the user should be presented with a unified ERC20 balance across\nall of the chains that the app is using.\nFor example, in the Klaster AbstraktAAVE Demo app, you can see the unified balance:\n\nand then the breakdown per chain:\n\nIn order to achieve this, you can use the Multichain token and Multichain RPC objects from earlier:\nconst uBalance = await mcClient.getUnifiedErc20Balance({\n tokenMapping: mUSDC,\n account: klaster.account,\n});\n \n// Total balance across all used chains, expressed in base units\nuBalance.balance;\n \n// Breakdown of balances across each separate blockchain\nuBalance.breakdown;\n \n// The decimals of the token. In order for tokenMapping to be created,\n// all instances must have the same number of decimals.\nuBalance.decimals;\n","title":"Fetching a Unified Balance","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"364":{"href":"/zero-to-hero-klaster-guide#encoding-the-bridging--execution-actions","html":"\n
Okay! Finally our entire setup is complete. This is most definitely one of the more complex cases which Klaster\ncovers - a fully chain abstracted app, so the amount of setup is a bit higher. For simpler cases, such as a unified\ndeposit address of one-click checkout flows, a lot of these steps can be omitted.
\n
So, for this demo, we'll say that we want to send the amount we receive from bridging on the destination chain to some other address. This in an intentionally simplistic case, and it could have been solved by just using LiFi bridge function, but for the purposes of this tutorial it just demonstrates how Klaster works.
\n
","isPage":false,"text":"\nOkay! Finally our entire setup is complete. This is most definitely one of the more complex cases which Klaster\ncovers - a fully chain abstracted app, so the amount of setup is a bit higher. For simpler cases, such as a unified\ndeposit address of one-click checkout flows, a lot of these steps can be omitted.\nSo, for this demo, we'll say that we want to send the amount we receive from bridging on the destination chain to some other address. This in an intentionally simplistic case, and it could have been solved by just using LiFi bridge function, but for the purposes of this tutorial it just demonstrates how Klaster works.\n","title":"Encoding the bridging + execution actions","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"365":{"href":"/zero-to-hero-klaster-guide#encoding-the-bridging-operations","html":"
In your own project, you'll be able to encode arbitrarily complex actions across any number of blockchains. For example, in\nthe AAVE case, after a token lands on the destination chain, the supply function is called on the AAVE Smart Contract
Anyways let's continue. The SDK is intelligent enough to calculate on its own the required steps to get some amount of\ntokens on some desired destination chain.
Let's assume a following situation. You have:
\n
10 USDC on Polygon
\n
20 USDC on Optimism
\n
12 USDC on Scroll
\n
and you're trying to call some function on Base with 35 USDC while having zero USDC on Base. What the Klaster\nSDK will do is calculate a route for bridging your tokens:
e.g. take 20 USDC (total balance) from OP, 12 USDC (total balance) from Scroll and 3 USDC (+ additional for what was lost to\nbridge fees when bridging from chains where you took the total balance) from Polygon and bridge it all to Base. Once the funds\narrive to Base - call the desired function there!
For most cases, the SDK will be able to calculate te exact routes for bridging to get your desired outcome. If this is not\npossible, you can always encode them yourself.
The function that does the calculations is called encodeBridgingOps. Simply pass all of the required parameters and as\nan output you'll get a series of steps (EVM Transactions) to be executed on one or more blockchains to get your desired amount\nonto your desired destinationChain
","isPage":false,"text":"In your own project, you'll be able to encode arbitrarily complex actions across any number of blockchains. For example, in\nthe AAVE case, after a token lands on the destination chain, the supply function is called on the AAVE Smart ContractAnyways let's continue. The SDK is intelligent enough to calculate on its own the required steps to get some amount of\ntokens on some desired destination chain.Let's assume a following situation. You have:\n10 USDC on Polygon\n20 USDC on Optimism\n12 USDC on Scroll\nand you're trying to call some function on Base with 35 USDC while having zero USDC on Base. What the Klaster\nSDK will do is calculate a route for bridging your tokens:e.g. take 20 USDC (total balance) from OP, 12 USDC (total balance) from Scroll and 3 USDC (+ additional for what was lost to\nbridge fees when bridging from chains where you took the total balance) from Polygon and bridge it all to Base. Once the funds\narrive to Base - call the desired function there!For most cases, the SDK will be able to calculate te exact routes for bridging to get your desired outcome. If this is not\npossible, you can always encode them yourself.The function that does the calculations is called encodeBridgingOps. Simply pass all of the required parameters and as\nan output you'll get a series of steps (EVM Transactions) to be executed on one or more blockchains to get your desired amount\nonto your desired destinationChainconst bridgingOps = await encodeBridgingOps({\n tokenMapping: mUSDC,\n account: klaster.account,\n amount: uBalance.balance - parseUnits("1", uBalance.decimals), // Don't send entire balance\n bridgePlugin: liFiBrigePlugin,\n client: mcClient,\n destinationChainId: base.id,\n unifiedBalance: uBalance,\n});","title":"Encoding the bridging operations","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Encoding the bridging + execution actions"]},"366":{"href":"/zero-to-hero-klaster-guide#encoding-the-desired-action","html":"
Now we can encode the transfer call on the destination chain. This is done with the call to the Klaster SDK rawTx helper\nfunction:
Note one thing here, the usage of bridgingOps.totalReceivedOnDestination - this is a variable which has calculated\nhow much assets will be available on the destination chain after bridging has completed. If you had zero on the destination\nthen this will be the total amount available. If you had > 0 available then the total available will be
totalReceivedOnDestination + balanceOnDestination
","isPage":false,"text":"Now we can encode the transfer call on the destination chain. This is done with the call to the Klaster SDK rawTx helper\nfunction:const sendERC20Op = rawTx({\n gasLimit: 100000n,\n to: destChainTokenAddress,\n data: encodeFunctionData({\n abi: erc20Abi,\n functionName: "transfer",\n args: [recipient, bridgingOps.totalReceivedOnDestination],\n }),\n});Note one thing here, the usage of bridgingOps.totalReceivedOnDestination - this is a variable which has calculated\nhow much assets will be available on the destination chain after bridging has completed. If you had zero on the destination\nthen this will be the total amount available. If you had > 0 available then the total available will betotalReceivedOnDestination + balanceOnDestination","title":"Encoding the desired action","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Encoding the bridging + execution actions"]},"367":{"href":"/zero-to-hero-klaster-guide#creating-an-interchain-transaction","html":"
Now, we can use all of the transactions we have created to encode an interchain transaction or an iTx. An iTx is an\nobject containing one or more transactions across one or more blockchains. In our case, the iTx will contain
\n
All necessary approve + bridging transactions calculated by the encodeBridgingOps function - on the source chain(s)
\n
The send transaction on the destination chain
\n
To create an iTx, we use the helper function buildItx.
const iTx = buildItx({\n // BridgingOPs + Execution on the destination chain\n // added as steps to the iTx\n steps: bridgingOps.steps.concat(singleTx(destinationChainId, sendERC20Op)),\n // Klaster works with cross-chain gas abstraction. This instructs the Klaster\n // nodes to take USDC on Optimism as tx fee payment.\n feeTx: klaster.encodePaymentFee(optimism.id, "USDC"),\n});
\n","isPage":false,"text":"Now, we can use all of the transactions we have created to encode an interchain transaction or an iTx. An iTx is an\nobject containing one or more transactions across one or more blockchains. In our case, the iTx will contain\nAll necessary approve + bridging transactions calculated by the encodeBridgingOps function - on the source chain(s)\nThe send transaction on the destination chain\nTo create an iTx, we use the helper function buildItx.const iTx = buildItx({\n // BridgingOPs + Execution on the destination chain\n // added as steps to the iTx\n steps: bridgingOps.steps.concat(singleTx(destinationChainId, sendERC20Op)),\n // Klaster works with cross-chain gas abstraction. This instructs the Klaster\n // nodes to take USDC on Optimism as tx fee payment.\n feeTx: klaster.encodePaymentFee(optimism.id, "USDC"),\n});\n","title":"Creating an Interchain Transaction","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Encoding the bridging + execution actions"]},"368":{"href":"/zero-to-hero-klaster-guide#executing-the-interchain-transaction","html":"\n
Now that we have everything we need encoded in the iTx object, we can send it to the Klaster network for execution.
\n
","isPage":false,"text":"\nNow that we have everything we need encoded in the iTx object, we can send it to the Klaster network for execution.\n","title":"Executing the Interchain Transaction","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"369":{"href":"/zero-to-hero-klaster-guide#getting-a-quote","html":"
Executing an Interchain transaction is a two-step process. The first part of the process is getting a quote from the\nKlaster Network. The quote will tell you how much the node wants to charge for the execution of the transaction in the\ntoken which you set in the feeTx field when building an iTx.
To get the quote, call:
const quote = await klaster.getQuote(iTx);\n\n// The amount of USD that the node is willing to execute the iTx for\nquote.tokenValue;
","isPage":false,"text":"Executing an Interchain transaction is a two-step process. The first part of the process is getting a quote from the\nKlaster Network. The quote will tell you how much the node wants to charge for the execution of the transaction in the\ntoken which you set in the feeTx field when building an iTx.To get the quote, call:const quote = await klaster.getQuote(iTx);\n \n// The amount of USD that the node is willing to execute the iTx for\nquote.tokenValue;","title":"Getting a quote","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Executing the Interchain Transaction"]},"370":{"href":"/zero-to-hero-klaster-guide#signing-the-quote","html":"
If you're satisfied with the quoted execution price, prompt the user to sign the iTx hash. You can get the hash from the\nquote object. By signing the iTx hash you're giving the Klaster Nodes approval to execute the transactions within the\niTx. This is cryptographically verified by smart contracts on every chain where the data is being executed - so the nodes\nare unable to execute anything without the explicit approval from the user.
","isPage":false,"text":"If you're satisfied with the quoted execution price, prompt the user to sign the iTx hash. You can get the hash from the\nquote object. By signing the iTx hash you're giving the Klaster Nodes approval to execute the transactions within the\niTx. This is cryptographically verified by smart contracts on every chain where the data is being executed - so the nodes\nare unable to execute anything without the explicit approval from the user.If you're using viem - make sure to use the message → raw to sign. If you pass the message directly into the message object,\nyou will get an error that you're using the wrong signature.const signed = await signer.signMessage({\n message: {\n raw: quote.itxHash,\n },\n account: signerAccount,\n});","title":"Signing the quote","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Executing the Interchain Transaction"]},"371":{"href":"/zero-to-hero-klaster-guide#sending-the-itx-for-execution","html":"
After the user has signed the iTx hash, pass the QuoteResponse together with the signed hash to the execute function.
const result = await klaster.execute(quote, signed)
","isPage":false,"text":"After the user has signed the iTx hash, pass the QuoteResponse together with the signed hash to the execute function.const result = await klaster.execute(quote, signed)","title":"Sending the iTx for execution","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Executing the Interchain Transaction"]},"372":{"href":"/zero-to-hero-klaster-guide#tracking-the-execution","html":"
After the iTx has been received by the Klaster Network, you will receive a result from the execute function. In that result,\nyou will have the iTx hash. You can go to the Klaster Explorer to check the status of the hash:
https://explorer.klaster.io/details/{iTxHash}
\n","isPage":false,"text":"After the iTx has been received by the Klaster Network, you will receive a result from the execute function. In that result,\nyou will have the iTx hash. You can go to the Klaster Explorer to check the status of the hash:https://explorer.klaster.io/details/{iTxHash}\n","title":"Tracking the execution","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Executing the Interchain Transaction"]},"373":{"href":"/zero-to-hero-klaster-guide#conclusion","html":"\n
Congrats - you have sucessfully executed your first Interchain Transaction and prepared your project for chain abstraction.
","isPage":false,"text":"\nCongrats - you have sucessfully executed your first Interchain Transaction and prepared your project for chain abstraction.","title":"Conclusion","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"374":{"href":"/accounts/biconomy#initializing-a-biconomy-account","html":"\n
To initialize a Biconomy account, you use the following function
","isPage":true,"text":"\nTo initialize a Biconomy account, you use the following function\nconst klaster = await initKlaster({\n accountInitData: loadBicoV2Account({\n owner: '0xEOA_OWNER',\n }),\n nodeUrl: 'https://node-url',\n});","title":"Initializing a Biconomy account","titles":[null]},"375":{"href":"/accounts/safe#initializing-a-safe-account","html":"\n
To initialize the Klaster SDK with a Safe account you can use the following function:
\n","isPage":true,"text":"\nTo initialize the Klaster SDK with a Safe account you can use the following function:\nconst klaster = await initKlaster({\n accountInitData: loadSafeV141Account({\n signers: ["0xSIGNER"],\n threshold: 1n,\n }),\n nodeUrl: "https://<node-url>",\n});\nThe signers information is used to derive the account address. If the signers change, you should keep using the initial\nsigners information which was used to create the Safe account.","title":"Initializing a Safe Account","titles":[null]},"376":{"href":"/concepts/bridge-plugins#bridging-plugins","html":"\n
The Klaster SDK enables chain abstracted user experiences by performing the bridging of assets in the background. In order to be\nable to perform bridging actions, the Klaster SDK needs to know how to encode them.
\n
The Klaster Bridging Plugins rely on the fact that most bridges are triggered by a simple call to a smart contract on some\nchain - and as such, can be ecnoded as a series of transactions (e.g. Bridge + Approve). The bridging plugin then\nreturns a series of calls to the blockchain (to be encoded into an InterchainTransaction) and how much the user will\nend up with at the destination chain (after all the bridging and gas fees are paid - this is usually availble information\nbefore bridging.)
\n
In order to do so, you pass it an instance of a BridgePlugin. A BridgePlugin is a simple function of type:
\n
type BridgePlugin = (BridgePluginParams) => BridgePluginResult\n\n// The BridgePluginParams expose all of the information\n// required to encode a bridging action using some existing\n// bridging provider\ntype BridgePluginParams = {\n sourceChainId: number,\n destinationChainId: number,\n account: MutlichainAccount,\n sourceToken: Address,\n destinationToken: Address,\n amount: bigint\n}\n\n// BridgePluginResult tells the Klaster SDK \n// - how much will be received on the destination chain post bridign\n// - which transactions need to be executed to trigger the bridge\ntype BridgePluginResult = {\n receivedOnDesitnation: bigint,\n steps: TxBatch[]\n}
export const acrossBridgePlugin: BridgePlugin = async (data) => {\n // Call Across API to get the bridging fee data, as well as all the other required\n // inforation about the bridging procedure\n const feesResponse = await getAcrossSuggestedFees(data);\n\n // Calculate the amount which you will receive on the destination chain from the\n // response given by the Across API\n const outputAmount = data.amount - BigInt(feesResponse.totalRelayFee.total);\n\n // Encode a transcation approving the Across pool contract to get the\n // required amount of ERC20 tokens from your accoount.\n const acrossApproveTx = encodeApproveTx({\n tokenAddress: data.sourceToken,\n amount: outputAmount,\n recipient: feesResponse.spokePoolAddress,\n });\n\n // Encode a transaction to call the Across Pool\n const acrossCallTx = rawTx({\n to: feesResponse.spokePoolAddress,\n data: encodeAcrossCallData(data, feesResponse),\n gasLimit: BigInt(250000),\n });\n\n return {\n // The total amount which the user will receive on the destination chain. This is\n // used by the SDK to calculate how much funds it can count on after bridging.\n receivedOnDestination: outputAmount,\n // The sequence of transactions which need to be executed in order to start the brdging\n // procedure.\n txBatch: batchTx(data.sourceChainId, [acrossApproveTx, acrossCallTx]),\n };\n};\n
","isPage":true,"text":"\nThe Klaster SDK enables chain abstracted user experiences by performing the bridging of assets in the background. In order to be\nable to perform bridging actions, the Klaster SDK needs to know how to encode them.\nThe Klaster Bridging Plugins rely on the fact that most bridges are triggered by a simple call to a smart contract on some\nchain - and as such, can be ecnoded as a series of transactions (e.g. Bridge + Approve). The bridging plugin then\nreturns a series of calls to the blockchain (to be encoded into an InterchainTransaction) and how much the user will\nend up with at the destination chain (after all the bridging and gas fees are paid - this is usually availble information\nbefore bridging.)\nIn order to do so, you pass it an instance of a BridgePlugin. A BridgePlugin is a simple function of type:\ntype BridgePlugin = (BridgePluginParams) => BridgePluginResult\n \n// The BridgePluginParams expose all of the information\n// required to encode a bridging action using some existing\n// bridging provider\ntype BridgePluginParams = {\n sourceChainId: number,\n destinationChainId: number,\n account: MutlichainAccount,\n sourceToken: Address,\n destinationToken: Address,\n amount: bigint\n}\n \n// BridgePluginResult tells the Klaster SDK \n// - how much will be received on the destination chain post bridign\n// - which transactions need to be executed to trigger the bridge\ntype BridgePluginResult = {\n receivedOnDesitnation: bigint,\n steps: TxBatch[]\n}\nAn example of a BridgePlugin for Across\nexport const acrossBridgePlugin: BridgePlugin = async (data) => {\n // Call Across API to get the bridging fee data, as well as all the other required\n // inforation about the bridging procedure\n const feesResponse = await getAcrossSuggestedFees(data);\n \n // Calculate the amount which you will receive on the destination chain from the\n // response given by the Across API\n const outputAmount = data.amount - BigInt(feesResponse.totalRelayFee.total);\n \n // Encode a transcation approving the Across pool contract to get the\n // required amount of ERC20 tokens from your accoount.\n const acrossApproveTx = encodeApproveTx({\n tokenAddress: data.sourceToken,\n amount: outputAmount,\n recipient: feesResponse.spokePoolAddress,\n });\n \n // Encode a transaction to call the Across Pool\n const acrossCallTx = rawTx({\n to: feesResponse.spokePoolAddress,\n data: encodeAcrossCallData(data, feesResponse),\n gasLimit: BigInt(250000),\n });\n \n return {\n // The total amount which the user will receive on the destination chain. This is\n // used by the SDK to calculate how much funds it can count on after bridging.\n receivedOnDestination: outputAmount,\n // The sequence of transactions which need to be executed in order to start the brdging\n // procedure.\n txBatch: batchTx(data.sourceChainId, [acrossApproveTx, acrossCallTx]),\n };\n};\n ","title":"Bridging Plugins","titles":[null]},"377":{"href":"/concepts/interchain-transaction#interchain-transaction","html":"\n
The InterchainTransaction or iTx is the beating heart of the Klaster protocol. It's an object containing two or more\ntransactions to be executed on one or more blockchain networks - encoded in a merkle tree.
\n","isPage":true,"text":"\nThe InterchainTransaction or iTx is the beating heart of the Klaster protocol. It's an object containing two or more\ntransactions to be executed on one or more blockchain networks - encoded in a merkle tree.\n","title":"Interchain Transaction","titles":[null]},"378":{"href":"/concepts/interchain-transaction#details","html":"\n
\n
\n
The leafs of the tree are the transactions contained in the interchain transaction. They define all of the actions which can be\nexecuted by the iTx.
\n
\n
\n
The root hash of the merkle tree is called the Interchain Transcation Hash
\n
\n
\n
Every iTx is uniquely defined by it's iTx hash
\n
\n
\n
In order to execute the iTx, the user signs the iTx hash with their private key and sends the signed hash, togehter with\nthe list of the leaf transactions - to a Klaster Node.
\n
\n
\n
The first transaction in the iTx is always the transaction fee payment transaction.
\n
\n
\n
","isPage":false,"text":"\n\n\nThe leafs of the tree are the transactions contained in the interchain transaction. They define all of the actions which can be\nexecuted by the iTx.\n\n\nThe root hash of the merkle tree is called the Interchain Transcation Hash\n\n\nEvery iTx is uniquely defined by it's iTx hash\n\n\nIn order to execute the iTx, the user signs the iTx hash with their private key and sends the signed hash, togehter with\nthe list of the leaf transactions - to a Klaster Node.\n\n\nThe first transaction in the iTx is always the transaction fee payment transaction.\n\n\n","title":"Details","titles":[null,"Interchain Transaction",null]},"379":{"href":"/concepts/multichain-account#multichain-smart-contract-account","html":"\n
The Klaster account system is built on top of ERC4337 Account Abstraction. Account wise, the main difference between\nKlaster and other solutions is that Klaster tightly couples deployed Smart Contract Account instances across multiple\nblockchains.
\n
Simply put, this means that these accounts, deployed on multiple blockchain networks - have the ability to act as a single\naccount.
\n
Klaster uses the CREATE2 opcode when deploying accounts. However, some blockchains - notably the zkSync ecosystem - don't\nderive the accounts the same way that Ethereum does.
\n
That's why the Klaster SDK uses an internal object called the MutltichainAccount, which holds all of the address deployments\nfor all of the blockchains.
\n
Beyond holding the address deployments, the MultichainAccount object holds the initData - which was the data used to derive\nthe account.
\n","isPage":true,"text":"\nThe Klaster account system is built on top of ERC4337 Account Abstraction. Account wise, the main difference between\nKlaster and other solutions is that Klaster tightly couples deployed Smart Contract Account instances across multiple\nblockchains.\nSimply put, this means that these accounts, deployed on multiple blockchain networks - have the ability to act as a single\naccount.\nKlaster uses the CREATE2 opcode when deploying accounts. However, some blockchains - notably the zkSync ecosystem - don't\nderive the accounts the same way that Ethereum does.\nThat's why the Klaster SDK uses an internal object called the MutltichainAccount, which holds all of the address deployments\nfor all of the blockchains.\nBeyond holding the address deployments, the MultichainAccount object holds the initData - which was the data used to derive\nthe account.\n","title":"Multichain Smart Contract Account","titles":[null]},"380":{"href":"/concepts/multichain-account#deriving-accounts","html":"\n
Several key pieces of information determine which account address will be derived when loading a smart contract account:
Factory data (derived from account init parameters, specific for each vendor)
\n
Account blockchain (e.g. ETH, Base, OP, Polygon, AVAX all derive the same, while e.g. zkSync and Abstract derive differently)
\n\n
The Klaster Node exposes this as a utility endpoint https://<node-url>/v2/address/{VENDOR_ID}/0xFACTORY_DATA
\n
The vendor id is a Klaster defined string, definining every supported account vendor (e.g. SAFE_V141 or BICO_V2), while\nfactory data is encoded for every vendor, according to their standard.
\n
e.g. for Safe, the FactoryData is derived from address[] signers, uint256 threshold, bytes32 salt, while for Biconomy -\nit's derived from address owner, bytes32 salt
","isPage":false,"text":"\nSeveral key pieces of information determine which account address will be derived when loading a smart contract account:\n\nAccount vendor (e.g. Biconomy, Safe, ZeroDev, ...)\nFactory data (derived from account init parameters, specific for each vendor)\nAccount blockchain (e.g. ETH, Base, OP, Polygon, AVAX all derive the same, while e.g. zkSync and Abstract derive differently)\n\nThe Klaster Node exposes this as a utility endpoint https://<node-url>/v2/address/{VENDOR_ID}/0xFACTORY_DATA\nThe vendor id is a Klaster defined string, definining every supported account vendor (e.g. SAFE_V141 or BICO_V2), while\nfactory data is encoded for every vendor, according to their standard.\ne.g. for Safe, the FactoryData is derived from address[] signers, uint256 threshold, bytes32 salt, while for Biconomy -\nit's derived from address owner, bytes32 salt","title":"Deriving accounts","titles":[null,"Multichain Smart Contract Account"]},"381":{"href":"/concepts/multichain-public-client#multichain-public-client","html":"\n
In order to achieve certain functionalities, such as fetching a unified multichain balance or encoding bridging strategies - the\nKlaster SDK must have the ability to read from the blockchains with which your application is interacting with.
\n
To achieve this, the Klaster SDK counts on the MultichainClient object. This object is a simple mapping of rpcUrl to\nchainId. As of version 0.5.2 - the MultichainClient exposes a utility function to read the unified balance of an\nERC20 token (provided by a TokenMapping object).
\n
A multichain public client can be easily built by leveraging the buildMultichainReadonlyClient function.
\n
const mcClient = buildMultichainReadonlyClient([\n buildRpcInfo(optimism.id, 'https://optimism-rpc'),\n buildRpcInfo(base.id, 'https://base-rpc'),\n //... add the rest of the chains\n])
","isPage":true,"text":"\nIn order to achieve certain functionalities, such as fetching a unified multichain balance or encoding bridging strategies - the\nKlaster SDK must have the ability to read from the blockchains with which your application is interacting with.\nTo achieve this, the Klaster SDK counts on the MultichainClient object. This object is a simple mapping of rpcUrl to\nchainId. As of version 0.5.2 - the MultichainClient exposes a utility function to read the unified balance of an\nERC20 token (provided by a TokenMapping object).\nA multichain public client can be easily built by leveraging the buildMultichainReadonlyClient function.\nconst mcClient = buildMultichainReadonlyClient([\n buildRpcInfo(optimism.id, 'https://optimism-rpc'),\n buildRpcInfo(base.id, 'https://base-rpc'),\n //... add the rest of the chains\n])","title":"Multichain Public Client","titles":[null]},"382":{"href":"/concepts/multichain-token-mapping#multichain-token-mapping","html":"\n
Klaster is a multichain first framework, and as such - all objects within it are made to work in a multichain environment. One\nof the core aspects of working with blockchain system is interacting with tokens. In the EVM ecosystem, these are primarily\nERC20 or ERC721 tokens (with certain subtypes which also comply to these two interfaces).
\n
Since the Klaster SDK wishes to achieve things like unified balances, which can be spent from any chain to any chain - we must\nprovide it with a way to map like tokens to eachother.
\n
This is achieved through the use of a simple MultichainTokenMapping object, which simply maps the addresses of a desired token\nacross multiple chains. The way you build a multichain token mapping is the following:
\n
const mcUSDC = buildTokenMapping([\n deployment(optimism.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(base.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(arbitrum.id, "0x<USDC-ON-ARBITRUM-ADDRESS>"),\n //... add rest of the chains\n]);
\n
Then, in a function such as getUnifiedBalance or encodeBridgingData - you simply pass the mcUSDC object and the SDK knows\nhow to handle the token on mutliple blockchains.
\n","isPage":true,"text":"\nKlaster is a multichain first framework, and as such - all objects within it are made to work in a multichain environment. One\nof the core aspects of working with blockchain system is interacting with tokens. In the EVM ecosystem, these are primarily\nERC20 or ERC721 tokens (with certain subtypes which also comply to these two interfaces).\nSince the Klaster SDK wishes to achieve things like unified balances, which can be spent from any chain to any chain - we must\nprovide it with a way to map like tokens to eachother.\nThis is achieved through the use of a simple MultichainTokenMapping object, which simply maps the addresses of a desired token\nacross multiple chains. The way you build a multichain token mapping is the following:\nconst mcUSDC = buildTokenMapping([\n deployment(optimism.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(base.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(arbitrum.id, "0x<USDC-ON-ARBITRUM-ADDRESS>"),\n //... add rest of the chains\n]);\nThen, in a function such as getUnifiedBalance or encodeBridgingData - you simply pass the mcUSDC object and the SDK knows\nhow to handle the token on mutliple blockchains.\n","title":"Multichain Token Mapping","titles":[null]},"383":{"href":"/concepts/multichain-token-mapping#notes","html":"\n
Some of the things to note with the MultichainTokenMapping object:
\n
\n
Only one token deployment is supported per chain
\n
All deployments must have the same number of decimals
\n
","isPage":false,"text":"\nSome of the things to note with the MultichainTokenMapping object:\n\nOnly one token deployment is supported per chain\nAll deployments must have the same number of decimals\n","title":"Notes","titles":[null,"Multichain Token Mapping"]},"384":{"href":"/concepts/unified-balance#unified-balance","html":"\n
A UnifiedBalance object contains the balance of some ERC20 token across multiple blockchains. It can be fetched by calling\nthe getUnifiedErc20Balance function on the MultichainClient object.
\n
type UnifiedBalance = {\n balance: bigint // total balance across all blockchains\n decimals: number // the number of decimals of the token for which the unified balance is fetched\n breakdown: { // breakdown of balances across all queried blockchains\n balance: bigint,\n chainId: number\n }[]\n}
","isPage":true,"text":"\nA UnifiedBalance object contains the balance of some ERC20 token across multiple blockchains. It can be fetched by calling\nthe getUnifiedErc20Balance function on the MultichainClient object.\ntype UnifiedBalance = {\n balance: bigint // total balance across all blockchains\n decimals: number // the number of decimals of the token for which the unified balance is fetched\n breakdown: { // breakdown of balances across all queried blockchains\n balance: bigint,\n chainId: number\n }[]\n}","title":"Unified Balance","titles":[null]},"385":{"href":"/quickstart/gas-abstraction#gas-abstraction-quickstart","html":"\n
Klaster Protocol is a chain abstraction framework that enables the execution of complex cross-chain transaction bundles with a single user signature. It introduces a Transaction Commitment Layer between users/dApps and multiple blockchain networks, facilitating seamless interaction across different chains.
\n","isPage":false,"text":"\nKlaster Protocol is a chain abstraction framework that enables the execution of complex cross-chain transaction bundles with a single user signature. It introduces a Transaction Commitment Layer between users/dApps and multiple blockchain networks, facilitating seamless interaction across different chains.\n","title":"Overview","titles":["Klaster Protocol Technical Summary"]},"2":{"href":"/protocol#key-concepts","html":"\n","isPage":false,"text":"\n","title":"Key Concepts","titles":["Klaster Protocol Technical Summary"]},"3":{"href":"/protocol#1-itx-interchain-transaction-bundles","html":"\n
\n
Series of (possibly dependent) transactions spanning across multiple chains
\n
Represented as a Merkle Tree of UserOps
\n
Defined by a unique Merkle Root hash (iTx hash)
\n
\n","isPage":false,"text":"\n\nSeries of (possibly dependent) transactions spanning across multiple chains\nRepresented as a Merkle Tree of UserOps\nDefined by a unique Merkle Root hash (iTx hash)\n\n","title":"1. iTx (Interchain Transaction) bundles","titles":["Klaster Protocol Technical Summary","Key Concepts"]},"4":{"href":"/protocol#2-transaction-commitment-layer","html":"\n
\n
Network of Klaster Nodes
\n
Provides execution guarantees
\n
Orchestrates iTx execution across multiple blockchain networks
Standardized ERC-7579 module for smart contract accounts
\n
Enables single signature approval for entire iTx bundles
\n
Compatible with existing smart account wallets
\n
\n","isPage":false,"text":"\n\nStandardized ERC-7579 module for smart contract accounts\nEnables single signature approval for entire iTx bundles\nCompatible with existing smart account wallets\n\n","title":"Smart Accounts - iTx Module","titles":["Klaster Protocol Technical Summary","Core Components"]},"7":{"href":"/protocol#klaster-nodes","html":"\n
Responsibilities:
\n
\n
Estimating iTx fees & responding to quote requests
\n
Committing to iTx execution
\n
Executing fully signed iTx bundles
\n
\n
Node Selection Process:
\n\n
Nodes provide quotes for iTx execution
\n
User/dApp selects best quote based on cost and node reputation
\n
Selected node commits to iTx execution
\n
User signs the iTx bundle
\n
Node executes the iTx bundle
\n\n","isPage":false,"text":"\nResponsibilities:\n\nEstimating iTx fees & responding to quote requests\nCommitting to iTx execution\nExecuting fully signed iTx bundles\n\nNode Selection Process:\n\nNodes provide quotes for iTx execution\nUser/dApp selects best quote based on cost and node reputation\nSelected node commits to iTx execution\nUser signs the iTx bundle\nNode executes the iTx bundle\n\n","title":"Klaster Nodes","titles":["Klaster Protocol Technical Summary","Core Components"]},"8":{"href":"/protocol#meta-paymaster-and-multichain-gas-refunds","html":"\n
\n
Nodes act as Meta Paymasters, accepting payment in one token/chain and executing transactions across multiple chains
\n
Utilizes ERC-4337 EntryPoint for UserOp routing
\n
Implements gas refunds for overpaid transactions
\n
\n","isPage":false,"text":"\n\nNodes act as Meta Paymasters, accepting payment in one token/chain and executing transactions across multiple chains\nUtilizes ERC-4337 EntryPoint for UserOp routing\nImplements gas refunds for overpaid transactions\n\n","title":"Meta Paymaster and Multichain Gas Refunds","titles":["Klaster Protocol Technical Summary","Core Components"]},"9":{"href":"/protocol#optimistic-itx-execution","html":"\n
\n
Nodes determine optimal execution order through simulation
\n
Executes UserOps when simulations yield 0 REVERT opcodes
\n
Incentivized by diminishing success tips
\n
\n","isPage":false,"text":"\n\nNodes determine optimal execution order through simulation\nExecutes UserOps when simulations yield 0 REVERT opcodes\nIncentivized by diminishing success tips\n\n","title":"Optimistic iTx Execution","titles":["Klaster Protocol Technical Summary","Core Components"]},"10":{"href":"/protocol#integration","html":"\n
\n
SDK available for dApp/Wallet developers
\n
Enables efficient building of chain-abstracted applications
\n
Neutral approach, compatible with various bridges and AA wallet providers
\n
\n","isPage":false,"text":"\n\nSDK available for dApp/Wallet developers\nEnables efficient building of chain-abstracted applications\nNeutral approach, compatible with various bridges and AA wallet providers\n\n","title":"Integration","titles":["Klaster Protocol Technical Summary"]},"11":{"href":"/protocol#use-cases","html":"\n
\n
Chain-abstracted versions of existing dApps (e.g., AAVE)
\n
Streamlined checkout flows
\n
Easier onboarding to SocialFi L2/L3 apps
\n
Single-chain dApps attracting users from various chains
\n
\n","isPage":false,"text":"\n\nChain-abstracted versions of existing dApps (e.g., AAVE)\nStreamlined checkout flows\nEasier onboarding to SocialFi L2/L3 apps\nSingle-chain dApps attracting users from various chains\n\n","title":"Use Cases","titles":["Klaster Protocol Technical Summary"]},"12":{"href":"/protocol#security-considerations","html":"\n
\n
Users maintain full control of funds through AA wallets
\n
Nodes can be slashed for failing to execute committed iTx bundles
\n
Security reduced to the security of bridges used for asset transfers between chains
\n
\n","isPage":false,"text":"\n\nUsers maintain full control of funds through AA wallets\nNodes can be slashed for failing to execute committed iTx bundles\nSecurity reduced to the security of bridges used for asset transfers between chains\n\n","title":"Security Considerations","titles":["Klaster Protocol Technical Summary"]},"13":{"href":"/protocol#future-developments","html":"\n
\n
Decentralization phase including slashing and multichain staking
\n
Public node implementation for verification and customization
\n
Potential integration with intent solver networks
\n
","isPage":false,"text":"\n\nDecentralization phase including slashing and multichain staking\nPublic node implementation for verification and customization\nPotential integration with intent solver networks\n","title":"Future Developments","titles":["Klaster Protocol Technical Summary"]},"14":{"href":"/reference#klaster-sdk","html":"\n","isPage":true,"text":"\n","title":"klaster-sdk","titles":[]},"15":{"href":"/reference#classes","html":"\n","isPage":false,"text":"\n","title":"Classes","titles":["klaster-sdk"]},"16":{"href":"/reference#encodingservice","html":"\n
A service for encoding user operations (UserOps) for Smart Contract Accounts in the Klaster ecosystem.
\n
This service provides methods to encode single and batch transactions into UserOps\nthat can be processed by the Klaster Node. It intelligently chooses between single\nand batch encoding to optimize for gas efficiency and ensure atomic execution of\nmultiple transactions when needed.
\n","isPage":false,"text":"\nA service for encoding user operations (UserOps) for Smart Contract Accounts in the Klaster ecosystem.\nThis service provides methods to encode single and batch transactions into UserOps\nthat can be processed by the Klaster Node. It intelligently chooses between single\nand batch encoding to optimize for gas efficiency and ensure atomic execution of\nmultiple transactions when needed.\n","title":"EncodingService","titles":["klaster-sdk","Classes"]},"17":{"href":"/reference#constructors","html":"\n","isPage":false,"text":"\n","title":"Constructors","titles":["klaster-sdk","Classes","EncodingService"]},"18":{"href":"/reference#new-encodingservice","html":"\n
Encodes multiple transactions into a single UserOp for batch execution on a Smart Contract Account.
\n
This method prepares a UserOp that, when executed, will call the 'executeBatch' function\non the Smart Contract Account, allowing multiple transactions to be executed atomically.\nThis can lead to significant gas savings compared to executing transactions individually.
\n","isPage":false,"text":"\n\nstatic encodeBatchCall(txs, chainId, masterWallet, salt): ApiUserOp\n\nEncodes multiple transactions into a single UserOp for batch execution on a Smart Contract Account.\nThis method prepares a UserOp that, when executed, will call the 'executeBatch' function\non the Smart Contract Account, allowing multiple transactions to be executed atomically.\nThis can lead to significant gas savings compared to executing transactions individually.\n","title":"encodeBatchCall()","titles":["klaster-sdk","Classes","EncodingService","Methods"]},"22":{"href":"/reference#parameters","html":"\n
An array of transactions to be encoded for batch execution.
\n
• chainId: number
\n
The ID of the blockchain where the transactions will be executed.
\n
• masterWallet: `0x${string}`
\n
The address of the master wallet from which the Smart Contract Account is derived.
\n
• salt: string
\n
A unique value used in conjunction with the masterWallet to derive the Smart Contract Account address.
\n","isPage":false,"text":"\n• txs: RawTransaction[]\nAn array of transactions to be encoded for batch execution.\n• chainId: number\nThe ID of the blockchain where the transactions will be executed.\n• masterWallet: `0x${string}`\nThe address of the master wallet from which the Smart Contract Account is derived.\n• salt: string\nA unique value used in conjunction with the masterWallet to derive the Smart Contract Account address.\n","title":"Parameters","titles":["klaster-sdk","Classes","EncodingService","Methods","encodeBatchCall()"]},"23":{"href":"/reference#returns-1","html":"\n
A UserOp object representing the batch execution, which can be sent to the Klaster Node for quoting and execution.
\n","isPage":false,"text":"\nApiUserOp\nA UserOp object representing the batch execution, which can be sent to the Klaster Node for quoting and execution.\n","title":"Returns","titles":["klaster-sdk","Classes","EncodingService","Methods","encodeBatchCall()"]},"24":{"href":"/reference#example","html":"\n
Encodes a single transaction into a UserOp for execution on a Smart Contract Account.
\n
This method prepares a UserOp that, when executed, will call the 'execute' function\non the Smart Contract Account derived from the provided masterWallet and salt.
\n","isPage":false,"text":"\n\nstatic encodeUserOpCall(tx, chainId, masterWallet, salt): ApiUserOp\n\nEncodes a single transaction into a UserOp for execution on a Smart Contract Account.\nThis method prepares a UserOp that, when executed, will call the 'execute' function\non the Smart Contract Account derived from the provided masterWallet and salt.\n","title":"encodeUserOpCall()","titles":["klaster-sdk","Classes","EncodingService","Methods"]},"27":{"href":"/reference#parameters-1","html":"\n
The ID of the blockchain where the transaction will be executed.
\n
• masterWallet: `0x${string}`
\n
The address of the master wallet from which the Smart Contract Account is derived.
\n
• salt: string
\n
A unique value used in conjunction with the masterWallet to derive the Smart Contract Account address.
\n","isPage":false,"text":"\n• tx: RawTransaction\nThe transaction to be encoded.\n• chainId: number\nThe ID of the blockchain where the transaction will be executed.\n• masterWallet: `0x${string}`\nThe address of the master wallet from which the Smart Contract Account is derived.\n• salt: string\nA unique value used in conjunction with the masterWallet to derive the Smart Contract Account address.\n","title":"Parameters","titles":["klaster-sdk","Classes","EncodingService","Methods","encodeUserOpCall()"]},"28":{"href":"/reference#returns-2","html":"\n
A UserOp object that can be sent to the Klaster Node for quoting and execution.
\n","isPage":false,"text":"\nApiUserOp\nA UserOp object that can be sent to the Klaster Node for quoting and execution.\n","title":"Returns","titles":["klaster-sdk","Classes","EncodingService","Methods","encodeUserOpCall()"]},"29":{"href":"/reference#example-1","html":"\n
KlasterSDK creates an instance of the SDK used to communicate with\nthe Klaster protocol. It offers typed information for all the types\nused to communicate with the protocol, as well as utility functions\nfor encoding tokens, transactions and accounts.
\n","isPage":false,"text":"\nKlasterSDK creates an instance of the SDK used to communicate with\nthe Klaster protocol. It offers typed information for all the types\nused to communicate with the protocol, as well as utility functions\nfor encoding tokens, transactions and accounts.\n","title":"KlasterSDK","titles":["klaster-sdk","Classes"]},"32":{"href":"/reference#constructors-1","html":"\n","isPage":false,"text":"\n","title":"Constructors","titles":["klaster-sdk","Classes","KlasterSDK"]},"33":{"href":"/reference#new-klastersdk","html":"\n
Automatically fetches a quote and executes the Interchain Transaction (iTx).
\n
This function streamlines the process of executing an iTx by combining the quote\nfetching and execution steps. It automatically handles the flow of getting a quote,\nsigning the iTx hash, and executing the transaction.
\n","isPage":false,"text":"\n\nautoExecute(itx, signHash): Promise<ExecuteResponse>\n\nAutomatically fetches a quote and executes the Interchain Transaction (iTx).\nThis function streamlines the process of executing an iTx by combining the quote\nfetching and execution steps. It automatically handles the flow of getting a quote,\nsigning the iTx hash, and executing the transaction.\n","title":"autoExecute()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"44":{"href":"/reference#parameters-3","html":"\n
The interchain transaction object containing\nthe transactions you wish to execute. This should include all necessary\ninformation for the iTx, such as actions and payment details.
\n
• signHash
\n
A function to sign the iTx hash with a private key.\nThis function should take a hash string (prefixed with '0x') and return\na Promise resolving to the signed hash string.
\n","isPage":false,"text":"\n• itx: InterchainTransaction\nThe interchain transaction object containing\nthe transactions you wish to execute. This should include all necessary\ninformation for the iTx, such as actions and payment details.\n• signHash\nA function to sign the iTx hash with a private key.\nThis function should take a hash string (prefixed with '0x') and return\na Promise resolving to the signed hash string.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"45":{"href":"/reference#returns-4","html":"\n
A promise that resolves to an ExecuteResponse object,\ncontaining the iTx hash of the executed transaction.
\n","isPage":false,"text":"\nPromise<ExecuteResponse>\nA promise that resolves to an ExecuteResponse object,\ncontaining the iTx hash of the executed transaction.\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"46":{"href":"/reference#async","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"47":{"href":"/reference#throws","html":"\n
May throw errors during the quote fetching, signing, or execution phases.\nThese could include network errors, signing failures, or execution issues.
\n","isPage":false,"text":"\nMay throw errors during the quote fetching, signing, or execution phases.\nThese could include network errors, signing failures, or execution issues.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"48":{"href":"/reference#example-2","html":"\n
const itx = {\n actions: [...], // Array of actions to be executed\n paymentInfo: ... // Payment information\n};\n\nconst signHash = async (hash) => {\n // Implement your signing logic here\n return signedHash;\n};\n\ntry {\n const result = await klasterSDK.autoExecute(itx, signHash);\n console.log('iTx executed successfully. Hash:', result.iTxHash);\n} catch (error) {\n console.error('AutoExecute failed:', error);\n}
The signHash function must return a properly signed hash. Ensure you're using\nthe correct signing method (e.g., personalSign) to avoid execution errors.
\n
This function abstracts away the separate steps of quoting and executing,\nmaking it more convenient for straightforward iTx executions.
\n
\n","isPage":false,"text":"\n\nThe signHash function must return a properly signed hash. Ensure you're using\nthe correct signing method (e.g., personalSign) to avoid execution errors.\nThis function abstracts away the separate steps of quoting and executing,\nmaking it more convenient for straightforward iTx executions.\n\n","title":"Remarks","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"50":{"href":"/reference#see","html":"\n
execute - Used internally to execute the transaction.
\n
\n","isPage":false,"text":"\n\ngetQuote - Used internally to fetch the quote.\nexecute - Used internally to execute the transaction.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","autoExecute()"]},"51":{"href":"/reference#defined-in-5","html":"\n
Changes the salt value used for deriving ERC4337 multichain smart accounts.
\n
This function updates the activeAccountSalt parameter of the SDK instance. The salt,\nin combination with the connected Externally Owned Account (EOA), is used to\ndeterministically derive ERC4337 compliant multichain smart contract accounts.\nChanging this salt will result in deriving a different smart contract account\nfor all subsequent operations.
\n","isPage":false,"text":"\n\nchangeAccountSalt(salt): void\n\nChanges the salt value used for deriving ERC4337 multichain smart accounts.\nThis function updates the activeAccountSalt parameter of the SDK instance. The salt,\nin combination with the connected Externally Owned Account (EOA), is used to\ndeterministically derive ERC4337 compliant multichain smart contract accounts.\nChanging this salt will result in deriving a different smart contract account\nfor all subsequent operations.\n","title":"changeAccountSalt()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"53":{"href":"/reference#parameters-4","html":"\n
• salt: string
\n
The new salt value to be used for account derivation.\nThis should be a unique string that, when combined with\nthe EOA address, produces a unique smart account address.
\n","isPage":false,"text":"\n• salt: string\nThe new salt value to be used for account derivation.\nThis should be a unique string that, when combined with\nthe EOA address, produces a unique smart account address.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeAccountSalt()"]},"54":{"href":"/reference#returns-5","html":"\n
// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\nklasterSDK.changeAccountSalt('uniqueSaltValue123');
\n","isPage":false,"text":"\n// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\nklasterSDK.changeAccountSalt('uniqueSaltValue123');\n","title":"Example","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeAccountSalt()"]},"56":{"href":"/reference#note","html":"\n
Changing the account salt will affect all future account derivations and operations.\nIt does not affect previously derived accounts or ongoing transactions. Ensure you understand\nthe implications of changing this salt in the context of your application.
\n","isPage":false,"text":"\nChanging the account salt will affect all future account derivations and operations.\nIt does not affect previously derived accounts or ongoing transactions. Ensure you understand\nthe implications of changing this salt in the context of your application.\n","title":"Note","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeAccountSalt()"]},"57":{"href":"/reference#see-1","html":"\n
For more information on ERC4337 and account abstraction, visit:\nAccount Abstraction
\n","isPage":false,"text":"\nFor more information on ERC4337 and account abstraction, visit:\nAccount Abstraction\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeAccountSalt()"]},"58":{"href":"/reference#defined-in-6","html":"\n
Changes the master wallet address used for deriving ERC4337 multichain smart accounts.
\n
This function updates the masterAddress parameter of the SDK instance. The master address,\nin combination with a salt value, is used to deterministically derive ERC4337 compliant\nmultichain smart contract accounts. Changing this address will result in deriving\ndifferent smart contract accounts for all subsequent operations.
\n","isPage":false,"text":"\n\nchangeMasterAddress(wallet): void\n\nChanges the master wallet address used for deriving ERC4337 multichain smart accounts.\nThis function updates the masterAddress parameter of the SDK instance. The master address,\nin combination with a salt value, is used to deterministically derive ERC4337 compliant\nmultichain smart contract accounts. Changing this address will result in deriving\ndifferent smart contract accounts for all subsequent operations.\n","title":"changeMasterAddress()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"60":{"href":"/reference#parameters-5","html":"\n
• wallet: `0x${string}`
\n
The new master wallet address to be used for account derivation.\nThis should be a valid Ethereum address.
\n","isPage":false,"text":"\n• wallet: `0x${string}`\nThe new master wallet address to be used for account derivation.\nThis should be a valid Ethereum address.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeMasterAddress()"]},"61":{"href":"/reference#returns-6","html":"\n
May throw an error if the provided address is invalid.
\n","isPage":false,"text":"\nMay throw an error if the provided address is invalid.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeMasterAddress()"]},"63":{"href":"/reference#example-4","html":"\n
// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\nklasterSDK.changeMasterAddress('0x742d35Cc6634C0532925a3b844Bc454e4438f44e');
\n","isPage":false,"text":"\n// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\nklasterSDK.changeMasterAddress('0x742d35Cc6634C0532925a3b844Bc454e4438f44e');\n","title":"Example","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeMasterAddress()"]},"64":{"href":"/reference#note-1","html":"\n
Changing the master address will affect all future account derivations and operations.\nIt does not affect previously derived accounts or ongoing transactions. Ensure you understand\nthe implications of changing this address in the context of your application.
\n","isPage":false,"text":"\nChanging the master address will affect all future account derivations and operations.\nIt does not affect previously derived accounts or ongoing transactions. Ensure you understand\nthe implications of changing this address in the context of your application.\n","title":"Note","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeMasterAddress()"]},"65":{"href":"/reference#see-2","html":"\n
For more information on ERC4337 and account abstraction, visit:\nAccount Abstraction
\n","isPage":false,"text":"\nFor more information on ERC4337 and account abstraction, visit:\nAccount Abstraction\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","changeMasterAddress()"]},"66":{"href":"/reference#defined-in-7","html":"\n
A helper function that prepares an ApiPaymentData object for transaction fee payments.
\n
This asynchronous function simplifies the process of creating an ApiPaymentData object,\nwhich is used to specify how transaction fees should be paid on the Klaster Protocol.\nIt combines information from the multichain account, the current SDK configuration,\nand the specified payment token to create a complete payment data structure.
\n","isPage":false,"text":"\n\nencodeTxFee(paymentToken, chainId): Promise<ApiPaymentData>\n\nA helper function that prepares an ApiPaymentData object for transaction fee payments.\nThis asynchronous function simplifies the process of creating an ApiPaymentData object,\nwhich is used to specify how transaction fees should be paid on the Klaster Protocol.\nIt combines information from the multichain account, the current SDK configuration,\nand the specified payment token to create a complete payment data structure.\n","title":"encodeTxFee()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"68":{"href":"/reference#parameters-6","html":"\n
A string representing the symbol of the token being used for\npayments. e.g. ETH, USDC, MATIC, WSTETH, ...
\n
• chainId: number
\n
The chainId of the chain on which you wish to execute the payment.
\n","isPage":false,"text":"\n• paymentToken: PaymentTokenSymbol\nA string representing the symbol of the token being used for\npayments. e.g. ETH, USDC, MATIC, WSTETH, ...\n• chainId: number\nThe chainId of the chain on which you wish to execute the payment.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"69":{"href":"/reference#returns-7","html":"\n
A promise that resolves to an ApiPaymentData object containing:
\n
\n
chainId: The chain ID where the payment will be processed
\n
masterWallet: The address of the master wallet used in the SDK.
\n
salt: The salt used for deriving the multichain account.
\n
token: The address of the token to be used for payment.
\n
\n","isPage":false,"text":"\nPromise<ApiPaymentData>\nA promise that resolves to an ApiPaymentData object containing:\n\nchainId: The chain ID where the payment will be processed\nmasterWallet: The address of the master wallet used in the SDK.\nsalt: The salt used for deriving the multichain account.\ntoken: The address of the token to be used for payment.\n\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"70":{"href":"/reference#async-1","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"71":{"href":"/reference#throws-2","html":"\n
May throw an error if:
\n
\n
There's an issue retrieving the multichain account.
\n
The specified payment token is not found or invalid.
\n
Any other unexpected error occurs during the process.
\n
\n","isPage":false,"text":"\nMay throw an error if:\n\nThere's an issue retrieving the multichain account.\nThe specified payment token is not found or invalid.\nAny other unexpected error occurs during the process.\n\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"72":{"href":"/reference#example-5","html":"\n
// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\ntry {\n const paymentData = await klasterSDK.encodeTxFee('USDC', optimism.id);\n console.log('Payment data:', paymentData);\n} catch (error) {\n console.error('Failed to encode transaction fee:', error);\n}
\n","isPage":false,"text":"\n// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\ntry {\n const paymentData = await klasterSDK.encodeTxFee('USDC', optimism.id);\n console.log('Payment data:', paymentData);\n} catch (error) {\n console.error('Failed to encode transaction fee:', error);\n}\n","title":"Example","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"73":{"href":"/reference#note-2","html":"\n
This function uses the current state of the SDK, including the master wallet address.\nMake sure these are set correctly before calling this function.
\n","isPage":false,"text":"\nThis function uses the current state of the SDK, including the master wallet address.\nMake sure these are set correctly before calling this function.\n","title":"Note","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"74":{"href":"/reference#see-3","html":"\n
getPaymentToken - Used internally to resolve the token address from the ChainTokenPair.
\n
\n","isPage":false,"text":"\n\ngetMultichainAccount - Used internally to fetch the current multichain account.\ngetPaymentToken - Used internally to resolve the token address from the ChainTokenPair.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","encodeTxFee()"]},"75":{"href":"/reference#defined-in-8","html":"\n
Executes the Interchain Transaction (iTx) based on a quote response and signed hash.
\n
This function triggers the execution of an iTx on the Klaster network. Once called\nwith a valid signed hash, the execution becomes irreversible.
\n","isPage":false,"text":"\n\nexecute(response, signedHash): Promise<ExecuteResponse>\n\nExecutes the Interchain Transaction (iTx) based on a quote response and signed hash.\nThis function triggers the execution of an iTx on the Klaster network. Once called\nwith a valid signed hash, the execution becomes irreversible.\n","title":"execute()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"77":{"href":"/reference#parameters-7","html":"\n
The response object returned from calling the quote\nendpoint. This contains necessary information for execution.
\n
• signedHash: string
\n
The iTx hash, signed by the wallet using the personalSign method.
\n","isPage":false,"text":"\n• response: QuoteResponse\nThe response object returned from calling the quote\nendpoint. This contains necessary information for execution.\n• signedHash: string\nThe iTx hash, signed by the wallet using the personalSign method.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"78":{"href":"/reference#returns-8","html":"\n
A promise that resolves to an ExecuteResponse object\ncontaining the iTx hash of the executed transaction.
\n","isPage":false,"text":"\nPromise<ExecuteResponse>\nA promise that resolves to an ExecuteResponse object\ncontaining the iTx hash of the executed transaction.\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"79":{"href":"/reference#async-2","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"80":{"href":"/reference#throws-3","html":"\n
May throw an error if the execution fails, if the signed hash is invalid,\nor if there are network issues.
\n","isPage":false,"text":"\nMay throw an error if the execution fails, if the signed hash is invalid,\nor if there are network issues.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"81":{"href":"/reference#remarks-1","html":"\n
IMPORTANT: The hash must be signed using the personalSign method.\nIf you encounter an "invalid merkle hash" error, ensure you're using the correct\nsigning method. Some libraries may default to a different signing scheme.
\n","isPage":false,"text":"\nIMPORTANT: The hash must be signed using the personalSign method.\nIf you encounter an "invalid merkle hash" error, ensure you're using the correct\nsigning method. Some libraries may default to a different signing scheme.\n","title":"Remarks","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"82":{"href":"/reference#example-6","html":"\n
\n","isPage":false,"text":"\n\ngetQuote - Used to obtain the necessary QuoteResponse.\nhttps://eips.ethereum.org/EIPS/eip-191 - EIP-191 for signed data standard.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","execute()"]},"84":{"href":"/reference#defined-in-9","html":"\n
Fetches the multichain ERC4337 account derived from the current masterWallet and salt.
\n
This asynchronous function retrieves the multichain smart contract account that is\ndeterministically derived using the masterWallet and salt parameters set during\nSDK initialization or subsequently updated.
\n
The derived account is compliant with the ERC4337 standard for account abstraction\nand can be used across multiple blockchain networks.
\n","isPage":false,"text":"\n\ngetMultichainAccount(): Promise<MultichainAccount>\n\nFetches the multichain ERC4337 account derived from the current masterWallet and salt.\nThis asynchronous function retrieves the multichain smart contract account that is\ndeterministically derived using the masterWallet and salt parameters set during\nSDK initialization or subsequently updated.\nThe derived account is compliant with the ERC4337 standard for account abstraction\nand can be used across multiple blockchain networks.\n","title":"getMultichainAccount()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"86":{"href":"/reference#returns-9","html":"\n
A promise that resolves to a MultichainAccount object.\nThe object contains:
\n
\n
salt: The current active account salt used for derivation.
\n
address: The derived multichain smart contract account address.
\n
\n","isPage":false,"text":"\nPromise<MultichainAccount>\nA promise that resolves to a MultichainAccount object.\nThe object contains:\n\nsalt: The current active account salt used for derivation.\naddress: The derived multichain smart contract account address.\n\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"87":{"href":"/reference#async-3","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"88":{"href":"/reference#throws-4","html":"\n
May throw an error if there's an issue communicating with the node service\nor if the account derivation fails.
\n","isPage":false,"text":"\nMay throw an error if there's an issue communicating with the node service\nor if the account derivation fails.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"89":{"href":"/reference#example-7","html":"\n
// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\ntry {\n const account = await klasterSDK.getMultichainAccount();\n console.log('Derived account:', account.address);\n console.log('Used salt:', account.salt);\n} catch (error) {\n console.error('Failed to fetch multichain account:', error);\n}
\n","isPage":false,"text":"\n// Assuming 'klasterSDK' is an initialized instance of the Klaster SDK\ntry {\n const account = await klasterSDK.getMultichainAccount();\n console.log('Derived account:', account.address);\n console.log('Used salt:', account.salt);\n} catch (error) {\n console.error('Failed to fetch multichain account:', error);\n}\n","title":"Example","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"90":{"href":"/reference#note-3","html":"\n
This function uses the current values of masterWallet and salt. If you need\nto derive a different account, use changeMasterAddress() or changeAccountSalt()\nbefore calling this function.
\n","isPage":false,"text":"\nThis function uses the current values of masterWallet and salt. If you need\nto derive a different account, use changeMasterAddress() or changeAccountSalt()\nbefore calling this function.\n","title":"Note","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"91":{"href":"/reference#see-5","html":"\n
\n","isPage":false,"text":"\n\nchangeMasterAddress - To change the master wallet address.\nchangeAccountSalt - To change the account salt.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getMultichainAccount()"]},"92":{"href":"/reference#defined-in-10","html":"\n
Fetches a quote for the interchain transaction (iTx).
\n
This asynchronous function processes an InterchainTransaction object to obtain a quote\nfrom the Klaster Node. The quote contains the full iTx information as well as the\nrequired payment information for executing the transaction.
\n","isPage":false,"text":"\n\ngetQuote(itx): Promise<QuoteResponse>\n\nFetches a quote for the interchain transaction (iTx).\nThis asynchronous function processes an InterchainTransaction object to obtain a quote\nfrom the Klaster Node. The quote contains the full iTx information as well as the\nrequired payment information for executing the transaction.\n","title":"getQuote()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"94":{"href":"/reference#parameters-8","html":"\n
The full Interchain Transaction object. This object\nshould contain an array of actions and payment information.
\n","isPage":false,"text":"\n• itx: InterchainTransaction\nThe full Interchain Transaction object. This object\nshould contain an array of actions and payment information.\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"95":{"href":"/reference#returns-10","html":"\n
A promise that resolves to a QuoteResponse object\ncontaining the full iTx information and required payment details.
\n","isPage":false,"text":"\nPromise<QuoteResponse>\nA promise that resolves to a QuoteResponse object\ncontaining the full iTx information and required payment details.\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"96":{"href":"/reference#async-4","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"97":{"href":"/reference#throws-5","html":"\n
Throws an error if the actions array in the iTx is empty.
\n","isPage":false,"text":"\nThrows an error if the actions array in the iTx is empty.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"98":{"href":"/reference#throws-6","html":"\n
May throw errors from the EncodingService or the node service if there\nare issues encoding the actions or fetching the quote.
\n","isPage":false,"text":"\nMay throw errors from the EncodingService or the node service if there\nare issues encoding the actions or fetching the quote.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"99":{"href":"/reference#example-8","html":"\n
This function uses the current values of masterAddress and activeAccountSalt\nfrom the SDK instance for encoding user operations.
\n","isPage":false,"text":"\nThis function uses the current values of masterAddress and activeAccountSalt\nfrom the SDK instance for encoding user operations.\n","title":"Note","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"101":{"href":"/reference#see-6","html":"\n
\n","isPage":false,"text":"\n\nEncodingService.encodeUserOpCall - Used for encoding single transaction actions.\nEncodingService.encodeBatchCall - Used for encoding multi-transaction actions.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","getQuote()"]},"102":{"href":"/reference#defined-in-11","html":"\n
Transfers ERC20 tokens to the multichain smart contract account and\nexecutes the desired actions across multiple blockchains.
\n
This function performs two main operations:
\n\n
Transfers ERC20 tokens to the smart contract account.
\n
Executes an interchain transaction (iTx) after the transfer is confirmed.
\n\n","isPage":false,"text":"\n\ntransferAndExecute(params): Promise<ExecuteResponse>\n\nTransfers ERC20 tokens to the multichain smart contract account and\nexecutes the desired actions across multiple blockchains.\nThis function performs two main operations:\n\nTransfers ERC20 tokens to the smart contract account.\nExecutes an interchain transaction (iTx) after the transfer is confirmed.\n\n","title":"transferAndExecute()","titles":["klaster-sdk","Classes","KlasterSDK","Methods"]},"104":{"href":"/reference#parameters-9","html":"\n
• params
\n
The parameters object containing transfer and execution instructions.
\n
• params.executeItx
\n
Instructions for executing the interchain transaction.
\n","isPage":false,"text":"\n• params\nThe parameters object containing transfer and execution instructions.\n• params.executeItx\nInstructions for executing the interchain transaction.\n• params.executeItx.iTx: InterchainTransaction\n• params.executeItx.signItxHashAction\n• params.transferToSmartAccount\nInstructions for transferring ERC20 tokens to the smart account.\n• params.transferToSmartAccount.amountToTransfer: bigint\n• params.transferToSmartAccount.chainId: number\n• params.transferToSmartAccount.executeTxAction\n• params.transferToSmartAccount.tokenToTransfer: `0x${string}`\n","title":"Parameters","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"105":{"href":"/reference#returns-11","html":"\n
A promise that resolves to the execution response of the iTx.
\n","isPage":false,"text":"\nPromise<ExecuteResponse>\nA promise that resolves to the execution response of the iTx.\n","title":"Returns","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"106":{"href":"/reference#async-5","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"107":{"href":"/reference#throws-7","html":"\n
May throw errors during the token transfer, quote fetching, signing, or execution phases.
\n","isPage":false,"text":"\nMay throw errors during the token transfer, quote fetching, signing, or execution phases.\n","title":"Throws","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"108":{"href":"/reference#example-9","html":"\n
The executeTxAction function should handle the actual sending of the transfer transaction to the blockchain.\nConsult the Klaster documentation for details on implementing this with your specific provider.
\n
The signItxHashAction function should handle the signing of the iTx hash.\nEnsure you're using the correct signing method as specified in the Klaster documentation.
\n
This function will wait for the transfer transaction to be accepted before proceeding with the iTx execution.
\n
\n","isPage":false,"text":"\n\nThe executeTxAction function should handle the actual sending of the transfer transaction to the blockchain.\nConsult the Klaster documentation for details on implementing this with your specific provider.\nThe signItxHashAction function should handle the signing of the iTx hash.\nEnsure you're using the correct signing method as specified in the Klaster documentation.\nThis function will wait for the transfer transaction to be accepted before proceeding with the iTx execution.\n\n","title":"Remarks","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"110":{"href":"/reference#see-7","html":"\n
\n
Klaster documentation for detailed information on implementing executeTxAction and signItxHashAction.
\n","isPage":false,"text":"\n\nKlaster documentation for detailed information on implementing executeTxAction and signItxHashAction.\nbuildTransferERC20FromEoaTx - Used internally to construct the transfer transaction.\ngetQuote - Used internally to fetch the quote for the iTx.\nexecute - Used internally to execute the iTx.\n\n","title":"See","titles":["klaster-sdk","Classes","KlasterSDK","Methods","transferAndExecute()"]},"111":{"href":"/reference#defined-in-12","html":"\n
Utility class for generating salt values used in KlasterSDK functions.
\n
Salt values are crucial for deriving unique smart contract accounts within the Klaster ecosystem.\nThis class provides methods to generate salts for different account scenarios.
\n","isPage":false,"text":"\nUtility class for generating salt values used in KlasterSDK functions.\nSalt values are crucial for deriving unique smart contract accounts within the Klaster ecosystem.\nThis class provides methods to generate salts for different account scenarios.\n","title":"SaltUtil","titles":["klaster-sdk","Classes"]},"113":{"href":"/reference#constructors-2","html":"\n","isPage":false,"text":"\n","title":"Constructors","titles":["klaster-sdk","Classes","SaltUtil"]},"114":{"href":"/reference#new-saltutil","html":"\n
Generates a salt for an account at a specific index.
\n
This method allows for deterministic generation of salts for multiple accounts.
\n","isPage":false,"text":"\n\nstatic accountAt(i): string\n\nGenerates a salt for an account at a specific index.\nThis method allows for deterministic generation of salts for multiple accounts.\n","title":"accountAt()","titles":["klaster-sdk","Classes","SaltUtil","Methods"]},"118":{"href":"/reference#parameters-10","html":"\n
• i: number
\n
The index of the account, starting from 0.
\n","isPage":false,"text":"\n• i: number\nThe index of the account, starting from 0.\n","title":"Parameters","titles":["klaster-sdk","Classes","SaltUtil","Methods","accountAt()"]},"119":{"href":"/reference#returns-13","html":"\n
string
\n
A salt value corresponding to the given index.
\n","isPage":false,"text":"\nstring\nA salt value corresponding to the given index.\n","title":"Returns","titles":["klaster-sdk","Classes","SaltUtil","Methods","accountAt()"]},"120":{"href":"/reference#example-10","html":"\n
This method provides flexibility for users who want to use their own salt values.
\n","isPage":false,"text":"\n\nstatic customAccount(salt): string\n\nAllows for the use of a custom salt value.\nThis method provides flexibility for users who want to use their own salt values.\n","title":"customAccount()","titles":["klaster-sdk","Classes","SaltUtil","Methods"]},"123":{"href":"/reference#parameters-11","html":"\n
• salt: string
\n
A custom salt value.
\n","isPage":false,"text":"\n• salt: string\nA custom salt value.\n","title":"Parameters","titles":["klaster-sdk","Classes","SaltUtil","Methods","customAccount()"]},"124":{"href":"/reference#returns-14","html":"\n
string
\n
The provided custom salt value.
\n","isPage":false,"text":"\nstring\nThe provided custom salt value.\n","title":"Returns","titles":["klaster-sdk","Classes","SaltUtil","Methods","customAccount()"]},"125":{"href":"/reference#example-11","html":"\n
When using custom salts, ensure they are unique to avoid account collisions.\nCustom salts should be securely generated and managed to maintain account security.
\n","isPage":false,"text":"\nWhen using custom salts, ensure they are unique to avoid account collisions.\nCustom salts should be securely generated and managed to maintain account security.\n","title":"Remarks","titles":["klaster-sdk","Classes","SaltUtil","Methods","customAccount()"]},"127":{"href":"/reference#defined-in-14","html":"\n
\n","isPage":false,"text":"\n\nstatic firstAccount(): string\n\nGenerates a salt for the first (default) account.\n","title":"firstAccount()","titles":["klaster-sdk","Classes","SaltUtil","Methods"]},"129":{"href":"/reference#returns-15","html":"\n
string
\n
A salt value of "0", representing the first account.
\n","isPage":false,"text":"\nstring\nA salt value of "0", representing the first account.\n","title":"Returns","titles":["klaster-sdk","Classes","SaltUtil","Methods","firstAccount()"]},"130":{"href":"/reference#example-12","html":"\n
Represents the payment data structure for gas costs and transaction fees in the Klaster API.\nThis interface defines the necessary information for processing payments related to\nuser operations on the Klaster network.
\n
ApiPaymentData
\n","isPage":false,"text":"\nRepresents the payment data structure for gas costs and transaction fees in the Klaster API.\nThis interface defines the necessary information for processing payments related to\nuser operations on the Klaster network.\nApiPaymentData\n","title":"ApiPaymentData","titles":["klaster-sdk","Interfaces"]},"134":{"href":"/reference#properties-1","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ApiPaymentData"]},"135":{"href":"/reference#chainid","html":"\n
\n
chainId: number
\n
\n
The ID of the blockchain network on which the payment for\nthe gas cost and transaction fees will be processed. This determines the specific\nblockchain where the payment transaction will occur.
\n","isPage":false,"text":"\n\nchainId: number\n\nThe ID of the blockchain network on which the payment for\nthe gas cost and transaction fees will be processed. This determines the specific\nblockchain where the payment transaction will occur.\n","title":"chainId","titles":["klaster-sdk","Interfaces","ApiPaymentData","Properties"]},"136":{"href":"/reference#defined-in-16","html":"\n
The address of the Externally Owned Account (EOA) from which\nthe Klaster Multichain Smart Account is derived.
\n","isPage":false,"text":"\n\nmasterWallet: `0x${string}`\n\nThe address of the Externally Owned Account (EOA) from which\nthe Klaster Multichain Smart Account is derived.\n","title":"masterWallet","titles":["klaster-sdk","Interfaces","ApiPaymentData","Properties"]},"138":{"href":"/reference#defined-in-17","html":"\n
A unique value used in conjunction with the masterWallet address\nto calculate the Klaster Multichain Smart Account address. This ensures unique account\naddresses for the same EOA.
\n","isPage":false,"text":"\n\nsalt: string\n\nA unique value used in conjunction with the masterWallet address\nto calculate the Klaster Multichain Smart Account address. This ensures unique account\naddresses for the same EOA.\n","title":"salt","titles":["klaster-sdk","Interfaces","ApiPaymentData","Properties"]},"140":{"href":"/reference#defined-in-18","html":"\n
The address of the ERC20 token that will be used to pay for\nthe gas cost and transaction fees associated with the user operation.
\n","isPage":false,"text":"\n\ntoken: string\n\nThe address of the ERC20 token that will be used to pay for\nthe gas cost and transaction fees associated with the user operation.\n","title":"token","titles":["klaster-sdk","Interfaces","ApiPaymentData","Properties"]},"142":{"href":"/reference#defined-in-19","html":"\n
Represents the user operation format expected as input by the Klaster Node API.\nThis interface defines the structure for ERC-4337 compliant user operations\nspecifically tailored for Klaster Multichain Smart Accounts.
\n
ApiUserOp
\n","isPage":false,"text":"\nRepresents the user operation format expected as input by the Klaster Node API.\nThis interface defines the structure for ERC-4337 compliant user operations\nspecifically tailored for Klaster Multichain Smart Accounts.\nApiUserOp\n","title":"ApiUserOp","titles":["klaster-sdk","Interfaces"]},"144":{"href":"/reference#properties-2","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ApiUserOp"]},"145":{"href":"/reference#calldata","html":"\n
\n
callData: string
\n
\n
The encoded function call data to be executed on the blockchain.\nThis represents the actual operation the user wants to perform.
\n","isPage":false,"text":"\n\ncallData: string\n\nThe encoded function call data to be executed on the blockchain.\nThis represents the actual operation the user wants to perform.\n","title":"callData","titles":["klaster-sdk","Interfaces","ApiUserOp","Properties"]},"146":{"href":"/reference#defined-in-20","html":"\n
The maximum amount of gas that can be used for the execution\nof the callData on the target blockchain. This is part of the ERC-4337 specification for\naccount abstraction.
\n","isPage":false,"text":"\n\ncallGasLimit: string\n\nThe maximum amount of gas that can be used for the execution\nof the callData on the target blockchain. This is part of the ERC-4337 specification for\naccount abstraction.\n","title":"callGasLimit","titles":["klaster-sdk","Interfaces","ApiUserOp","Properties"]},"148":{"href":"/reference#defined-in-21","html":"\n
The ID of the blockchain network where the UserOp is to be executed.\nThis determines which network the operation will be sent to.
\n","isPage":false,"text":"\n\nchainId: number\n\nThe ID of the blockchain network where the UserOp is to be executed.\nThis determines which network the operation will be sent to.\n","title":"chainId","titles":["klaster-sdk","Interfaces","ApiUserOp","Properties"]},"150":{"href":"/reference#defined-in-22","html":"\n
The address of the Externally Owned Account (EOA) from which\nthe Klaster Multichain Smart Account is derived.
\n","isPage":false,"text":"\n\nmasterWallet: `0x${string}`\n\nThe address of the Externally Owned Account (EOA) from which\nthe Klaster Multichain Smart Account is derived.\n","title":"masterWallet","titles":["klaster-sdk","Interfaces","ApiUserOp","Properties"]},"152":{"href":"/reference#defined-in-23","html":"\n
A unique value used in conjunction with the masterWallet address\nto calculate the Klaster Multichain Smart Account address. This ensures unique account\naddresses for the same EOA.
\n","isPage":false,"text":"\n\nsalt: string\n\nA unique value used in conjunction with the masterWallet address\nto calculate the Klaster Multichain Smart Account address. This ensures unique account\naddresses for the same EOA.\n","title":"salt","titles":["klaster-sdk","Interfaces","ApiUserOp","Properties"]},"154":{"href":"/reference#defined-in-24","html":"\n
Represents the full ERC-4337 UserOperation standard object format.\nThis interface defines the structure of a user operation as specified in the ERC-4337 standard\nfor account abstraction in Ethereum.
\n
ERC4337UserOp
\n","isPage":false,"text":"\nRepresents the full ERC-4337 UserOperation standard object format.\nThis interface defines the structure of a user operation as specified in the ERC-4337 standard\nfor account abstraction in Ethereum.\nERC4337UserOp\n","title":"ERC4337UserOp","titles":["klaster-sdk","Interfaces"]},"156":{"href":"/reference#properties-3","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ERC4337UserOp"]},"157":{"href":"/reference#calldata-1","html":"\n
\n
callData: string
\n
\n
The data to be passed to the sender during the main execution call.
\n","isPage":false,"text":"\n\ncallData: string\n\nThe data to be passed to the sender during the main execution call.\n","title":"callData","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"158":{"href":"/reference#defined-in-25","html":"\n
\n","isPage":false,"text":"\n\ncallGasLimit: string\n\nThe gas limit for the main execution call.\n","title":"callGasLimit","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"160":{"href":"/reference#defined-in-26","html":"\n
The initialization code for the account if it hasn't been deployed yet. Empty string if the account is already deployed.
\n","isPage":false,"text":"\n\ninitCode: string\n\nThe initialization code for the account if it hasn't been deployed yet. Empty string if the account is already deployed.\n","title":"initCode","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"162":{"href":"/reference#defined-in-27","html":"\n
The maximum total fee per gas the sender is willing to pay (including the priority fee).
\n","isPage":false,"text":"\n\nmaxFeePerGas: string\n\nThe maximum total fee per gas the sender is willing to pay (including the priority fee).\n","title":"maxFeePerGas","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"164":{"href":"/reference#defined-in-28","html":"\n
The maximum priority fee per gas the sender is willing to pay.
\n","isPage":false,"text":"\n\nmaxPriorityFeePerGas: string\n\nThe maximum priority fee per gas the sender is willing to pay.\n","title":"maxPriorityFeePerGas","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"166":{"href":"/reference#defined-in-29","html":"\n
A unique identifier to prevent replay attacks, typically managed by the account itself.
\n","isPage":false,"text":"\n\nnonce: string\n\nA unique identifier to prevent replay attacks, typically managed by the account itself.\n","title":"nonce","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"168":{"href":"/reference#defined-in-30","html":"\n
The address of the paymaster sponsoring the transaction, followed by extra data to send to the paymaster. Empty string if there's no paymaster.
\n","isPage":false,"text":"\n\npaymasterAndData: string\n\nThe address of the paymaster sponsoring the transaction, followed by extra data to send to the paymaster. Empty string if there's no paymaster.\n","title":"paymasterAndData","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"170":{"href":"/reference#defined-in-31","html":"\n
The amount of gas to compensate the bundler for pre-verification execution and calldata.
\n","isPage":false,"text":"\n\npreVerificationGas: string\n\nThe amount of gas to compensate the bundler for pre-verification execution and calldata.\n","title":"preVerificationGas","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"172":{"href":"/reference#defined-in-32","html":"\n
The address of the smart contract account that will make the transaction.
\n","isPage":false,"text":"\n\nsender: `0x${string}`\n\nThe address of the smart contract account that will make the transaction.\n","title":"sender","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"174":{"href":"/reference#defined-in-33","html":"\n
The signature over the entire UserOperation, to be validated during verification.
\n","isPage":false,"text":"\n\nsignature: string\n\nThe signature over the entire UserOperation, to be validated during verification.\n","title":"signature","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"176":{"href":"/reference#defined-in-34","html":"\n
\n","isPage":false,"text":"\n\nverificationGasLimit: string\n\nThe gas limit for the verification step.\n","title":"verificationGasLimit","titles":["klaster-sdk","Interfaces","ERC4337UserOp","Properties"]},"178":{"href":"/reference#defined-in-35","html":"\n
Represents the response model returned by the /execute route of the Klaster Node API.\nThis interface encapsulates the result of initiating the execution of an interchain transaction.
\n
ExecuteResponse
\n","isPage":false,"text":"\nRepresents the response model returned by the /execute route of the Klaster Node API.\nThis interface encapsulates the result of initiating the execution of an interchain transaction.\nExecuteResponse\n","title":"ExecuteResponse","titles":["klaster-sdk","Interfaces"]},"180":{"href":"/reference#properties-4","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ExecuteResponse"]},"181":{"href":"/reference#itxhash","html":"\n
\n
iTxHash: string
\n
\n
The hash of the Klaster Interchain Transaction (iTx) that has been\nsubmitted for execution. This hash serves as a unique identifier for the interchain transaction\nand can be used to track or reference the transaction's status and outcome across multiple chains.
\n","isPage":false,"text":"\n\niTxHash: string\n\nThe hash of the Klaster Interchain Transaction (iTx) that has been\nsubmitted for execution. This hash serves as a unique identifier for the interchain transaction\nand can be used to track or reference the transaction's status and outcome across multiple chains.\n","title":"iTxHash","titles":["klaster-sdk","Interfaces","ExecuteResponse","Properties"]},"182":{"href":"/reference#defined-in-36","html":"\n
Represents the model returned by the Klaster Node API after an Action has been executed.\nThis interface provides detailed information about the execution status and parameters\nof a user operation processed by Klaster.
\n
ExecutedAction
\n","isPage":false,"text":"\nRepresents the model returned by the Klaster Node API after an Action has been executed.\nThis interface provides detailed information about the execution status and parameters\nof a user operation processed by Klaster.\nExecutedAction\n","title":"ExecutedAction","titles":["klaster-sdk","Interfaces"]},"184":{"href":"/reference#properties-5","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ExecutedAction"]},"185":{"href":"/reference#chainid-2","html":"\n
\n
chainId: string
\n
\n
The identifier of the blockchain network on which the userOp is executed.
\n","isPage":false,"text":"\n\nchainId: string\n\nThe identifier of the blockchain network on which the userOp is executed.\n","title":"chainId","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"186":{"href":"/reference#defined-in-37","html":"\n
The callData of the executed action, representing the actual operation performed.
\n","isPage":false,"text":"\n\nexecutionData: string\n\nThe callData of the executed action, representing the actual operation performed.\n","title":"executionData","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"188":{"href":"/reference#defined-in-38","html":"\n
"SUCCESS": The operation was successfully executed.
\n
"FAILED": The operation failed during execution.
\n
"PENDING": The Klaster node is waiting for conditions to be met before execution.\nThis status is part of the Klaster spec and is particularly relevant for multichain actions\nwhere execution conditions on the destination chain may depend on prior token bridging.
\n
\n","isPage":false,"text":"\n\nexecutionStatus: "SUCCESS" | "PENDING" | "FAILED"\n\nThe current status of the UserOp execution:\n\n"SUCCESS": The operation was successfully executed.\n"FAILED": The operation failed during execution.\n"PENDING": The Klaster node is waiting for conditions to be met before execution.\nThis status is part of the Klaster spec and is particularly relevant for multichain actions\nwhere execution conditions on the destination chain may depend on prior token bridging.\n\n","title":"executionStatus","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"190":{"href":"/reference#defined-in-39","html":"\n
The earliest timestamp at which the userOp will be executed on the target blockchain.
\n","isPage":false,"text":"\n\nlowerBoundTimestap: string\n\nThe earliest timestamp at which the userOp will be executed on the target blockchain.\n","title":"lowerBoundTimestap","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"192":{"href":"/reference#defined-in-40","html":"\n
The maximum gas limit allowed for the execution of this userOp.
\n","isPage":false,"text":"\n\nmaxGasLimit: string\n\nThe maximum gas limit allowed for the execution of this userOp.\n","title":"maxGasLimit","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"194":{"href":"/reference#defined-in-41","html":"\n
The latest timestamp by which the userOp will be executed on the target blockchain.
\n","isPage":false,"text":"\n\nupperBoundTimestamp: string\n\nThe latest timestamp by which the userOp will be executed on the target blockchain.\n","title":"upperBoundTimestamp","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"196":{"href":"/reference#defined-in-42","html":"\n
The full ERC-4337 UserOperation object that was executed.
\n","isPage":false,"text":"\n\nuserOp: ERC4337UserOp\n\nThe full ERC-4337 UserOperation object that was executed.\n","title":"userOp","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"198":{"href":"/reference#defined-in-43","html":"\n
The hash of the userOp, serving as a unique identifier for the operation.
\n","isPage":false,"text":"\n\nuserOpHash: string\n\nThe hash of the userOp, serving as a unique identifier for the operation.\n","title":"userOpHash","titles":["klaster-sdk","Interfaces","ExecutedAction","Properties"]},"200":{"href":"/reference#defined-in-44","html":"\n
Represents the minimal UserOperation required for a fully described Klaster Interchain Transaction model.\nThis interface defines the structure for actions that can be performed on a single chain within\na Klaster Interchain Transaction.
\n
ITxUserOp
\n","isPage":false,"text":"\nRepresents the minimal UserOperation required for a fully described Klaster Interchain Transaction model.\nThis interface defines the structure for actions that can be performed on a single chain within\na Klaster Interchain Transaction.\nITxUserOp\n","title":"ITxUserOp","titles":["klaster-sdk","Interfaces"]},"202":{"href":"/reference#properties-6","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ITxUserOp"]},"203":{"href":"/reference#chainid-3","html":"\n
\n
chainId: number
\n
\n
The identifier of the blockchain network on which the transaction(s) will be executed.
\n","isPage":false,"text":"\n\nchainId: number\n\nThe identifier of the blockchain network on which the transaction(s) will be executed.\n","title":"chainId","titles":["klaster-sdk","Interfaces","ITxUserOp","Properties"]},"204":{"href":"/reference#defined-in-45","html":"\n
Optional. The earliest timestamp at which the transaction(s) can be executed.
\n","isPage":false,"text":"\n\noptional lowerBoundTime: number\n\nOptional. The earliest timestamp at which the transaction(s) can be executed.\n","title":"lowerBoundTime?","titles":["klaster-sdk","Interfaces","ITxUserOp","Properties"]},"206":{"href":"/reference#defined-in-46","html":"\n
An array of raw transactions to be executed on the specified chain.
\n
\n
If this array contains a single transaction, the 'execute' function will be called on the smart contract account.
\n
If this array contains multiple transactions, the 'batchExecute' function will be called on the smart contract account.
\n
\n","isPage":false,"text":"\n\ntxs: RawTransaction[]\n\nAn array of raw transactions to be executed on the specified chain.\n\nIf this array contains a single transaction, the 'execute' function will be called on the smart contract account.\nIf this array contains multiple transactions, the 'batchExecute' function will be called on the smart contract account.\n\n","title":"txs","titles":["klaster-sdk","Interfaces","ITxUserOp","Properties"]},"208":{"href":"/reference#defined-in-47","html":"\n
Optional. The latest timestamp by which the transaction(s) should be executed.
\n","isPage":false,"text":"\n\noptional upperBoundTime: number\n\nOptional. The latest timestamp by which the transaction(s) should be executed.\n","title":"upperBoundTime?","titles":["klaster-sdk","Interfaces","ITxUserOp","Properties"]},"210":{"href":"/reference#defined-in-48","html":"\n
Represents the response model returned by the /explorer route of the Klaster Node API.\nThis interface provides detailed information about the status and execution details of an interchain transaction.
\n
ItxStatusResponse
\n","isPage":false,"text":"\nRepresents the response model returned by the /explorer route of the Klaster Node API.\nThis interface provides detailed information about the status and execution details of an interchain transaction.\nItxStatusResponse\n","title":"ItxStatusResponse","titles":["klaster-sdk","Interfaces"]},"218":{"href":"/reference#properties-8","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","ItxStatusResponse"]},"219":{"href":"/reference#commitment","html":"\n
\n
commitment: string
\n
\n
The cryptographic commitment generated by the Klaster node, guaranteeing\nthe execution of the interchain transaction.
\n","isPage":false,"text":"\n\ncommitment: string\n\nThe cryptographic commitment generated by the Klaster node, guaranteeing\nthe execution of the interchain transaction.\n","title":"commitment","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties"]},"220":{"href":"/reference#defined-in-51","html":"\n
The hash of the Klaster Interchain Transaction (iTx). Serves as a unique identifier\nfor the interchain transaction.
\n","isPage":false,"text":"\n\nitxHash: string\n\nThe hash of the Klaster Interchain Transaction (iTx). Serves as a unique identifier\nfor the interchain transaction.\n","title":"itxHash","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties"]},"222":{"href":"/reference#defined-in-52","html":"\n
The address of the Klaster node that is responsible for executing the interchain transaction.
\n","isPage":false,"text":"\n\nnode: `0x${string}`\n\nThe address of the Klaster node that is responsible for executing the interchain transaction.\n","title":"node","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties"]},"224":{"href":"/reference#defined-in-53","html":"\n
Contains information about the payment for the transaction, including the token\nused and the actual amount quoted for the execution.
\n","isPage":false,"text":"\n\npaymentInfo: ApiPaymentData & object\n\nContains information about the payment for the transaction, including the token\nused and the actual amount quoted for the execution.\n","title":"paymentInfo","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties"]},"226":{"href":"/reference#type-declaration","html":"\n","isPage":false,"text":"\n","title":"Type declaration","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties","paymentInfo"]},"227":{"href":"/reference#tokenamount","html":"\n
An array of ExecutedAction objects, each representing the status and\ndetails of a user operation executed as part of this interchain transaction across different chains.
\n","isPage":false,"text":"\n\nuserOps: ExecutedAction[]\n\nAn array of ExecutedAction objects, each representing the status and\ndetails of a user operation executed as part of this interchain transaction across different chains.\n","title":"userOps","titles":["klaster-sdk","Interfaces","ItxStatusResponse","Properties"]},"231":{"href":"/reference#defined-in-55","html":"\n
Represents a Klaster Multichain Smart Contract account model.\nThis interface defines the essential properties of a smart contract account\nthat can operate across multiple blockchain networks.
\n
MultichainAccount
\n","isPage":false,"text":"\nRepresents a Klaster Multichain Smart Contract account model.\nThis interface defines the essential properties of a smart contract account\nthat can operate across multiple blockchain networks.\nMultichainAccount\n","title":"MultichainAccount","titles":["klaster-sdk","Interfaces"]},"233":{"href":"/reference#properties-9","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","MultichainAccount"]},"234":{"href":"/reference#address","html":"\n
\n
address: `0x${string}`
\n
\n
The unique address of the multichain smart contract account.\nThis address is (mostly) consistent across all supported blockchain networks, allowing\nfor unified identity and seamless cross-chain operations. Some exceptions to the generated\naddress being consistent are blockchains in the zkSync ecosystem & any other ecosystem where\nthe CREATE2 opcode doesn't behave the same way as on Ethereum mainnet.
\n","isPage":false,"text":"\n\naddress: `0x${string}`\n\nThe unique address of the multichain smart contract account.\nThis address is (mostly) consistent across all supported blockchain networks, allowing\nfor unified identity and seamless cross-chain operations. Some exceptions to the generated\naddress being consistent are blockchains in the zkSync ecosystem & any other ecosystem where\nthe CREATE2 opcode doesn't behave the same way as on Ethereum mainnet.\n","title":"address","titles":["klaster-sdk","Interfaces","MultichainAccount","Properties"]},"235":{"href":"/reference#defined-in-56","html":"\n
A unique value used in the account creation process.\nThe salt, combined with other parameters (such as the owner's address),\nensures that the account address is unique and deterministically generated\nacross all supported chains.
\n","isPage":false,"text":"\n\nsalt: string\n\nA unique value used in the account creation process.\nThe salt, combined with other parameters (such as the owner's address),\nensures that the account address is unique and deterministically generated\nacross all supported chains.\n","title":"salt","titles":["klaster-sdk","Interfaces","MultichainAccount","Properties"]},"237":{"href":"/reference#defined-in-57","html":"\n
Represents the model returned by the Klaster Node API when a user requests a quote for an interchain transaction.\nThis interface provides detailed information about the quote, including the transaction hash,\nnode commitment, and the user operations to be executed across multiple chains.
\n
QuoteResponse
\n","isPage":false,"text":"\nRepresents the model returned by the Klaster Node API when a user requests a quote for an interchain transaction.\nThis interface provides detailed information about the quote, including the transaction hash,\nnode commitment, and the user operations to be executed across multiple chains.\nQuoteResponse\n","title":"QuoteResponse","titles":["klaster-sdk","Interfaces"]},"239":{"href":"/reference#properties-10","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","QuoteResponse"]},"240":{"href":"/reference#commitment-1","html":"\n
\n
commitment: string
\n
\n
The cryptographic commitment generated by the Klaster node.\nThis commitment guarantees the execution of the quoted interchain transaction.
\n","isPage":false,"text":"\n\ncommitment: string\n\nThe cryptographic commitment generated by the Klaster node.\nThis commitment guarantees the execution of the quoted interchain transaction.\n","title":"commitment","titles":["klaster-sdk","Interfaces","QuoteResponse","Properties"]},"241":{"href":"/reference#defined-in-58","html":"\n
The hash of the Klaster Interchain Transaction. This serves\nas a unique identifier for the entire interchain operation.
\n","isPage":false,"text":"\n\nitxHash: `0x${string}`\n\nThe hash of the Klaster Interchain Transaction. This serves\nas a unique identifier for the entire interchain operation.\n","title":"itxHash","titles":["klaster-sdk","Interfaces","QuoteResponse","Properties"]},"243":{"href":"/reference#defined-in-59","html":"\n
The address of the Klaster node that has returned the quote and\ncommitted itself to executing the interchain transaction.
\n","isPage":false,"text":"\n\nnode: `0x${string}`\n\nThe address of the Klaster node that has returned the quote and\ncommitted itself to executing the interchain transaction.\n","title":"node","titles":["klaster-sdk","Interfaces","QuoteResponse","Properties"]},"245":{"href":"/reference#defined-in-60","html":"\n
Contains information about the payment for the\ntransaction, including the token to be used and the chain on which the payment will occur.
\n","isPage":false,"text":"\n\npaymentInfo: ApiPaymentData\n\nContains information about the payment for the\ntransaction, including the token to be used and the chain on which the payment will occur.\n","title":"paymentInfo","titles":["klaster-sdk","Interfaces","QuoteResponse","Properties"]},"247":{"href":"/reference#defined-in-61","html":"\n
An array of all UserOperations across all chains that\nthe node has committed to executing as part of this interchain transaction. Each UserOp\nrepresents a specific action on a particular blockchain within the interchain transaction.
\n","isPage":false,"text":"\n\nuserOps: ERC4337UserOp[]\n\nAn array of all UserOperations across all chains that\nthe node has committed to executing as part of this interchain transaction. Each UserOp\nrepresents a specific action on a particular blockchain within the interchain transaction.\n","title":"userOps","titles":["klaster-sdk","Interfaces","QuoteResponse","Properties"]},"249":{"href":"/reference#defined-in-62","html":"\n
Represents a raw transaction as expected by the execute and batchExecute functions\nof smart contract wallets compliant with the ERC-4337 standard.\nThis interface defines the structure for a single transaction to be executed\nas part of a user operation in account abstraction.
\n
RawTransaction
\n","isPage":false,"text":"\nRepresents a raw transaction as expected by the execute and batchExecute functions\nof smart contract wallets compliant with the ERC-4337 standard.\nThis interface defines the structure for a single transaction to be executed\nas part of a user operation in account abstraction.\nRawTransaction\n","title":"RawTransaction","titles":["klaster-sdk","Interfaces"]},"251":{"href":"/reference#properties-11","html":"\n","isPage":false,"text":"\n","title":"Properties","titles":["klaster-sdk","Interfaces","RawTransaction"]},"252":{"href":"/reference#data","html":"\n
\n
data: string
\n
\n
The input data of the transaction, typically the encoded function\ncall for contract interactions. For simple value transfers, this can be an empty string.
\n","isPage":false,"text":"\n\ndata: string\n\nThe input data of the transaction, typically the encoded function\ncall for contract interactions. For simple value transfers, this can be an empty string.\n","title":"data","titles":["klaster-sdk","Interfaces","RawTransaction","Properties"]},"253":{"href":"/reference#defined-in-63","html":"\n
The maximum amount of gas that can be used for executing\nthis transaction, represented as a bigint. This helps prevent unexpectedly high gas costs.
\n","isPage":false,"text":"\n\ngasLimit: bigint\n\nThe maximum amount of gas that can be used for executing\nthis transaction, represented as a bigint. This helps prevent unexpectedly high gas costs.\n","title":"gasLimit","titles":["klaster-sdk","Interfaces","RawTransaction","Properties"]},"255":{"href":"/reference#defined-in-64","html":"\n
The recipient address of the transaction. This can be a contract\naddress for contract interactions or an EOA for simple transfers.
\n","isPage":false,"text":"\n\nto: `0x${string}`\n\nThe recipient address of the transaction. This can be a contract\naddress for contract interactions or an EOA for simple transfers.\n","title":"to","titles":["klaster-sdk","Interfaces","RawTransaction","Properties"]},"257":{"href":"/reference#defined-in-65","html":"\n
The amount of native currency (e.g., ETH) to be sent with the\ntransaction, represented as a bigint. Use 0n for transactions that don't transfer value.
\n","isPage":false,"text":"\n\nvalue: bigint\n\nThe amount of native currency (e.g., ETH) to be sent with the\ntransaction, represented as a bigint. Use 0n for transactions that don't transfer value.\n","title":"value","titles":["klaster-sdk","Interfaces","RawTransaction","Properties"]},"259":{"href":"/reference#defined-in-66","html":"\n
Represents the symbol of a payment token supported by the system.\nThese symbols correspond to various tokens\nthat can be used for payments across different blockchain networks.
\n","isPage":false,"text":"\n\nPaymentTokenSymbol: "ETH" | "WETH" | "LINK" | "USDC" | "wstETH" | "USDT" | "MATIC" | "WMATIC" | "stMATIC" | "AVAX" | "WAVAX" | "BNB" | "WBNB" | "axlUSDC" | "crUSDC" | "BSC-USD"\n\nRepresents the symbol of a payment token supported by the system.\nThese symbols correspond to various tokens\nthat can be used for payments across different blockchain networks.\n","title":"PaymentTokenSymbol","titles":["klaster-sdk","Type Aliases"]},"277":{"href":"/reference#defined-in-72","html":"\n
Builds a strategy for using tokens across multiple chains to satisfy a given amount.\nEnsures all tokens have the same number of decimals.
\n","isPage":false,"text":"\n\nbuildTokenStrategy(__namedParameters): Promise<TokenStrategy>\n\nBuilds a strategy for using tokens across multiple chains to satisfy a given amount.\nEnsures all tokens have the same number of decimals.\n","title":"buildTokenStrategy()","titles":["klaster-sdk","Functions"]},"280":{"href":"/reference#parameters-12","html":"\n
An array of StrategyItem objects, each containing a chainId and an amount to use from that chain.
\n
null if the total balance across all chains is insufficient to satisfy the requested amount.
\n
\n","isPage":false,"text":"\nPromise<TokenStrategy>\nA promise that resolves to either:\n\nAn array of StrategyItem objects, each containing a chainId and an amount to use from that chain.\nnull if the total balance across all chains is insufficient to satisfy the requested amount.\n\n","title":"Returns","titles":["klaster-sdk","Functions","buildTokenStrategy()"]},"282":{"href":"/reference#throws-8","html":"\n
Throws an error if:
\n
\n
There's an issue fetching balances or decimals
\n
The token addresses are invalid
\n
Tokens across different chains have different numbers of decimals
\n
\n","isPage":false,"text":"\nThrows an error if:\n\nThere's an issue fetching balances or decimals\nThe token addresses are invalid\nTokens across different chains have different numbers of decimals\n\n","title":"Throws","titles":["klaster-sdk","Functions","buildTokenStrategy()"]},"283":{"href":"/reference#example-13","html":"\n
Builds a transaction to transfer ERC20 tokens from an Externally Owned Account (EOA)\nto another account, typically a smart contract account.
\n
This function constructs a RawTransaction object that, when executed, will transfer\nthe specified amount of ERC20 tokens from the sending EOA to the recipient address.\nIt's commonly used to fund smart contract accounts with tokens.
\n","isPage":false,"text":"\n\nbuildTransferERC20FromEoaTx(params): RawTransaction\n\nBuilds a transaction to transfer ERC20 tokens from an Externally Owned Account (EOA)\nto another account, typically a smart contract account.\nThis function constructs a RawTransaction object that, when executed, will transfer\nthe specified amount of ERC20 tokens from the sending EOA to the recipient address.\nIt's commonly used to fund smart contract accounts with tokens.\n","title":"buildTransferERC20FromEoaTx()","titles":["klaster-sdk","Functions"]},"286":{"href":"/reference#parameters-13","html":"\n
• params
\n
The parameters for building the transaction.
\n
• params.amount: bigint
\n
The amount of tokens to transfer, in the token's smallest unit (e.g., wei for ETH-like tokens).
\n
• params.chainId: number
\n
The ID of the blockchain network where the transaction will be executed.
\n
• params.recipient: `0x${string}`
\n
The address of the account receiving the tokens.
\n
• params.token: `0x${string}`
\n
The address of the ERC20 token contract.
\n","isPage":false,"text":"\n• params\nThe parameters for building the transaction.\n• params.amount: bigint\nThe amount of tokens to transfer, in the token's smallest unit (e.g., wei for ETH-like tokens).\n• params.chainId: number\nThe ID of the blockchain network where the transaction will be executed.\n• params.recipient: `0x${string}`\nThe address of the account receiving the tokens.\n• params.token: `0x${string}`\nThe address of the ERC20 token contract.\n","title":"Parameters","titles":["klaster-sdk","Functions","buildTransferERC20FromEoaTx()"]},"287":{"href":"/reference#returns-17","html":"\n
A RawTransaction object ready to be signed and broadcasted.\nThe object includes:
\n
\n
to: The address of the ERC20 token contract.
\n
value: Always 0n for ERC20 transfers.
\n
data: The encoded function call data for the ERC20 'transfer' function.
\n
gasLimit: A predefined gas limit set to 55000 (adjust if necessary for different tokens or networks).
\n
\n","isPage":false,"text":"\nRawTransaction\nA RawTransaction object ready to be signed and broadcasted.\nThe object includes:\n\nto: The address of the ERC20 token contract.\nvalue: Always 0n for ERC20 transfers.\ndata: The encoded function call data for the ERC20 'transfer' function.\ngasLimit: A predefined gas limit set to 55000 (adjust if necessary for different tokens or networks).\n\n","title":"Returns","titles":["klaster-sdk","Functions","buildTransferERC20FromEoaTx()"]},"288":{"href":"/reference#example-14","html":"\n
const txParams = {\n recipient: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',\n amount: BigInt(1000000), // 1 USDC if USDC has 6 decimals\n chainId: 1,\n token: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48' // USDC on Ethereum mainnet\n};\nconst rawTx = buildTransferERC20FromEoaTx(txParams);\n// rawTx can now be signed and sent to the network
\n","isPage":false,"text":"\nconst txParams = {\n recipient: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e',\n amount: BigInt(1000000), // 1 USDC if USDC has 6 decimals\n chainId: 1,\n token: '0xA0b86991c6218b36c1d19D4a2e9Eb0cE3606eB48' // USDC on Ethereum mainnet\n};\nconst rawTx = buildTransferERC20FromEoaTx(txParams);\n// rawTx can now be signed and sent to the network\n","title":"Example","titles":["klaster-sdk","Functions","buildTransferERC20FromEoaTx()"]},"289":{"href":"/reference#defined-in-74","html":"\n
Creates a TokenMapping object from an array of TokenInfo objects.
\n
This function generates a mapping of chain IDs to token addresses, which is used\nin other Klaster SDK functions like getUnifiedBalance. It allows for easy\nspecification of token addresses across multiple chains.
\n","isPage":false,"text":"\n\ncreateTokenMapping(tokens): TokenMapping\n\nCreates a TokenMapping object from an array of TokenInfo objects.\nThis function generates a mapping of chain IDs to token addresses, which is used\nin other Klaster SDK functions like getUnifiedBalance. It allows for easy\nspecification of token addresses across multiple chains.\n","title":"createTokenMapping()","titles":["klaster-sdk","Functions"]},"291":{"href":"/reference#parameters-14","html":"\n
• tokens: TokenInfo[]
\n
An array of TokenInfo objects. Each TokenInfo should contain:
\n
\n
chain: The chain ID (number) where the token is deployed.
\n
address: The address (string) of the token contract on the specified chain.
\n
\n","isPage":false,"text":"\n• tokens: TokenInfo[]\nAn array of TokenInfo objects. Each TokenInfo should contain:\n\nchain: The chain ID (number) where the token is deployed.\naddress: The address (string) of the token contract on the specified chain.\n\n","title":"Parameters","titles":["klaster-sdk","Functions","createTokenMapping()"]},"292":{"href":"/reference#returns-18","html":"\n
TokenMapping
\n
An object where keys are chain IDs and values are token addresses.
\n","isPage":false,"text":"\nTokenMapping\nAn object where keys are chain IDs and values are token addresses.\n","title":"Returns","titles":["klaster-sdk","Functions","createTokenMapping()"]},"293":{"href":"/reference#throws-9","html":"\n
Throws an error if duplicate chain IDs are provided in the input array.
\n","isPage":false,"text":"\nThrows an error if duplicate chain IDs are provided in the input array.\n","title":"Throws","titles":["klaster-sdk","Functions","createTokenMapping()"]},"294":{"href":"/reference#example-15","html":"\n
import { createTokenMapping } from 'klaster-sdk';\n\n// Create a mapping for USDC across multiple chains\nconst usdcMapping = createTokenMapping([\n { chain: 1, address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' }, // Ethereum Mainnet\n { chain: 10, address: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85' }, // Optimism\n { chain: 137, address: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174' } // Polygon\n]);\n\nconsole.log(usdcMapping);\n// Output:\n// {\n// 1: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',\n// 10: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85',\n// 137: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174'\n// }\n\n// This mapping can then be used in other SDK functions:\nconst balance = await getUnifiedBalance({\n mapping: usdcMapping,\n address: '0x...',\n chainConfigs: [...]\n});
\n","isPage":false,"text":"\nimport { createTokenMapping } from 'klaster-sdk';\n \n// Create a mapping for USDC across multiple chains\nconst usdcMapping = createTokenMapping([\n { chain: 1, address: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48' }, // Ethereum Mainnet\n { chain: 10, address: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85' }, // Optimism\n { chain: 137, address: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174' } // Polygon\n]);\n \nconsole.log(usdcMapping);\n// Output:\n// {\n// 1: '0xa0b86991c6218b36c1d19d4a2e9eb0ce3606eb48',\n// 10: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85',\n// 137: '0x2791bca1f2de4661ed88a30c99a7a9449aa84174'\n// }\n \n// This mapping can then be used in other SDK functions:\nconst balance = await getUnifiedBalance({\n mapping: usdcMapping,\n address: '0x...',\n chainConfigs: [...]\n});\n","title":"Example","titles":["klaster-sdk","Functions","createTokenMapping()"]},"295":{"href":"/reference#see-8","html":"\n
For using the created mapping, see the documentation for getUnifiedBalance.
\n","isPage":false,"text":"\nFor using the created mapping, see the documentation for getUnifiedBalance.\n","title":"See","titles":["klaster-sdk","Functions","createTokenMapping()"]},"296":{"href":"/reference#defined-in-75","html":"\n
A syntactic helper for creating action objects in the Klaster SDK.
\n
This function combines an array of RawTransactions with a chain ID into an object.\nIt's used to provide a consistent coding style when working with actions in the Klaster SDK.
\n","isPage":false,"text":"\n\nencodeAction(txs, chainId): object\n\nA syntactic helper for creating action objects in the Klaster SDK.\nThis function combines an array of RawTransactions with a chain ID into an object.\nIt's used to provide a consistent coding style when working with actions in the Klaster SDK.\n","title":"encodeAction()","titles":["klaster-sdk","Functions"]},"298":{"href":"/reference#parameters-15","html":"\n
\n","isPage":false,"text":"\n• txs: RawTransaction[]\nAn array of RawTransaction objects.\n• chainId: number\nThe ID of the blockchain for this action.\n","title":"Parameters","titles":["klaster-sdk","Functions","encodeAction()"]},"299":{"href":"/reference#returns-19","html":"\n
object
\n
An object containing the transactions and chain ID.
\n","isPage":false,"text":"\nobject\nAn object containing the transactions and chain ID.\n","title":"Returns","titles":["klaster-sdk","Functions","encodeAction()"]},"300":{"href":"/reference#chainid-4","html":"\n
Encodes bridging data from a token strategy for multiple chains.
\n
This function takes a token strategy (typically generated by buildTokenStrategy) and encodes\nthe necessary data for bridging tokens from multiple source chains to a single destination chain.\nIt uses the provided encodeSingleBridgeData function to generate the specific bridging data for each chain.
\n","isPage":false,"text":"\n\nencodeBridgingDataFromStrategy(options): Promise<object[]>\n\nEncodes bridging data from a token strategy for multiple chains.\nThis function takes a token strategy (typically generated by buildTokenStrategy) and encodes\nthe necessary data for bridging tokens from multiple source chains to a single destination chain.\nIt uses the provided encodeSingleBridgeData function to generate the specific bridging data for each chain.\n","title":"encodeBridgingDataFromStrategy()","titles":["klaster-sdk","Functions"]},"305":{"href":"/reference#parameters-16","html":"\n
• options: EncodeBridgingDataFromStrategyOptions
\n
The options for encoding bridging data.
\n","isPage":false,"text":"\n• options: EncodeBridgingDataFromStrategyOptions\nThe options for encoding bridging data.\n","title":"Parameters","titles":["klaster-sdk","Functions","encodeBridgingDataFromStrategy()"]},"306":{"href":"/reference#returns-20","html":"\n
Promise<object[]>
\n
A promise that resolves to an array of RawTransaction objects,\neach containing the encoded bridging data for a single chain in the strategy.
\n","isPage":false,"text":"\nPromise<object[]>\nA promise that resolves to an array of RawTransaction objects,\neach containing the encoded bridging data for a single chain in the strategy.\n","title":"Returns","titles":["klaster-sdk","Functions","encodeBridgingDataFromStrategy()"]},"307":{"href":"/reference#throws-10","html":"\n
Throws an error if the strategy is null, indicating no feasible strategy exists,\nor if a token address is not found for a chain in the strategy.
\n","isPage":false,"text":"\nThrows an error if the strategy is null, indicating no feasible strategy exists,\nor if a token address is not found for a chain in the strategy.\n","title":"Throws","titles":["klaster-sdk","Functions","encodeBridgingDataFromStrategy()"]},"308":{"href":"/reference#example-17","html":"\n
const tokenMapping = {\n 10: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85', // USDC on Optimism\n 8453: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913' // USDC on Base\n};\n\nconst strategy = [\n { chainId: 10, amount: BigInt("15000") },\n { chainId: 8453, amount: BigInt("5000") }\n];\n\nconst encodeSingleBridgeData = async (\n tokenAddress,\n sourceChainId,\n destinationChainId,\n amount,\n multichainAddress\n) => {\n // Implement your specific bridge encoding logic here\n // This is just a placeholder implementation\n return {\n to: multichainAddress,\n value: //\n gasLimit: //\n data: // Data encoded by your bridge encoding implementation\n };\n};\n\ntry {\n const bridgingData = await encodeBridgingDataFromStrategy({\n strategy,\n tokenMapping,\n destinationChainId: 1, // Ethereum mainnet\n multichainAddress: '0x1234567890123456789012345678901234567890',\n encodeSingleBridgeData\n });\n\n console.log(bridgingData);\n // Output will be an array of RawTransaction objects, one for each chain in the strategy\n} catch (error) {\n console.error('Error encoding bridging data:', error.message);\n}
\n","isPage":false,"text":"\nconst tokenMapping = {\n 10: '0x0b2C639c533813f4Aa9D7837CAf62653d097Ff85', // USDC on Optimism\n 8453: '0x833589fCD6eDb6E08f4c7C32D4f71b54bdA02913' // USDC on Base\n};\n \nconst strategy = [\n { chainId: 10, amount: BigInt("15000") },\n { chainId: 8453, amount: BigInt("5000") }\n];\n \nconst encodeSingleBridgeData = async (\n tokenAddress,\n sourceChainId,\n destinationChainId,\n amount,\n multichainAddress\n) => {\n // Implement your specific bridge encoding logic here\n // This is just a placeholder implementation\n return {\n to: multichainAddress,\n value: //\n gasLimit: //\n data: // Data encoded by your bridge encoding implementation\n };\n};\n \ntry {\n const bridgingData = await encodeBridgingDataFromStrategy({\n strategy,\n tokenMapping,\n destinationChainId: 1, // Ethereum mainnet\n multichainAddress: '0x1234567890123456789012345678901234567890',\n encodeSingleBridgeData\n });\n \n console.log(bridgingData);\n // Output will be an array of RawTransaction objects, one for each chain in the strategy\n} catch (error) {\n console.error('Error encoding bridging data:', error.message);\n}\n","title":"Example","titles":["klaster-sdk","Functions","encodeBridgingDataFromStrategy()"]},"309":{"href":"/reference#defined-in-77","html":"\n
A syntactic helper for creating InterchainTransaction objects in the Klaster SDK.
\n
This function returns its input unchanged. Its purpose is to provide a consistent\ncoding style when working with the Klaster SDK, allowing for a more fluent and\nreadable way of creating InterchainTransaction objects.
\n","isPage":false,"text":"\n\nencodeItx(itx): InterchainTransaction\n\nA syntactic helper for creating InterchainTransaction objects in the Klaster SDK.\nThis function returns its input unchanged. Its purpose is to provide a consistent\ncoding style when working with the Klaster SDK, allowing for a more fluent and\nreadable way of creating InterchainTransaction objects.\n","title":"encodeItx()","titles":["klaster-sdk","Functions"]},"311":{"href":"/reference#parameters-17","html":"\n
\n","isPage":false,"text":"\n• itx: InterchainTransaction\nThe InterchainTransaction object to be "encoded".\n","title":"Parameters","titles":["klaster-sdk","Functions","encodeItx()"]},"312":{"href":"/reference#returns-21","html":"\n
\n","isPage":false,"text":"\nInterchainTransaction\nThe same InterchainTransaction object, unchanged.\n","title":"Returns","titles":["klaster-sdk","Functions","encodeItx()"]},"313":{"href":"/reference#example-18","html":"\n
A syntactic helper for working with RawTransaction objects in the Klaster SDK.
\n
This function returns its input unchanged. Its purpose is to provide a consistent\ncoding style when working with the Klaster SDK, allowing for a more fluent way\nof handling RawTransaction objects.
\n","isPage":false,"text":"\n\nencodeTx(tx): RawTransaction\n\nA syntactic helper for working with RawTransaction objects in the Klaster SDK.\nThis function returns its input unchanged. Its purpose is to provide a consistent\ncoding style when working with the Klaster SDK, allowing for a more fluent way\nof handling RawTransaction objects.\n","title":"encodeTx()","titles":["klaster-sdk","Functions"]},"316":{"href":"/reference#parameters-18","html":"\n
\n","isPage":false,"text":"\n• tx: RawTransaction\nThe RawTransaction object to be "encoded".\n","title":"Parameters","titles":["klaster-sdk","Functions","encodeTx()"]},"317":{"href":"/reference#returns-22","html":"\n
\n","isPage":false,"text":"\nRawTransaction\nThe same RawTransaction object, unchanged.\n","title":"Returns","titles":["klaster-sdk","Functions","encodeTx()"]},"318":{"href":"/reference#example-19","html":"\n
Fetches the primary Ethereum address from an injected web3 wallet provider (e.g., MetaMask).
\n
This function creates a wallet client using the viem library and the injected Ethereum provider.\nIt then retrieves the list of addresses associated with the wallet and returns the first address.
\n","isPage":false,"text":"\n\nfetchInjectedAddress(): Promise<Address | undefined>\n\nFetches the primary Ethereum address from an injected web3 wallet provider (e.g., MetaMask).\nThis function creates a wallet client using the viem library and the injected Ethereum provider.\nIt then retrieves the list of addresses associated with the wallet and returns the first address.\n","title":"fetchInjectedAddress()","titles":["klaster-sdk","Functions"]},"321":{"href":"/reference#returns-23","html":"\n
Promise<Address | undefined>
\n
A promise that resolves to:
\n
\n
The primary Ethereum address (type Address) if available.
\n
undefined if no addresses are associated with the wallet or if the wallet is locked.
\n
\n","isPage":false,"text":"\nPromise<Address | undefined>\nA promise that resolves to:\n\nThe primary Ethereum address (type Address) if available.\nundefined if no addresses are associated with the wallet or if the wallet is locked.\n\n","title":"Returns","titles":["klaster-sdk","Functions","fetchInjectedAddress()"]},"322":{"href":"/reference#async-6","html":"\n","isPage":false,"text":"\n","title":"Async","titles":["klaster-sdk","Functions","fetchInjectedAddress()"]},"323":{"href":"/reference#function","html":"\n
No injected Ethereum provider is detected (i.e., window.ethereum is undefined).
\n
The user denies permission to access their accounts.
\n
There's an issue connecting to the Ethereum network.
\n
\n","isPage":false,"text":"\nThrows an error if:\n\nNo injected Ethereum provider is detected (i.e., window.ethereum is undefined).\nThe user denies permission to access their accounts.\nThere's an issue connecting to the Ethereum network.\n\n","title":"Throws","titles":["klaster-sdk","Functions","fetchInjectedAddress()"]},"325":{"href":"/reference#example-20","html":"\n
try {\n const address = await fetchInjectedAddress();\n if (address) {\n console.log('Connected wallet address:', address);\n } else {\n console.log('No wallet address found or wallet is locked');\n }\n} catch (error) {\n console.error('Error fetching wallet address:', error);\n}
\n","isPage":false,"text":"\ntry {\n const address = await fetchInjectedAddress();\n if (address) {\n console.log('Connected wallet address:', address);\n } else {\n console.log('No wallet address found or wallet is locked');\n }\n} catch (error) {\n console.error('Error fetching wallet address:', error);\n}\n","title":"Example","titles":["klaster-sdk","Functions","fetchInjectedAddress()"]},"326":{"href":"/reference#requires","html":"\n
This function is designed to work in a browser environment and requires\na web3-enabled browser with an injected Ethereum provider (like MetaMask).\nIt will not work in a Node.js environment or browsers without an Ethereum wallet.
\n","isPage":false,"text":"\nThis function is designed to work in a browser environment and requires\na web3-enabled browser with an injected Ethereum provider (like MetaMask).\nIt will not work in a Node.js environment or browsers without an Ethereum wallet.\n","title":"Note","titles":["klaster-sdk","Functions","fetchInjectedAddress()"]},"329":{"href":"/reference#defined-in-80","html":"\n
Fetches and aggregates token balances across multiple blockchains for a given address.
\n","isPage":false,"text":"\n\ngetUnifiedBalance(params): Promise<UnifiedBalanceResult>\n\nFetches and aggregates token balances across multiple blockchains for a given address.\n","title":"getUnifiedBalance()","titles":["klaster-sdk","Functions"]},"331":{"href":"/reference#parameters-19","html":"\n
• params
\n
The parameters for the function.
\n
• params.address: `0x${string}`
\n
The address for which to fetch the token balances.
\n
• params.chainConfigs: ChainConfig[]
\n
An array of objects, each containing a chainId and an rpcUrl.
\n
• params.mapping: TokenMapping
\n
An object mapping chain IDs to token addresses.
\n","isPage":false,"text":"\n• params\nThe parameters for the function.\n• params.address: `0x${string}`\nThe address for which to fetch the token balances.\n• params.chainConfigs: ChainConfig[]\nAn array of objects, each containing a chainId and an rpcUrl.\n• params.mapping: TokenMapping\nAn object mapping chain IDs to token addresses.\n","title":"Parameters","titles":["klaster-sdk","Functions","getUnifiedBalance()"]},"332":{"href":"/reference#returns-24","html":"\n
Promise<UnifiedBalanceResult>
\n
A promise that resolves to an object containing:
\n
\n
amount: The total balance across all chains as a bigint.
\n
decimals: The number of decimals for the token.
\n
\n","isPage":false,"text":"\nPromise<UnifiedBalanceResult>\nA promise that resolves to an object containing:\n\namount: The total balance across all chains as a bigint.\ndecimals: The number of decimals for the token.\n\n","title":"Returns","titles":["klaster-sdk","Functions","getUnifiedBalance()"]},"333":{"href":"/reference#throws-12","html":"\n
Throws an error in the following cases:
\n
\n
If tokens across different chains have different numbers of decimals.
\n
If no valid tokens are found in the mapping.
\n
\n","isPage":false,"text":"\nThrows an error in the following cases:\n\nIf tokens across different chains have different numbers of decimals.\nIf no valid tokens are found in the mapping.\n\n","title":"Throws","titles":["klaster-sdk","Functions","getUnifiedBalance()"]},"334":{"href":"/reference#example-21","html":"\n
Initializes the Klaster SDK with the provided configuration.
\n
This function serves as the entry point for using the Klaster SDK. It creates and\nreturns a new instance of the KlasterSDK class, configured with the provided options.
\n","isPage":false,"text":"\n\ninitKlaster(config): KlasterSDK\n\nInitializes the Klaster SDK with the provided configuration.\nThis function serves as the entry point for using the Klaster SDK. It creates and\nreturns a new instance of the KlasterSDK class, configured with the provided options.\n","title":"initKlaster()","titles":["klaster-sdk","Functions"]},"337":{"href":"/reference#parameters-20","html":"\n
\n","isPage":false,"text":"\n• config: Config\nThe configuration options for the Klaster SDK.\n","title":"Parameters","titles":["klaster-sdk","Functions","initKlaster()"]},"338":{"href":"/reference#returns-25","html":"\n
\n","isPage":false,"text":"\nKlasterSDK\nA new instance of the KlasterSDK, ready for use.\n","title":"Returns","titles":["klaster-sdk","Functions","initKlaster()"]},"339":{"href":"/reference#example-22","html":"\n
import { initKlaster, Config } from 'klaster-sdk';\n\nconst config: Config = {\n nodeUrl: 'https://klaster-node.example.com',\n masterAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e'\n};\n\nconst klasterSDK = initKlaster(config);\n\n// Now you can use klasterSDK to interact with the Klaster ecosystem
\n","isPage":false,"text":"\nimport { initKlaster, Config } from 'klaster-sdk';\n \nconst config: Config = {\n nodeUrl: 'https://klaster-node.example.com',\n masterAddress: '0x742d35Cc6634C0532925a3b844Bc454e4438f44e'\n};\n \nconst klasterSDK = initKlaster(config);\n \n// Now you can use klasterSDK to interact with the Klaster ecosystem\n","title":"Example","titles":["klaster-sdk","Functions","initKlaster()"]},"340":{"href":"/reference#throws-13","html":"\n
Throws an error if the provided configuration is invalid or if\nthe SDK fails to initialize for any reason.
\n","isPage":false,"text":"\nThrows an error if the provided configuration is invalid or if\nthe SDK fails to initialize for any reason.\n","title":"Throws","titles":["klaster-sdk","Functions","initKlaster()"]},"341":{"href":"/reference#defined-in-82","html":"\n
Resolves a payment token based on its symbol and the chain ID.
\n","isPage":false,"text":"\n\nresolveToken(symbol, chainId): TokenInfo\n\nResolves a payment token based on its symbol and the chain ID.\n","title":"resolveToken()","titles":["klaster-sdk","Functions"]},"343":{"href":"/reference#parameters-21","html":"\n
\n","isPage":false,"text":"\n• symbol: PaymentTokenSymbol\nThe symbol of the payment token to resolve.\n• chainId: number\nThe ID of the blockchain network.\n","title":"Parameters","titles":["klaster-sdk","Functions","resolveToken()"]},"344":{"href":"/reference#returns-26","html":"\n
TokenInfo
\n
A promise that resolves to the token information.
\n","isPage":false,"text":"\nTokenInfo\nA promise that resolves to the token information.\n","title":"Returns","titles":["klaster-sdk","Functions","resolveToken()"]},"345":{"href":"/reference#throws-14","html":"\n
If the token cannot be resolved for the given chain ID.
\n","isPage":false,"text":"\nIf the token cannot be resolved for the given chain ID.\n","title":"Throws","titles":["klaster-sdk","Functions","resolveToken()"]},"346":{"href":"/reference#defined-in-83","html":"\n
Signs a message using the injected Ethereum provider (e.g., MetaMask) in the browser.
\n
This function uses the personal_sign method to create a signature with the user's\nEthereum account. It requires a web3-enabled browser with an injected Ethereum provider.
\n","isPage":false,"text":"\n\nsignWithInjectedWallet(address, message): Promise<string>\n\nSigns a message using the injected Ethereum provider (e.g., MetaMask) in the browser.\nThis function uses the personal_sign method to create a signature with the user's\nEthereum account. It requires a web3-enabled browser with an injected Ethereum provider.\n","title":"signWithInjectedWallet()","titles":["klaster-sdk","Functions"]},"348":{"href":"/reference#parameters-22","html":"\n
• address: `0x${string}`
\n
The Ethereum address to sign the message with. This should\nbe an address that the user controls in their injected wallet.
\n
• message: string
\n
The message to be signed. This will be converted to UTF-8\nand prefixed with "\\x19Ethereum Signed Message:\\n" before signing.
\n","isPage":false,"text":"\n• address: `0x${string}`\nThe Ethereum address to sign the message with. This should\nbe an address that the user controls in their injected wallet.\n• message: string\nThe message to be signed. This will be converted to UTF-8\nand prefixed with "\\x19Ethereum Signed Message:\\n" before signing.\n","title":"Parameters","titles":["klaster-sdk","Functions","signWithInjectedWallet()"]},"349":{"href":"/reference#returns-27","html":"\n
Promise<string>
\n
A promise that resolves to the signature string.\nThe signature is in hexadecimal format.
\n","isPage":false,"text":"\nPromise<string>\nA promise that resolves to the signature string.\nThe signature is in hexadecimal format.\n","title":"Returns","titles":["klaster-sdk","Functions","signWithInjectedWallet()"]},"350":{"href":"/reference#throws-15","html":"\n
Throws an error if the injected Ethereum provider is not available,\nif the user rejects the signature request, or if there's any other\nissue during the signing process.
\n","isPage":false,"text":"\nThrows an error if the injected Ethereum provider is not available,\nif the user rejects the signature request, or if there's any other\nissue during the signing process.\n","title":"Throws","titles":["klaster-sdk","Functions","signWithInjectedWallet()"]},"351":{"href":"/reference#example-23","html":"\n
This function is designed to work in a browser environment and requires\na web3-enabled browser with an injected Ethereum provider (like MetaMask).\nIt will not work in a Node.js environment or browsers without an Ethereum wallet.
\n","isPage":false,"text":"\nThis function is designed to work in a browser environment and requires\na web3-enabled browser with an injected Ethereum provider (like MetaMask).\nIt will not work in a Node.js environment or browsers without an Ethereum wallet.\n","title":"Note","titles":["klaster-sdk","Functions","signWithInjectedWallet()"]},"353":{"href":"/reference#defined-in-84","html":"\n
This will be a zero-to-hero introduction to the Klaster SDK. Here, we will explore all of the main concepts pertaining to\nthe development of chain abstracted apps and flows.
\n
In this tutorial, you will get all the required steps to build a chain abstracted application. If you're interested in what\na chain abstracted application looks like, check out our video on AbstraktAAVE - a chain abstracted implementation of AAVE.
\n\n","isPage":true,"text":"\n\nThis will be a zero-to-hero introduction to the Klaster SDK. Here, we will explore all of the main concepts pertaining to\nthe development of chain abstracted apps and flows.\nIn this tutorial, you will get all the required steps to build a chain abstracted application. If you're interested in what\na chain abstracted application looks like, check out our video on AbstraktAAVE - a chain abstracted implementation of AAVE.\n\nYou can also use the app yourself at:\nhttps://demo-aave.klaster.io\nWhile Klaster works with all major Ethereum SDK providers, such as ethers.js, web3.js and viem - it works best when used\nin conjuction with viem.\n","title":"Zero to Hero Guide: Building a Chain Abstracted Application","titles":[]},"357":{"href":"/zero-to-hero-klaster-guide#install-klaster-and-viem","html":"\n
npm i klaster-sdk viem
\n","isPage":false,"text":"\nnpm i klaster-sdk viem\n","title":"Install Klaster and Viem","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"358":{"href":"/zero-to-hero-klaster-guide#create-a-signer-object","html":"\n
Usign viem, create a signer object - which will be used to sign transactions.
\n
import {\n buildMultichainReadonlyClient,\n buildRpcInfo,\n initKlaster,\n klasterNodeHost,\n loadBiconomyV2Account,\n} from "klaster-sdk";\nimport { createWalletClient, custom, http } from "viem";\nimport { generatePrivateKey, privateKeyToAccount } from "viem/accounts";\nimport { arbitrum, base, optimism, polygon, scroll } from "viem/chains";\n\n// When in browser environment create a signer\n// which uses the injected wallet (e.g. MetaMask, Rabby, ...)\nconst signer = createWalletClient({\n transport: custom((window as any).ethereum),\n});\n\n// When in non-browser environment you can use private key\n// to sign messages.\nconst privateKey = generatePrivateKey();\nconst signerAccount = privateKeyToAccount(privateKey);\nconst signer = createWalletClient({\n transport: http(),\n});
\n","isPage":false,"text":"\nUsign viem, create a signer object - which will be used to sign transactions.\nimport {\n buildMultichainReadonlyClient,\n buildRpcInfo,\n initKlaster,\n klasterNodeHost,\n loadBiconomyV2Account,\n} from "klaster-sdk";\nimport { createWalletClient, custom, http } from "viem";\nimport { generatePrivateKey, privateKeyToAccount } from "viem/accounts";\nimport { arbitrum, base, optimism, polygon, scroll } from "viem/chains";\n \n// When in browser environment create a signer\n// which uses the injected wallet (e.g. MetaMask, Rabby, ...)\nconst signer = createWalletClient({\n transport: custom((window as any).ethereum),\n});\n \n// When in non-browser environment you can use private key\n// to sign messages.\nconst privateKey = generatePrivateKey();\nconst signerAccount = privateKeyToAccount(privateKey);\nconst signer = createWalletClient({\n transport: http(),\n});\n","title":"Create a signer object","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"359":{"href":"/zero-to-hero-klaster-guide#initialize-klaster-sdk","html":"\n
To initialize the Klaster SDK, you must provide it with the following information:
\n
\n
Klaster Node URL
\n
ERC4337 Account Provider
\n
\n
You can use multiple account providers (check documentation reference for supported account providers). In this tutorial,\nwe will use the Biconomy account provider:
\n
// Fetch the address from viem. You might need to call signer.requestAddresses()\n// depending on your injected Web3 provider.\nconst [address] = await signer.getAddresses();\n\n// Initializing the Klaster SDK with Biconomy as the smart contract account\n// provider.\nconst klaster = await initKlaster({\n accountInitData: loadBiconomyV2Account({\n owner: address, // Fetch\n }),\n nodeUrl: klasterNodeHost.default,\n});
\n","isPage":false,"text":"\nTo initialize the Klaster SDK, you must provide it with the following information:\n\nKlaster Node URL\nERC4337 Account Provider\n\nYou can use multiple account providers (check documentation reference for supported account providers). In this tutorial,\nwe will use the Biconomy account provider:\n// Fetch the address from viem. You might need to call signer.requestAddresses()\n// depending on your injected Web3 provider.\nconst [address] = await signer.getAddresses();\n \n// Initializing the Klaster SDK with Biconomy as the smart contract account\n// provider.\nconst klaster = await initKlaster({\n accountInitData: loadBiconomyV2Account({\n owner: address, // Fetch\n }),\n nodeUrl: klasterNodeHost.default,\n});\n","title":"Initialize Klaster SDK","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"360":{"href":"/zero-to-hero-klaster-guide#initialize-a-multichain-readonly-rpc-client","html":"\n
In order to achieve certain functionality for chain abstraction, such as getting a unified token balance across chains\nor encoding bridging actions - you will need to have a public RPC for every chain you wish to interact with. Do note\nthat this is only a public RPC, you don't need to have the abilty to write to chain - as this is handled by the Klaster nodes.
\n\n
// Build a multichain client by calling the buildMultichainReadonlyClient\n// and passing the buildRpcInfo objects into the array\nconst mcClient = buildMultichainReadonlyClient([\n buildRpcInfo(optimism.id, "<op-rpc-url>"),\n buildRpcInfo(base.id, "<base-rpc-url>"),\n]);
\n
Since this is a tutorial project, we can use the viem default RPCs.
\n\n
// This is a hacky way of doing this, just to get you quickly started\n// with the tutorial. Please don't initialize the client like this in\n// production projects.\nconst mcClient = buildMultichainReadonlyClient(\n [optimism, base, polygon, arbitrum, scroll].map((x) => {\n return {\n chainId: x.id,\n rpcUrl: x.rpcUrls.default.http[0],\n };\n })\n);
\n","isPage":false,"text":"\nIn order to achieve certain functionality for chain abstraction, such as getting a unified token balance across chains\nor encoding bridging actions - you will need to have a public RPC for every chain you wish to interact with. Do note\nthat this is only a public RPC, you don't need to have the abilty to write to chain - as this is handled by the Klaster nodes.\nThis tutorial project will be using Optimism, Base, Polygon, Arbitrum and Scroll as the underlying blockchains\n// Build a multichain client by calling the buildMultichainReadonlyClient\n// and passing the buildRpcInfo objects into the array\nconst mcClient = buildMultichainReadonlyClient([\n buildRpcInfo(optimism.id, "<op-rpc-url>"),\n buildRpcInfo(base.id, "<base-rpc-url>"),\n]);\nSince this is a tutorial project, we can use the viem default RPCs.\nThis is highly discouraged in a production project. Use private RPCs when deploying to production.\n// This is a hacky way of doing this, just to get you quickly started\n// with the tutorial. Please don't initialize the client like this in\n// production projects.\nconst mcClient = buildMultichainReadonlyClient(\n [optimism, base, polygon, arbitrum, scroll].map((x) => {\n return {\n chainId: x.id,\n rpcUrl: x.rpcUrls.default.http[0],\n };\n })\n);\n","title":"Initialize a multichain readonly RPC client","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"361":{"href":"/zero-to-hero-klaster-guide#map-token-deployments-across-multiple-blockchains","html":"\n
As well as working with the Multichain RPC provider, the Klaster SDK works best when provided with MultichainTokenMapping\nobjects. These objects represent mappings of tokens you consider equivalent across various blockchains. One example would\nbe USDC - which is widely deployed by Circle across multiple blockchains.
\n
You can use the Circle Token Deployments to see which address the canonical\nversion of which token is deployed to.
\n
However, nothing limits you to using only offical token deployments. If you consider the axlUSDC to be equivalent to cannonical\nUSDC - you can simply map them together and the Klaster SDK will treat them as if they're the same token. You can provide one\ntoken per chain.
\n\n
// Build a token mapping by calling the buildTokenMapping function and passing instances of\n// deployment object into the array. These represent the chainId → address mappings.\nconst mcUSDC = buildTokenMapping([\n deployment(optimism.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(base.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n]);
\n
The Klaster SDK exposes some multichain tokens by default. These are mcUSDC and mcUSDT. They are available to you\nas exported constants. They expose deployments on a lot of blockchains so it's important that you truncate them before\nusage only to blockchains which you use.
\n\n
// A lambda which intersects the chains available in the\n// token mapping with the ones available in the multichain client.\n// In general, you should not be using this in a production project.\n// Instead, you should create your own tokenmappings by the method shown\n// above.\nconst intersectTokenAndClients = (\n token: MultichainTokenMapping,\n mcClient: MultichainClient\n) => {\n return token.filter((deployment) =>\n mcClient.chainsRpcInfo\n .map((info) => info.chainId)\n .includes(deployment.chainId)\n );\n};\n\n// Store the intersection of the Klaster provided token and the chains your project is using.\nconst mUSDC = intersectTokenAndClients(mcUSDC, mcClient);
\n","isPage":false,"text":"\nAs well as working with the Multichain RPC provider, the Klaster SDK works best when provided with MultichainTokenMapping\nobjects. These objects represent mappings of tokens you consider equivalent across various blockchains. One example would\nbe USDC - which is widely deployed by Circle across multiple blockchains.\nYou can use the Circle Token Deployments to see which address the canonical\nversion of which token is deployed to.\nHowever, nothing limits you to using only offical token deployments. If you consider the axlUSDC to be equivalent to cannonical\nUSDC - you can simply map them together and the Klaster SDK will treat them as if they're the same token. You can provide one\ntoken per chain.\nOne hard requirement for all tokens in a single mapping is that they all must have the same number of decimals.\n// Build a token mapping by calling the buildTokenMapping function and passing instances of\n// deployment object into the array. These represent the chainId → address mappings.\nconst mcUSDC = buildTokenMapping([\n deployment(optimism.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(base.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n]);\nThe Klaster SDK exposes some multichain tokens by default. These are mcUSDC and mcUSDT. They are available to you\nas exported constants. They expose deployments on a lot of blockchains so it's important that you truncate them before\nusage only to blockchains which you use.\nThe default Klaster exported tokens might not fit your project. Please double check the documentation to learn which tokens the Klaster SDK considers to be cannonical and idential to eachother.\n// A lambda which intersects the chains available in the\n// token mapping with the ones available in the multichain client.\n// In general, you should not be using this in a production project.\n// Instead, you should create your own tokenmappings by the method shown\n// above.\nconst intersectTokenAndClients = (\n token: MultichainTokenMapping,\n mcClient: MultichainClient\n) => {\n return token.filter((deployment) =>\n mcClient.chainsRpcInfo\n .map((info) => info.chainId)\n .includes(deployment.chainId)\n );\n};\n \n// Store the intersection of the Klaster provided token and the chains your project is using.\nconst mUSDC = intersectTokenAndClients(mcUSDC, mcClient);\n","title":"Map token deployments across multiple blockchains","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"362":{"href":"/zero-to-hero-klaster-guide#create-a-bridging-plugin","html":"\n
Klaster introduces a concept of Bridging Plugigs. Yoa can think of them as templates, which the Klaster SDK\nuses to encode and execute a bridging action whenever it needs to. Since Klaster is an agnostic protocol and SDK,\nevery function that might require bridging can accept the function of type BridgePlugin as input.
\n
For this tutorial we have prepared a LiFi bridging plugin example.
\n
But in general, what is a Klaster Bridging Plugin?
\n
It's a simple function which provides a data object containing things needed to encode a brdiging transaction such as\nsourceChainId, destinationChainId, sourceToken, destinationToken, amount, etc... and expects an object in return\nwhich tells the Klaster SDK i) which transactions need to be executed ii) how much will be received on destination.
\n
For this tutorial, we can create a LiFi bridging plugin, which will leverage LiFi Aggregation to get us the fastest route\navailable for every transfer. Since Klaster is primarily a user experience oriented framework, the speed of execution is\nparamout!
It's as simple as that! Now - you Klaster SDK has LiFi support 🥳
\n","isPage":false,"text":"\nKlaster introduces a concept of Bridging Plugigs. Yoa can think of them as templates, which the Klaster SDK\nuses to encode and execute a bridging action whenever it needs to. Since Klaster is an agnostic protocol and SDK,\nevery function that might require bridging can accept the function of type BridgePlugin as input.\nFor this tutorial we have prepared a LiFi bridging plugin example.\nBut in general, what is a Klaster Bridging Plugin?\nIt's a simple function which provides a data object containing things needed to encode a brdiging transaction such as\nsourceChainId, destinationChainId, sourceToken, destinationToken, amount, etc... and expects an object in return\nwhich tells the Klaster SDK i) which transactions need to be executed ii) how much will be received on destination.\nFor this tutorial, we can create a LiFi bridging plugin, which will leverage LiFi Aggregation to get us the fastest route\navailable for every transfer. Since Klaster is primarily a user experience oriented framework, the speed of execution is\nparamout!\nFirst, install the LiFi SDK\nnpm i @lifi/sdk\nThen write the plugin:\nimport { getRoutes, RoutesRequest } from "@lifi/sdk";\nimport { Address, batchTx, BridgePlugin, rawTx } from "klaster-sdk";\nimport { Hex } from "viem";\n \nexport const liFiBrigePlugin: BridgePlugin = async (data) => {\n \n const routesRequest: RoutesRequest = {\n fromChainId: data.sourceChainId,\n toChainId: data.destinationChainId,\n fromTokenAddress: data.sourceToken,\n toTokenAddress: data.destinationToken,\n fromAmount: data.amount.toString(),\n options: {\n order: "FASTEST",\n },\n };\n \n const result = await getRoutes(routesRequest);\n const route = result.routes.at(0)\n \n if (!route) {\n throw Error('...');\n }\n \n const routeSteps = route.steps.map(step => {\n if(!step.transactionRequest) { throw Error('...') }\n const { to, gasLimit, data, value} = step.transactionRequest\n if(!to || !gasLimit || !data || !value) { throw Error('...') } \n return rawTx({\n to: to as Address,\n gasLimit: BigInt(gasLimit),\n data: data as Hex,\n value: BigInt(value)\n })\n })\n \n return {\n receivedOnDestination: BigInt(route.toAmountMin),\n txBatch: batchTx(data.sourceChainId, routeSteps)\n }\n};\nIt's as simple as that! Now - you Klaster SDK has LiFi support 🥳\n","title":"Create a Bridging Plugin","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"363":{"href":"/zero-to-hero-klaster-guide#fetching-a-unified-balance","html":"\n
In order to achieve true chain abstraction, the user should be presented with a unified ERC20 balance across\nall of the chains that the app is using.
\n
For example, in the Klaster AbstraktAAVE Demo app, you can see the unified balance:\n
\n
and then the breakdown per chain:
\n\n
In order to achieve this, you can use the Multichain token and Multichain RPC objects from earlier:
\n
const uBalance = await mcClient.getUnifiedErc20Balance({\n tokenMapping: mUSDC,\n account: klaster.account,\n});\n\n// Total balance across all used chains, expressed in base units\nuBalance.balance;\n\n// Breakdown of balances across each separate blockchain\nuBalance.breakdown;\n\n// The decimals of the token. In order for tokenMapping to be created,\n// all instances must have the same number of decimals.\nuBalance.decimals;
\n","isPage":false,"text":"\nIn order to achieve true chain abstraction, the user should be presented with a unified ERC20 balance across\nall of the chains that the app is using.\nFor example, in the Klaster AbstraktAAVE Demo app, you can see the unified balance:\n\nand then the breakdown per chain:\n\nIn order to achieve this, you can use the Multichain token and Multichain RPC objects from earlier:\nconst uBalance = await mcClient.getUnifiedErc20Balance({\n tokenMapping: mUSDC,\n account: klaster.account,\n});\n \n// Total balance across all used chains, expressed in base units\nuBalance.balance;\n \n// Breakdown of balances across each separate blockchain\nuBalance.breakdown;\n \n// The decimals of the token. In order for tokenMapping to be created,\n// all instances must have the same number of decimals.\nuBalance.decimals;\n","title":"Fetching a Unified Balance","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"364":{"href":"/zero-to-hero-klaster-guide#encoding-the-bridging--execution-actions","html":"\n
Okay! Finally our entire setup is complete. This is most definitely one of the more complex cases which Klaster\ncovers - a fully chain abstracted app, so the amount of setup is a bit higher. For simpler cases, such as a unified\ndeposit address of one-click checkout flows, a lot of these steps can be omitted.
\n
So, for this demo, we'll say that we want to send the amount we receive from bridging on the destination chain to some other address. This in an intentionally simplistic case, and it could have been solved by just using LiFi bridge function, but for the purposes of this tutorial it just demonstrates how Klaster works.
\n
","isPage":false,"text":"\nOkay! Finally our entire setup is complete. This is most definitely one of the more complex cases which Klaster\ncovers - a fully chain abstracted app, so the amount of setup is a bit higher. For simpler cases, such as a unified\ndeposit address of one-click checkout flows, a lot of these steps can be omitted.\nSo, for this demo, we'll say that we want to send the amount we receive from bridging on the destination chain to some other address. This in an intentionally simplistic case, and it could have been solved by just using LiFi bridge function, but for the purposes of this tutorial it just demonstrates how Klaster works.\n","title":"Encoding the bridging + execution actions","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"365":{"href":"/zero-to-hero-klaster-guide#encoding-the-bridging-operations","html":"
In your own project, you'll be able to encode arbitrarily complex actions across any number of blockchains. For example, in\nthe AAVE case, after a token lands on the destination chain, the supply function is called on the AAVE Smart Contract
Anyways let's continue. The SDK is intelligent enough to calculate on its own the required steps to get some amount of\ntokens on some desired destination chain.
Let's assume a following situation. You have:
\n
10 USDC on Polygon
\n
20 USDC on Optimism
\n
12 USDC on Scroll
\n
and you're trying to call some function on Base with 35 USDC while having zero USDC on Base. What the Klaster\nSDK will do is calculate a route for bridging your tokens:
e.g. take 20 USDC (total balance) from OP, 12 USDC (total balance) from Scroll and 3 USDC (+ additional for what was lost to\nbridge fees when bridging from chains where you took the total balance) from Polygon and bridge it all to Base. Once the funds\narrive to Base - call the desired function there!
For most cases, the SDK will be able to calculate te exact routes for bridging to get your desired outcome. If this is not\npossible, you can always encode them yourself.
The function that does the calculations is called encodeBridgingOps. Simply pass all of the required parameters and as\nan output you'll get a series of steps (EVM Transactions) to be executed on one or more blockchains to get your desired amount\nonto your desired destinationChain
","isPage":false,"text":"In your own project, you'll be able to encode arbitrarily complex actions across any number of blockchains. For example, in\nthe AAVE case, after a token lands on the destination chain, the supply function is called on the AAVE Smart ContractAnyways let's continue. The SDK is intelligent enough to calculate on its own the required steps to get some amount of\ntokens on some desired destination chain.Let's assume a following situation. You have:\n10 USDC on Polygon\n20 USDC on Optimism\n12 USDC on Scroll\nand you're trying to call some function on Base with 35 USDC while having zero USDC on Base. What the Klaster\nSDK will do is calculate a route for bridging your tokens:e.g. take 20 USDC (total balance) from OP, 12 USDC (total balance) from Scroll and 3 USDC (+ additional for what was lost to\nbridge fees when bridging from chains where you took the total balance) from Polygon and bridge it all to Base. Once the funds\narrive to Base - call the desired function there!For most cases, the SDK will be able to calculate te exact routes for bridging to get your desired outcome. If this is not\npossible, you can always encode them yourself.The function that does the calculations is called encodeBridgingOps. Simply pass all of the required parameters and as\nan output you'll get a series of steps (EVM Transactions) to be executed on one or more blockchains to get your desired amount\nonto your desired destinationChainconst bridgingOps = await encodeBridgingOps({\n tokenMapping: mUSDC,\n account: klaster.account,\n amount: uBalance.balance - parseUnits("1", uBalance.decimals), // Don't send entire balance\n bridgePlugin: liFiBrigePlugin,\n client: mcClient,\n destinationChainId: base.id,\n unifiedBalance: uBalance,\n});","title":"Encoding the bridging operations","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Encoding the bridging + execution actions"]},"366":{"href":"/zero-to-hero-klaster-guide#encoding-the-desired-action","html":"
Now we can encode the transfer call on the destination chain. This is done with the call to the Klaster SDK rawTx helper\nfunction:
Note one thing here, the usage of bridgingOps.totalReceivedOnDestination - this is a variable which has calculated\nhow much assets will be available on the destination chain after bridging has completed. If you had zero on the destination\nthen this will be the total amount available. If you had > 0 available then the total available will be
totalReceivedOnDestination + balanceOnDestination
","isPage":false,"text":"Now we can encode the transfer call on the destination chain. This is done with the call to the Klaster SDK rawTx helper\nfunction:const sendERC20Op = rawTx({\n gasLimit: 100000n,\n to: destChainTokenAddress,\n data: encodeFunctionData({\n abi: erc20Abi,\n functionName: "transfer",\n args: [recipient, bridgingOps.totalReceivedOnDestination],\n }),\n});Note one thing here, the usage of bridgingOps.totalReceivedOnDestination - this is a variable which has calculated\nhow much assets will be available on the destination chain after bridging has completed. If you had zero on the destination\nthen this will be the total amount available. If you had > 0 available then the total available will betotalReceivedOnDestination + balanceOnDestination","title":"Encoding the desired action","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Encoding the bridging + execution actions"]},"367":{"href":"/zero-to-hero-klaster-guide#creating-an-interchain-transaction","html":"
Now, we can use all of the transactions we have created to encode an interchain transaction or an iTx. An iTx is an\nobject containing one or more transactions across one or more blockchains. In our case, the iTx will contain
\n
All necessary approve + bridging transactions calculated by the encodeBridgingOps function - on the source chain(s)
\n
The send transaction on the destination chain
\n
To create an iTx, we use the helper function buildItx.
const iTx = buildItx({\n // BridgingOPs + Execution on the destination chain\n // added as steps to the iTx\n steps: bridgingOps.steps.concat(singleTx(destinationChainId, sendERC20Op)),\n // Klaster works with cross-chain gas abstraction. This instructs the Klaster\n // nodes to take USDC on Optimism as tx fee payment.\n feeTx: klaster.encodePaymentFee(optimism.id, "USDC"),\n});
\n","isPage":false,"text":"Now, we can use all of the transactions we have created to encode an interchain transaction or an iTx. An iTx is an\nobject containing one or more transactions across one or more blockchains. In our case, the iTx will contain\nAll necessary approve + bridging transactions calculated by the encodeBridgingOps function - on the source chain(s)\nThe send transaction on the destination chain\nTo create an iTx, we use the helper function buildItx.const iTx = buildItx({\n // BridgingOPs + Execution on the destination chain\n // added as steps to the iTx\n steps: bridgingOps.steps.concat(singleTx(destinationChainId, sendERC20Op)),\n // Klaster works with cross-chain gas abstraction. This instructs the Klaster\n // nodes to take USDC on Optimism as tx fee payment.\n feeTx: klaster.encodePaymentFee(optimism.id, "USDC"),\n});\n","title":"Creating an Interchain Transaction","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Encoding the bridging + execution actions"]},"368":{"href":"/zero-to-hero-klaster-guide#executing-the-interchain-transaction","html":"\n
Now that we have everything we need encoded in the iTx object, we can send it to the Klaster network for execution.
\n
","isPage":false,"text":"\nNow that we have everything we need encoded in the iTx object, we can send it to the Klaster network for execution.\n","title":"Executing the Interchain Transaction","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"369":{"href":"/zero-to-hero-klaster-guide#getting-a-quote","html":"
Executing an Interchain transaction is a two-step process. The first part of the process is getting a quote from the\nKlaster Network. The quote will tell you how much the node wants to charge for the execution of the transaction in the\ntoken which you set in the feeTx field when building an iTx.
To get the quote, call:
const quote = await klaster.getQuote(iTx);\n\n// The amount of USD that the node is willing to execute the iTx for\nquote.tokenValue;
","isPage":false,"text":"Executing an Interchain transaction is a two-step process. The first part of the process is getting a quote from the\nKlaster Network. The quote will tell you how much the node wants to charge for the execution of the transaction in the\ntoken which you set in the feeTx field when building an iTx.To get the quote, call:const quote = await klaster.getQuote(iTx);\n \n// The amount of USD that the node is willing to execute the iTx for\nquote.tokenValue;","title":"Getting a quote","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Executing the Interchain Transaction"]},"370":{"href":"/zero-to-hero-klaster-guide#signing-the-quote","html":"
If you're satisfied with the quoted execution price, prompt the user to sign the iTx hash. You can get the hash from the\nquote object. By signing the iTx hash you're giving the Klaster Nodes approval to execute the transactions within the\niTx. This is cryptographically verified by smart contracts on every chain where the data is being executed - so the nodes\nare unable to execute anything without the explicit approval from the user.
","isPage":false,"text":"If you're satisfied with the quoted execution price, prompt the user to sign the iTx hash. You can get the hash from the\nquote object. By signing the iTx hash you're giving the Klaster Nodes approval to execute the transactions within the\niTx. This is cryptographically verified by smart contracts on every chain where the data is being executed - so the nodes\nare unable to execute anything without the explicit approval from the user.If you're using viem - make sure to use the message → raw to sign. If you pass the message directly into the message object,\nyou will get an error that you're using the wrong signature.const signed = await signer.signMessage({\n message: {\n raw: quote.itxHash,\n },\n account: signerAccount,\n});","title":"Signing the quote","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Executing the Interchain Transaction"]},"371":{"href":"/zero-to-hero-klaster-guide#sending-the-itx-for-execution","html":"
After the user has signed the iTx hash, pass the QuoteResponse together with the signed hash to the execute function.
const result = await klaster.execute(quote, signed)
","isPage":false,"text":"After the user has signed the iTx hash, pass the QuoteResponse together with the signed hash to the execute function.const result = await klaster.execute(quote, signed)","title":"Sending the iTx for execution","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Executing the Interchain Transaction"]},"372":{"href":"/zero-to-hero-klaster-guide#tracking-the-execution","html":"
After the iTx has been received by the Klaster Network, you will receive a result from the execute function. In that result,\nyou will have the iTx hash. You can go to the Klaster Explorer to check the status of the hash:
https://explorer.klaster.io/details/{iTxHash}
\n","isPage":false,"text":"After the iTx has been received by the Klaster Network, you will receive a result from the execute function. In that result,\nyou will have the iTx hash. You can go to the Klaster Explorer to check the status of the hash:https://explorer.klaster.io/details/{iTxHash}\n","title":"Tracking the execution","titles":["Zero to Hero Guide: Building a Chain Abstracted Application","Executing the Interchain Transaction"]},"373":{"href":"/zero-to-hero-klaster-guide#conclusion","html":"\n
Congrats - you have sucessfully executed your first Interchain Transaction and prepared your project for chain abstraction.
","isPage":false,"text":"\nCongrats - you have sucessfully executed your first Interchain Transaction and prepared your project for chain abstraction.","title":"Conclusion","titles":["Zero to Hero Guide: Building a Chain Abstracted Application"]},"374":{"href":"/accounts/biconomy#initializing-a-biconomy-account","html":"\n
To initialize a Biconomy account, you use the following function
","isPage":true,"text":"\nTo initialize a Biconomy account, you use the following function\nconst klaster = await initKlaster({\n accountInitData: loadBiconomyV2Account({\n owner: '0xEOA_OWNER',\n }),\n nodeUrl: 'https://node-url',\n});","title":"Initializing a Biconomy account","titles":[null]},"375":{"href":"/accounts/safe#initializing-a-safe-account","html":"\n
To initialize the Klaster SDK with a Safe account you can use the following function:
\n","isPage":true,"text":"\nTo initialize the Klaster SDK with a Safe account you can use the following function:\nconst klaster = await initKlaster({\n accountInitData: loadSafeV141Account({\n signers: ["0xSIGNER"],\n threshold: 1n,\n }),\n nodeUrl: "https://<node-url>",\n});\nThe signers information is used to derive the account address. If the signers change, you should keep using the initial\nsigners information which was used to create the Safe account.","title":"Initializing a Safe Account","titles":[null]},"376":{"href":"/concepts/bridge-plugins#bridging-plugins","html":"\n
The Klaster SDK enables chain abstracted user experiences by performing the bridging of assets in the background. In order to be\nable to perform bridging actions, the Klaster SDK needs to know how to encode them.
\n
The Klaster Bridging Plugins rely on the fact that most bridges are triggered by a simple call to a smart contract on some\nchain - and as such, can be ecnoded as a series of transactions (e.g. Bridge + Approve). The bridging plugin then\nreturns a series of calls to the blockchain (to be encoded into an InterchainTransaction) and how much the user will\nend up with at the destination chain (after all the bridging and gas fees are paid - this is usually availble information\nbefore bridging.)
\n
In order to do so, you pass it an instance of a BridgePlugin. A BridgePlugin is a simple function of type:
\n
type BridgePlugin = (BridgePluginParams) => BridgePluginResult\n\n// The BridgePluginParams expose all of the information\n// required to encode a bridging action using some existing\n// bridging provider\ntype BridgePluginParams = {\n sourceChainId: number,\n destinationChainId: number,\n account: MutlichainAccount,\n sourceToken: Address,\n destinationToken: Address,\n amount: bigint\n}\n\n// BridgePluginResult tells the Klaster SDK \n// - how much will be received on the destination chain post bridign\n// - which transactions need to be executed to trigger the bridge\ntype BridgePluginResult = {\n receivedOnDesitnation: bigint,\n steps: TxBatch[]\n}
export const acrossBridgePlugin: BridgePlugin = async (data) => {\n // Call Across API to get the bridging fee data, as well as all the other required\n // inforation about the bridging procedure\n const feesResponse = await getAcrossSuggestedFees(data);\n\n // Calculate the amount which you will receive on the destination chain from the\n // response given by the Across API\n const outputAmount = data.amount - BigInt(feesResponse.totalRelayFee.total);\n\n // Encode a transcation approving the Across pool contract to get the\n // required amount of ERC20 tokens from your accoount.\n const acrossApproveTx = encodeApproveTx({\n tokenAddress: data.sourceToken,\n amount: outputAmount,\n recipient: feesResponse.spokePoolAddress,\n });\n\n // Encode a transaction to call the Across Pool\n const acrossCallTx = rawTx({\n to: feesResponse.spokePoolAddress,\n data: encodeAcrossCallData(data, feesResponse),\n gasLimit: BigInt(250000),\n });\n\n return {\n // The total amount which the user will receive on the destination chain. This is\n // used by the SDK to calculate how much funds it can count on after bridging.\n receivedOnDestination: outputAmount,\n // The sequence of transactions which need to be executed in order to start the brdging\n // procedure.\n txBatch: batchTx(data.sourceChainId, [acrossApproveTx, acrossCallTx]),\n };\n};\n
","isPage":true,"text":"\nThe Klaster SDK enables chain abstracted user experiences by performing the bridging of assets in the background. In order to be\nable to perform bridging actions, the Klaster SDK needs to know how to encode them.\nThe Klaster Bridging Plugins rely on the fact that most bridges are triggered by a simple call to a smart contract on some\nchain - and as such, can be ecnoded as a series of transactions (e.g. Bridge + Approve). The bridging plugin then\nreturns a series of calls to the blockchain (to be encoded into an InterchainTransaction) and how much the user will\nend up with at the destination chain (after all the bridging and gas fees are paid - this is usually availble information\nbefore bridging.)\nIn order to do so, you pass it an instance of a BridgePlugin. A BridgePlugin is a simple function of type:\ntype BridgePlugin = (BridgePluginParams) => BridgePluginResult\n \n// The BridgePluginParams expose all of the information\n// required to encode a bridging action using some existing\n// bridging provider\ntype BridgePluginParams = {\n sourceChainId: number,\n destinationChainId: number,\n account: MutlichainAccount,\n sourceToken: Address,\n destinationToken: Address,\n amount: bigint\n}\n \n// BridgePluginResult tells the Klaster SDK \n// - how much will be received on the destination chain post bridign\n// - which transactions need to be executed to trigger the bridge\ntype BridgePluginResult = {\n receivedOnDesitnation: bigint,\n steps: TxBatch[]\n}\nAn example of a BridgePlugin for Across\nexport const acrossBridgePlugin: BridgePlugin = async (data) => {\n // Call Across API to get the bridging fee data, as well as all the other required\n // inforation about the bridging procedure\n const feesResponse = await getAcrossSuggestedFees(data);\n \n // Calculate the amount which you will receive on the destination chain from the\n // response given by the Across API\n const outputAmount = data.amount - BigInt(feesResponse.totalRelayFee.total);\n \n // Encode a transcation approving the Across pool contract to get the\n // required amount of ERC20 tokens from your accoount.\n const acrossApproveTx = encodeApproveTx({\n tokenAddress: data.sourceToken,\n amount: outputAmount,\n recipient: feesResponse.spokePoolAddress,\n });\n \n // Encode a transaction to call the Across Pool\n const acrossCallTx = rawTx({\n to: feesResponse.spokePoolAddress,\n data: encodeAcrossCallData(data, feesResponse),\n gasLimit: BigInt(250000),\n });\n \n return {\n // The total amount which the user will receive on the destination chain. This is\n // used by the SDK to calculate how much funds it can count on after bridging.\n receivedOnDestination: outputAmount,\n // The sequence of transactions which need to be executed in order to start the brdging\n // procedure.\n txBatch: batchTx(data.sourceChainId, [acrossApproveTx, acrossCallTx]),\n };\n};\n ","title":"Bridging Plugins","titles":[null]},"377":{"href":"/concepts/interchain-transaction#interchain-transaction","html":"\n
The InterchainTransaction or iTx is the beating heart of the Klaster protocol. It's an object containing two or more\ntransactions to be executed on one or more blockchain networks - encoded in a merkle tree.
\n","isPage":true,"text":"\nThe InterchainTransaction or iTx is the beating heart of the Klaster protocol. It's an object containing two or more\ntransactions to be executed on one or more blockchain networks - encoded in a merkle tree.\n","title":"Interchain Transaction","titles":[null]},"378":{"href":"/concepts/interchain-transaction#details","html":"\n
\n
\n
The leafs of the tree are the transactions contained in the interchain transaction. They define all of the actions which can be\nexecuted by the iTx.
\n
\n
\n
The root hash of the merkle tree is called the Interchain Transcation Hash
\n
\n
\n
Every iTx is uniquely defined by it's iTx hash
\n
\n
\n
In order to execute the iTx, the user signs the iTx hash with their private key and sends the signed hash, togehter with\nthe list of the leaf transactions - to a Klaster Node.
\n
\n
\n
The first transaction in the iTx is always the transaction fee payment transaction.
\n
\n
\n
","isPage":false,"text":"\n\n\nThe leafs of the tree are the transactions contained in the interchain transaction. They define all of the actions which can be\nexecuted by the iTx.\n\n\nThe root hash of the merkle tree is called the Interchain Transcation Hash\n\n\nEvery iTx is uniquely defined by it's iTx hash\n\n\nIn order to execute the iTx, the user signs the iTx hash with their private key and sends the signed hash, togehter with\nthe list of the leaf transactions - to a Klaster Node.\n\n\nThe first transaction in the iTx is always the transaction fee payment transaction.\n\n\n","title":"Details","titles":[null,"Interchain Transaction",null]},"379":{"href":"/concepts/multichain-account#multichain-smart-contract-account","html":"\n
The Klaster account system is built on top of ERC4337 Account Abstraction. Account wise, the main difference between\nKlaster and other solutions is that Klaster tightly couples deployed Smart Contract Account instances across multiple\nblockchains.
\n
Simply put, this means that these accounts, deployed on multiple blockchain networks - have the ability to act as a single\naccount.
\n
Klaster uses the CREATE2 opcode when deploying accounts. However, some blockchains - notably the zkSync ecosystem - don't\nderive the accounts the same way that Ethereum does.
\n
That's why the Klaster SDK uses an internal object called the MutltichainAccount, which holds all of the address deployments\nfor all of the blockchains.
\n
Beyond holding the address deployments, the MultichainAccount object holds the initData - which was the data used to derive\nthe account.
\n","isPage":true,"text":"\nThe Klaster account system is built on top of ERC4337 Account Abstraction. Account wise, the main difference between\nKlaster and other solutions is that Klaster tightly couples deployed Smart Contract Account instances across multiple\nblockchains.\nSimply put, this means that these accounts, deployed on multiple blockchain networks - have the ability to act as a single\naccount.\nKlaster uses the CREATE2 opcode when deploying accounts. However, some blockchains - notably the zkSync ecosystem - don't\nderive the accounts the same way that Ethereum does.\nThat's why the Klaster SDK uses an internal object called the MutltichainAccount, which holds all of the address deployments\nfor all of the blockchains.\nBeyond holding the address deployments, the MultichainAccount object holds the initData - which was the data used to derive\nthe account.\n","title":"Multichain Smart Contract Account","titles":[null]},"380":{"href":"/concepts/multichain-account#deriving-accounts","html":"\n
Several key pieces of information determine which account address will be derived when loading a smart contract account:
Factory data (derived from account init parameters, specific for each vendor)
\n
Account blockchain (e.g. ETH, Base, OP, Polygon, AVAX all derive the same, while e.g. zkSync and Abstract derive differently)
\n\n
The Klaster Node exposes this as a utility endpoint https://<node-url>/v2/address/{VENDOR_ID}/0xFACTORY_DATA
\n
The vendor id is a Klaster defined string, definining every supported account vendor (e.g. SAFE_V141 or BICO_V2), while\nfactory data is encoded for every vendor, according to their standard.
\n
e.g. for Safe, the FactoryData is derived from address[] signers, uint256 threshold, bytes32 salt, while for Biconomy -\nit's derived from address owner, bytes32 salt
","isPage":false,"text":"\nSeveral key pieces of information determine which account address will be derived when loading a smart contract account:\n\nAccount vendor (e.g. Biconomy, Safe, ZeroDev, ...)\nFactory data (derived from account init parameters, specific for each vendor)\nAccount blockchain (e.g. ETH, Base, OP, Polygon, AVAX all derive the same, while e.g. zkSync and Abstract derive differently)\n\nThe Klaster Node exposes this as a utility endpoint https://<node-url>/v2/address/{VENDOR_ID}/0xFACTORY_DATA\nThe vendor id is a Klaster defined string, definining every supported account vendor (e.g. SAFE_V141 or BICO_V2), while\nfactory data is encoded for every vendor, according to their standard.\ne.g. for Safe, the FactoryData is derived from address[] signers, uint256 threshold, bytes32 salt, while for Biconomy -\nit's derived from address owner, bytes32 salt","title":"Deriving accounts","titles":[null,"Multichain Smart Contract Account"]},"381":{"href":"/concepts/multichain-public-client#multichain-public-client","html":"\n
In order to achieve certain functionalities, such as fetching a unified multichain balance or encoding bridging strategies - the\nKlaster SDK must have the ability to read from the blockchains with which your application is interacting with.
\n
To achieve this, the Klaster SDK counts on the MultichainClient object. This object is a simple mapping of rpcUrl to\nchainId. As of version 0.5.2 - the MultichainClient exposes a utility function to read the unified balance of an\nERC20 token (provided by a TokenMapping object).
\n
A multichain public client can be easily built by leveraging the buildMultichainReadonlyClient function.
\n
const mcClient = buildMultichainReadonlyClient([\n buildRpcInfo(optimism.id, 'https://optimism-rpc'),\n buildRpcInfo(base.id, 'https://base-rpc'),\n //... add the rest of the chains\n])
","isPage":true,"text":"\nIn order to achieve certain functionalities, such as fetching a unified multichain balance or encoding bridging strategies - the\nKlaster SDK must have the ability to read from the blockchains with which your application is interacting with.\nTo achieve this, the Klaster SDK counts on the MultichainClient object. This object is a simple mapping of rpcUrl to\nchainId. As of version 0.5.2 - the MultichainClient exposes a utility function to read the unified balance of an\nERC20 token (provided by a TokenMapping object).\nA multichain public client can be easily built by leveraging the buildMultichainReadonlyClient function.\nconst mcClient = buildMultichainReadonlyClient([\n buildRpcInfo(optimism.id, 'https://optimism-rpc'),\n buildRpcInfo(base.id, 'https://base-rpc'),\n //... add the rest of the chains\n])","title":"Multichain Public Client","titles":[null]},"382":{"href":"/concepts/multichain-token-mapping#multichain-token-mapping","html":"\n
Klaster is a multichain first framework, and as such - all objects within it are made to work in a multichain environment. One\nof the core aspects of working with blockchain system is interacting with tokens. In the EVM ecosystem, these are primarily\nERC20 or ERC721 tokens (with certain subtypes which also comply to these two interfaces).
\n
Since the Klaster SDK wishes to achieve things like unified balances, which can be spent from any chain to any chain - we must\nprovide it with a way to map like tokens to eachother.
\n
This is achieved through the use of a simple MultichainTokenMapping object, which simply maps the addresses of a desired token\nacross multiple chains. The way you build a multichain token mapping is the following:
\n
const mcUSDC = buildTokenMapping([\n deployment(optimism.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(base.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(arbitrum.id, "0x<USDC-ON-ARBITRUM-ADDRESS>"),\n //... add rest of the chains\n]);
\n
Then, in a function such as getUnifiedBalance or encodeBridgingData - you simply pass the mcUSDC object and the SDK knows\nhow to handle the token on mutliple blockchains.
\n","isPage":true,"text":"\nKlaster is a multichain first framework, and as such - all objects within it are made to work in a multichain environment. One\nof the core aspects of working with blockchain system is interacting with tokens. In the EVM ecosystem, these are primarily\nERC20 or ERC721 tokens (with certain subtypes which also comply to these two interfaces).\nSince the Klaster SDK wishes to achieve things like unified balances, which can be spent from any chain to any chain - we must\nprovide it with a way to map like tokens to eachother.\nThis is achieved through the use of a simple MultichainTokenMapping object, which simply maps the addresses of a desired token\nacross multiple chains. The way you build a multichain token mapping is the following:\nconst mcUSDC = buildTokenMapping([\n deployment(optimism.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(base.id, "0x<USDC-ON-OPTIMISM-ADDRESS>"),\n deployment(arbitrum.id, "0x<USDC-ON-ARBITRUM-ADDRESS>"),\n //... add rest of the chains\n]);\nThen, in a function such as getUnifiedBalance or encodeBridgingData - you simply pass the mcUSDC object and the SDK knows\nhow to handle the token on mutliple blockchains.\n","title":"Multichain Token Mapping","titles":[null]},"383":{"href":"/concepts/multichain-token-mapping#notes","html":"\n
Some of the things to note with the MultichainTokenMapping object:
\n
\n
Only one token deployment is supported per chain
\n
All deployments must have the same number of decimals
\n
","isPage":false,"text":"\nSome of the things to note with the MultichainTokenMapping object:\n\nOnly one token deployment is supported per chain\nAll deployments must have the same number of decimals\n","title":"Notes","titles":[null,"Multichain Token Mapping"]},"384":{"href":"/concepts/unified-balance#unified-balance","html":"\n
A UnifiedBalance object contains the balance of some ERC20 token across multiple blockchains. It can be fetched by calling\nthe getUnifiedErc20Balance function on the MultichainClient object.
\n
type UnifiedBalance = {\n balance: bigint // total balance across all blockchains\n decimals: number // the number of decimals of the token for which the unified balance is fetched\n breakdown: { // breakdown of balances across all queried blockchains\n balance: bigint,\n chainId: number\n }[]\n}
","isPage":true,"text":"\nA UnifiedBalance object contains the balance of some ERC20 token across multiple blockchains. It can be fetched by calling\nthe getUnifiedErc20Balance function on the MultichainClient object.\ntype UnifiedBalance = {\n balance: bigint // total balance across all blockchains\n decimals: number // the number of decimals of the token for which the unified balance is fetched\n breakdown: { // breakdown of balances across all queried blockchains\n balance: bigint,\n chainId: number\n }[]\n}","title":"Unified Balance","titles":[null]},"385":{"href":"/quickstart/gas-abstraction#gas-abstraction-quickstart","html":"\n
![\"Ca\"/](\"https://i.imgur.com/vHWji39.jpeg\")
![\"Unified\"/](\"https://i.imgur.com/IK1gRRt.png\")
![](\"https://i.imgur.com/PJneGgj.png\")
\n![\"iTx\"/](\"https://i.imgur.com/Uqun3NL.png\")