Class SignatureBridge

Hierarchy

SignatureBridge

Constructors

Private constructor

new SignatureBridge(bridgeSides: Map<number, SignatureBridgeSide>, webbTokenAddresses: Map<number, string>, linkedAnchors: Map<string, IAnchor[]>, anchors: Map<string, IAnchor>): Bridges.SignatureBridge

- Defined in packages/bridges/src/SignatureBridge.ts:47
Parameters
- bridgeSides: Map<number, SignatureBridgeSide>
- webbTokenAddresses: Map<number, string>
- linkedAnchors: Map<string, IAnchor[]>
- anchors: Map<string, IAnchor>
Returns Bridges.SignatureBridge

Properties

anchors

anchors: Map<string, IAnchor>

bridgeSides

bridgeSides: Map<number, SignatureBridgeSide>

linkedAnchors

linkedAnchors: Map<string, IAnchor[]>

webbTokenAddresses

webbTokenAddresses: Map<number, string>

Methods

deposit

deposit(destinationChainId: number, anchorSize: BigNumberish, signer: Signer): Promise<IAnchorDeposit>

- Defined in packages/bridges/src/SignatureBridge.ts:295
Parameters
- destinationChainId: number
- anchorSize: BigNumberish
- signer: Signer
Returns Promise<IAnchorDeposit>

exportConfig

exportConfig(): SignatureBridgeConfig

- Defined in packages/bridges/src/SignatureBridge.ts:287
Returns SignatureBridgeConfig

getAnchor

getAnchor(chainId: number, anchorSize: BigNumberish): IAnchor

- Defined in packages/bridges/src/SignatureBridge.ts:276
Parameters
- chainId: number
- anchorSize: BigNumberish
Returns IAnchor

getBridgeSide

getBridgeSide(chainId: number): SignatureBridgeSide

- Defined in packages/bridges/src/SignatureBridge.ts:272
Parameters
- chainId: number
Returns SignatureBridgeSide

getWebbTokenAddress

getWebbTokenAddress(chainId: number): string

- Defined in packages/bridges/src/SignatureBridge.ts:283
Parameters
- chainId: number
Returns string

update

update(chainId: number, anchorSize: BigNumberish): Promise<void>

- Defined in packages/bridges/src/SignatureBridge.ts:263
Parameters
- chainId: number
- anchorSize: BigNumberish
Returns Promise<void>

updateLinkedAnchors

updateLinkedAnchors(srcAnchor: IAnchor): Promise<void>

- Defined in packages/bridges/src/SignatureBridge.ts:244
Updates the state of the SignatureBridgeSides and Anchors with the new state of the @param srcAnchor.

Parameters
- srcAnchor: IAnchor
  
  The anchor that has updated.
Returns Promise<void>

withdraw

withdraw(depositInfo: IAnchorDeposit, anchorSize: BigNumberish, recipient: string, relayer: string, signer: Signer): Promise<boolean>

- Defined in packages/bridges/src/SignatureBridge.ts:383
Parameters
- depositInfo: IAnchorDeposit
- anchorSize: BigNumberish
- recipient: string
- relayer: string
- signer: Signer
Returns Promise<boolean>

withdrawAndUnwrap

withdrawAndUnwrap(depositInfo: IAnchorDeposit, tokenAddress: string, anchorSize: BigNumberish, recipient: string, relayer: string, signer: Signer): Promise<boolean>

- Defined in packages/bridges/src/SignatureBridge.ts:414
Parameters
- depositInfo: IAnchorDeposit
- tokenAddress: string
- anchorSize: BigNumberish
- recipient: string
- relayer: string
- signer: Signer
Returns Promise<boolean>

wrapAndDeposit

wrapAndDeposit(destinationChainId: number, tokenAddress: string, anchorSize: BigNumberish, wrappingFee?: number, signer: Signer): Promise<IAnchorDeposit>

- Defined in packages/bridges/src/SignatureBridge.ts:332
Parameters
- destinationChainId: number
- tokenAddress: string
- anchorSize: BigNumberish
- wrappingFee: number = 0
- signer: Signer
Returns Promise<IAnchorDeposit>

Static createAnchorIdString

createAnchorIdString(anchorIdentifier: AnchorIdentifier): string

- Defined in packages/bridges/src/SignatureBridge.ts:62
Parameters
- anchorIdentifier: AnchorIdentifier
Returns string

Static createAnchorIdentifier

createAnchorIdentifier(anchorString: string): AnchorIdentifier

- Defined in packages/bridges/src/SignatureBridge.ts:66
Parameters
- anchorString: string
Returns AnchorIdentifier

Static createLinkedAnchorMap

createLinkedAnchorMap(createdAnchors: IAnchor[][]): Promise<Map<string, IAnchor[]>>

- Defined in packages/bridges/src/SignatureBridge.ts:79
Parameters
- createdAnchors: IAnchor[][]
Returns Promise<Map<string, IAnchor[]>>

Static deployFixedDepositBridge

deployFixedDepositBridge(bridgeInput: BridgeInput, deployers: Interfaces.DeployerConfig, initialGovernors: GovernorConfig, zkComponents: ZkComponents): Promise<Bridges.SignatureBridge>

- Defined in packages/bridges/src/SignatureBridge.ts:100
Parameters
- bridgeInput: BridgeInput
- deployers: Interfaces.DeployerConfig
- initialGovernors: GovernorConfig
- zkComponents: ZkComponents
Returns Promise<Bridges.SignatureBridge>

Static setPermissions

setPermissions(bridgeSide: SignatureBridgeSide, anchors: IAnchor[]): Promise<void>

- Defined in packages/bridges/src/SignatureBridge.ts:228
Parameters
- bridgeSide: SignatureBridgeSide
- anchors: IAnchor[]
Returns Promise<void>

Generated using TypeDoc