Class WithdrawalProof

Hierarchy

WithdrawalProof

Constructors

constructor

new WithdrawalProof(network, transferId): WithdrawalProof
Parameters
- network: string
- transferId: string
Returns WithdrawalProof
- Defined in src/utils/WithdrawalProof.ts:32

Properties

`Optional` leaves

leaves?: string[]

network

network: string

`Optional` numLeaves

numLeaves?: number

`Optional` proof

proof?: string[]

`Optional` rootTotalAmount

rootTotalAmount?: string

`Optional` transfer

transfer?: any

transferId

transferId: string

`Optional` transferIndex

transferIndex?: number

`Optional` transferRoot

transferRoot?: any

`Optional` transferRootHash

transferRootHash?: string

Methods

checkWithdrawable

checkWithdrawable(): void
Returns void
- Defined in src/utils/WithdrawalProof.ts:110

`Private` findTransfer

findTransfer(transferId): Promise<any>
Parameters
- transferId: string
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:224

generateProof

generateProof(): Promise<string[]>
Returns Promise<string[]>
- Defined in src/utils/WithdrawalProof.ts:53

`Private` generateProofForTransferId

generateProofForTransferId(transferIdOrTxHash): Promise<{
    leaves: string[];
    numLeaves: number;
    proof: string[];
    rootTotalAmount: any;
    transfer: any;
    transferId: string;
    transferIndex: number;
    transferRoot: any;
    transferRootHash: any;
}>
Parameters
- transferIdOrTxHash: string
Returns Promise<{
    leaves: string[];
    numLeaves: number;
    proof: string[];
    rootTotalAmount: any;
    transfer: any;
    transferId: string;
    transferIndex: number;
    transferRoot: any;
    transferRootHash: any;
}>
- Defined in src/utils/WithdrawalProof.ts:130

getProofPayload

getProofPayload(): {
    leaves: string[];
    numLeaves: number;
    proof: string[];
    rootTotalAmount: string;
    transferId: string;
    transferIndex: number;
    transferRootHash: string;
}
Returns {
    leaves: string[];
    numLeaves: number;
    proof: string[];
    rootTotalAmount: string;
    transferId: string;
    transferIndex: number;
    transferRootHash: string;
}
- leaves: string[]
- numLeaves: number
- proof: string[]
- rootTotalAmount: string
- transferId: string
- transferIndex: number
- transferRootHash: string
- Defined in src/utils/WithdrawalProof.ts:77

`Private` getTransferRoot

getTransferRoot(chain, token, transferRootHash): Promise<any>
Parameters
- chain: string
- token: string
- transferRootHash: string
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:695

`Private` getTransferRootForTransferId

getTransferRootForTransferId(transfer): Promise<any>
Parameters
- transfer: any
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:436

getTransferSents

getTransferSents(options, lastId?): Promise<any>
Parameters
- options: any
- lastId: string = ''
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:715

getTxPayload

getTxPayload(): {
    amount: any;
    amountOutMin: any;
    bonderFee: any;
    deadline: any;
    recipient: any;
    rootTotalAmount: string;
    siblings: string[];
    totalLeaves: number;
    transferIdTreeIndex: number;
    transferNonce: any;
    transferRootHash: string;
}
Returns {
    amount: any;
    amountOutMin: any;
    bonderFee: any;
    deadline: any;
    recipient: any;
    rootTotalAmount: string;
    siblings: string[];
    totalLeaves: number;
    transferIdTreeIndex: number;
    transferNonce: any;
    transferRootHash: string;
}
- amount: any
- amountOutMin: any
- bonderFee: any
- deadline: any
- recipient: any
- rootTotalAmount: string
- siblings: string[]
- totalLeaves: number
- transferIdTreeIndex: number
- transferNonce: any
- transferRootHash: string
- Defined in src/utils/WithdrawalProof.ts:91

`Private` getWithdrawalProofData

getWithdrawalProofData(transferId, rootTotalAmount, transferIds): {
    leaves: string[];
    numLeaves: number;
    proof: string[];
    rootTotalAmount: string;
    transferIndex: number;
}
Parameters
- transferId: string
- rootTotalAmount: string
- transferIds: string[]
Returns {
    leaves: string[];
    numLeaves: number;
    proof: string[];
    rootTotalAmount: string;
    transferIndex: number;
}
- leaves: string[]
- numLeaves: number
- proof: string[]
- rootTotalAmount: string
- transferIndex: number
- Defined in src/utils/WithdrawalProof.ts:174

`Private` makeRequest

makeRequest(chain, query, params?): Promise<any>
Parameters
- chain: string
- query: string
- params: any = {}
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:200

`Private` normalizeEntity

normalizeEntity(x): any
Parameters
- x: any
Returns any
- Defined in src/utils/WithdrawalProof.ts:775

`Private` queryBondWithdrawal

queryBondWithdrawal(transferId, chain): Promise<any>
Parameters
- transferId: string
- chain: string
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:403

`Private` queryRootSet

queryRootSet(chain, token, transferRootHash): Promise<any>
Parameters
- chain: string
- token: string
- transferRootHash: string
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:663

`Private` queryTransfer

queryTransfer(transferId, chain): Promise<any>
Parameters
- transferId: string
- chain: string
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:267

`Private` queryTransferByTransactionHash

queryTransferByTransactionHash(transactionHash, chain): Promise<any>
Parameters
- transactionHash: string
- chain: string
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:315

`Private` queryTransferIdsForTransferRoot

queryTransferIdsForTransferRoot(chain, token, rootHash): Promise<any>
Parameters
- chain: string
- token: string
- rootHash: string
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:483

`Private` queryTransferRoot

queryTransferRoot(chain, token, transferRootHash): Promise<any>
Parameters
- chain: string
- token: string
- transferRootHash: string
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:629

`Private` queryWithdrew

queryWithdrew(transferId, chain): Promise<any>
Parameters
- transferId: string
- chain: string
Returns Promise<any>
- Defined in src/utils/WithdrawalProof.ts:363

Class WithdrawalProof

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

network: string

transferId: string

Returns WithdrawalProof

Properties

Optional leaves

network

Optional numLeaves

Optional proof

Optional rootTotalAmount

Optional transfer

transferId

Optional transferIndex

Optional transferRoot

Optional transferRootHash

Methods

checkWithdrawable

Returns void

Private findTransfer

Parameters

transferId: string

Returns Promise<any>

generateProof

Returns Promise<string[]>

Private generateProofForTransferId

Parameters

transferIdOrTxHash: string

Returns Promise<{ leaves: string[]; numLeaves: number; proof: string[]; rootTotalAmount: any; transfer: any; transferId: string; transferIndex: number; transferRoot: any; transferRootHash: any; }>

getProofPayload

Returns { leaves: string[]; numLeaves: number; proof: string[]; rootTotalAmount: string; transferId: string; transferIndex: number; transferRootHash: string; }

leaves: string[]

numLeaves: number

proof: string[]

rootTotalAmount: string

transferId: string

transferIndex: number

transferRootHash: string

Private getTransferRoot

Parameters

chain: string

token: string

transferRootHash: string

Returns Promise<any>

Private getTransferRootForTransferId

Parameters

transfer: any

Returns Promise<any>

getTransferSents

Parameters

options: any

lastId: string = ''

Returns Promise<any>

getTxPayload

Returns { amount: any; amountOutMin: any; bonderFee: any; deadline: any; recipient: any; rootTotalAmount: string; siblings: string[]; totalLeaves: number; transferIdTreeIndex: number; transferNonce: any; transferRootHash: string; }

amount: any

amountOutMin: any

bonderFee: any

deadline: any

recipient: any

rootTotalAmount: string

siblings: string[]

totalLeaves: number

transferIdTreeIndex: number

transferNonce: any

transferRootHash: string

Private getWithdrawalProofData

Parameters

transferId: string

rootTotalAmount: string

transferIds: string[]

Returns { leaves: string[]; numLeaves: number; proof: string[]; rootTotalAmount: string; transferIndex: number; }

leaves: string[]

`Optional` leaves

`Optional` numLeaves

`Optional` proof

`Optional` rootTotalAmount

`Optional` transfer

`Optional` transferIndex

`Optional` transferRoot

`Optional` transferRootHash

`Private` findTransfer

`Private` generateProofForTransferId

Returns Promise<{
leaves: string[];
numLeaves: number;
proof: string[];
rootTotalAmount: any;
transfer: any;
transferId: string;
transferIndex: number;
transferRoot: any;
transferRootHash: any;
}>

Returns {
leaves: string[];
numLeaves: number;
proof: string[];
rootTotalAmount: string;
transferId: string;
transferIndex: number;
transferRootHash: string;
}

`Private` getTransferRoot

`Private` getTransferRootForTransferId

Returns {
amount: any;
amountOutMin: any;
bonderFee: any;
deadline: any;
recipient: any;
rootTotalAmount: string;
siblings: string[];
totalLeaves: number;
transferIdTreeIndex: number;
transferNonce: any;
transferRootHash: string;
}

`Private` getWithdrawalProofData

Returns {
leaves: string[];
numLeaves: number;
proof: string[];
rootTotalAmount: string;
transferIndex: number;
}

`Private` makeRequest

`Private` normalizeEntity

`Private` queryBondWithdrawal

`Private` queryRootSet

`Private` queryTransfer

`Private` queryTransferByTransactionHash

`Private` queryTransferIdsForTransferRoot

`Private` queryTransferRoot

`Private` queryWithdrew