@liquality.types.SwapProvider

Interface: SwapProvider

@liquality/types.SwapProvider

Table of contents

Methods

• claimSwap
• findClaimSwapTransaction
• findInitiateSwapTransaction
• findRefundSwapTransaction
• generateSecret
• getSwapSecret
• initiateSwap
• refundSwap
• verifyInitiateSwapTransaction

Methods

claimSwap

▸ claimSwap(swapParams, initiationTxHash, secret, fee): Promise<Transaction<any>>

Parameters

Name	Type
swapParams	SwapParams
initiationTxHash	string
secret	string
fee	FeeType

Returns

Promise<Transaction<any>>

Defined in

types/lib/Swap.ts:44

---

findClaimSwapTransaction

▸ findClaimSwapTransaction(swapParams, initiationTxHash, blockNumber?): Promise<Transaction<any>>

Parameters

Name	Type
swapParams	SwapParams
initiationTxHash	string
blockNumber?	number

Returns

Promise<Transaction<any>>

Defined in

types/lib/Swap.ts:32

---

findInitiateSwapTransaction

▸ findInitiateSwapTransaction(swapParams, blockNumber?): Promise<Transaction<any>>

Parameters

Name	Type
swapParams	SwapParams
blockNumber?	number

Returns

Promise<Transaction<any>>

Defined in

types/lib/Swap.ts:30

---

findRefundSwapTransaction

▸ findRefundSwapTransaction(swapParams, initiationTxHash, blockNumber?): Promise<Transaction<any>>

Parameters

Name	Type
swapParams	SwapParams
initiationTxHash	string
blockNumber?	number

Returns

Promise<Transaction<any>>

Defined in

types/lib/Swap.ts:34

---

generateSecret

▸ generateSecret(message): Promise<string>

Parameters

Name	Type
message	string

Returns

Promise<string>

Defined in

types/lib/Swap.ts:36

---

getSwapSecret

▸ getSwapSecret(claimTxHash, initTxHash?): Promise<string>

Parameters

Name	Type
claimTxHash	string
initTxHash?	string

Returns

Promise<string>

Defined in

types/lib/Swap.ts:38

---

initiateSwap

▸ initiateSwap(swapParams, fee): Promise<Transaction<any>>

Parameters

Name	Type
swapParams	SwapParams
fee	FeeType

Returns

Promise<Transaction<any>>

Defined in

types/lib/Swap.ts:40

---

refundSwap

▸ refundSwap(swapParams, initiationTxHash, fee): Promise<Transaction<any>>

Parameters

Name	Type
swapParams	SwapParams
initiationTxHash	string
fee	FeeType

Returns

Promise<Transaction<any>>

Defined in

types/lib/Swap.ts:46

---

verifyInitiateSwapTransaction

▸ verifyInitiateSwapTransaction(swapParams, initiationTxHash): Promise<boolean>

Parameters

Name	Type
swapParams	SwapParams
initiationTxHash	string | Transaction<any>

Returns

Promise<boolean>

Defined in

types/lib/Swap.ts:42