@atomiqlabs/chain-evm 1.0.0-dev.38 → 1.0.0-dev.40

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 (167) hide show
  1. package/LICENSE +201 -201
  2. package/dist/chains/botanix/BotanixChainType.d.ts +13 -0
  3. package/dist/chains/botanix/BotanixChainType.js +2 -0
  4. package/dist/chains/botanix/BotanixInitializer.d.ts +30 -0
  5. package/dist/chains/botanix/BotanixInitializer.js +117 -0
  6. package/dist/chains/citrea/CitreaBtcRelay.d.ts +21 -21
  7. package/dist/chains/citrea/CitreaBtcRelay.js +43 -43
  8. package/dist/chains/citrea/CitreaChainType.d.ts +13 -13
  9. package/dist/chains/citrea/CitreaChainType.js +2 -2
  10. package/dist/chains/citrea/CitreaFees.d.ts +29 -29
  11. package/dist/chains/citrea/CitreaFees.js +67 -67
  12. package/dist/chains/citrea/CitreaInitializer.d.ts +30 -30
  13. package/dist/chains/citrea/CitreaInitializer.js +127 -127
  14. package/dist/chains/citrea/CitreaSpvVaultContract.d.ts +15 -15
  15. package/dist/chains/citrea/CitreaSpvVaultContract.js +74 -74
  16. package/dist/chains/citrea/CitreaSwapContract.d.ts +22 -22
  17. package/dist/chains/citrea/CitreaSwapContract.js +96 -96
  18. package/dist/chains/citrea/CitreaTokens.d.ts +9 -9
  19. package/dist/chains/citrea/CitreaTokens.js +20 -20
  20. package/dist/evm/btcrelay/BtcRelayAbi.d.ts +198 -198
  21. package/dist/evm/btcrelay/BtcRelayAbi.js +261 -261
  22. package/dist/evm/btcrelay/BtcRelayTypechain.d.ts +172 -172
  23. package/dist/evm/btcrelay/BtcRelayTypechain.js +2 -2
  24. package/dist/evm/btcrelay/EVMBtcRelay.d.ts +195 -195
  25. package/dist/evm/btcrelay/EVMBtcRelay.js +423 -423
  26. package/dist/evm/btcrelay/headers/EVMBtcHeader.d.ts +33 -33
  27. package/dist/evm/btcrelay/headers/EVMBtcHeader.js +84 -84
  28. package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.d.ts +56 -56
  29. package/dist/evm/btcrelay/headers/EVMBtcStoredHeader.js +123 -123
  30. package/dist/evm/chain/EVMChainInterface.d.ts +51 -51
  31. package/dist/evm/chain/EVMChainInterface.js +89 -89
  32. package/dist/evm/chain/EVMModule.d.ts +9 -9
  33. package/dist/evm/chain/EVMModule.js +13 -13
  34. package/dist/evm/chain/modules/ERC20Abi.d.ts +168 -168
  35. package/dist/evm/chain/modules/ERC20Abi.js +225 -225
  36. package/dist/evm/chain/modules/EVMAddresses.d.ts +10 -10
  37. package/dist/evm/chain/modules/EVMAddresses.js +30 -30
  38. package/dist/evm/chain/modules/EVMBlocks.d.ts +20 -20
  39. package/dist/evm/chain/modules/EVMBlocks.js +64 -64
  40. package/dist/evm/chain/modules/EVMEvents.d.ts +36 -36
  41. package/dist/evm/chain/modules/EVMEvents.js +122 -122
  42. package/dist/evm/chain/modules/EVMFees.d.ts +36 -36
  43. package/dist/evm/chain/modules/EVMFees.js +73 -73
  44. package/dist/evm/chain/modules/EVMSignatures.d.ts +29 -29
  45. package/dist/evm/chain/modules/EVMSignatures.js +68 -68
  46. package/dist/evm/chain/modules/EVMTokens.d.ts +70 -70
  47. package/dist/evm/chain/modules/EVMTokens.js +142 -142
  48. package/dist/evm/chain/modules/EVMTransactions.d.ts +89 -89
  49. package/dist/evm/chain/modules/EVMTransactions.js +230 -230
  50. package/dist/evm/contract/EVMContractBase.d.ts +22 -22
  51. package/dist/evm/contract/EVMContractBase.js +34 -34
  52. package/dist/evm/contract/EVMContractModule.d.ts +8 -8
  53. package/dist/evm/contract/EVMContractModule.js +11 -11
  54. package/dist/evm/contract/modules/EVMContractEvents.d.ts +42 -42
  55. package/dist/evm/contract/modules/EVMContractEvents.js +75 -75
  56. package/dist/evm/events/EVMChainEvents.d.ts +22 -22
  57. package/dist/evm/events/EVMChainEvents.js +67 -67
  58. package/dist/evm/events/EVMChainEventsBrowser.d.ts +86 -86
  59. package/dist/evm/events/EVMChainEventsBrowser.js +294 -294
  60. package/dist/evm/spv_swap/EVMSpvVaultContract.d.ts +78 -78
  61. package/dist/evm/spv_swap/EVMSpvVaultContract.js +478 -478
  62. package/dist/evm/spv_swap/EVMSpvVaultData.d.ts +39 -39
  63. package/dist/evm/spv_swap/EVMSpvVaultData.js +180 -180
  64. package/dist/evm/spv_swap/EVMSpvWithdrawalData.d.ts +19 -19
  65. package/dist/evm/spv_swap/EVMSpvWithdrawalData.js +55 -55
  66. package/dist/evm/spv_swap/SpvVaultContractAbi.d.ts +91 -91
  67. package/dist/evm/spv_swap/SpvVaultContractAbi.js +849 -849
  68. package/dist/evm/spv_swap/SpvVaultContractTypechain.d.ts +450 -450
  69. package/dist/evm/spv_swap/SpvVaultContractTypechain.js +2 -2
  70. package/dist/evm/swaps/EVMSwapContract.d.ts +193 -193
  71. package/dist/evm/swaps/EVMSwapContract.js +378 -378
  72. package/dist/evm/swaps/EVMSwapData.d.ts +66 -66
  73. package/dist/evm/swaps/EVMSwapData.js +260 -260
  74. package/dist/evm/swaps/EVMSwapModule.d.ts +9 -9
  75. package/dist/evm/swaps/EVMSwapModule.js +11 -11
  76. package/dist/evm/swaps/EscrowManagerAbi.d.ts +120 -120
  77. package/dist/evm/swaps/EscrowManagerAbi.js +985 -985
  78. package/dist/evm/swaps/EscrowManagerTypechain.d.ts +475 -475
  79. package/dist/evm/swaps/EscrowManagerTypechain.js +2 -2
  80. package/dist/evm/swaps/handlers/IHandler.d.ts +13 -13
  81. package/dist/evm/swaps/handlers/IHandler.js +2 -2
  82. package/dist/evm/swaps/handlers/claim/ClaimHandlers.d.ts +10 -10
  83. package/dist/evm/swaps/handlers/claim/ClaimHandlers.js +13 -13
  84. package/dist/evm/swaps/handlers/claim/HashlockClaimHandler.d.ts +20 -20
  85. package/dist/evm/swaps/handlers/claim/HashlockClaimHandler.js +39 -39
  86. package/dist/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.d.ts +24 -24
  87. package/dist/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.js +59 -59
  88. package/dist/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.d.ts +25 -25
  89. package/dist/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.js +51 -51
  90. package/dist/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.d.ts +21 -21
  91. package/dist/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.js +28 -28
  92. package/dist/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.d.ts +48 -48
  93. package/dist/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.js +63 -63
  94. package/dist/evm/swaps/handlers/refund/TimelockRefundHandler.d.ts +17 -17
  95. package/dist/evm/swaps/handlers/refund/TimelockRefundHandler.js +28 -28
  96. package/dist/evm/swaps/modules/EVMLpVault.d.ts +69 -69
  97. package/dist/evm/swaps/modules/EVMLpVault.js +134 -134
  98. package/dist/evm/swaps/modules/EVMSwapClaim.d.ts +54 -54
  99. package/dist/evm/swaps/modules/EVMSwapClaim.js +137 -137
  100. package/dist/evm/swaps/modules/EVMSwapInit.d.ts +88 -88
  101. package/dist/evm/swaps/modules/EVMSwapInit.js +274 -274
  102. package/dist/evm/swaps/modules/EVMSwapRefund.d.ts +62 -62
  103. package/dist/evm/swaps/modules/EVMSwapRefund.js +167 -167
  104. package/dist/evm/typechain/common.d.ts +50 -50
  105. package/dist/evm/typechain/common.js +2 -2
  106. package/dist/evm/wallet/EVMSigner.d.ts +10 -10
  107. package/dist/evm/wallet/EVMSigner.js +17 -17
  108. package/dist/index.d.ts +40 -38
  109. package/dist/index.js +56 -54
  110. package/dist/utils/Utils.d.ts +15 -15
  111. package/dist/utils/Utils.js +71 -71
  112. package/package.json +37 -37
  113. package/src/chains/botanix/BotanixChainType.ts +28 -0
  114. package/src/chains/botanix/BotanixInitializer.ts +164 -0
  115. package/src/chains/citrea/CitreaBtcRelay.ts +57 -57
  116. package/src/chains/citrea/CitreaChainType.ts +28 -28
  117. package/src/chains/citrea/CitreaFees.ts +77 -77
  118. package/src/chains/citrea/CitreaInitializer.ts +178 -178
  119. package/src/chains/citrea/CitreaSpvVaultContract.ts +75 -75
  120. package/src/chains/citrea/CitreaSwapContract.ts +102 -102
  121. package/src/chains/citrea/CitreaTokens.ts +21 -21
  122. package/src/evm/btcrelay/BtcRelayAbi.ts +258 -258
  123. package/src/evm/btcrelay/BtcRelayTypechain.ts +371 -371
  124. package/src/evm/btcrelay/EVMBtcRelay.ts +522 -522
  125. package/src/evm/btcrelay/headers/EVMBtcHeader.ts +109 -109
  126. package/src/evm/btcrelay/headers/EVMBtcStoredHeader.ts +152 -152
  127. package/src/evm/chain/EVMChainInterface.ts +155 -155
  128. package/src/evm/chain/EVMModule.ts +21 -21
  129. package/src/evm/chain/modules/ERC20Abi.ts +222 -222
  130. package/src/evm/chain/modules/EVMAddresses.ts +28 -28
  131. package/src/evm/chain/modules/EVMBlocks.ts +75 -75
  132. package/src/evm/chain/modules/EVMEvents.ts +139 -139
  133. package/src/evm/chain/modules/EVMFees.ts +104 -104
  134. package/src/evm/chain/modules/EVMSignatures.ts +76 -76
  135. package/src/evm/chain/modules/EVMTokens.ts +155 -155
  136. package/src/evm/chain/modules/EVMTransactions.ts +257 -257
  137. package/src/evm/contract/EVMContractBase.ts +63 -63
  138. package/src/evm/contract/EVMContractModule.ts +16 -16
  139. package/src/evm/contract/modules/EVMContractEvents.ts +102 -102
  140. package/src/evm/events/EVMChainEvents.ts +81 -81
  141. package/src/evm/events/EVMChainEventsBrowser.ts +390 -390
  142. package/src/evm/spv_swap/EVMSpvVaultContract.ts +608 -608
  143. package/src/evm/spv_swap/EVMSpvVaultData.ts +224 -224
  144. package/src/evm/spv_swap/EVMSpvWithdrawalData.ts +70 -70
  145. package/src/evm/spv_swap/SpvVaultContractAbi.ts +846 -846
  146. package/src/evm/spv_swap/SpvVaultContractTypechain.ts +685 -685
  147. package/src/evm/swaps/EVMSwapContract.ts +600 -600
  148. package/src/evm/swaps/EVMSwapData.ts +378 -378
  149. package/src/evm/swaps/EVMSwapModule.ts +16 -16
  150. package/src/evm/swaps/EscrowManagerAbi.ts +982 -982
  151. package/src/evm/swaps/EscrowManagerTypechain.ts +723 -723
  152. package/src/evm/swaps/handlers/IHandler.ts +17 -17
  153. package/src/evm/swaps/handlers/claim/ClaimHandlers.ts +20 -20
  154. package/src/evm/swaps/handlers/claim/HashlockClaimHandler.ts +46 -46
  155. package/src/evm/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.ts +82 -82
  156. package/src/evm/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.ts +76 -76
  157. package/src/evm/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.ts +46 -46
  158. package/src/evm/swaps/handlers/claim/btc/IBitcoinClaimHandler.ts +115 -115
  159. package/src/evm/swaps/handlers/refund/TimelockRefundHandler.ts +37 -37
  160. package/src/evm/swaps/modules/EVMLpVault.ts +154 -154
  161. package/src/evm/swaps/modules/EVMSwapClaim.ts +172 -172
  162. package/src/evm/swaps/modules/EVMSwapInit.ts +328 -328
  163. package/src/evm/swaps/modules/EVMSwapRefund.ts +229 -229
  164. package/src/evm/typechain/common.ts +131 -131
  165. package/src/evm/wallet/EVMSigner.ts +25 -25
  166. package/src/index.ts +48 -45
  167. package/src/utils/Utils.ts +81 -81
@@ -1,178 +1,178 @@
1
- import {BaseTokenType, BitcoinNetwork, BitcoinRpc, ChainData, ChainInitializer, ChainSwapType} from "@atomiqlabs/base";
2
- import {JsonRpcApiProvider, JsonRpcProvider} from "ethers";
3
- import {EVMChainInterface, EVMRetryPolicy} from "../../evm/chain/EVMChainInterface";
4
- import {EVMFees} from "../../evm/chain/modules/EVMFees";
5
- import {CitreaChainType} from "./CitreaChainType";
6
- import {EVMBtcRelay} from "../../evm/btcrelay/EVMBtcRelay";
7
- import {EVMSwapContract} from "../../evm/swaps/EVMSwapContract";
8
- import {EVMSpvVaultContract} from "../../evm/spv_swap/EVMSpvVaultContract";
9
- import {EVMChainEventsBrowser} from "../../evm/events/EVMChainEventsBrowser";
10
- import {EVMSwapData} from "../../evm/swaps/EVMSwapData";
11
- import {EVMSpvVaultData} from "../../evm/spv_swap/EVMSpvVaultData";
12
- import {EVMSpvWithdrawalData} from "../../evm/spv_swap/EVMSpvWithdrawalData";
13
- import {CitreaFees} from "./CitreaFees";
14
- import {CitreaBtcRelay} from "./CitreaBtcRelay";
15
- import {CitreaSwapContract} from "./CitreaSwapContract";
16
- import {CitreaTokens} from "./CitreaTokens";
17
- import {CitreaSpvVaultContract} from "./CitreaSpvVaultContract";
18
-
19
- const CitreaChainIds = {
20
- MAINNET: null,
21
- TESTNET4: 5115
22
- };
23
-
24
- const CitreaContractAddresses = {
25
- MAINNET: {
26
- executionContract: "",
27
- swapContract: "",
28
- btcRelayContract: "",
29
- btcRelayDeploymentHeight: 0,
30
- spvVaultContract: "",
31
- spvVaultDeploymentHeight: 0,
32
- handlerContracts: {
33
- refund: {
34
- timelock: ""
35
- },
36
- claim: {
37
- [ChainSwapType.HTLC]: "",
38
- [ChainSwapType.CHAIN_TXID]: "",
39
- [ChainSwapType.CHAIN]: "",
40
- [ChainSwapType.CHAIN_NONCED]: ""
41
- }
42
- }
43
- },
44
- TESTNET4: {
45
- executionContract: "0x9e289512965A0842b342A6BB3F3c41F22a555Cfe",
46
- swapContract: "0xBbf7755b674dD107d59F0650D1A3fA9C60bf6Fe6",
47
- btcRelayContract: "0x00D122E9f9766cd81a38D2dd44f9AFfb94c67Af7",
48
- btcRelayDeploymentHeight: 12346223,
49
- spvVaultContract: "0x9Bf990C6088F716279797a602b05941c40591533",
50
- spvVaultDeploymentHeight: 12346223,
51
- handlerContracts: {
52
- refund: {
53
- timelock: "0x4699450973c21d6Fe09e36A8A475EaE4D78a3137"
54
- },
55
- claim: {
56
- [ChainSwapType.HTLC]: "0x1120e1Eb3049148AeBEe497331774BfE1f6c174D",
57
- [ChainSwapType.CHAIN_TXID]: "0xf61D1da542111216337FeEA5586022130D468842",
58
- [ChainSwapType.CHAIN]: "0xBe8C784b03F0c6d54aC35a4D41bd6CF2EDb6e012",
59
- [ChainSwapType.CHAIN_NONCED]: "0x65faec5DC334bf2005eC2DFcf012da87a832f1F0"
60
- }
61
- }
62
- }
63
- };
64
-
65
- export type CitreaAssetsType = BaseTokenType<"CBTC" | "USDC">;
66
- export const CitreaAssets: CitreaAssetsType = {
67
- CBTC: {
68
- address: "0x0000000000000000000000000000000000000000",
69
- decimals: 18,
70
- displayDecimals: 8
71
- },
72
- USDC: {
73
- address: "0x2C8abD2A528D19AFc33d2ebA507c0F405c131335",
74
- decimals: 6,
75
- displayDecimals: 6
76
- }
77
- } as const;
78
-
79
- export type CitreaOptions = {
80
- rpcUrl: string | JsonRpcApiProvider,
81
- retryPolicy?: EVMRetryPolicy,
82
- chainType?: "MAINNET" | "TESTNET4",
83
- maxLogsBlockRange?: number,
84
-
85
- swapContract?: string,
86
- btcRelayContract?: string,
87
- btcRelayDeploymentHeight?: number,
88
- spvVaultContract?: string,
89
- spvVaultDeploymentHeight?: number,
90
- handlerContracts?: {
91
- refund?: {
92
- timelock?: string
93
- },
94
- claim?: {
95
- [type in ChainSwapType]?: string
96
- }
97
- }
98
-
99
- fees?: CitreaFees
100
- }
101
-
102
- export function initializeCitrea(
103
- options: CitreaOptions,
104
- bitcoinRpc: BitcoinRpc<any>,
105
- network: BitcoinNetwork
106
- ): ChainData<CitreaChainType> {
107
- if(options.chainType==null) {
108
- switch (network) {
109
- case BitcoinNetwork.TESTNET4:
110
- options.chainType = "TESTNET4";
111
- break;
112
- case BitcoinNetwork.MAINNET:
113
- options.chainType = "MAINNET";
114
- break;
115
- }
116
- }
117
-
118
- const defaultContractAddresses = CitreaContractAddresses[options.chainType];
119
- const chainId = CitreaChainIds[options.chainType];
120
-
121
- const provider = typeof(options.rpcUrl)==="string" ?
122
- new JsonRpcProvider(options.rpcUrl, {name: "Citrea", chainId}) :
123
- options.rpcUrl;
124
-
125
- const Fees = options.fees ?? new CitreaFees(provider, 2n * 1_000_000_000n, 1_000_000n);
126
-
127
- const chainInterface = new EVMChainInterface("CITREA", chainId, provider, {
128
- safeBlockTag: "latest",
129
- maxLogsBlockRange: options.maxLogsBlockRange ?? 500
130
- }, options.retryPolicy, Fees);
131
- chainInterface.Tokens = new CitreaTokens(chainInterface); //Override with custom token module allowing l1 state diff based fee calculation
132
-
133
- const btcRelay = new CitreaBtcRelay(
134
- chainInterface, bitcoinRpc, network, options.btcRelayContract ?? defaultContractAddresses.btcRelayContract,
135
- options.btcRelayDeploymentHeight ?? defaultContractAddresses.btcRelayDeploymentHeight
136
- );
137
-
138
- const swapContract = new CitreaSwapContract(
139
- chainInterface, btcRelay, options.swapContract ?? defaultContractAddresses.swapContract, {
140
- refund: {
141
- ...defaultContractAddresses.handlerContracts.refund,
142
- ...options?.handlerContracts?.refund
143
- },
144
- claim: {
145
- ...defaultContractAddresses.handlerContracts.claim,
146
- ...options?.handlerContracts?.claim
147
- }
148
- }
149
- );
150
-
151
- const spvVaultContract = new CitreaSpvVaultContract(
152
- chainInterface, btcRelay, bitcoinRpc, options.spvVaultContract ?? defaultContractAddresses.spvVaultContract,
153
- options.spvVaultDeploymentHeight ?? defaultContractAddresses.spvVaultDeploymentHeight
154
- )
155
-
156
- const chainEvents = new EVMChainEventsBrowser(chainInterface, swapContract, spvVaultContract);
157
-
158
- return {
159
- chainId: "CITREA",
160
- btcRelay,
161
- chainInterface,
162
- swapContract,
163
- chainEvents,
164
- swapDataConstructor: EVMSwapData,
165
- spvVaultContract,
166
- spvVaultDataConstructor: EVMSpvVaultData,
167
- spvVaultWithdrawalDataConstructor: EVMSpvWithdrawalData
168
- }
169
- };
170
-
171
- export type CitreaInitializerType = ChainInitializer<CitreaOptions, CitreaChainType, CitreaAssetsType>;
172
- export const CitreaInitializer: CitreaInitializerType = {
173
- chainId: "CITREA",
174
- chainType: null as CitreaChainType,
175
- initializer: initializeCitrea,
176
- tokens: CitreaAssets,
177
- options: null as CitreaOptions
178
- } as const;
1
+ import {BaseTokenType, BitcoinNetwork, BitcoinRpc, ChainData, ChainInitializer, ChainSwapType} from "@atomiqlabs/base";
2
+ import {JsonRpcApiProvider, JsonRpcProvider} from "ethers";
3
+ import {EVMChainInterface, EVMRetryPolicy} from "../../evm/chain/EVMChainInterface";
4
+ import {EVMFees} from "../../evm/chain/modules/EVMFees";
5
+ import {CitreaChainType} from "./CitreaChainType";
6
+ import {EVMBtcRelay} from "../../evm/btcrelay/EVMBtcRelay";
7
+ import {EVMSwapContract} from "../../evm/swaps/EVMSwapContract";
8
+ import {EVMSpvVaultContract} from "../../evm/spv_swap/EVMSpvVaultContract";
9
+ import {EVMChainEventsBrowser} from "../../evm/events/EVMChainEventsBrowser";
10
+ import {EVMSwapData} from "../../evm/swaps/EVMSwapData";
11
+ import {EVMSpvVaultData} from "../../evm/spv_swap/EVMSpvVaultData";
12
+ import {EVMSpvWithdrawalData} from "../../evm/spv_swap/EVMSpvWithdrawalData";
13
+ import {CitreaFees} from "./CitreaFees";
14
+ import {CitreaBtcRelay} from "./CitreaBtcRelay";
15
+ import {CitreaSwapContract} from "./CitreaSwapContract";
16
+ import {CitreaTokens} from "./CitreaTokens";
17
+ import {CitreaSpvVaultContract} from "./CitreaSpvVaultContract";
18
+
19
+ const CitreaChainIds = {
20
+ MAINNET: null,
21
+ TESTNET4: 5115
22
+ };
23
+
24
+ const CitreaContractAddresses = {
25
+ MAINNET: {
26
+ executionContract: "",
27
+ swapContract: "",
28
+ btcRelayContract: "",
29
+ btcRelayDeploymentHeight: 0,
30
+ spvVaultContract: "",
31
+ spvVaultDeploymentHeight: 0,
32
+ handlerContracts: {
33
+ refund: {
34
+ timelock: ""
35
+ },
36
+ claim: {
37
+ [ChainSwapType.HTLC]: "",
38
+ [ChainSwapType.CHAIN_TXID]: "",
39
+ [ChainSwapType.CHAIN]: "",
40
+ [ChainSwapType.CHAIN_NONCED]: ""
41
+ }
42
+ }
43
+ },
44
+ TESTNET4: {
45
+ executionContract: "0x9e289512965A0842b342A6BB3F3c41F22a555Cfe",
46
+ swapContract: "0xBbf7755b674dD107d59F0650D1A3fA9C60bf6Fe6",
47
+ btcRelayContract: "0x00D122E9f9766cd81a38D2dd44f9AFfb94c67Af7",
48
+ btcRelayDeploymentHeight: 12346223,
49
+ spvVaultContract: "0x9Bf990C6088F716279797a602b05941c40591533",
50
+ spvVaultDeploymentHeight: 12346223,
51
+ handlerContracts: {
52
+ refund: {
53
+ timelock: "0x4699450973c21d6Fe09e36A8A475EaE4D78a3137"
54
+ },
55
+ claim: {
56
+ [ChainSwapType.HTLC]: "0x1120e1Eb3049148AeBEe497331774BfE1f6c174D",
57
+ [ChainSwapType.CHAIN_TXID]: "0xf61D1da542111216337FeEA5586022130D468842",
58
+ [ChainSwapType.CHAIN]: "0xBe8C784b03F0c6d54aC35a4D41bd6CF2EDb6e012",
59
+ [ChainSwapType.CHAIN_NONCED]: "0x65faec5DC334bf2005eC2DFcf012da87a832f1F0"
60
+ }
61
+ }
62
+ }
63
+ };
64
+
65
+ export type CitreaAssetsType = BaseTokenType<"CBTC" | "USDC">;
66
+ export const CitreaAssets: CitreaAssetsType = {
67
+ CBTC: {
68
+ address: "0x0000000000000000000000000000000000000000",
69
+ decimals: 18,
70
+ displayDecimals: 8
71
+ },
72
+ USDC: {
73
+ address: "0x2C8abD2A528D19AFc33d2ebA507c0F405c131335",
74
+ decimals: 6,
75
+ displayDecimals: 6
76
+ }
77
+ } as const;
78
+
79
+ export type CitreaOptions = {
80
+ rpcUrl: string | JsonRpcApiProvider,
81
+ retryPolicy?: EVMRetryPolicy,
82
+ chainType?: "MAINNET" | "TESTNET4",
83
+ maxLogsBlockRange?: number,
84
+
85
+ swapContract?: string,
86
+ btcRelayContract?: string,
87
+ btcRelayDeploymentHeight?: number,
88
+ spvVaultContract?: string,
89
+ spvVaultDeploymentHeight?: number,
90
+ handlerContracts?: {
91
+ refund?: {
92
+ timelock?: string
93
+ },
94
+ claim?: {
95
+ [type in ChainSwapType]?: string
96
+ }
97
+ }
98
+
99
+ fees?: CitreaFees
100
+ }
101
+
102
+ export function initializeCitrea(
103
+ options: CitreaOptions,
104
+ bitcoinRpc: BitcoinRpc<any>,
105
+ network: BitcoinNetwork
106
+ ): ChainData<CitreaChainType> {
107
+ if(options.chainType==null) {
108
+ switch (network) {
109
+ case BitcoinNetwork.TESTNET4:
110
+ options.chainType = "TESTNET4";
111
+ break;
112
+ case BitcoinNetwork.MAINNET:
113
+ options.chainType = "MAINNET";
114
+ break;
115
+ }
116
+ }
117
+
118
+ const defaultContractAddresses = CitreaContractAddresses[options.chainType];
119
+ const chainId = CitreaChainIds[options.chainType];
120
+
121
+ const provider = typeof(options.rpcUrl)==="string" ?
122
+ new JsonRpcProvider(options.rpcUrl, {name: "Citrea", chainId}) :
123
+ options.rpcUrl;
124
+
125
+ const Fees = options.fees ?? new CitreaFees(provider, 2n * 1_000_000_000n, 1_000_000n);
126
+
127
+ const chainInterface = new EVMChainInterface("CITREA", chainId, provider, {
128
+ safeBlockTag: "latest",
129
+ maxLogsBlockRange: options.maxLogsBlockRange ?? 500
130
+ }, options.retryPolicy, Fees);
131
+ chainInterface.Tokens = new CitreaTokens(chainInterface); //Override with custom token module allowing l1 state diff based fee calculation
132
+
133
+ const btcRelay = new CitreaBtcRelay(
134
+ chainInterface, bitcoinRpc, network, options.btcRelayContract ?? defaultContractAddresses.btcRelayContract,
135
+ options.btcRelayDeploymentHeight ?? defaultContractAddresses.btcRelayDeploymentHeight
136
+ );
137
+
138
+ const swapContract = new CitreaSwapContract(
139
+ chainInterface, btcRelay, options.swapContract ?? defaultContractAddresses.swapContract, {
140
+ refund: {
141
+ ...defaultContractAddresses.handlerContracts.refund,
142
+ ...options?.handlerContracts?.refund
143
+ },
144
+ claim: {
145
+ ...defaultContractAddresses.handlerContracts.claim,
146
+ ...options?.handlerContracts?.claim
147
+ }
148
+ }
149
+ );
150
+
151
+ const spvVaultContract = new CitreaSpvVaultContract(
152
+ chainInterface, btcRelay, bitcoinRpc, options.spvVaultContract ?? defaultContractAddresses.spvVaultContract,
153
+ options.spvVaultDeploymentHeight ?? defaultContractAddresses.spvVaultDeploymentHeight
154
+ )
155
+
156
+ const chainEvents = new EVMChainEventsBrowser(chainInterface, swapContract, spvVaultContract);
157
+
158
+ return {
159
+ chainId: "CITREA",
160
+ btcRelay,
161
+ chainInterface,
162
+ swapContract,
163
+ chainEvents,
164
+ swapDataConstructor: EVMSwapData,
165
+ spvVaultContract,
166
+ spvVaultDataConstructor: EVMSpvVaultData,
167
+ spvVaultWithdrawalDataConstructor: EVMSpvWithdrawalData
168
+ }
169
+ };
170
+
171
+ export type CitreaInitializerType = ChainInitializer<CitreaOptions, CitreaChainType, CitreaAssetsType>;
172
+ export const CitreaInitializer: CitreaInitializerType = {
173
+ chainId: "CITREA",
174
+ chainType: null as CitreaChainType,
175
+ initializer: initializeCitrea,
176
+ tokens: CitreaAssets,
177
+ options: null as CitreaOptions
178
+ } as const;
@@ -1,75 +1,75 @@
1
- import {EVMSpvVaultContract} from "../../evm/spv_swap/EVMSpvVaultContract";
2
- import {EVMSpvWithdrawalData} from "../../evm/spv_swap/EVMSpvWithdrawalData";
3
- import {EVMSpvVaultData} from "../../evm/spv_swap/EVMSpvVaultData";
4
- import {ZeroAddress, ZeroHash} from "ethers";
5
- import {CitreaFees} from "./CitreaFees";
6
- import {EVMAddresses} from "../../evm/chain/modules/EVMAddresses";
7
-
8
-
9
- export class CitreaSpvVaultContract extends EVMSpvVaultContract<"CITREA"> {
10
-
11
- public static readonly StateDiffSize = {
12
- BASE_DIFF_SIZE: 50,
13
- ERC_20_TRANSFER_DIFF_SIZE: 50,
14
- NATIVE_SELF_TRANSFER_DIFF_SIZE: 20,
15
- NATIVE_TRANSFER_DIFF_SIZE: 30,
16
- EXECUTION_SCHEDULE_DIFF_SIZE: 40
17
- };
18
-
19
- private calculateStateDiff(signer: string, tokenStateChanges: Set<string>): number {
20
- let stateDiffSize = 0;
21
- tokenStateChanges.forEach(val => {
22
- const [address, token] = val.split(":");
23
- if(token.toLowerCase()===this.Chain.getNativeCurrencyAddress().toLowerCase()) {
24
- stateDiffSize += address.toLowerCase()===signer?.toLowerCase() ? CitreaSpvVaultContract.StateDiffSize.NATIVE_SELF_TRANSFER_DIFF_SIZE : CitreaSpvVaultContract.StateDiffSize.NATIVE_TRANSFER_DIFF_SIZE;
25
- } else {
26
- stateDiffSize += CitreaSpvVaultContract.StateDiffSize.ERC_20_TRANSFER_DIFF_SIZE;
27
- }
28
- });
29
- return stateDiffSize;
30
- }
31
-
32
- async getClaimFee(signer: string, vault?: EVMSpvVaultData, data?: EVMSpvWithdrawalData, feeRate?: string): Promise<bigint> {
33
- vault ??= EVMSpvVaultData.randomVault();
34
- feeRate ??= await this.Chain.Fees.getFeeRate();
35
- const tokenStateChanges: Set<string> = new Set();
36
-
37
- let diffSize = CitreaSpvVaultContract.StateDiffSize.BASE_DIFF_SIZE;
38
- const recipient = data!=null ? data.recipient : EVMAddresses.randomAddress();
39
- if (data==null || (data.rawAmounts[0] != null && data.rawAmounts[0] > 0n)) {
40
- tokenStateChanges.add(recipient.toLowerCase()+":"+vault.token0.token.toLowerCase());
41
- if (data==null || data.frontingFeeRate > 0n) tokenStateChanges.add(ZeroAddress+":"+vault.token0.token.toLowerCase()); //Also needs to pay out to fronter
42
- if (data==null || data.callerFeeRate > 0n) tokenStateChanges.add(signer+":"+vault.token0.token.toLowerCase()); //Also needs to pay out to caller
43
- }
44
- if (data==null || (data.rawAmounts[1] != null && data.rawAmounts[1] > 0n)) {
45
- tokenStateChanges.add(recipient.toLowerCase()+":"+vault.token1.token.toLowerCase());
46
- if (data==null || data.frontingFeeRate > 0n) tokenStateChanges.add(ZeroAddress+":"+vault.token1.token.toLowerCase()); //Also needs to pay out to fronter
47
- if (data==null || data.callerFeeRate > 0n) tokenStateChanges.add(signer+":"+vault.token1.token.toLowerCase()); //Also needs to pay out to caller
48
- }
49
- diffSize += this.calculateStateDiff(signer, tokenStateChanges);
50
- if (data==null || (data.executionHash != null && data.executionHash !== ZeroHash)) diffSize += CitreaSpvVaultContract.StateDiffSize.EXECUTION_SCHEDULE_DIFF_SIZE;
51
-
52
- const gasFee = await super.getClaimFee(signer, vault, data, feeRate);
53
- return gasFee + CitreaFees.getGasFee(0, feeRate, diffSize);
54
- }
55
-
56
- async getFrontFee(signer: string, vault?: EVMSpvVaultData, data?: EVMSpvWithdrawalData, feeRate?: string): Promise<bigint> {
57
- vault ??= EVMSpvVaultData.randomVault();
58
- feeRate ??= await this.Chain.Fees.getFeeRate();
59
- const tokenStateChanges: Set<string> = new Set();
60
-
61
- let diffSize = CitreaSpvVaultContract.StateDiffSize.BASE_DIFF_SIZE;
62
- if (data==null || (data.rawAmounts[0] != null && data.rawAmounts[0] > 0n)) {
63
- tokenStateChanges.add(signer+":"+vault.token0.token.toLowerCase());
64
- }
65
- if (data==null || (data.rawAmounts[1] != null && data.rawAmounts[1] > 0n)) {
66
- tokenStateChanges.add(signer+":"+vault.token1.token.toLowerCase());
67
- }
68
- diffSize += this.calculateStateDiff(signer, tokenStateChanges);
69
- if (data==null || (data.executionHash != null && data.executionHash !== ZeroHash)) diffSize += CitreaSpvVaultContract.StateDiffSize.EXECUTION_SCHEDULE_DIFF_SIZE;
70
-
71
- const gasFee = await super.getFrontFee(signer, vault, data, feeRate);
72
- return gasFee + CitreaFees.getGasFee(0, feeRate, diffSize);
73
- }
74
-
75
- }
1
+ import {EVMSpvVaultContract} from "../../evm/spv_swap/EVMSpvVaultContract";
2
+ import {EVMSpvWithdrawalData} from "../../evm/spv_swap/EVMSpvWithdrawalData";
3
+ import {EVMSpvVaultData} from "../../evm/spv_swap/EVMSpvVaultData";
4
+ import {ZeroAddress, ZeroHash} from "ethers";
5
+ import {CitreaFees} from "./CitreaFees";
6
+ import {EVMAddresses} from "../../evm/chain/modules/EVMAddresses";
7
+
8
+
9
+ export class CitreaSpvVaultContract extends EVMSpvVaultContract<"CITREA"> {
10
+
11
+ public static readonly StateDiffSize = {
12
+ BASE_DIFF_SIZE: 50,
13
+ ERC_20_TRANSFER_DIFF_SIZE: 50,
14
+ NATIVE_SELF_TRANSFER_DIFF_SIZE: 20,
15
+ NATIVE_TRANSFER_DIFF_SIZE: 30,
16
+ EXECUTION_SCHEDULE_DIFF_SIZE: 40
17
+ };
18
+
19
+ private calculateStateDiff(signer: string, tokenStateChanges: Set<string>): number {
20
+ let stateDiffSize = 0;
21
+ tokenStateChanges.forEach(val => {
22
+ const [address, token] = val.split(":");
23
+ if(token.toLowerCase()===this.Chain.getNativeCurrencyAddress().toLowerCase()) {
24
+ stateDiffSize += address.toLowerCase()===signer?.toLowerCase() ? CitreaSpvVaultContract.StateDiffSize.NATIVE_SELF_TRANSFER_DIFF_SIZE : CitreaSpvVaultContract.StateDiffSize.NATIVE_TRANSFER_DIFF_SIZE;
25
+ } else {
26
+ stateDiffSize += CitreaSpvVaultContract.StateDiffSize.ERC_20_TRANSFER_DIFF_SIZE;
27
+ }
28
+ });
29
+ return stateDiffSize;
30
+ }
31
+
32
+ async getClaimFee(signer: string, vault?: EVMSpvVaultData, data?: EVMSpvWithdrawalData, feeRate?: string): Promise<bigint> {
33
+ vault ??= EVMSpvVaultData.randomVault();
34
+ feeRate ??= await this.Chain.Fees.getFeeRate();
35
+ const tokenStateChanges: Set<string> = new Set();
36
+
37
+ let diffSize = CitreaSpvVaultContract.StateDiffSize.BASE_DIFF_SIZE;
38
+ const recipient = data!=null ? data.recipient : EVMAddresses.randomAddress();
39
+ if (data==null || (data.rawAmounts[0] != null && data.rawAmounts[0] > 0n)) {
40
+ tokenStateChanges.add(recipient.toLowerCase()+":"+vault.token0.token.toLowerCase());
41
+ if (data==null || data.frontingFeeRate > 0n) tokenStateChanges.add(ZeroAddress+":"+vault.token0.token.toLowerCase()); //Also needs to pay out to fronter
42
+ if (data==null || data.callerFeeRate > 0n) tokenStateChanges.add(signer+":"+vault.token0.token.toLowerCase()); //Also needs to pay out to caller
43
+ }
44
+ if (data==null || (data.rawAmounts[1] != null && data.rawAmounts[1] > 0n)) {
45
+ tokenStateChanges.add(recipient.toLowerCase()+":"+vault.token1.token.toLowerCase());
46
+ if (data==null || data.frontingFeeRate > 0n) tokenStateChanges.add(ZeroAddress+":"+vault.token1.token.toLowerCase()); //Also needs to pay out to fronter
47
+ if (data==null || data.callerFeeRate > 0n) tokenStateChanges.add(signer+":"+vault.token1.token.toLowerCase()); //Also needs to pay out to caller
48
+ }
49
+ diffSize += this.calculateStateDiff(signer, tokenStateChanges);
50
+ if (data==null || (data.executionHash != null && data.executionHash !== ZeroHash)) diffSize += CitreaSpvVaultContract.StateDiffSize.EXECUTION_SCHEDULE_DIFF_SIZE;
51
+
52
+ const gasFee = await super.getClaimFee(signer, vault, data, feeRate);
53
+ return gasFee + CitreaFees.getGasFee(0, feeRate, diffSize);
54
+ }
55
+
56
+ async getFrontFee(signer: string, vault?: EVMSpvVaultData, data?: EVMSpvWithdrawalData, feeRate?: string): Promise<bigint> {
57
+ vault ??= EVMSpvVaultData.randomVault();
58
+ feeRate ??= await this.Chain.Fees.getFeeRate();
59
+ const tokenStateChanges: Set<string> = new Set();
60
+
61
+ let diffSize = CitreaSpvVaultContract.StateDiffSize.BASE_DIFF_SIZE;
62
+ if (data==null || (data.rawAmounts[0] != null && data.rawAmounts[0] > 0n)) {
63
+ tokenStateChanges.add(signer+":"+vault.token0.token.toLowerCase());
64
+ }
65
+ if (data==null || (data.rawAmounts[1] != null && data.rawAmounts[1] > 0n)) {
66
+ tokenStateChanges.add(signer+":"+vault.token1.token.toLowerCase());
67
+ }
68
+ diffSize += this.calculateStateDiff(signer, tokenStateChanges);
69
+ if (data==null || (data.executionHash != null && data.executionHash !== ZeroHash)) diffSize += CitreaSpvVaultContract.StateDiffSize.EXECUTION_SCHEDULE_DIFF_SIZE;
70
+
71
+ const gasFee = await super.getFrontFee(signer, vault, data, feeRate);
72
+ return gasFee + CitreaFees.getGasFee(0, feeRate, diffSize);
73
+ }
74
+
75
+ }