Balances and History
Retrieve user's shielded funds and activity
Get the Account Balance
async getTotalBalance(updateState: boolean = true): Promise<bigint>Parameters
updateState - update the state before calculating the balance if true
Returns
Promise returns the shielded token's balance in the pool dimension (account + all unspent notes)
Example
const balance = await zkClient.getTotalBalance();
console.log(`Your balance in the private pool is: ${balance}`);
// output: Your balance in the private pool is: 150000000000Get the Balance Including Pending Transactions
Get the balance including transactions owned by the account that have been submitted to the pool contract but not yet mined.
async getOptimisticTotalBalance(updateState: boolean = true): Promise<bigint>Parameters
updateState - update the state before calculating the balance if true
Returns
Promise returns the shielded token's balance (including pending transactions) in the pool dimension (account + all unspent notes).
Example
const confirmedBalance = await zkClient.getTotalBalance();
const optimisticBalance = await zkClient.getOptimisticTotalBalance(false);
console.log(`Your confirmed balance: ${confirmedBalance}`);
console.log(`Your optimistic balance: ${optimisticBalance}`);
// output: Your confirmed balance: 150000000000
// Your optimistic balance: 170000000000Get the Balance Components
The customer's balance consists of the account balance and the unspent notes. The notes are produced by incoming transfers. Each user-originated transaction collects the 3 oldest notes to the account and marks them as spent ones. The balance configuration (funds distribution between account and notes) may affect the outgoing transfers and withdrawals. The following method retrieves the total balance as well as the account and notes components.
async getBalances(updateState: boolean = true): Promise<[bigint, bigint, bigint]>Parameters
updateState - update the state before calculating the balance if true
Returns
Promise returns the tuple [total, account, notes] where total = account + notes without pending transactions (all balances are in the pool token dimension).
Example
const [total, acc, note] = await zkAccount.getBalances();
console.log(`Balance: ${total} (${acc} on the account and ${notes} in notes)`);
// output: Balance: 170000000000 (150000000000 on the account and 20000000000 in notes)Get the Transaction History
async getAllHistory(updateState: boolean = true): Promise<HistoryRecord[]>Parameters
updateState - update the state before calculating the balance if true
Returns
Promise returns an array of HistoryRecord objects
Example
const records = await zkAccount.getAllHistory();
console.log(`The account contains ${records.count} history records`);
// output: The account contains 42 history recordsGet the Compliance Report
The compliance report is an extended version of the regular history. It contains transaction details including input notes, decryption keys and other fields needed to show historical integrity.
async getComplianceReport(
fromTimestamp: number | null,
toTimestamp: number | null,
updateState: boolean = true,
): Promise<ComplianceHistoryRecord[]>Parameters
fromTimestamp- the start time for the compliance report request (seconds since Jan 01 1970)fromTimestamp- the final time for the compliance report request (seconds since Jan 01 1970)updateState- update the state before calculating the balance iftrue
Returns
Promise returns the array of ComplianceHistoryRecord objects
Example
const records = await zkAccount.getComplianceReport();
console.log(`Generated ${records.count} compliance history records`);
// output: Generated 42 compliance history recordsLast updated
Was this helpful?