A regular shielded address for the currently selected privacy pool (aka pool-specific address).
async generateAddress(): Promise<string>
The shielded address has a human-readable prefix to indicate which privacy pool it belongs to. Do not remove this: the address without the prefix considered invalid.
Returns
Promise returns the shielded address for the current pool.
seed - spending key for the account generated address belongs to
Returns
Promise returns the shielded address for the current pool belonging to the provided spending key
Example
const mnemonic = 'magic trophy foil direct marriage glad bench wash doctor risk end cheap';
const sk = deriveSpendingKeyZkBob(mnemonic);
console.log(`${await zkClient.generateAddressForSeed(sk)}`);
// output: zkbob_sepolia:SZgsuNkez8MMZJ4tvVyNCUajQNu26agnZvqJmkxdNpcTmshdfSzA2sUW1fsPVPU
address - pool-specific or generic shielded address
Addresses without prefixes are deprecated, the only exception is the USDC pool on Polygon where they are allowed. Otherwise, prefix-less addresses will be marked as invalid.
Returns
Promise returns true if address checksum is correct and can be used on the current privacy pool
Example
const address = 'zkbob:4NeCQJijr9GQKBUBkp61bdQiqB15sf42fvy3CKGeXjUqJR3GBrQKSRrkboJounM';
const isValid = await zkClient.verifyShieldedAddress(address)
console.log(`The checking address is ${!isValid ? 'IN' : ''}VALID`);
// output: The checking address is VALID
address - pool-specific or generic shielded address
Addresses without prefixes are deprecated, the only exception is the USDC pool on Polygon where they are allowed. Otherwise, prefix-less addresses will be marked as invalid.
Returns
Promise returns true if address checksum is correct, it can be used on the current privacy pool and it belongs to the current user account
Example
const address = 'zkbob_sepolia:SZgsuNkez8MMZJ4tvVyNCUajQNu26agnZvqJmkxdNpcTmshdfSzA2sUW1fsPVPU';
const isOwn = await zkClient.isMyAddress(address)
console.log(`The address is ${!isOwn ? 'not ' : ''}belongs to our account`);
// output: The address is belongs to our account
