Interface IAnchor

Hierarchy

IAnchor

Implemented by

Properties

contract

contract: AnchorBase

Optional denomination

denomination?: string

depositHistory

depositHistory: Record<number, string>

latestSyncedBlock

latestSyncedBlock: number

signer

signer: Signer

Optional token

token?: string

tree

tree: any

Methods

bridgedTransact

bridgedTransact(inputs: Utxo[], outputs: Utxo[], fee: BigNumberish, recipient: string, relayer: string, merkleProofsForInputs: any[]): Promise<ContractReceipt>

- Defined in packages/interfaces/src/IAnchor.ts:79
Parameters
- inputs: Utxo[]
- outputs: Utxo[]
- fee: BigNumberish
- recipient: string
- relayer: string
- merkleProofsForInputs: any[]
Returns Promise<ContractReceipt>

bridgedTransactWrap

bridgedTransactWrap(tokenAddress: string, inputs: Utxo[], outputs: Utxo[], fee: BigNumberish, recipient: string, relayer: string, merkleProofsForInputs: any[]): Promise<ContractReceipt>

- Defined in packages/interfaces/src/IAnchor.ts:69
Parameters
- tokenAddress: string
- inputs: Utxo[]
- outputs: Utxo[]
- fee: BigNumberish
- recipient: string
- relayer: string
- merkleProofsForInputs: any[]
Returns Promise<ContractReceipt>

bridgedWithdraw

bridgedWithdraw(deposit: IAnchorDeposit, merkleProof: any, recipient: string, relayer: string, fee: string, refund: string, refreshCommitment: string): Promise<Event>

- Defined in packages/interfaces/src/IAnchor.ts:58
Parameters
- deposit: IAnchorDeposit
- merkleProof: any
- recipient: string
- relayer: string
- fee: string
- refund: string
- refreshCommitment: string
Returns Promise<Event>

bridgedWithdrawAndUnwrap

bridgedWithdrawAndUnwrap(deposit: IAnchorDeposit, merkleProof: any, recipient: string, relayer: string, fee: string, refund: string, refreshCommitment: string, tokenAddress: string): Promise<Event>

- Defined in packages/interfaces/src/IAnchor.ts:48
Parameters
- deposit: IAnchorDeposit
- merkleProof: any
- recipient: string
- relayer: string
- fee: string
- refund: string
- refreshCommitment: string
- tokenAddress: string
Returns Promise<Event>

createResourceId

createResourceId(): Promise<string>

- Defined in packages/interfaces/src/IAnchor.ts:26
Returns Promise<string>

deposit

deposit(destinationChainId: number): Promise<IAnchorDeposit>

- Defined in packages/interfaces/src/IAnchor.ts:30
Parameters
- destinationChainId: number
Returns Promise<IAnchorDeposit>

getAddress

getAddress(): string

- Defined in packages/interfaces/src/IAnchor.ts:23
Returns string

getHandler

getHandler(): Promise<string>

- Defined in packages/interfaces/src/IAnchor.ts:21
Returns Promise<string>

getHandlerProposalData

getHandlerProposalData(newHandler: string): Promise<string>

- Defined in packages/interfaces/src/IAnchor.ts:22
Parameters
- newHandler: string
Returns Promise<string>

getMaxDepositLimitProposalData

getMaxDepositLimitProposalData(_maximumDepositAmount: string): Promise<string>

- Defined in packages/interfaces/src/IAnchor.ts:25
Parameters
- _maximumDepositAmount: string
Returns Promise<string>

getMerkleProof

getMerkleProof(input: Utxo): IMerkleProofData

- Defined in packages/interfaces/src/IAnchor.ts:78
Parameters
- input: Utxo
Returns IMerkleProofData

getMinWithdrawalLimitProposalData

getMinWithdrawalLimitProposalData(_minimalWithdrawalAmount: string): Promise<string>

- Defined in packages/interfaces/src/IAnchor.ts:24
Parameters
- _minimalWithdrawalAmount: string
Returns Promise<string>

getProposalData

getProposalData(resourceID: string, leafIndex?: number): Promise<string>

- Defined in packages/interfaces/src/IAnchor.ts:20
Parameters
- resourceID: string
- Optional leafIndex: number
Returns Promise<string>

setSigner

setSigner(signer: Signer): any

- Defined in packages/interfaces/src/IAnchor.ts:19
Parameters
- signer: Signer
Returns any

setupWithdraw

setupWithdraw(deposit: IAnchorDepositInfo, index: number, recipient: string, relayer: string, fee: bigint, refreshCommitment: string | number): any

- Defined in packages/interfaces/src/IAnchor.ts:31
Parameters
- deposit: IAnchorDepositInfo
- index: number
- recipient: string
- relayer: string
- fee: bigint
- refreshCommitment: string | number
Returns any

update

update(blockNumber?: number): Promise<void>

- Defined in packages/interfaces/src/IAnchor.ts:27
Parameters
- Optional blockNumber: number
Returns Promise<void>

withdraw

withdraw(deposit: IAnchorDepositInfo, index: number, recipient: string, relayer: string, fee: bigint, refreshCommitment: string | number): Promise<Event>

- Defined in packages/interfaces/src/IAnchor.ts:39
Parameters
- deposit: IAnchorDepositInfo
- index: number
- recipient: string
- relayer: string
- fee: bigint
- refreshCommitment: string | number
Returns Promise<Event>

wrapAndDeposit

wrapAndDeposit(tokenAddress: string, wrappingFee: number, destinationChainId?: number): Promise<IAnchorDeposit>

- Defined in packages/interfaces/src/IAnchor.ts:47
Parameters
- tokenAddress: string
- wrappingFee: number
- Optional destinationChainId: number
Returns Promise<IAnchorDeposit>

Generated using TypeDoc