full-functions-list.md

description
All available functions of ZkBobClient object

Full Functions List

{% hint style="info" %} Functions available in the account-less mode are marked with [*] {% endhint %}

Initializing and Сonfiguring

• create
• login
• logout
• [*] currentPool
• [*] availabePools
• switchToPool
• hasAccount
• [*] getProverMode
• [*] setProverMode

Balances and History

• getTotalBalance
• getBalances
• getOptimisticTotalBalance
• giftCardBalance
• getAllHistory
• getPendingDDs
• getComplianceReport

Addresses

• generateAddress
• generateUniversalAddress
• generateAddressForSeed
• verifyShieldedAddress
• isMyAddress
• addressInfo

Transactions

• deposit
• depositEphemeral
• directDeposit
• transferMulti
• withdrawMulti
• redeemGiftCard
• waitJobsTxHashes
• waitJobTxHash
• isReadyToTransact
• waitReadyToTransact

Preparing Transactions

• [*] getRelayerFee
• [*] atomicTxFee
• feeEstimate
• directDepositFee
• [*] maxSupportedTokenSwap
• [*] minTxAmount
• calcMaxAvailableTransfer
• getTransactionParts
• [*] getLimits

Ephemeral Addresses

• getEphemeralAddress
• getNonusedEphemeralIndex
• getUsedEphemeralAddresses
• getEphemeralAddressInTxCount
• getEphemeralAddressOutTxCount
• getEphemeralAddressPrivateKey

Forced Exit

• isAccountDead
• isForcedExitSupported
• forcedExitState
• activeForcedExit
• executedForcedExit
• availableFundsToForcedExit
• requestForcedExit
• executeForcedExit
• cancelForcedExit

Misc

• [*] shieldedAmountToWei
• [*] weiToShieldedAmount
• [*] networkName
• [*] poolId
• [*] getRelayerState
• [*] getRelayerOptimisticState
• [*] getPoolState
• getLocalState
• rollbackState
• cleanState
• updateState
• [*] getLibraryVersion
• [*] getRelayerVersion
• [*] getProverVersion
• [*] codeForGiftCard
• [*] giftCardFromCode
• getStatFullSync
• getAverageTimePerTx
• directDepositContract
• [*] tokenSellerContract
• [*] getState
• [*] getProgress