Skip to content

Commit

Permalink
Clean out TBTC class a little
Browse files Browse the repository at this point in the history 
Clean out TBTC class a little (in threshold-ts lib).The main thing here was to
not use artifacts from `@keep-network/tbtc-v2" lib and we made it! It now
imports mainnet and goerli artifacts from the new SDK v2 and we can get it by
calling `getTbtcV2Artifact`.

Beisdes that we are know saving ethereum config in a privae property of TBTC
class (just like we do with bitcoinConfig). This allow us to get ethereum chain
id in any of the function and we need that in some places to get an artifact
(based on the chain id), and the get the block number that it was depoloyed to.
We use that block number to look for the specific events.
  • Loading branch information
@michalsmiarowski
michalsmiarowski committed Nov 10, 2023
1 parent 7e9179a commit ca5af68
Show file tree
Hide file tree
Showing 2 changed files with 99 additions and 52 deletions.
120 changes: 68 additions & 52 deletions src/threshold-ts/tbtc/index.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ import {
fromSatoshiToTokenPrecision,
getSigner,
getGoerliDevelopmentContracts,
getTbtcV2Artifact,
} from "../utils"
import {
Client,
Expand All @@ -32,9 +33,6 @@ import {
EthereumTBTCToken,
} from "@keep-network/tbtc-v2.ts/dist/src"
import { BitcoinConfig, BitcoinNetwork, EthereumConfig } from "../types"
import TBTCVault from "@keep-network/tbtc-v2/artifacts/TBTCVault.json"
import Bridge from "@keep-network/tbtc-v2/artifacts/Bridge.json"
import TBTCToken from "@keep-network/tbtc-v2/artifacts/TBTC.json"
import {
BigNumber,
BigNumberish,
Expand All @@ -50,7 +48,6 @@ import {
requestRedemption,
findWalletForRedemption,
} from "@keep-network/tbtc-v2.ts/dist/src/redemption"
import { TBTCToken as ChainTBTCToken } from "@keep-network/tbtc-v2.ts/dist/src/chain"
import {
BitcoinUtxo,
Deposit,
Expand Down Expand Up @@ -117,9 +114,9 @@ export interface RedemptionRequestedEvent {
txHash: string
}

export type QueryEventFilter = { fromBlock?: BlockTag; toBlock?: BlockTag }
type QueryEventFilter = { fromBlock?: BlockTag; toBlock?: BlockTag }

export type RedemptionRequestedEventFilter = {
type RedemptionRequestedEventFilter = {
walletPublicKeyHash?: string | string[]
redeemer?: string | string[]
} & QueryEventFilter
Expand All @@ -136,35 +133,35 @@ export interface RedemptionRequest<
isTimedOut: boolean
}

export type RedemptionTimedOutEventFilter = {
type RedemptionTimedOutEventFilter = {
walletPublicKeyHash?: string | string[]
} & QueryEventFilter

export interface RedemptionTimedOutEvent {
interface RedemptionTimedOutEvent {
walletPublicKeyHash: string
redeemerOutputScript: string
txHash: string
blockNumber: number
}

export type RedemptionsCompletedEventFilter = {
type RedemptionsCompletedEventFilter = {
walletPublicKeyHash: string
} & QueryEventFilter

export interface RedemptionsCompletedEvent {
interface RedemptionsCompletedEvent {
walletPublicKeyHash: string
redemptionBitcoinTxHash: string
txHash: string
blockNumber: number
}

export type BitcoinTransactionHashByteOrder = "little-endian" | "big-endian"
type BitcoinTransactionHashByteOrder = "little-endian" | "big-endian"

export type RedemptionWalletData = Awaited<
ReturnType<typeof findWalletForRedemption>
>

export type AmountToSatoshiResult = {
type AmountToSatoshiResult = {
/**
* Amount of TBTC to be minted/unminted.
*/
Expand Down Expand Up @@ -192,9 +189,15 @@ class EmptyDepositObjectError extends Error {
}

export interface ITBTC {
/**
* Ethereum chain id specified in the ethereum config that we pass to the
* threshold lib.
* @returns {string | number}
*/
readonly ethereumChainId: string | number
/**
* Bitcoin network specified in the bitcoin config that we pass to the
* threshold lib
* threshold lib.
* @returns {BitcoinNetwork}
*/
readonly bitcoinNetwork: BitcoinNetwork
Expand Down Expand Up @@ -432,17 +435,17 @@ export interface ITBTC {

export class TBTC implements ITBTC {
private _bridge: EthereumBridge
private _tbtcVault: Contract
private _bitcoinClient: BitcoinClient
private _multicall: IMulticall
private _bridgeContract: Contract
private _token: ChainTBTCToken
private _tbtcVaultContract: Contract
private _tokenContract: Contract
private _bitcoinClient: BitcoinClient
private _multicall: IMulticall
/**
* Deposit refund locktime duration in seconds.
* This is 9 month in seconds assuming 1 month = 30 days
*/
private _depositRefundLocktimDuration = 23328000
private _ethereumConfig: EthereumConfig
private _bitcoinConfig: BitcoinConfig
private readonly _satoshiMultiplier = BigNumber.from(10).pow(10)
private _redemptionTreasuryFeeDivisor: BigNumber | undefined
Expand All @@ -459,25 +462,37 @@ export class TBTC implements ITBTC {
"Neither bitcoin client nor bitcoin credentials are specified"
)
}
this._bridge = new EthereumBridge({
address: Bridge.address,
signerOrProvider: getProviderOrSigner(
ethereumConfig.providerOrSigner as any,
ethereumConfig.account
),
})
this._tbtcVault = getContract(
TBTCVault.address,
TBTCVault.abi,
const tbtcVaultArtifact = getTbtcV2Artifact(
"TBTCVault",
ethereumConfig.chainId
)
const bridgeArtifact = getTbtcV2Artifact("Bridge", ethereumConfig.chainId)
const tbtcTokenArtifact = getTbtcV2Artifact("TBTC", ethereumConfig.chainId)
this._bridgeContract = getContract(
bridgeArtifact.address,
bridgeArtifact.abi,
ethereumConfig.providerOrSigner,
ethereumConfig.account
)
this._bridgeContract = getContract(
Bridge.address,
Bridge.abi,
this._tbtcVaultContract = getContract(
tbtcVaultArtifact.address,
tbtcVaultArtifact.abi,
ethereumConfig.providerOrSigner,
ethereumConfig.account
)
this._tokenContract = getContract(
tbtcTokenArtifact.address,
tbtcTokenArtifact.abi,
ethereumConfig.providerOrSigner,
ethereumConfig.account
)
this._bridge = new EthereumBridge({
address: bridgeArtifact.address,
signerOrProvider: getProviderOrSigner(
ethereumConfig.providerOrSigner as any,
ethereumConfig.account
),
})
// @ts-ignore
this._bitcoinClient =
bitcoinConfig.client ??
Expand All @@ -486,20 +501,8 @@ export class TBTC implements ITBTC {
bitcoinConfig.clientOptions
)
this._multicall = multicall
this._ethereumConfig = ethereumConfig
this._bitcoinConfig = bitcoinConfig
this._token = new EthereumTBTCToken({
address: TBTCToken.address,
signerOrProvider: getProviderOrSigner(
ethereumConfig.providerOrSigner as any,
ethereumConfig.account
),
})
this._tokenContract = getContract(
TBTCToken.address,
TBTCToken.abi,
ethereumConfig.providerOrSigner,
ethereumConfig.account
)
}

async initializeSdk(
Expand Down Expand Up @@ -554,6 +557,10 @@ export class TBTC implements ITBTC {
return this._deposit
}

get ethereumChainId(): string | number {
return this._ethereumConfig.chainId
}

get bitcoinNetwork(): BitcoinNetwork {
return this._bitcoinConfig.network
}
Expand All @@ -563,7 +570,7 @@ export class TBTC implements ITBTC {
}

get vaultContract() {
return this._tbtcVault
return this._tbtcVaultContract
}

get tokenContract() {
Expand Down Expand Up @@ -632,13 +639,13 @@ export class TBTC implements ITBTC {
const calls: ContractCall[] = [
{
interface: this._bridgeContract.interface,
address: Bridge.address,
address: this._bridgeContract.address,
method: "depositParameters",
args: [],
},
{
interface: this._tbtcVault.interface,
address: this._tbtcVault.address,
interface: this._tbtcVaultContract.interface,
address: this._tbtcVaultContract.address,
method: "optimisticMintingFeeDivisor",
args: [],
},
Expand Down Expand Up @@ -793,8 +800,9 @@ export class TBTC implements ITBTC {
findAllRevealedDeposits = async (
depositor: string
): Promise<RevealedDepositEvent[]> => {
const bridgeArtifact = getTbtcV2Artifact("Bridge", this.ethereumChainId)
const deposits = await getContractPastEvents(this._bridgeContract, {
fromBlock: Bridge.receipt.blockNumber,
fromBlock: bridgeArtifact.receipt.blockNumber,
filterParams: [null, null, depositor],
eventName: "DepositRevealed",
})
Expand Down Expand Up @@ -883,8 +891,12 @@ export class TBTC implements ITBTC {
depositor: string,
depositKeys: string[] = []
): Promise<ReturnType<typeof getContractPastEvents>> => {
return await getContractPastEvents(this._tbtcVault, {
fromBlock: TBTCVault.receipt.blockNumber,
const tbtcVaultArtifact = getTbtcV2Artifact(
"TBTCVault",
this.ethereumChainId
)
return await getContractPastEvents(this._tbtcVaultContract, {
fromBlock: tbtcVaultArtifact.receipt.blockNumber,
filterParams: [null, depositKeys, depositor],
eventName: "OptimisticMintingFinalized",
})
Expand All @@ -893,8 +905,12 @@ export class TBTC implements ITBTC {
private _findAllCancelledDeposits = async (
depositKeys: string[]
): Promise<ReturnType<typeof getContractPastEvents>> => {
return getContractPastEvents(this._tbtcVault, {
fromBlock: TBTCVault.receipt.blockNumber,
const tbtcVaultArtifact = getTbtcV2Artifact(
"TBTCVault",
this.ethereumChainId
)
return getContractPastEvents(this._tbtcVaultContract, {
fromBlock: tbtcVaultArtifact.receipt.blockNumber,
filterParams: [null, depositKeys],
eventName: "OptimisticMintingCancelled",
})
Expand Down
31 changes: 31 additions & 0 deletions src/threshold-ts/utils/contract.ts
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,14 @@ import {
} from "tbtc-sdk-v2"
import { getEnvVariable } from "../../utils/getEnvVariable"
import { EnvVariable } from "../../enums"
import { EthersContractDeployment } from "tbtc-sdk-v2/dist/src/lib/ethereum/adapter"

import BridgeArtifactMainnet from "tbtc-sdk-v2/src/lib/ethereum/artifacts/mainnet/Bridge.json"
import BridgeArtifactGoerli from "tbtc-sdk-v2/src/lib/ethereum/artifacts/goerli/Bridge.json"
import TbtcVaultArtifactMainnet from "tbtc-sdk-v2/src/lib/ethereum/artifacts/mainnet/TBTCVault.json"
import TbtcVaultArtifactGoerli from "tbtc-sdk-v2/src/lib/ethereum/artifacts/goerli/TBTCVault.json"
import TbtcTokenArtifactMainnet from "tbtc-sdk-v2/src/lib/ethereum/artifacts/mainnet/TBTC.json"
import TbtcTokenArtifactGoerli from "tbtc-sdk-v2/src/lib/ethereum/artifacts/goerli/TBTC.json"

// account is not optional
export function getSigner(
Expand Down Expand Up @@ -76,6 +84,29 @@ export function getContractAddressFromTruffleArtifact(
: AddressZero
}

export const getTbtcV2Artifact = (
artifactName: "Bridge" | "TBTCVault" | "TBTC",
chainId: string | number
) => {
// TODO: Update this function with goerli development artifact.
switch (artifactName) {
case "Bridge":
return chainId.toString() === "1"
? BridgeArtifactMainnet
: BridgeArtifactGoerli
case "TBTCVault":
return chainId.toString() === "1"
? TbtcVaultArtifactMainnet
: TbtcVaultArtifactGoerli
case "TBTC":
return chainId.toString() === "1"
? TbtcTokenArtifactMainnet
: TbtcTokenArtifactGoerli
default:
throw new Error("Can't get tbtc-v2 artifacts!")
}
}

export const getGoerliDevelopmentContracts = (
signerOrProvider: Signer | providers.Provider
): TBTCContracts => {
Expand Down

0 comments on commit ca5af68

Please sign in to comment.