@atomiqlabs/chain-evm 1.0.0-dev.22

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (146) hide show
  1. package/LICENSE +201 -0
  2. package/dist/chains/citrea/CitreaChainType.d.ts +13 -0
  3. package/dist/chains/citrea/CitreaChainType.js +2 -0
  4. package/dist/chains/citrea/CitreaInitializer.d.ts +30 -0
  5. package/dist/chains/citrea/CitreaInitializer.js +120 -0
  6. package/dist/evm/btcrelay/BtcRelayAbi.d.ts +198 -0
  7. package/dist/evm/btcrelay/BtcRelayAbi.js +261 -0
  8. package/dist/evm/btcrelay/BtcRelayTypechain.d.ts +172 -0
  9. package/dist/evm/btcrelay/BtcRelayTypechain.js +2 -0
  10. package/dist/evm/btcrelay/EVMBtcRelay.d.ts +188 -0
  11. package/dist/evm/btcrelay/EVMBtcRelay.js +419 -0
  12. package/dist/evm/btcrelay/headers/EVMBtcHeader.d.ts +33 -0
  13. package/dist/evm/btcrelay/headers/EVMBtcHeader.js +84 -0
  14. package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.d.ts +56 -0
  15. package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.js +123 -0
  16. package/dist/evm/chain/EVMChainInterface.d.ts +51 -0
  17. package/dist/evm/chain/EVMChainInterface.js +90 -0
  18. package/dist/evm/chain/EVMModule.d.ts +9 -0
  19. package/dist/evm/chain/EVMModule.js +13 -0
  20. package/dist/evm/chain/modules/ERC20Abi.d.ts +168 -0
  21. package/dist/evm/chain/modules/ERC20Abi.js +225 -0
  22. package/dist/evm/chain/modules/EVMAddresses.d.ts +9 -0
  23. package/dist/evm/chain/modules/EVMAddresses.js +26 -0
  24. package/dist/evm/chain/modules/EVMBlocks.d.ts +20 -0
  25. package/dist/evm/chain/modules/EVMBlocks.js +64 -0
  26. package/dist/evm/chain/modules/EVMEvents.d.ts +36 -0
  27. package/dist/evm/chain/modules/EVMEvents.js +122 -0
  28. package/dist/evm/chain/modules/EVMFees.d.ts +35 -0
  29. package/dist/evm/chain/modules/EVMFees.js +73 -0
  30. package/dist/evm/chain/modules/EVMSignatures.d.ts +29 -0
  31. package/dist/evm/chain/modules/EVMSignatures.js +68 -0
  32. package/dist/evm/chain/modules/EVMTokens.d.ts +49 -0
  33. package/dist/evm/chain/modules/EVMTokens.js +105 -0
  34. package/dist/evm/chain/modules/EVMTransactions.d.ts +89 -0
  35. package/dist/evm/chain/modules/EVMTransactions.js +216 -0
  36. package/dist/evm/contract/EVMContractBase.d.ts +22 -0
  37. package/dist/evm/contract/EVMContractBase.js +34 -0
  38. package/dist/evm/contract/EVMContractModule.d.ts +8 -0
  39. package/dist/evm/contract/EVMContractModule.js +11 -0
  40. package/dist/evm/contract/modules/EVMContractEvents.d.ts +42 -0
  41. package/dist/evm/contract/modules/EVMContractEvents.js +75 -0
  42. package/dist/evm/events/EVMChainEvents.d.ts +22 -0
  43. package/dist/evm/events/EVMChainEvents.js +67 -0
  44. package/dist/evm/events/EVMChainEventsBrowser.d.ts +86 -0
  45. package/dist/evm/events/EVMChainEventsBrowser.js +294 -0
  46. package/dist/evm/spv_swap/EVMSpvVaultContract.d.ts +64 -0
  47. package/dist/evm/spv_swap/EVMSpvVaultContract.js +410 -0
  48. package/dist/evm/spv_swap/EVMSpvVaultData.d.ts +38 -0
  49. package/dist/evm/spv_swap/EVMSpvVaultData.js +159 -0
  50. package/dist/evm/spv_swap/EVMSpvWithdrawalData.d.ts +19 -0
  51. package/dist/evm/spv_swap/EVMSpvWithdrawalData.js +55 -0
  52. package/dist/evm/spv_swap/SpvVaultContractAbi.d.ts +91 -0
  53. package/dist/evm/spv_swap/SpvVaultContractAbi.js +849 -0
  54. package/dist/evm/spv_swap/SpvVaultContractTypechain.d.ts +450 -0
  55. package/dist/evm/spv_swap/SpvVaultContractTypechain.js +2 -0
  56. package/dist/evm/swaps/EVMSwapContract.d.ts +192 -0
  57. package/dist/evm/swaps/EVMSwapContract.js +373 -0
  58. package/dist/evm/swaps/EVMSwapData.d.ts +64 -0
  59. package/dist/evm/swaps/EVMSwapData.js +254 -0
  60. package/dist/evm/swaps/EVMSwapModule.d.ts +9 -0
  61. package/dist/evm/swaps/EVMSwapModule.js +11 -0
  62. package/dist/evm/swaps/EscrowManagerAbi.d.ts +120 -0
  63. package/dist/evm/swaps/EscrowManagerAbi.js +985 -0
  64. package/dist/evm/swaps/EscrowManagerTypechain.d.ts +475 -0
  65. package/dist/evm/swaps/EscrowManagerTypechain.js +2 -0
  66. package/dist/evm/swaps/handlers/IHandler.d.ts +13 -0
  67. package/dist/evm/swaps/handlers/IHandler.js +2 -0
  68. package/dist/evm/swaps/handlers/claim/ClaimHandlers.d.ts +10 -0
  69. package/dist/evm/swaps/handlers/claim/ClaimHandlers.js +13 -0
  70. package/dist/evm/swaps/handlers/claim/HashlockClaimHandler.d.ts +20 -0
  71. package/dist/evm/swaps/handlers/claim/HashlockClaimHandler.js +39 -0
  72. package/dist/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.d.ts +24 -0
  73. package/dist/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.js +59 -0
  74. package/dist/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.d.ts +25 -0
  75. package/dist/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.js +51 -0
  76. package/dist/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.d.ts +21 -0
  77. package/dist/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.js +28 -0
  78. package/dist/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.d.ts +48 -0
  79. package/dist/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.js +63 -0
  80. package/dist/evm/swaps/handlers/refund/TimelockRefundHandler.d.ts +17 -0
  81. package/dist/evm/swaps/handlers/refund/TimelockRefundHandler.js +28 -0
  82. package/dist/evm/swaps/modules/EVMLpVault.d.ts +69 -0
  83. package/dist/evm/swaps/modules/EVMLpVault.js +131 -0
  84. package/dist/evm/swaps/modules/EVMSwapClaim.d.ts +53 -0
  85. package/dist/evm/swaps/modules/EVMSwapClaim.js +101 -0
  86. package/dist/evm/swaps/modules/EVMSwapInit.d.ts +88 -0
  87. package/dist/evm/swaps/modules/EVMSwapInit.js +241 -0
  88. package/dist/evm/swaps/modules/EVMSwapRefund.d.ts +62 -0
  89. package/dist/evm/swaps/modules/EVMSwapRefund.js +132 -0
  90. package/dist/evm/typechain/common.d.ts +50 -0
  91. package/dist/evm/typechain/common.js +2 -0
  92. package/dist/evm/wallet/EVMSigner.d.ts +9 -0
  93. package/dist/evm/wallet/EVMSigner.js +16 -0
  94. package/dist/index.d.ts +37 -0
  95. package/dist/index.js +53 -0
  96. package/dist/utils/Utils.d.ts +15 -0
  97. package/dist/utils/Utils.js +71 -0
  98. package/package.json +37 -0
  99. package/src/chains/citrea/CitreaChainType.ts +28 -0
  100. package/src/chains/citrea/CitreaInitializer.ts +167 -0
  101. package/src/evm/btcrelay/BtcRelayAbi.ts +258 -0
  102. package/src/evm/btcrelay/BtcRelayTypechain.ts +371 -0
  103. package/src/evm/btcrelay/EVMBtcRelay.ts +517 -0
  104. package/src/evm/btcrelay/headers/EVMBtcHeader.ts +110 -0
  105. package/src/evm/btcrelay/headers/EVMBtcStoredHeader.ts +153 -0
  106. package/src/evm/chain/EVMChainInterface.ts +157 -0
  107. package/src/evm/chain/EVMModule.ts +21 -0
  108. package/src/evm/chain/modules/ERC20Abi.ts +222 -0
  109. package/src/evm/chain/modules/EVMAddresses.ts +24 -0
  110. package/src/evm/chain/modules/EVMBlocks.ts +75 -0
  111. package/src/evm/chain/modules/EVMEvents.ts +139 -0
  112. package/src/evm/chain/modules/EVMFees.ts +105 -0
  113. package/src/evm/chain/modules/EVMSignatures.ts +76 -0
  114. package/src/evm/chain/modules/EVMTokens.ts +115 -0
  115. package/src/evm/chain/modules/EVMTransactions.ts +246 -0
  116. package/src/evm/contract/EVMContractBase.ts +63 -0
  117. package/src/evm/contract/EVMContractModule.ts +16 -0
  118. package/src/evm/contract/modules/EVMContractEvents.ts +102 -0
  119. package/src/evm/events/EVMChainEvents.ts +81 -0
  120. package/src/evm/events/EVMChainEventsBrowser.ts +390 -0
  121. package/src/evm/spv_swap/EVMSpvVaultContract.ts +533 -0
  122. package/src/evm/spv_swap/EVMSpvVaultData.ts +201 -0
  123. package/src/evm/spv_swap/EVMSpvWithdrawalData.ts +70 -0
  124. package/src/evm/spv_swap/SpvVaultContractAbi.ts +846 -0
  125. package/src/evm/spv_swap/SpvVaultContractTypechain.ts +685 -0
  126. package/src/evm/swaps/EVMSwapContract.ts +590 -0
  127. package/src/evm/swaps/EVMSwapData.ts +367 -0
  128. package/src/evm/swaps/EVMSwapModule.ts +16 -0
  129. package/src/evm/swaps/EscrowManagerAbi.ts +982 -0
  130. package/src/evm/swaps/EscrowManagerTypechain.ts +723 -0
  131. package/src/evm/swaps/handlers/IHandler.ts +17 -0
  132. package/src/evm/swaps/handlers/claim/ClaimHandlers.ts +20 -0
  133. package/src/evm/swaps/handlers/claim/HashlockClaimHandler.ts +47 -0
  134. package/src/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.ts +82 -0
  135. package/src/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.ts +76 -0
  136. package/src/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.ts +46 -0
  137. package/src/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.ts +115 -0
  138. package/src/evm/swaps/handlers/refund/TimelockRefundHandler.ts +38 -0
  139. package/src/evm/swaps/modules/EVMLpVault.ts +153 -0
  140. package/src/evm/swaps/modules/EVMSwapClaim.ts +141 -0
  141. package/src/evm/swaps/modules/EVMSwapInit.ts +292 -0
  142. package/src/evm/swaps/modules/EVMSwapRefund.ts +198 -0
  143. package/src/evm/typechain/common.ts +131 -0
  144. package/src/evm/wallet/EVMSigner.ts +23 -0
  145. package/src/index.ts +44 -0
  146. package/src/utils/Utils.ts +81 -0
@@ -0,0 +1,533 @@
1
+ import {
2
+ BigIntBufferUtils,
3
+ BitcoinRpc,
4
+ BtcTx,
5
+ RelaySynchronizer,
6
+ SpvVaultContract,
7
+ SpvVaultTokenData,
8
+ SpvWithdrawalState,
9
+ SpvWithdrawalStateType,
10
+ SpvWithdrawalTransactionData,
11
+ TransactionConfirmationOptions
12
+ } from "@atomiqlabs/base";
13
+ import {Buffer} from "buffer";
14
+ import { EVMTx } from "../chain/modules/EVMTransactions";
15
+ import { EVMContractBase } from "../contract/EVMContractBase";
16
+ import { EVMSigner } from "../wallet/EVMSigner";
17
+ import {SpvVaultContractAbi} from "./SpvVaultContractAbi";
18
+ import {SpvVaultManager, SpvVaultParametersStructOutput} from "./SpvVaultContractTypechain";
19
+ import {EVMBtcRelay} from "../btcrelay/EVMBtcRelay";
20
+ import {getLogger} from "../../utils/Utils";
21
+ import {EVMChainInterface} from "../chain/EVMChainInterface";
22
+ import {AbiCoder, getAddress, hexlify, keccak256, TransactionRequest, ZeroAddress, ZeroHash} from "ethers";
23
+ import {EVMAddresses} from "../chain/modules/EVMAddresses";
24
+ import {EVMSpvVaultData, getVaultParamsCommitment} from "./EVMSpvVaultData";
25
+ import {EVMSpvWithdrawalData} from "./EVMSpvWithdrawalData";
26
+ import {EVMFees} from "../chain/modules/EVMFees";
27
+ import {EVMBtcStoredHeader} from "../btcrelay/headers/EVMBtcStoredHeader";
28
+ import {TypedEventLog} from "../typechain/common";
29
+
30
+ function decodeUtxo(utxo: string): {txHash: string, vout: bigint} {
31
+ const [txId, vout] = utxo.split(":");
32
+ return {
33
+ txHash: "0x"+Buffer.from(txId, "hex").reverse().toString("hex"),
34
+ vout: BigInt(vout)
35
+ }
36
+ }
37
+
38
+ export function packOwnerAndVaultId(owner: string, vaultId: bigint): string {
39
+ if(owner.length!==42) throw new Error("Invalid owner address");
40
+ return owner.toLowerCase() + BigIntBufferUtils.toBuffer(vaultId, "be", 12).toString("hex");
41
+ }
42
+
43
+ export function unpackOwnerAndVaultId(data: string): [string, bigint] {
44
+ return [getAddress(data.substring(0, 42)), BigInt("0x"+data.substring(42, 66))];
45
+ }
46
+
47
+ export class EVMSpvVaultContract<ChainId extends string>
48
+ extends EVMContractBase<SpvVaultManager>
49
+ implements SpvVaultContract<
50
+ EVMTx,
51
+ EVMSigner,
52
+ ChainId,
53
+ EVMSpvVaultData,
54
+ EVMSpvWithdrawalData
55
+ >
56
+ {
57
+ private static readonly GasCosts = {
58
+ DEPOSIT: 150_000,
59
+ OPEN: 100_000,
60
+ FRONT: 250_000,
61
+ CLAIM: 250_000
62
+ };
63
+
64
+ readonly chainId: ChainId;
65
+
66
+ readonly btcRelay: EVMBtcRelay<any>;
67
+ readonly bitcoinRpc: BitcoinRpc<any>;
68
+ readonly claimTimeout: number = 180;
69
+
70
+ readonly logger = getLogger("EVMSpvVaultContract: ");
71
+
72
+ constructor(
73
+ chainInterface: EVMChainInterface<ChainId>,
74
+ btcRelay: EVMBtcRelay<any>,
75
+ bitcoinRpc: BitcoinRpc<any>,
76
+ contractAddress: string,
77
+ contractDeploymentHeight?: number
78
+ ) {
79
+ super(chainInterface, contractAddress, SpvVaultContractAbi, contractDeploymentHeight);
80
+ this.btcRelay = btcRelay;
81
+ this.bitcoinRpc = bitcoinRpc;
82
+ }
83
+
84
+ //Transactions
85
+ protected async Open(signer: string, vault: EVMSpvVaultData, feeRate: string): Promise<TransactionRequest> {
86
+ const {txHash, vout} = decodeUtxo(vault.getUtxo());
87
+
88
+ const tokens = vault.getTokenData();
89
+ if(tokens.length!==2) throw new Error("Must specify exactly 2 tokens for vault!");
90
+
91
+ const tx = await this.contract.open.populateTransaction(vault.vaultId, vault.getVaultParamsStruct(), txHash, vout);
92
+ tx.from = signer;
93
+ EVMFees.applyFeeRate(tx, EVMSpvVaultContract.GasCosts.OPEN, feeRate);
94
+
95
+ return tx;
96
+ }
97
+
98
+ protected async Deposit(signer: string, vault: EVMSpvVaultData, rawAmounts: bigint[], feeRate: string): Promise<TransactionRequest> {
99
+ let value = 0n;
100
+ if(vault.token0.token.toLowerCase()===this.Chain.getNativeCurrencyAddress().toLowerCase())
101
+ value += rawAmounts[0] * vault.token0.multiplier;
102
+ if(vault.token1.token.toLowerCase()===this.Chain.getNativeCurrencyAddress().toLowerCase())
103
+ value += (rawAmounts[1] ?? 0n) * vault.token1.multiplier;
104
+
105
+ const tx = await this.contract.deposit.populateTransaction(
106
+ vault.owner, vault.vaultId, vault.getVaultParamsStruct(),
107
+ rawAmounts[0], rawAmounts[1] ?? 0n, { value }
108
+ );
109
+ tx.from = signer;
110
+ EVMFees.applyFeeRate(tx, EVMSpvVaultContract.GasCosts.DEPOSIT, feeRate);
111
+
112
+ return tx;
113
+ }
114
+
115
+ protected async Front(
116
+ signer: string, vault: EVMSpvVaultData, data: EVMSpvWithdrawalData, withdrawalSequence: number, feeRate: string
117
+ ): Promise<TransactionRequest> {
118
+ let value = 0n;
119
+ const frontingAmount = data.getFrontingAmount();
120
+ if(vault.token0.token.toLowerCase()===this.Chain.getNativeCurrencyAddress().toLowerCase())
121
+ value += frontingAmount[0] * vault.token0.multiplier;
122
+ if(vault.token1.token.toLowerCase()===this.Chain.getNativeCurrencyAddress().toLowerCase())
123
+ value += (frontingAmount[1] ?? 0n) * vault.token1.multiplier;
124
+
125
+ const tx = await this.contract.front.populateTransaction(
126
+ vault.owner, vault.vaultId, vault.getVaultParamsStruct(),
127
+ withdrawalSequence, data.getTxHash(), data.serializeToStruct(),
128
+ { value }
129
+ );
130
+ tx.from = signer;
131
+ EVMFees.applyFeeRate(tx, EVMSpvVaultContract.GasCosts.FRONT, feeRate);
132
+
133
+ return tx;
134
+ }
135
+
136
+ protected async Claim(
137
+ signer: string, vault: EVMSpvVaultData, data: EVMSpvWithdrawalData,
138
+ blockheader: EVMBtcStoredHeader, merkle: Buffer[], position: number, feeRate: string
139
+ ): Promise<TransactionRequest> {
140
+ const tx = await this.contract.claim.populateTransaction(
141
+ vault.owner, vault.vaultId, vault.getVaultParamsStruct(), "0x"+data.btcTx.hex,
142
+ blockheader.serializeToStruct(), merkle, position
143
+ )
144
+
145
+ tx.from = signer;
146
+ EVMFees.applyFeeRate(tx, EVMSpvVaultContract.GasCosts.CLAIM, feeRate);
147
+
148
+ return tx;
149
+ }
150
+
151
+ async checkWithdrawalTx(tx: SpvWithdrawalTransactionData): Promise<void> {
152
+ const result = await this.contract.parseBitcoinTx(Buffer.from(tx.btcTx.hex, "hex"));
153
+ if(result==null) throw new Error("Failed to parse transaction!");
154
+ }
155
+
156
+ createVaultData(
157
+ owner: string, vaultId: bigint, utxo: string, confirmations: number, tokenData: SpvVaultTokenData[]
158
+ ): Promise<EVMSpvVaultData> {
159
+ if(tokenData.length!==2) throw new Error("Must specify 2 tokens in tokenData!");
160
+
161
+ const vaultParams = {
162
+ btcRelayContract: this.btcRelay.contractAddress,
163
+ token0: tokenData[0].token,
164
+ token1: tokenData[1].token,
165
+ token0Multiplier: tokenData[0].multiplier,
166
+ token1Multiplier: tokenData[1].multiplier,
167
+ confirmations: BigInt(confirmations)
168
+ };
169
+
170
+ const spvVaultParametersCommitment = keccak256(AbiCoder.defaultAbiCoder().encode(
171
+ ["address", "address", "address", "uint192", "uint192", "uint256"],
172
+ [vaultParams.btcRelayContract, vaultParams.token0, vaultParams.token1, vaultParams.token0Multiplier, vaultParams.token1Multiplier, vaultParams.confirmations]
173
+ ));
174
+
175
+ return Promise.resolve(new EVMSpvVaultData(owner, vaultId, {
176
+ spvVaultParametersCommitment,
177
+ utxoTxHash: ZeroHash,
178
+ utxoVout: 0n,
179
+ openBlockheight: 0n,
180
+ withdrawCount: 0n,
181
+ depositCount: 0n,
182
+ token0Amount: 0n,
183
+ token1Amount: 0n
184
+ }, vaultParams, utxo));
185
+ }
186
+
187
+ //Getters
188
+ async getFronterAddress(owner: string, vaultId: bigint, withdrawal: EVMSpvWithdrawalData): Promise<string> {
189
+ const frontingAddress = await this.contract.getFronterById(owner, vaultId, "0x"+withdrawal.getFrontingId());
190
+ if(frontingAddress===ZeroAddress) return null;
191
+ return frontingAddress;
192
+ }
193
+
194
+ async getVaultData(owner: string, vaultId: bigint): Promise<EVMSpvVaultData> {
195
+ const vaultState = await this.contract.getVault(owner, vaultId);
196
+ const blockheight = Number(vaultState.openBlockheight);
197
+ const events = await this.Events.getContractBlockEvents(
198
+ ["Opened"],
199
+ [
200
+ "0x"+owner.substring(2).padStart(64, "0"),
201
+ hexlify(BigIntBufferUtils.toBuffer(vaultId, "be", 32))
202
+ ],
203
+ blockheight
204
+ );
205
+
206
+ const foundEvent = events.find(
207
+ event => getVaultParamsCommitment(event.args.params)===vaultState.spvVaultParametersCommitment
208
+ );
209
+ if(foundEvent==null) throw new Error("Valid open event not found!");
210
+
211
+ const vaultParams = foundEvent.args.params;
212
+ if(vaultParams.btcRelayContract.toLowerCase()!==this.btcRelay.contractAddress.toLowerCase()) return null;
213
+
214
+ return new EVMSpvVaultData(owner, vaultId, vaultState, vaultParams);
215
+ }
216
+
217
+ async getAllVaults(owner?: string): Promise<EVMSpvVaultData[]> {
218
+ const openedVaults = new Map<string, SpvVaultParametersStructOutput>();
219
+ await this.Events.findInContractEventsForward(
220
+ ["Opened", "Closed"],
221
+ owner==null ? null : [
222
+ "0x"+owner.substring(2).padStart(64, "0")
223
+ ],
224
+ (event) => {
225
+ const vaultIdentifier = event.args.owner+":"+event.args.vaultId.toString(10);
226
+ if(event.eventName==="Opened") {
227
+ const _event = event as TypedEventLog<SpvVaultManager["filters"]["Opened"]>;
228
+ openedVaults.set(vaultIdentifier, _event.args.params);
229
+ } else {
230
+ openedVaults.delete(vaultIdentifier);
231
+ }
232
+ return null;
233
+ }
234
+ );
235
+ const vaults: EVMSpvVaultData[] = [];
236
+ for(let [identifier, vaultParams] of openedVaults.entries()) {
237
+ const [owner, vaultIdStr] = identifier.split(":");
238
+
239
+ const vaultState = await this.contract.getVault(owner, BigInt(vaultIdStr));
240
+ if(vaultState.spvVaultParametersCommitment === getVaultParamsCommitment(vaultParams)) {
241
+ vaults.push(new EVMSpvVaultData(owner, BigInt(vaultIdStr), vaultState, vaultParams))
242
+ }
243
+ }
244
+ return vaults;
245
+ }
246
+
247
+ async getWithdrawalState(btcTxId: string): Promise<SpvWithdrawalState> {
248
+ const txHash = Buffer.from(btcTxId, "hex").reverse();
249
+ let result: SpvWithdrawalState = await this.Events.findInContractEvents(
250
+ ["Fronted", "Claimed", "Closed"],
251
+ [
252
+ null,
253
+ null,
254
+ hexlify(txHash)
255
+ ],
256
+ async (event) => {
257
+ switch(event.eventName) {
258
+ case "Fronted":
259
+ const frontedEvent = event as TypedEventLog<SpvVaultManager["filters"]["Fronted"]>;
260
+ const [ownerFront, vaultIdFront] = unpackOwnerAndVaultId(frontedEvent.args.ownerAndVaultId);
261
+ return {
262
+ type: SpvWithdrawalStateType.FRONTED,
263
+ txId: event.transactionHash,
264
+ owner: ownerFront,
265
+ vaultId: vaultIdFront,
266
+ recipient: frontedEvent.args.recipient,
267
+ fronter: frontedEvent.args.caller
268
+ };
269
+ case "Claimed":
270
+ const claimedEvent = event as TypedEventLog<SpvVaultManager["filters"]["Claimed"]>;
271
+ const [ownerClaim, vaultIdClaim] = unpackOwnerAndVaultId(claimedEvent.args.ownerAndVaultId);
272
+ return {
273
+ type: SpvWithdrawalStateType.CLAIMED,
274
+ txId: event.transactionHash,
275
+ owner: ownerClaim,
276
+ vaultId: vaultIdClaim,
277
+ recipient: claimedEvent.args.recipient,
278
+ claimer: claimedEvent.args.caller,
279
+ fronter: claimedEvent.args.frontingAddress
280
+ };
281
+ case "Closed":
282
+ const closedEvent = event as TypedEventLog<SpvVaultManager["filters"]["Closed"]>;
283
+ return {
284
+ type: SpvWithdrawalStateType.CLOSED,
285
+ txId: event.transactionHash,
286
+ owner: closedEvent.args.owner,
287
+ vaultId: closedEvent.args.vaultId,
288
+ error: closedEvent.args.error
289
+ };
290
+ }
291
+ }
292
+ );
293
+ result ??= {
294
+ type: SpvWithdrawalStateType.NOT_FOUND
295
+ };
296
+ return result;
297
+ }
298
+
299
+ getWithdrawalData(btcTx: BtcTx): Promise<EVMSpvWithdrawalData> {
300
+ return Promise.resolve(new EVMSpvWithdrawalData(btcTx));
301
+ }
302
+
303
+ //OP_RETURN data encoding/decoding
304
+ fromOpReturnData(data: Buffer): { recipient: string; rawAmounts: bigint[]; executionHash: string } {
305
+ return EVMSpvVaultContract.fromOpReturnData(data);
306
+ }
307
+ static fromOpReturnData(data: Buffer): { recipient: string; rawAmounts: bigint[]; executionHash: string } {
308
+ let rawAmount0: bigint = 0n;
309
+ let rawAmount1: bigint = 0n;
310
+ let executionHash: string = null;
311
+ if(data.length===28) {
312
+ rawAmount0 = data.readBigInt64BE(20).valueOf();
313
+ } else if(data.length===36) {
314
+ rawAmount0 = data.readBigInt64BE(20).valueOf();
315
+ rawAmount1 = data.readBigInt64BE(28).valueOf();
316
+ } else if(data.length===60) {
317
+ rawAmount0 = data.readBigInt64BE(20).valueOf();
318
+ executionHash = data.slice(28, 60).toString("hex");
319
+ } else if(data.length===68) {
320
+ rawAmount0 = data.readBigInt64BE(20).valueOf();
321
+ rawAmount1 = data.readBigInt64BE(28).valueOf();
322
+ executionHash = data.slice(36, 68).toString("hex");
323
+ } else {
324
+ throw new Error("Invalid OP_RETURN data length!");
325
+ }
326
+
327
+ const recipient = "0x"+data.slice(0, 20).toString("hex");
328
+ if(!EVMAddresses.isValidAddress(recipient)) throw new Error("Invalid recipient specified");
329
+
330
+ return {executionHash, rawAmounts: [rawAmount0, rawAmount1], recipient: getAddress(recipient)};
331
+ }
332
+
333
+ toOpReturnData(recipient: string, rawAmounts: bigint[], executionHash?: string): Buffer {
334
+ return EVMSpvVaultContract.toOpReturnData(recipient, rawAmounts, executionHash);
335
+ }
336
+ static toOpReturnData(recipient: string, rawAmounts: bigint[], executionHash?: string): Buffer {
337
+ if(!EVMAddresses.isValidAddress(recipient)) throw new Error("Invalid recipient specified");
338
+ if(rawAmounts.length < 1) throw new Error("At least 1 amount needs to be specified");
339
+ if(rawAmounts.length > 2) throw new Error("At most 2 amounts need to be specified");
340
+ rawAmounts.forEach(val => {
341
+ if(val < 0n) throw new Error("Negative raw amount specified");
342
+ if(val >= 2n**64n) throw new Error("Raw amount overflow");
343
+ });
344
+ if(executionHash!=null) {
345
+ if(Buffer.from(executionHash, "hex").length !== 32)
346
+ throw new Error("Invalid execution hash");
347
+ }
348
+ const recipientBuffer = Buffer.from(recipient.substring(2).padStart(40, "0"), "hex");
349
+ const amount0Buffer = BigIntBufferUtils.toBuffer(rawAmounts[0], "be", 8);
350
+ const amount1Buffer = rawAmounts[1]==null || rawAmounts[1]===0n ? Buffer.alloc(0) : BigIntBufferUtils.toBuffer(rawAmounts[1], "be", 8);
351
+ const executionHashBuffer = executionHash==null ? Buffer.alloc(0) : Buffer.from(executionHash, "hex");
352
+
353
+ return Buffer.concat([
354
+ recipientBuffer,
355
+ amount0Buffer,
356
+ amount1Buffer,
357
+ executionHashBuffer
358
+ ]);
359
+ }
360
+
361
+ //Actions
362
+ async claim(signer: EVMSigner, vault: EVMSpvVaultData, txs: {tx: EVMSpvWithdrawalData, storedHeader?: EVMBtcStoredHeader}[], synchronizer?: RelaySynchronizer<any, any, any>, initAta?: boolean, txOptions?: TransactionConfirmationOptions): Promise<string> {
363
+ const result = await this.txsClaim(signer.getAddress(), vault, txs, synchronizer, initAta, txOptions?.feeRate);
364
+ const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
365
+ return signature;
366
+ }
367
+
368
+ async deposit(signer: EVMSigner, vault: EVMSpvVaultData, rawAmounts: bigint[], txOptions?: TransactionConfirmationOptions): Promise<string> {
369
+ const result = await this.txsDeposit(signer.getAddress(), vault, rawAmounts, txOptions?.feeRate);
370
+ const txHashes = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
371
+ return txHashes[txHashes.length - 1];
372
+ }
373
+
374
+ async frontLiquidity(signer: EVMSigner, vault: EVMSpvVaultData, realWithdrawalTx: EVMSpvWithdrawalData, withdrawSequence: number, txOptions?: TransactionConfirmationOptions): Promise<string> {
375
+ const result = await this.txsFrontLiquidity(signer.getAddress(), vault, realWithdrawalTx, withdrawSequence, txOptions?.feeRate);
376
+ const txHashes = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
377
+ return txHashes[txHashes.length - 1];
378
+ }
379
+
380
+ async open(signer: EVMSigner, vault: EVMSpvVaultData, txOptions?: TransactionConfirmationOptions): Promise<string> {
381
+ const result = await this.txsOpen(signer.getAddress(), vault, txOptions?.feeRate);
382
+ const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
383
+ return signature;
384
+ }
385
+
386
+ //Transactions
387
+ async txsClaim(
388
+ signer: string, vault: EVMSpvVaultData, txs: {
389
+ tx: EVMSpvWithdrawalData,
390
+ storedHeader?: EVMBtcStoredHeader
391
+ }[], synchronizer?: RelaySynchronizer<any, any, any>,
392
+ initAta?: boolean, feeRate?: string
393
+ ): Promise<EVMTx[]> {
394
+ if(!vault.isOpened()) throw new Error("Cannot claim from a closed vault!");
395
+ feeRate ??= await this.Chain.Fees.getFeeRate();
396
+
397
+ const txsWithMerkleProofs: {
398
+ tx: EVMSpvWithdrawalData,
399
+ reversedTxId: Buffer,
400
+ pos: number,
401
+ blockheight: number,
402
+ merkle: Buffer[],
403
+ storedHeader?: EVMBtcStoredHeader
404
+ }[] = [];
405
+ for(let tx of txs) {
406
+ const merkleProof = await this.bitcoinRpc.getMerkleProof(tx.tx.btcTx.txid, tx.tx.btcTx.blockhash);
407
+ this.logger.debug("txsClaim(): merkle proof computed: ", merkleProof);
408
+ txsWithMerkleProofs.push({
409
+ ...merkleProof,
410
+ ...tx
411
+ });
412
+ }
413
+
414
+ const evmTxs: EVMTx[] = [];
415
+ const storedHeaders: {[blockhash: string]: EVMBtcStoredHeader} = await EVMBtcRelay.getCommitedHeadersAndSynchronize(
416
+ signer, this.btcRelay, txsWithMerkleProofs.filter(tx => tx.storedHeader==null).map(tx => {
417
+ return {
418
+ blockhash: tx.tx.btcTx.blockhash,
419
+ blockheight: tx.blockheight,
420
+ requiredConfirmations: vault.getConfirmations()
421
+ }
422
+ }), evmTxs, synchronizer, feeRate
423
+ );
424
+ if(storedHeaders==null) throw new Error("Cannot fetch committed header!");
425
+
426
+ for(let tx of txsWithMerkleProofs) {
427
+ evmTxs.push(await this.Claim(signer, vault, tx.tx, tx.storedHeader ?? storedHeaders[tx.tx.btcTx.blockhash], tx.merkle, tx.pos, feeRate));
428
+ }
429
+
430
+ this.logger.debug("txsClaim(): "+evmTxs.length+" claim TXs created claiming "+txs.length+" txs, owner: "+vault.getOwner()+
431
+ " vaultId: "+vault.getVaultId().toString(10));
432
+
433
+ return evmTxs;
434
+ }
435
+
436
+ async txsDeposit(signer: string, vault: EVMSpvVaultData, rawAmounts: bigint[], feeRate?: string): Promise<EVMTx[]> {
437
+ if(!vault.isOpened()) throw new Error("Cannot deposit to a closed vault!");
438
+ feeRate ??= await this.Chain.Fees.getFeeRate();
439
+
440
+ const txs: EVMTx[] = [];
441
+
442
+ let realAmount0: bigint = 0n;
443
+ let realAmount1: bigint = 0n;
444
+
445
+ //Approve first
446
+ const requiredApprovals: {[address: string]: bigint} = {};
447
+ if(rawAmounts[0]!=null && rawAmounts[0]!==0n) {
448
+ if(vault.token0.token.toLowerCase()!==this.Chain.getNativeCurrencyAddress().toLowerCase()) {
449
+ realAmount0 = rawAmounts[0] * vault.token0.multiplier;
450
+ requiredApprovals[vault.token0.token.toLowerCase()] = realAmount0;
451
+ }
452
+ }
453
+ if(rawAmounts[1]!=null && rawAmounts[1]!==0n) {
454
+ if(vault.token1.token.toLowerCase()!==this.Chain.getNativeCurrencyAddress().toLowerCase()) {
455
+ realAmount1 = rawAmounts[1] * vault.token1.multiplier;
456
+ requiredApprovals[vault.token1.token.toLowerCase()] ??= 0n;
457
+ requiredApprovals[vault.token1.token.toLowerCase()] += realAmount1;
458
+ }
459
+ }
460
+ for(let tokenAddress in requiredApprovals) {
461
+ txs.push(await this.Chain.Tokens.Approve(signer, tokenAddress, requiredApprovals[tokenAddress], this.contractAddress, feeRate));
462
+ }
463
+
464
+ txs.push(await this.Deposit(signer, vault, rawAmounts, feeRate));
465
+
466
+ this.logger.debug("txsDeposit(): deposit TX created,"+
467
+ " token0: "+vault.token0.token+" rawAmount0: "+rawAmounts[0].toString(10)+" amount0: "+realAmount0.toString(10)+
468
+ " token1: "+vault.token1.token+" rawAmount1: "+(rawAmounts[1] ?? 0n).toString(10)+" amount1: "+realAmount1.toString(10));
469
+
470
+ return txs;
471
+ }
472
+
473
+ async txsFrontLiquidity(signer: string, vault: EVMSpvVaultData, realWithdrawalTx: EVMSpvWithdrawalData, withdrawSequence: number, feeRate?: string): Promise<EVMTx[]> {
474
+ if(!vault.isOpened()) throw new Error("Cannot front on a closed vault!");
475
+ feeRate ??= await this.Chain.Fees.getFeeRate();
476
+
477
+ const txs: EVMTx[] = [];
478
+
479
+ let realAmount0 = 0n;
480
+ let realAmount1 = 0n;
481
+
482
+ //Approve first
483
+ const rawAmounts = realWithdrawalTx.getFrontingAmount();
484
+ //Approve first
485
+ const requiredApprovals: {[address: string]: bigint} = {};
486
+ if(rawAmounts[0]!=null && rawAmounts[0]!==0n) {
487
+ if(vault.token0.token.toLowerCase()!==this.Chain.getNativeCurrencyAddress().toLowerCase()) {
488
+ realAmount0 = rawAmounts[0] * vault.token0.multiplier;
489
+ requiredApprovals[vault.token0.token.toLowerCase()] = realAmount0;
490
+ }
491
+ }
492
+ if(rawAmounts[1]!=null && rawAmounts[1]!==0n) {
493
+ if(vault.token1.token.toLowerCase()!==this.Chain.getNativeCurrencyAddress().toLowerCase()) {
494
+ realAmount1 = rawAmounts[1] * vault.token1.multiplier;
495
+ requiredApprovals[vault.token1.token.toLowerCase()] ??= 0n;
496
+ requiredApprovals[vault.token1.token.toLowerCase()] += realAmount1;
497
+ }
498
+ }
499
+ for(let tokenAddress in requiredApprovals) {
500
+ txs.push(await this.Chain.Tokens.Approve(signer, tokenAddress, requiredApprovals[tokenAddress], this.contractAddress, feeRate));
501
+ }
502
+ txs.push(await this.Front(signer, vault, realWithdrawalTx, withdrawSequence, feeRate));
503
+
504
+ this.logger.debug("txsFrontLiquidity(): front TX created,"+
505
+ " token0: "+vault.token0.token+" rawAmount0: "+rawAmounts[0].toString(10)+" amount0: "+realAmount0.toString(10)+
506
+ " token1: "+vault.token1.token+" rawAmount1: "+(rawAmounts[1] ?? 0n).toString(10)+" amount1: "+realAmount1.toString(10));
507
+
508
+ return txs;
509
+ }
510
+
511
+ async txsOpen(signer: string, vault: EVMSpvVaultData, feeRate?: string): Promise<EVMTx[]> {
512
+ if(vault.isOpened()) throw new Error("Cannot open an already opened vault!");
513
+ feeRate ??= await this.Chain.Fees.getFeeRate();
514
+
515
+ const tx = await this.Open(signer, vault, feeRate);
516
+
517
+ this.logger.debug("txsOpen(): open TX created, owner: "+vault.getOwner()+
518
+ " vaultId: "+vault.getVaultId().toString(10));
519
+
520
+ return [tx];
521
+ }
522
+
523
+ async getClaimFee(signer: string, withdrawalData: EVMSpvWithdrawalData, feeRate?: string): Promise<bigint> {
524
+ feeRate ??= await this.Chain.Fees.getFeeRate();
525
+ return EVMFees.getGasFee(EVMSpvVaultContract.GasCosts.CLAIM, feeRate);
526
+ }
527
+
528
+ async getFrontFee(signer: string, withdrawalData: EVMSpvWithdrawalData, feeRate?: string): Promise<bigint> {
529
+ feeRate ??= await this.Chain.Fees.getFeeRate();
530
+ return EVMFees.getGasFee(EVMSpvVaultContract.GasCosts.FRONT, feeRate);
531
+ }
532
+
533
+ }