Class ShieldedPoolProver

Hierarchy

ShieldedPoolProver

Index

Constructors

Properties

account proofGen

Methods

shield transfer unshield

Constructors

constructor

new ShieldedPoolProver(account, proofGen): ShieldedPoolProver
Parameters
- account: Account
- proofGen: GenerateProofFn
Returns ShieldedPoolProver
- Defined in sdk/src/shielded_pool.ts:11

Properties

`Private` account

account: Account

`Private` proofGen

proofGen: GenerateProofFn

Methods

shield

shield(amount, asset?, swapParams?, checkBlocklist?): Promise<FormattedProof>
Generate a proof to add tokens to the shielded pool
Parameters
- amount: BigNumberish
- asset: BigNumberish = 0
- swapParams: SwapParams = ...
- checkBlocklist: boolean = false
Returns Promise<FormattedProof>
- Defined in sdk/src/shielded_pool.ts:19

transfer

transfer(amount, toPubKey, asset?, swapParams?, checkBlocklist?): Promise<FormattedProof>
Generate a proof to transfer tokens in the shielded pool
Parameters
- amount: BigNumberish
- toPubKey: string
  
  Keypair public key to send the note to
- asset: BigNumberish = 0
- swapParams: SwapParams = ...
- checkBlocklist: boolean = false
Returns Promise<FormattedProof>
- Defined in sdk/src/shielded_pool.ts:59

unshield

unshield(amount, recipientEthAddress, asset?, swapParams?, checkBlocklist?): Promise<FormattedProof>
Generate a proof to remove tokens in the shielded pool
Parameters
- amount: BigNumberish
  
  The amount
- recipientEthAddress: string
  
  the recippient address to burn in the proof to ensure the funds cannot be withdrawn elsewhere
- asset: BigNumberish = 0
- swapParams: SwapParams = ...
- checkBlocklist: boolean = false
Returns Promise<FormattedProof>
- Defined in sdk/src/shielded_pool.ts:118

Generated using TypeDoc