LogoLogo
zkBob AppLinks & Resources
  • 🦹zkBob Overview
    • zkBob
    • Basic Concepts
      • Getting Started
      • Open-Source and Decentralized
      • Multichain Deployment
      • Usage Statistics
      • Use Cases
        • Employee Salary
        • Vendor Purchasing
      • Development Timeline
      • zk Privacy Solution Comparison
    • zkBob Pools
      • USDC Pool on Polygon (sunsets January 31, 2025)
      • USDC Pool on Optimism
      • ETH Pool on Optimism
      • USDT Pool on Tron (sunsets Oct 29, 2024)
    • Fees
      • Unspent note handling
    • Deposit & Withdrawal Limits
    • Compliance & Security
      • TRM Labs Integration
    • Conferences, Workshops, Videos
      • International Videos
    • Governance
    • BOB Stablecoin
    • zkBob FAQ
  • πŸ¦Έβ€β™‚οΈzkBob Application
    • UI Overview
    • Account Creation
      • Login to an existing account
      • Lost Password
      • Metamask / Web3 Wallet Warning
    • Deposits
    • Transfers
      • Multitransfers
    • Withdrawals
      • Native Token Conversion
    • Generate a Receiving Address
    • Optional KYC
    • zkBob Direct Deposits
    • Support ID
    • Payment Links
    • Integrated Services
    • Multilingual support
      • PortuguΓͺs
      • Русский
      • δΈ­ζ–‡
  • πŸ‘©β€βš•οΈTechnical Implementation
    • zkBob Application Overview
    • Deployed Contracts
    • Smart Contracts
      • zkBob Pool Contract
        • Transaction Calldata
      • Bob Token Contract
      • Verifier contracts
      • Operator Manager Contract
        • Mutable Operator Manager
      • Voucher (XP) Token Contract
    • Accounts and Notes
      • Accounts
      • Notes
    • Relayer Node
      • Relayer Operations
      • Optimistic State
      • REST API
    • zkBob Keys
      • Address derivation
      • Ephemeral keys
    • zkSNARKs & Circuits
      • Transfer verifier circuit overview
    • zkBob Merkle Tree
      • The Poseidon Hash
    • Elliptic Curve Cryptography
    • Transaction Overview
      • Common Structure
      • Memo Block
        • Memo Block Encryption
      • Transaction Types
      • Nullifiers
      • Signing a Transaction
      • The Transaction Lifecycle
    • Client Library SDK
      • Configuration
        • Initializing the client
          • Client Configuration
        • Attaching a User Account
          • Account Configuration
        • Switching Between Pools
      • Account-less Mode Operations
        • Converting Token Amounts
        • Transaction Fees
        • Transaction Constraints
        • Using the Delegated Prover
        • Getting the State
        • Gift Cards
        • Client Library Status
        • Helpers
        • Versioning
      • Full Mode Operations
        • Balances and History
        • Shielded Addresses
        • Account State
        • Fee Estimations
        • Transaction Configuration
        • Sending Transactions
        • Transaction Maintenance
        • Direct Deposits
        • Gift Cards Maintenance
        • Ephemeral Deposits
        • Forced Exit
        • Other Routines
      • Common Types
      • Full Functions List
      • Utilities
  • πŸ‘©β€πŸ«Deployment
    • Trusted Setup Ceremony
    • Contract Deployment
    • Relayer Subsystem
  • πŸ‘·β€β™‚οΈRoadmap
    • On the Roadmap
    • Exploratory Features
      • XP (Experience Points)
        • XP-based Auctions
      • Multi-chain Custom Rollup Deployment
      • Round-robin Operator Manager
      • Compounding
  • πŸ§‘β€πŸ’»Jobs
    • Zero-Knowledge Researcher & Protocol Developer
  • 🧩Resources
    • Visual Assets
    • Hackathons
      • zkBob Cloud
    • Release Notes
      • October 11, 2023
      • July 13, 2023
      • June 13, 2023
      • March 28, 2023
      • January 30, 2023
      • January 16, 2023
      • January 2, 2023
      • Releases 2022
    • Security Audit
    • Github
    • Link tree
Powered by GitBook
On this page
  • Initializing and Π‘onfiguring
  • Balances and History
  • Addresses
  • Transactions
  • Preparing Transactions
  • Ephemeral Addresses
  • Forced Exit
  • Misc

Was this helpful?

  1. Technical Implementation
  2. Client Library SDK

Full Functions List

All available functions of ZkBobClient object

PreviousCommon TypesNextUtilities

Last updated 1 year ago

Was this helpful?

Functions available in the account-less mode are marked with [*]

Initializing and Π‘onfiguring

  • [*]

  • [*]

  • [*]

  • [*]

Balances and History

Addresses

Transactions

Preparing Transactions

Ephemeral Addresses

Forced Exit

Misc

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

[*]

πŸ‘©β€βš•οΈ
directDeposit
directDepositFee
directDepositContract
create
login
logout
hasAccount
getPendingDDs
redeemGiftCard
generateAddress
generateUniversalAddress
generateAddressForSeed
verifyShieldedAddress
isMyAddress
addressInfo
getTotalBalance
getBalances
getOptimisticTotalBalance
getAllHistory
getComplianceReport
giftCardBalance
getProverMode
setProverMode
waitJobsTxHashes
waitJobTxHash
deposit
transferMulti
withdrawMulti
depositEphemeral
getEphemeralAddress
getNonusedEphemeralIndex
getUsedEphemeralAddresses
getEphemeralAddressInTxCount
getEphemeralAddressOutTxCount
getEphemeralAddressPrivateKey
getRelayerFee
atomicTxFee
isReadyToTransact
waitReadyToTransact
getLocalState
rollbackState
cleanState
updateState
maxSupportedTokenSwap
minTxAmount
getLimits
feeEstimate
shieldedAmountToWei
weiToShieldedAmount
networkName
poolId
tokenSellerContract
getLibraryVersion
getRelayerVersion
getProverVersion
codeForGiftCard
giftCardFromCode
currentPool
availabePools
switchToPool
getState
getProgress
getRelayerState
getRelayerOptimisticState
getPoolState
isAccountDead
isForcedExitSupported
forcedExitState
activeForcedExit
executedForcedExit
availableFundsToForcedExit
requestForcedExit
executeForcedExit
cancelForcedExit
calcMaxAvailableTransfer
getTransactionParts
getStatFullSync
getAverageTimePerTx