Skip to content

Latest commit

 

History

History
148 lines (83 loc) · 4.19 KB

OptimisticMinting.md

File metadata and controls

148 lines (83 loc) · 4.19 KB

Class: OptimisticMinting

Table of contents

Constructors

Properties

Methods

Constructors

constructor

new OptimisticMinting(tbtcContracts): OptimisticMinting

Parameters

Name Type
tbtcContracts TBTCContracts

Returns

OptimisticMinting

Defined in

src/services/maintenance/optimistic-minting.ts:9

Properties

tbtcContracts

Private Readonly tbtcContracts: TBTCContracts

Defined in

src/services/maintenance/optimistic-minting.ts:7

Methods

cancelMint

cancelMint(depositTxHash, depositOutputIndex): Promise<Hex>

Cancels optimistic minting for a deposit on chain.

Parameters

Name Type Description
depositTxHash BitcoinTxHash The revealed deposit transaction's hash.
depositOutputIndex number Index of the deposit transaction output that funds the revealed deposit.

Returns

Promise<Hex>

Transaction hash of the optimistic mint cancel transaction.

Defined in

src/services/maintenance/optimistic-minting.ts:37


finalizeMint

finalizeMint(depositTxHash, depositOutputIndex): Promise<Hex>

Finalizes optimistic minting for a deposit on chain.

Parameters

Name Type Description
depositTxHash BitcoinTxHash The revealed deposit transaction's hash.
depositOutputIndex number Index of the deposit transaction output that funds the revealed deposit.

Returns

Promise<Hex>

Transaction hash of the optimistic mint finalize transaction.

Defined in

src/services/maintenance/optimistic-minting.ts:54


getMintingRequest

getMintingRequest(depositTxHash, depositOutputIndex): Promise<OptimisticMintingRequest>

Gets optimistic minting request for a deposit from chain.

Parameters

Name Type Description
depositTxHash BitcoinTxHash The revealed deposit transaction's hash.
depositOutputIndex number Index of the deposit transaction output that funds the revealed deposit.

Returns

Promise<OptimisticMintingRequest>

Optimistic minting request.

Defined in

src/services/maintenance/optimistic-minting.ts:71


requestMint

requestMint(depositTxHash, depositOutputIndex): Promise<Hex>

Requests optimistic minting for a deposit on chain.

Parameters

Name Type Description
depositTxHash BitcoinTxHash The revealed deposit transaction's hash.
depositOutputIndex number Index of the deposit transaction output that funds the revealed deposit.

Returns

Promise<Hex>

Transaction hash of the optimistic mint request transaction.

Defined in

src/services/maintenance/optimistic-minting.ts:20