@atomiqlabs/chain-starknet 4.0.0-dev.12 → 4.0.0-dev.13

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 -201
  2. package/dist/index.d.ts +38 -38
  3. package/dist/index.js +54 -54
  4. package/dist/starknet/StarknetChainType.d.ts +13 -13
  5. package/dist/starknet/StarknetChainType.js +2 -2
  6. package/dist/starknet/StarknetInitializer.d.ts +27 -27
  7. package/dist/starknet/StarknetInitializer.js +69 -69
  8. package/dist/starknet/btcrelay/BtcRelayAbi.d.ts +250 -250
  9. package/dist/starknet/btcrelay/BtcRelayAbi.js +341 -341
  10. package/dist/starknet/btcrelay/StarknetBtcRelay.d.ts +186 -186
  11. package/dist/starknet/btcrelay/StarknetBtcRelay.js +379 -379
  12. package/dist/starknet/btcrelay/headers/StarknetBtcHeader.d.ts +31 -31
  13. package/dist/starknet/btcrelay/headers/StarknetBtcHeader.js +74 -74
  14. package/dist/starknet/btcrelay/headers/StarknetBtcStoredHeader.d.ts +51 -51
  15. package/dist/starknet/btcrelay/headers/StarknetBtcStoredHeader.js +113 -113
  16. package/dist/starknet/chain/StarknetAction.d.ts +19 -19
  17. package/dist/starknet/chain/StarknetAction.js +73 -73
  18. package/dist/starknet/chain/StarknetChainInterface.d.ts +52 -52
  19. package/dist/starknet/chain/StarknetChainInterface.js +91 -91
  20. package/dist/starknet/chain/StarknetModule.d.ts +14 -14
  21. package/dist/starknet/chain/StarknetModule.js +13 -13
  22. package/dist/starknet/chain/modules/ERC20Abi.d.ts +755 -755
  23. package/dist/starknet/chain/modules/ERC20Abi.js +1032 -1032
  24. package/dist/starknet/chain/modules/StarknetAccounts.d.ts +6 -6
  25. package/dist/starknet/chain/modules/StarknetAccounts.js +24 -24
  26. package/dist/starknet/chain/modules/StarknetAddresses.d.ts +9 -9
  27. package/dist/starknet/chain/modules/StarknetAddresses.js +26 -26
  28. package/dist/starknet/chain/modules/StarknetBlocks.d.ts +20 -20
  29. package/dist/starknet/chain/modules/StarknetBlocks.js +64 -64
  30. package/dist/starknet/chain/modules/StarknetEvents.d.ts +44 -44
  31. package/dist/starknet/chain/modules/StarknetEvents.js +88 -88
  32. package/dist/starknet/chain/modules/StarknetFees.d.ts +77 -77
  33. package/dist/starknet/chain/modules/StarknetFees.js +114 -114
  34. package/dist/starknet/chain/modules/StarknetSignatures.d.ts +29 -29
  35. package/dist/starknet/chain/modules/StarknetSignatures.js +72 -72
  36. package/dist/starknet/chain/modules/StarknetTokens.d.ts +69 -69
  37. package/dist/starknet/chain/modules/StarknetTokens.js +102 -98
  38. package/dist/starknet/chain/modules/StarknetTransactions.d.ts +93 -93
  39. package/dist/starknet/chain/modules/StarknetTransactions.js +261 -260
  40. package/dist/starknet/contract/StarknetContractBase.d.ts +13 -13
  41. package/dist/starknet/contract/StarknetContractBase.js +20 -16
  42. package/dist/starknet/contract/StarknetContractModule.d.ts +8 -8
  43. package/dist/starknet/contract/StarknetContractModule.js +11 -11
  44. package/dist/starknet/contract/modules/StarknetContractEvents.d.ts +51 -51
  45. package/dist/starknet/contract/modules/StarknetContractEvents.js +97 -97
  46. package/dist/starknet/events/StarknetChainEvents.d.ts +21 -21
  47. package/dist/starknet/events/StarknetChainEvents.js +52 -52
  48. package/dist/starknet/events/StarknetChainEventsBrowser.d.ts +89 -90
  49. package/dist/starknet/events/StarknetChainEventsBrowser.js +296 -294
  50. package/dist/starknet/provider/RpcProviderWithRetries.d.ts +21 -21
  51. package/dist/starknet/provider/RpcProviderWithRetries.js +32 -32
  52. package/dist/starknet/spv_swap/SpvVaultContractAbi.d.ts +488 -488
  53. package/dist/starknet/spv_swap/SpvVaultContractAbi.js +656 -656
  54. package/dist/starknet/spv_swap/StarknetSpvVaultContract.d.ts +66 -66
  55. package/dist/starknet/spv_swap/StarknetSpvVaultContract.js +382 -382
  56. package/dist/starknet/spv_swap/StarknetSpvVaultData.d.ts +49 -49
  57. package/dist/starknet/spv_swap/StarknetSpvVaultData.js +145 -145
  58. package/dist/starknet/spv_swap/StarknetSpvWithdrawalData.d.ts +25 -25
  59. package/dist/starknet/spv_swap/StarknetSpvWithdrawalData.js +72 -72
  60. package/dist/starknet/swaps/EscrowManagerAbi.d.ts +431 -431
  61. package/dist/starknet/swaps/EscrowManagerAbi.js +583 -583
  62. package/dist/starknet/swaps/StarknetSwapContract.d.ts +191 -191
  63. package/dist/starknet/swaps/StarknetSwapContract.js +424 -424
  64. package/dist/starknet/swaps/StarknetSwapData.d.ts +74 -74
  65. package/dist/starknet/swaps/StarknetSwapData.js +325 -325
  66. package/dist/starknet/swaps/StarknetSwapModule.d.ts +10 -10
  67. package/dist/starknet/swaps/StarknetSwapModule.js +11 -11
  68. package/dist/starknet/swaps/handlers/IHandler.d.ts +13 -13
  69. package/dist/starknet/swaps/handlers/IHandler.js +2 -2
  70. package/dist/starknet/swaps/handlers/claim/ClaimHandlers.d.ts +13 -13
  71. package/dist/starknet/swaps/handlers/claim/ClaimHandlers.js +13 -13
  72. package/dist/starknet/swaps/handlers/claim/HashlockClaimHandler.d.ts +21 -21
  73. package/dist/starknet/swaps/handlers/claim/HashlockClaimHandler.js +44 -44
  74. package/dist/starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.d.ts +24 -24
  75. package/dist/starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.js +48 -48
  76. package/dist/starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.d.ts +25 -25
  77. package/dist/starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.js +40 -40
  78. package/dist/starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.d.ts +20 -20
  79. package/dist/starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.js +30 -30
  80. package/dist/starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler.d.ts +45 -45
  81. package/dist/starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler.js +52 -52
  82. package/dist/starknet/swaps/handlers/refund/TimelockRefundHandler.d.ts +17 -17
  83. package/dist/starknet/swaps/handlers/refund/TimelockRefundHandler.js +27 -27
  84. package/dist/starknet/swaps/modules/StarknetLpVault.d.ts +69 -69
  85. package/dist/starknet/swaps/modules/StarknetLpVault.js +122 -122
  86. package/dist/starknet/swaps/modules/StarknetSwapClaim.d.ts +53 -53
  87. package/dist/starknet/swaps/modules/StarknetSwapClaim.js +100 -100
  88. package/dist/starknet/swaps/modules/StarknetSwapInit.d.ts +94 -87
  89. package/dist/starknet/swaps/modules/StarknetSwapInit.js +235 -225
  90. package/dist/starknet/swaps/modules/StarknetSwapRefund.d.ts +62 -62
  91. package/dist/starknet/swaps/modules/StarknetSwapRefund.js +128 -128
  92. package/dist/starknet/wallet/StarknetKeypairWallet.d.ts +7 -7
  93. package/dist/starknet/wallet/StarknetKeypairWallet.js +35 -30
  94. package/dist/starknet/wallet/StarknetSigner.d.ts +12 -12
  95. package/dist/starknet/wallet/StarknetSigner.js +47 -46
  96. package/dist/utils/Utils.d.ts +37 -37
  97. package/dist/utils/Utils.js +260 -261
  98. package/package.json +43 -37
  99. package/src/index.ts +47 -47
  100. package/src/starknet/StarknetChainType.ts +28 -28
  101. package/src/starknet/StarknetInitializer.ts +108 -108
  102. package/src/starknet/btcrelay/BtcRelayAbi.ts +338 -338
  103. package/src/starknet/btcrelay/StarknetBtcRelay.ts +494 -494
  104. package/src/starknet/btcrelay/headers/StarknetBtcHeader.ts +100 -100
  105. package/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts +141 -141
  106. package/src/starknet/chain/StarknetAction.ts +85 -85
  107. package/src/starknet/chain/StarknetChainInterface.ts +149 -149
  108. package/src/starknet/chain/StarknetModule.ts +19 -19
  109. package/src/starknet/chain/modules/ERC20Abi.ts +1029 -1029
  110. package/src/starknet/chain/modules/StarknetAccounts.ts +25 -25
  111. package/src/starknet/chain/modules/StarknetAddresses.ts +22 -22
  112. package/src/starknet/chain/modules/StarknetBlocks.ts +75 -74
  113. package/src/starknet/chain/modules/StarknetEvents.ts +104 -104
  114. package/src/starknet/chain/modules/StarknetFees.ts +154 -154
  115. package/src/starknet/chain/modules/StarknetSignatures.ts +91 -91
  116. package/src/starknet/chain/modules/StarknetTokens.ts +120 -116
  117. package/src/starknet/chain/modules/StarknetTransactions.ts +285 -283
  118. package/src/starknet/contract/StarknetContractBase.ts +30 -26
  119. package/src/starknet/contract/StarknetContractModule.ts +16 -16
  120. package/src/starknet/contract/modules/StarknetContractEvents.ts +134 -134
  121. package/src/starknet/events/StarknetChainEvents.ts +67 -67
  122. package/src/starknet/events/StarknetChainEventsBrowser.ts +411 -411
  123. package/src/starknet/provider/RpcProviderWithRetries.ts +43 -43
  124. package/src/starknet/spv_swap/SpvVaultContractAbi.ts +656 -656
  125. package/src/starknet/spv_swap/StarknetSpvVaultContract.ts +483 -483
  126. package/src/starknet/spv_swap/StarknetSpvVaultData.ts +195 -195
  127. package/src/starknet/spv_swap/StarknetSpvWithdrawalData.ts +79 -79
  128. package/src/starknet/swaps/EscrowManagerAbi.ts +582 -582
  129. package/src/starknet/swaps/StarknetSwapContract.ts +647 -647
  130. package/src/starknet/swaps/StarknetSwapData.ts +455 -455
  131. package/src/starknet/swaps/StarknetSwapModule.ts +17 -17
  132. package/src/starknet/swaps/handlers/IHandler.ts +20 -20
  133. package/src/starknet/swaps/handlers/claim/ClaimHandlers.ts +23 -23
  134. package/src/starknet/swaps/handlers/claim/HashlockClaimHandler.ts +53 -53
  135. package/src/starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.ts +73 -73
  136. package/src/starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.ts +67 -67
  137. package/src/starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.ts +50 -50
  138. package/src/starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler.ts +102 -102
  139. package/src/starknet/swaps/handlers/refund/TimelockRefundHandler.ts +38 -38
  140. package/src/starknet/swaps/modules/StarknetLpVault.ts +147 -147
  141. package/src/starknet/swaps/modules/StarknetSwapClaim.ts +141 -141
  142. package/src/starknet/swaps/modules/StarknetSwapInit.ts +300 -287
  143. package/src/starknet/swaps/modules/StarknetSwapRefund.ts +196 -196
  144. package/src/starknet/wallet/StarknetKeypairWallet.ts +44 -39
  145. package/src/starknet/wallet/StarknetSigner.ts +55 -55
  146. package/src/utils/Utils.ts +251 -252
@@ -1,647 +1,647 @@
1
- import {
2
- BigIntBufferUtils,
3
- ChainSwapType,
4
- IntermediaryReputationType,
5
- RelaySynchronizer,
6
- SignatureData,
7
- SwapCommitState,
8
- SwapCommitStateType,
9
- SwapContract,
10
- TransactionConfirmationOptions
11
- } from "@atomiqlabs/base";
12
- import {Buffer} from "buffer";
13
- import {EscrowManagerAbi} from "./EscrowManagerAbi";
14
- import {StarknetContractBase} from "../contract/StarknetContractBase";
15
- import {StarknetTx} from "../chain/modules/StarknetTransactions";
16
- import {StarknetSigner} from "../wallet/StarknetSigner";
17
- import {BigNumberish, constants, logger} from "starknet";
18
- import {StarknetChainInterface} from "../chain/StarknetChainInterface";
19
- import {StarknetBtcRelay} from "../btcrelay/StarknetBtcRelay";
20
- import {StarknetSwapData} from "./StarknetSwapData";
21
- import {bigNumberishToBuffer, toHex} from "../../utils/Utils";
22
- import {TimelockRefundHandler} from "./handlers/refund/TimelockRefundHandler";
23
- import {StarknetLpVault} from "./modules/StarknetLpVault";
24
- import {StarknetPreFetchVerification, StarknetSwapInit} from "./modules/StarknetSwapInit";
25
- import {StarknetSwapRefund} from "./modules/StarknetSwapRefund";
26
- import {claimHandlersList, IClaimHandler} from "./handlers/claim/ClaimHandlers";
27
- import {StarknetSwapClaim} from "./modules/StarknetSwapClaim";
28
- import {IHandler} from "./handlers/IHandler";
29
- import {StarknetBtcStoredHeader} from "../btcrelay/headers/StarknetBtcStoredHeader";
30
- import {sha256} from "@noble/hashes/sha2";
31
-
32
- const ESCROW_STATE_COMMITTED = 1;
33
- const ESCROW_STATE_CLAIMED = 2;
34
- const ESCROW_STATE_REFUNDED = 3;
35
-
36
- const swapContractAddreses = {
37
- [constants.StarknetChainId.SN_SEPOLIA]: "0x017bf50dd28b6d823a231355bb25813d4396c8e19d2df03026038714a22f0413",
38
- [constants.StarknetChainId.SN_MAIN]: "0x04f278e1f19e495c3b1dd35ef307c4f7510768ed95481958fbae588bd173f79a"
39
- };
40
-
41
- const defaultClaimAddresses = {
42
- [constants.StarknetChainId.SN_SEPOLIA]: {
43
- [ChainSwapType.HTLC]: "0x04a57ea54d4637c352aad1bbee046868926a11702216a0aaf7eeec1568be2d7b",
44
- [ChainSwapType.CHAIN_TXID]: "0x04c7cde88359e14b6f6f779f8b9d8310cee37e91a6f143f855ae29fab33c396e",
45
- [ChainSwapType.CHAIN]: "0x051bef6f5fd12e2832a7d38653bdfc8eb84ba7eb7a4aada5b87ef38a9999cf17",
46
- [ChainSwapType.CHAIN_NONCED]: "0x050e50eacd16da414f2c3a7c3570fd5e248974c6fe757d41acbf72d2836fa0a1"
47
- },
48
- [constants.StarknetChainId.SN_MAIN]: {
49
- [ChainSwapType.HTLC]: "0x07b74b50a883ebee262b6db0e3c0c697670c6f30e3d610e75faf33a89c46aa2a",
50
- [ChainSwapType.CHAIN_TXID]: "0x016c2db2b03f39cf4fd7f871035000f66b62307d9983056e33a38315da8a44dc",
51
- [ChainSwapType.CHAIN]: "0x02c45a81c4a48d0645a0a199e620061e8a55dcc9c2b5946d050eaeeddba64e9a",
52
- [ChainSwapType.CHAIN_NONCED]: "0x0019b5480dd7ed8ded10a09437b0a7a30b8997b4ef139deb24ff8c86f995d84f"
53
- }
54
- }
55
-
56
- const defaultRefundAddresses = {
57
- [constants.StarknetChainId.SN_SEPOLIA]: {
58
- timelock: "0x034b8f28b3ca979036cb2849cfa3af7f67207459224b6ca5ce2474aa398ec3e7"
59
- },
60
- [constants.StarknetChainId.SN_MAIN]: {
61
- timelock: "0x06a59659990c2aefbf7239f6d911617b3ae60b79cb3364f3bd242a6ca8f4f4f7"
62
- }
63
- }
64
-
65
- export class StarknetSwapContract
66
- extends StarknetContractBase<typeof EscrowManagerAbi>
67
- implements SwapContract<
68
- StarknetSwapData,
69
- StarknetTx,
70
- never,
71
- StarknetPreFetchVerification,
72
- StarknetSigner,
73
- "STARKNET"
74
- > {
75
-
76
- readonly supportsInitWithoutClaimer = true;
77
-
78
- ////////////////////////
79
- //// Constants
80
- readonly chainId: "STARKNET" = "STARKNET";
81
-
82
- ////////////////////////
83
- //// Timeouts
84
- readonly claimWithSecretTimeout: number = 180;
85
- readonly claimWithTxDataTimeout: number = 180;
86
- readonly refundTimeout: number = 180;
87
- readonly claimGracePeriod: number = 10*60;
88
- readonly refundGracePeriod: number = 10*60;
89
- readonly authGracePeriod: number = 30;
90
-
91
- ////////////////////////
92
- //// Services
93
- readonly Init: StarknetSwapInit;
94
- readonly Refund: StarknetSwapRefund;
95
- readonly Claim: StarknetSwapClaim;
96
- readonly LpVault: StarknetLpVault;
97
-
98
- ////////////////////////
99
- //// Handlers
100
- readonly claimHandlersByAddress: {[address: string]: IClaimHandler<any, any>} = {};
101
- readonly claimHandlersBySwapType: {[type in ChainSwapType]?: IClaimHandler<any, any>} = {};
102
-
103
- readonly refundHandlersByAddress: {[address: string]: IHandler<any, any>} = {};
104
- readonly timelockRefundHandler: IHandler<any, any>;
105
-
106
- readonly btcRelay: StarknetBtcRelay<any>;
107
-
108
- constructor(
109
- chainInterface: StarknetChainInterface,
110
- btcRelay: StarknetBtcRelay<any>,
111
- contractAddress: string = swapContractAddreses[chainInterface.starknetChainId],
112
- handlerAddresses?: {
113
- refund?: {
114
- timelock?: string
115
- },
116
- claim?: {
117
- [type in ChainSwapType]?: string
118
- }
119
- }
120
- ) {
121
- super(chainInterface, contractAddress, EscrowManagerAbi);
122
- this.Init = new StarknetSwapInit(chainInterface, this);
123
- this.Refund = new StarknetSwapRefund(chainInterface, this);
124
- this.Claim = new StarknetSwapClaim(chainInterface, this);
125
- this.LpVault = new StarknetLpVault(chainInterface, this);
126
-
127
- this.btcRelay = btcRelay;
128
-
129
- handlerAddresses ??= {};
130
- handlerAddresses.refund ??= {};
131
- handlerAddresses.refund = {...defaultRefundAddresses[chainInterface.starknetChainId], ...handlerAddresses.refund};
132
- handlerAddresses.claim ??= {};
133
- handlerAddresses.claim = {...defaultClaimAddresses[chainInterface.starknetChainId], ...handlerAddresses.claim};
134
-
135
- claimHandlersList.forEach(handlerCtor => {
136
- const handler = new handlerCtor(handlerAddresses.claim[handlerCtor.type]);
137
- this.claimHandlersByAddress[toHex(handler.address)] = handler;
138
- this.claimHandlersBySwapType[handlerCtor.type] = handler;
139
- });
140
-
141
- this.timelockRefundHandler = new TimelockRefundHandler(handlerAddresses.refund.timelock);
142
- this.refundHandlersByAddress[this.timelockRefundHandler.address] = this.timelockRefundHandler;
143
- }
144
-
145
- async start(): Promise<void> {
146
- }
147
-
148
- ////////////////////////////////////////////
149
- //// Signatures
150
- preFetchForInitSignatureVerification(): Promise<StarknetPreFetchVerification> {
151
- return this.Init.preFetchForInitSignatureVerification();
152
- }
153
-
154
- getInitSignature(signer: StarknetSigner, swapData: StarknetSwapData, authorizationTimeout: number, preFetchedBlockData?: never, feeRate?: string): Promise<SignatureData> {
155
- return this.Init.signSwapInitialization(signer, swapData, authorizationTimeout);
156
- }
157
-
158
- isValidInitAuthorization(sender: string, swapData: StarknetSwapData, {timeout, prefix, signature}, feeRate?: string, preFetchedData?: StarknetPreFetchVerification): Promise<Buffer> {
159
- return this.Init.isSignatureValid(sender, swapData, timeout, prefix, signature, preFetchedData);
160
- }
161
-
162
- getInitAuthorizationExpiry(swapData: StarknetSwapData, {timeout, prefix, signature}, preFetchedData?: StarknetPreFetchVerification): Promise<number> {
163
- return this.Init.getSignatureExpiry(timeout);
164
- }
165
-
166
- isInitAuthorizationExpired(swapData: StarknetSwapData, {timeout, prefix, signature}): Promise<boolean> {
167
- return this.Init.isSignatureExpired(timeout);
168
- }
169
-
170
- getRefundSignature(signer: StarknetSigner, swapData: StarknetSwapData, authorizationTimeout: number): Promise<SignatureData> {
171
- return this.Refund.signSwapRefund(signer, swapData, authorizationTimeout);
172
- }
173
-
174
- isValidRefundAuthorization(swapData: StarknetSwapData, {timeout, prefix, signature}): Promise<Buffer> {
175
- return this.Refund.isSignatureValid(swapData, timeout, prefix, signature);
176
- }
177
-
178
- getDataSignature(signer: StarknetSigner, data: Buffer): Promise<string> {
179
- return this.Chain.Signatures.getDataSignature(signer, data);
180
- }
181
-
182
- isValidDataSignature(data: Buffer, signature: string, publicKey: string): Promise<boolean> {
183
- return this.Chain.Signatures.isValidDataSignature(data, signature, publicKey);
184
- }
185
-
186
- ////////////////////////////////////////////
187
- //// Swap data utils
188
- /**
189
- * Checks whether the claim is claimable by us, that means not expired, we are claimer & the swap is commited
190
- *
191
- * @param signer
192
- * @param data
193
- */
194
- async isClaimable(signer: string, data: StarknetSwapData): Promise<boolean> {
195
- if(!data.isClaimer(signer)) return false;
196
- if(await this.isExpired(signer, data)) return false;
197
- return await this.isCommited(data);
198
- }
199
-
200
- /**
201
- * Checks whether a swap is commited, i.e. the swap still exists on-chain and was not claimed nor refunded
202
- *
203
- * @param swapData
204
- */
205
- async isCommited(swapData: StarknetSwapData): Promise<boolean> {
206
- const data = await this.contract.get_hash_state("0x"+swapData.getEscrowHash());
207
- return Number(data.state)===ESCROW_STATE_COMMITTED;
208
- }
209
-
210
- /**
211
- * Checks whether the swap is expired, takes into consideration possible on-chain time skew, therefore for claimer
212
- * the swap expires a bit sooner than it should've & for the offerer it expires a bit later
213
- *
214
- * @param signer
215
- * @param data
216
- */
217
- isExpired(signer: string, data: StarknetSwapData): Promise<boolean> {
218
- let currentTimestamp: bigint = BigInt(Math.floor(Date.now()/1000));
219
- if(data.isClaimer(signer)) currentTimestamp = currentTimestamp + BigInt(this.claimGracePeriod);
220
- if(data.isOfferer(signer)) currentTimestamp = currentTimestamp - BigInt(this.refundGracePeriod);
221
- return Promise.resolve(data.getExpiry() < currentTimestamp);
222
- }
223
-
224
- /**
225
- * Checks if the swap is refundable by us, checks if we are offerer, if the swap is already expired & if the swap
226
- * is still commited
227
- *
228
- * @param signer
229
- * @param data
230
- */
231
- async isRequestRefundable(signer: string, data: StarknetSwapData): Promise<boolean> {
232
- //Swap can only be refunded by the offerer
233
- if(!data.isOfferer(signer)) return false;
234
- if(!(await this.isExpired(signer, data))) return false;
235
- return await this.isCommited(data);
236
- }
237
-
238
- getHashForTxId(txId: string, confirmations: number) {
239
- return bigNumberishToBuffer(this.claimHandlersBySwapType[ChainSwapType.CHAIN_TXID].getCommitment({
240
- txId,
241
- confirmations,
242
- btcRelay: this.btcRelay
243
- }), 32);
244
- }
245
-
246
- /**
247
- * Get the swap payment hash to be used for an on-chain swap, uses poseidon hash of the value
248
- *
249
- * @param outputScript output script required to claim the swap
250
- * @param amount sats sent required to claim the swap
251
- * @param confirmations
252
- * @param nonce swap nonce uniquely identifying the transaction to prevent replay attacks
253
- */
254
- getHashForOnchain(outputScript: Buffer, amount: bigint, confirmations: number, nonce?: bigint): Buffer {
255
- let result: BigNumberish;
256
- if(nonce==null || nonce === 0n) {
257
- result = this.claimHandlersBySwapType[ChainSwapType.CHAIN].getCommitment({
258
- output: outputScript,
259
- amount,
260
- confirmations,
261
- btcRelay: this.btcRelay
262
- });
263
- } else {
264
- result = this.claimHandlersBySwapType[ChainSwapType.CHAIN_NONCED].getCommitment({
265
- output: outputScript,
266
- amount,
267
- nonce,
268
- confirmations,
269
- btcRelay: this.btcRelay
270
- });
271
- }
272
- return bigNumberishToBuffer(result, 32);
273
- }
274
-
275
- /**
276
- * Get the swap payment hash to be used for a lightning htlc swap, uses poseidon hash of the sha256 hash of the preimage
277
- *
278
- * @param paymentHash payment hash of the HTLC
279
- */
280
- getHashForHtlc(paymentHash: Buffer): Buffer {
281
- return bigNumberishToBuffer(this.claimHandlersBySwapType[ChainSwapType.HTLC].getCommitment(paymentHash), 32);
282
- }
283
-
284
- getExtraData(outputScript: Buffer, amount: bigint, confirmations: number, nonce?: bigint): Buffer {
285
- if(nonce==null) nonce = 0n;
286
- const txoHash = Buffer.from(sha256(Buffer.concat([
287
- BigIntBufferUtils.toBuffer(amount, "le", 8),
288
- outputScript
289
- ])));
290
- return Buffer.concat([
291
- txoHash,
292
- BigIntBufferUtils.toBuffer(nonce, "be", 8),
293
- BigIntBufferUtils.toBuffer(BigInt(confirmations), "be", 2)
294
- ]);
295
- }
296
-
297
-
298
- ////////////////////////////////////////////
299
- //// Swap data getters
300
- /**
301
- * Gets the status of the specific swap, this also checks if we are offerer/claimer & checks for expiry (to see
302
- * if swap is refundable)
303
- *
304
- * @param signer
305
- * @param data
306
- */
307
- async getCommitStatus(signer: string, data: StarknetSwapData): Promise<SwapCommitState> {
308
- const escrowHash = data.getEscrowHash();
309
- const stateData = await this.contract.get_hash_state("0x"+escrowHash);
310
- const state = Number(stateData.state);
311
- const blockHeight = Number(stateData.finish_blockheight);
312
- switch(state) {
313
- case ESCROW_STATE_COMMITTED:
314
- if(data.isOfferer(signer) && await this.isExpired(signer,data)) return {type: SwapCommitStateType.REFUNDABLE};
315
- return {type: SwapCommitStateType.COMMITED};
316
- case ESCROW_STATE_CLAIMED:
317
- return {
318
- type: SwapCommitStateType.PAID,
319
- getTxBlock: async () => {
320
- return {
321
- blockTime: await this.Chain.Blocks.getBlockTime(blockHeight),
322
- blockHeight: blockHeight
323
- };
324
- },
325
- getClaimTxId: async () => {
326
- const events = await this.Events.getContractBlockEvents(
327
- ["escrow_manager::events::Claim"],
328
- [null, null, null, "0x"+escrowHash],
329
- blockHeight, blockHeight
330
- );
331
- return events.length===0 ? null : events[0].txHash;
332
- },
333
- getClaimResult: async () => {
334
- const events = await this.Events.getContractBlockEvents(
335
- ["escrow_manager::events::Claim"],
336
- [null, null, null, "0x"+escrowHash],
337
- blockHeight, blockHeight
338
- );
339
- if(events.length===0) return null;
340
- const event = events[0];
341
- const claimHandlerHex = toHex(event.params.claim_handler);
342
- const claimHandler = this.claimHandlersByAddress[claimHandlerHex];
343
- if(claimHandler==null) {
344
- logger.warn("getCommitStatus(): getClaimResult("+escrowHash+"): Unknown claim handler with claim: "+claimHandlerHex);
345
- return null;
346
- }
347
- const witnessResult = claimHandler.parseWitnessResult(event.params.witness_result);
348
- return witnessResult;
349
- }
350
- };
351
- default:
352
- return {
353
- type: await this.isExpired(signer, data) ? SwapCommitStateType.EXPIRED : SwapCommitStateType.NOT_COMMITED,
354
- getTxBlock: async () => {
355
- return {
356
- blockTime: await this.Chain.Blocks.getBlockTime(blockHeight),
357
- blockHeight: blockHeight
358
- };
359
- },
360
- getClaimTxId: async () => {
361
- const events = await this.Events.getContractBlockEvents(
362
- ["escrow_manager::events::Refund"],
363
- [null, null, null, "0x"+escrowHash],
364
- blockHeight, blockHeight
365
- );
366
- return events.length===0 ? null : events[0].txHash;
367
- }
368
- };
369
- }
370
- }
371
-
372
- /**
373
- * Returns the data committed for a specific payment hash, or null if no data is currently commited for
374
- * the specific swap
375
- *
376
- * @param paymentHashHex
377
- */
378
- async getCommitedData(paymentHashHex: string): Promise<StarknetSwapData> {
379
- //TODO: Noop
380
- return null;
381
- }
382
-
383
- ////////////////////////////////////////////
384
- //// Swap data initializer
385
- createSwapData(
386
- type: ChainSwapType,
387
- offerer: string,
388
- claimer: string,
389
- token: string,
390
- amount: bigint,
391
- paymentHash: string,
392
- sequence: bigint,
393
- expiry: bigint,
394
- payIn: boolean,
395
- payOut: boolean,
396
- securityDeposit: bigint,
397
- claimerBounty: bigint,
398
- depositToken: string = this.Chain.Tokens.getNativeCurrencyAddress()
399
- ): Promise<StarknetSwapData> {
400
- return Promise.resolve(new StarknetSwapData(
401
- offerer,
402
- claimer,
403
- token,
404
- this.timelockRefundHandler.address,
405
- this.claimHandlersBySwapType?.[type]?.address,
406
- payOut,
407
- payIn,
408
- payIn, //For now track reputation for all payIn swaps
409
- sequence,
410
- "0x"+paymentHash,
411
- toHex(expiry),
412
- amount,
413
- depositToken,
414
- securityDeposit,
415
- claimerBounty,
416
- type,
417
- null
418
- ));
419
- }
420
-
421
- ////////////////////////////////////////////
422
- //// Utils
423
- async getBalance(signer: string, tokenAddress: string, inContract?: boolean): Promise<bigint> {
424
- if(inContract) return await this.getIntermediaryBalance(signer, tokenAddress);
425
-
426
- //TODO: For native token we should discount the cost of deploying an account if it is not deployed yet
427
- return await this.Chain.getBalance(signer, tokenAddress);
428
- }
429
-
430
- getIntermediaryData(address: string, token: string): Promise<{
431
- balance: bigint,
432
- reputation: IntermediaryReputationType
433
- }> {
434
- return this.LpVault.getIntermediaryData(address, token);
435
- }
436
-
437
- getIntermediaryReputation(address: string, token: string): Promise<IntermediaryReputationType> {
438
- return this.LpVault.getIntermediaryReputation(address, token);
439
- }
440
-
441
- getIntermediaryBalance(address: string, token: string): Promise<bigint> {
442
- return this.LpVault.getIntermediaryBalance(address, token);
443
- }
444
-
445
- ////////////////////////////////////////////
446
- //// Transaction initializers
447
- async txsClaimWithSecret(
448
- signer: string | StarknetSigner,
449
- swapData: StarknetSwapData,
450
- secret: string,
451
- checkExpiry?: boolean,
452
- initAta?: boolean,
453
- feeRate?: string,
454
- skipAtaCheck?: boolean
455
- ): Promise<StarknetTx[]> {
456
- return this.Claim.txsClaimWithSecret(typeof(signer)==="string" ? signer : signer.getAddress(), swapData, secret, checkExpiry, feeRate)
457
- }
458
-
459
- async txsClaimWithTxData(
460
- signer: string | StarknetSigner,
461
- swapData: StarknetSwapData,
462
- tx: { blockhash: string, confirmations: number, txid: string, hex: string, height: number },
463
- requiredConfirmations: number,
464
- vout: number,
465
- commitedHeader?: StarknetBtcStoredHeader,
466
- synchronizer?: RelaySynchronizer<StarknetBtcStoredHeader, StarknetTx, any>,
467
- initAta?: boolean,
468
- feeRate?: string
469
- ): Promise<StarknetTx[] | null> {
470
- return this.Claim.txsClaimWithTxData(
471
- typeof(signer)==="string" ? signer : signer.getAddress(),
472
- swapData,
473
- tx,
474
- requiredConfirmations,
475
- vout,
476
- commitedHeader,
477
- synchronizer,
478
- feeRate
479
- );
480
- }
481
-
482
- txsRefund(signer: string, swapData: StarknetSwapData, check?: boolean, initAta?: boolean, feeRate?: string): Promise<StarknetTx[]> {
483
- return this.Refund.txsRefund(signer, swapData, check, feeRate);
484
- }
485
-
486
- txsRefundWithAuthorization(signer: string, swapData: StarknetSwapData, {timeout, prefix, signature}, check?: boolean, initAta?: boolean, feeRate?: string): Promise<StarknetTx[]> {
487
- return this.Refund.txsRefundWithAuthorization(signer, swapData, timeout, prefix,signature, check, feeRate);
488
- }
489
-
490
- txsInit(sender: string, swapData: StarknetSwapData, {timeout, prefix, signature}, skipChecks?: boolean, feeRate?: string): Promise<StarknetTx[]> {
491
- return this.Init.txsInit(sender, swapData, timeout, prefix, signature, skipChecks, feeRate);
492
- }
493
-
494
- txsWithdraw(signer: string, token: string, amount: bigint, feeRate?: string): Promise<StarknetTx[]> {
495
- return this.LpVault.txsWithdraw(signer, token, amount, feeRate);
496
- }
497
-
498
- txsDeposit(signer: string, token: string, amount: bigint, feeRate?: string): Promise<StarknetTx[]> {
499
- return this.LpVault.txsDeposit(signer, token, amount, feeRate);
500
- }
501
-
502
- ////////////////////////////////////////////
503
- //// Executors
504
- async claimWithSecret(
505
- signer: StarknetSigner,
506
- swapData: StarknetSwapData,
507
- secret: string,
508
- checkExpiry?: boolean,
509
- initAta?: boolean,
510
- txOptions?: TransactionConfirmationOptions
511
- ): Promise<string> {
512
- const result = await this.Claim.txsClaimWithSecret(signer.getAddress(), swapData, secret, checkExpiry, txOptions?.feeRate);
513
- const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
514
- return signature;
515
- }
516
-
517
- async claimWithTxData(
518
- signer: StarknetSigner,
519
- swapData: StarknetSwapData,
520
- tx: { blockhash: string, confirmations: number, txid: string, hex: string, height: number },
521
- requiredConfirmations: number,
522
- vout: number,
523
- commitedHeader?: StarknetBtcStoredHeader,
524
- synchronizer?: RelaySynchronizer<StarknetBtcStoredHeader, StarknetTx, any>,
525
- initAta?: boolean,
526
- txOptions?: TransactionConfirmationOptions
527
- ): Promise<string> {
528
- const txs = await this.Claim.txsClaimWithTxData(
529
- signer.getAddress(), swapData, tx, requiredConfirmations, vout,
530
- commitedHeader, synchronizer, txOptions?.feeRate
531
- );
532
- if(txs===null) throw new Error("Btc relay not synchronized to required blockheight!");
533
-
534
- //TODO: This doesn't return proper tx signature
535
- const [signature] = await this.Chain.sendAndConfirm(signer, txs, txOptions?.waitForConfirmation, txOptions?.abortSignal);
536
-
537
- return signature;
538
- }
539
-
540
- async refund(
541
- signer: StarknetSigner,
542
- swapData: StarknetSwapData,
543
- check?: boolean,
544
- initAta?: boolean,
545
- txOptions?: TransactionConfirmationOptions
546
- ): Promise<string> {
547
- let result = await this.txsRefund(signer.getAddress(), swapData, check, initAta, txOptions?.feeRate);
548
-
549
- const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
550
-
551
- return signature;
552
- }
553
-
554
- async refundWithAuthorization(
555
- signer: StarknetSigner,
556
- swapData: StarknetSwapData,
557
- signature: SignatureData,
558
- check?: boolean,
559
- initAta?: boolean,
560
- txOptions?: TransactionConfirmationOptions
561
- ): Promise<string> {
562
- let result = await this.txsRefundWithAuthorization(signer.getAddress(), swapData, signature, check, initAta, txOptions?.feeRate);
563
-
564
- const [txSignature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
565
-
566
- return txSignature;
567
- }
568
-
569
- async init(
570
- signer: StarknetSigner,
571
- swapData: StarknetSwapData,
572
- signature: SignatureData,
573
- skipChecks?: boolean,
574
- txOptions?: TransactionConfirmationOptions
575
- ): Promise<string> {
576
- if(swapData.isPayIn()) {
577
- if(!swapData.isOfferer(signer.getAddress())) throw new Error("Invalid signer provided!");
578
- } else {
579
- if(!swapData.isClaimer(signer.getAddress())) throw new Error("Invalid signer provided!");
580
- }
581
-
582
- let result = await this.txsInit(signer.getAddress(), swapData, signature, skipChecks, txOptions?.feeRate);
583
-
584
- const [txSignature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
585
-
586
- return txSignature;
587
- }
588
-
589
- async withdraw(
590
- signer: StarknetSigner,
591
- token: string,
592
- amount: bigint,
593
- txOptions?: TransactionConfirmationOptions
594
- ): Promise<string> {
595
- const txs = await this.LpVault.txsWithdraw(signer.getAddress(), token, amount, txOptions?.feeRate);
596
- const [txId] = await this.Chain.sendAndConfirm(signer, txs, txOptions?.waitForConfirmation, txOptions?.abortSignal, false);
597
- return txId;
598
- }
599
-
600
- async deposit(
601
- signer: StarknetSigner,
602
- token: string,
603
- amount: bigint,
604
- txOptions?: TransactionConfirmationOptions
605
- ): Promise<string> {
606
- const txs = await this.LpVault.txsDeposit(signer.getAddress(), token, amount, txOptions?.feeRate);
607
- const [txId] = await this.Chain.sendAndConfirm(signer, txs, txOptions?.waitForConfirmation, txOptions?.abortSignal, false);
608
- return txId;
609
- }
610
-
611
- ////////////////////////////////////////////
612
- //// Fees
613
- getInitPayInFeeRate(offerer?: string, claimer?: string, token?: string, paymentHash?: string): Promise<string> {
614
- return this.Chain.Fees.getFeeRate();
615
- }
616
-
617
- getInitFeeRate(offerer?: string, claimer?: string, token?: string, paymentHash?: string): Promise<string> {
618
- return this.Chain.Fees.getFeeRate();
619
- }
620
-
621
- getRefundFeeRate(swapData: StarknetSwapData): Promise<string> {
622
- return this.Chain.Fees.getFeeRate();
623
- }
624
-
625
- getClaimFeeRate(signer: string, swapData: StarknetSwapData): Promise<string> {
626
- return this.Chain.Fees.getFeeRate();
627
- }
628
-
629
- getClaimFee(signer: string, swapData: StarknetSwapData, feeRate?: string): Promise<bigint> {
630
- return this.Claim.getClaimFee(swapData, feeRate);
631
- }
632
-
633
- /**
634
- * Get the estimated solana fee of the commit transaction
635
- */
636
- getCommitFee(signer: string, swapData: StarknetSwapData, feeRate?: string): Promise<bigint> {
637
- return this.Init.getInitFee(swapData, feeRate);
638
- }
639
-
640
- /**
641
- * Get the estimated solana transaction fee of the refund transaction
642
- */
643
- getRefundFee(signer: string, swapData: StarknetSwapData, feeRate?: string): Promise<bigint> {
644
- return this.Refund.getRefundFee(swapData, feeRate);
645
- }
646
-
647
- }
1
+ import {
2
+ BigIntBufferUtils,
3
+ ChainSwapType,
4
+ IntermediaryReputationType,
5
+ RelaySynchronizer,
6
+ SignatureData,
7
+ SwapCommitState,
8
+ SwapCommitStateType,
9
+ SwapContract,
10
+ TransactionConfirmationOptions
11
+ } from "@atomiqlabs/base";
12
+ import {Buffer} from "buffer";
13
+ import {EscrowManagerAbi} from "./EscrowManagerAbi";
14
+ import {StarknetContractBase} from "../contract/StarknetContractBase";
15
+ import {StarknetTx} from "../chain/modules/StarknetTransactions";
16
+ import {StarknetSigner} from "../wallet/StarknetSigner";
17
+ import {BigNumberish, constants, logger} from "starknet";
18
+ import {StarknetChainInterface} from "../chain/StarknetChainInterface";
19
+ import {StarknetBtcRelay} from "../btcrelay/StarknetBtcRelay";
20
+ import {StarknetSwapData} from "./StarknetSwapData";
21
+ import {bigNumberishToBuffer, toHex} from "../../utils/Utils";
22
+ import {TimelockRefundHandler} from "./handlers/refund/TimelockRefundHandler";
23
+ import {StarknetLpVault} from "./modules/StarknetLpVault";
24
+ import {StarknetPreFetchVerification, StarknetSwapInit} from "./modules/StarknetSwapInit";
25
+ import {StarknetSwapRefund} from "./modules/StarknetSwapRefund";
26
+ import {claimHandlersList, IClaimHandler} from "./handlers/claim/ClaimHandlers";
27
+ import {StarknetSwapClaim} from "./modules/StarknetSwapClaim";
28
+ import {IHandler} from "./handlers/IHandler";
29
+ import {StarknetBtcStoredHeader} from "../btcrelay/headers/StarknetBtcStoredHeader";
30
+ import {sha256} from "@noble/hashes/sha2";
31
+
32
+ const ESCROW_STATE_COMMITTED = 1;
33
+ const ESCROW_STATE_CLAIMED = 2;
34
+ const ESCROW_STATE_REFUNDED = 3;
35
+
36
+ const swapContractAddreses = {
37
+ [constants.StarknetChainId.SN_SEPOLIA]: "0x017bf50dd28b6d823a231355bb25813d4396c8e19d2df03026038714a22f0413",
38
+ [constants.StarknetChainId.SN_MAIN]: "0x04f278e1f19e495c3b1dd35ef307c4f7510768ed95481958fbae588bd173f79a"
39
+ };
40
+
41
+ const defaultClaimAddresses = {
42
+ [constants.StarknetChainId.SN_SEPOLIA]: {
43
+ [ChainSwapType.HTLC]: "0x04a57ea54d4637c352aad1bbee046868926a11702216a0aaf7eeec1568be2d7b",
44
+ [ChainSwapType.CHAIN_TXID]: "0x04c7cde88359e14b6f6f779f8b9d8310cee37e91a6f143f855ae29fab33c396e",
45
+ [ChainSwapType.CHAIN]: "0x051bef6f5fd12e2832a7d38653bdfc8eb84ba7eb7a4aada5b87ef38a9999cf17",
46
+ [ChainSwapType.CHAIN_NONCED]: "0x050e50eacd16da414f2c3a7c3570fd5e248974c6fe757d41acbf72d2836fa0a1"
47
+ },
48
+ [constants.StarknetChainId.SN_MAIN]: {
49
+ [ChainSwapType.HTLC]: "0x07b74b50a883ebee262b6db0e3c0c697670c6f30e3d610e75faf33a89c46aa2a",
50
+ [ChainSwapType.CHAIN_TXID]: "0x016c2db2b03f39cf4fd7f871035000f66b62307d9983056e33a38315da8a44dc",
51
+ [ChainSwapType.CHAIN]: "0x02c45a81c4a48d0645a0a199e620061e8a55dcc9c2b5946d050eaeeddba64e9a",
52
+ [ChainSwapType.CHAIN_NONCED]: "0x0019b5480dd7ed8ded10a09437b0a7a30b8997b4ef139deb24ff8c86f995d84f"
53
+ }
54
+ }
55
+
56
+ const defaultRefundAddresses = {
57
+ [constants.StarknetChainId.SN_SEPOLIA]: {
58
+ timelock: "0x034b8f28b3ca979036cb2849cfa3af7f67207459224b6ca5ce2474aa398ec3e7"
59
+ },
60
+ [constants.StarknetChainId.SN_MAIN]: {
61
+ timelock: "0x06a59659990c2aefbf7239f6d911617b3ae60b79cb3364f3bd242a6ca8f4f4f7"
62
+ }
63
+ }
64
+
65
+ export class StarknetSwapContract
66
+ extends StarknetContractBase<typeof EscrowManagerAbi>
67
+ implements SwapContract<
68
+ StarknetSwapData,
69
+ StarknetTx,
70
+ never,
71
+ StarknetPreFetchVerification,
72
+ StarknetSigner,
73
+ "STARKNET"
74
+ > {
75
+
76
+ readonly supportsInitWithoutClaimer = true;
77
+
78
+ ////////////////////////
79
+ //// Constants
80
+ readonly chainId: "STARKNET" = "STARKNET";
81
+
82
+ ////////////////////////
83
+ //// Timeouts
84
+ readonly claimWithSecretTimeout: number = 180;
85
+ readonly claimWithTxDataTimeout: number = 180;
86
+ readonly refundTimeout: number = 180;
87
+ readonly claimGracePeriod: number = 10*60;
88
+ readonly refundGracePeriod: number = 10*60;
89
+ readonly authGracePeriod: number = 30;
90
+
91
+ ////////////////////////
92
+ //// Services
93
+ readonly Init: StarknetSwapInit;
94
+ readonly Refund: StarknetSwapRefund;
95
+ readonly Claim: StarknetSwapClaim;
96
+ readonly LpVault: StarknetLpVault;
97
+
98
+ ////////////////////////
99
+ //// Handlers
100
+ readonly claimHandlersByAddress: {[address: string]: IClaimHandler<any, any>} = {};
101
+ readonly claimHandlersBySwapType: {[type in ChainSwapType]?: IClaimHandler<any, any>} = {};
102
+
103
+ readonly refundHandlersByAddress: {[address: string]: IHandler<any, any>} = {};
104
+ readonly timelockRefundHandler: IHandler<any, any>;
105
+
106
+ readonly btcRelay: StarknetBtcRelay<any>;
107
+
108
+ constructor(
109
+ chainInterface: StarknetChainInterface,
110
+ btcRelay: StarknetBtcRelay<any>,
111
+ contractAddress: string = swapContractAddreses[chainInterface.starknetChainId],
112
+ handlerAddresses?: {
113
+ refund?: {
114
+ timelock?: string
115
+ },
116
+ claim?: {
117
+ [type in ChainSwapType]?: string
118
+ }
119
+ }
120
+ ) {
121
+ super(chainInterface, contractAddress, EscrowManagerAbi);
122
+ this.Init = new StarknetSwapInit(chainInterface, this);
123
+ this.Refund = new StarknetSwapRefund(chainInterface, this);
124
+ this.Claim = new StarknetSwapClaim(chainInterface, this);
125
+ this.LpVault = new StarknetLpVault(chainInterface, this);
126
+
127
+ this.btcRelay = btcRelay;
128
+
129
+ handlerAddresses ??= {};
130
+ handlerAddresses.refund ??= {};
131
+ handlerAddresses.refund = {...defaultRefundAddresses[chainInterface.starknetChainId], ...handlerAddresses.refund};
132
+ handlerAddresses.claim ??= {};
133
+ handlerAddresses.claim = {...defaultClaimAddresses[chainInterface.starknetChainId], ...handlerAddresses.claim};
134
+
135
+ claimHandlersList.forEach(handlerCtor => {
136
+ const handler = new handlerCtor(handlerAddresses.claim[handlerCtor.type]);
137
+ this.claimHandlersByAddress[toHex(handler.address)] = handler;
138
+ this.claimHandlersBySwapType[handlerCtor.type] = handler;
139
+ });
140
+
141
+ this.timelockRefundHandler = new TimelockRefundHandler(handlerAddresses.refund.timelock);
142
+ this.refundHandlersByAddress[this.timelockRefundHandler.address] = this.timelockRefundHandler;
143
+ }
144
+
145
+ async start(): Promise<void> {
146
+ }
147
+
148
+ ////////////////////////////////////////////
149
+ //// Signatures
150
+ preFetchForInitSignatureVerification(): Promise<StarknetPreFetchVerification> {
151
+ return this.Init.preFetchForInitSignatureVerification();
152
+ }
153
+
154
+ getInitSignature(signer: StarknetSigner, swapData: StarknetSwapData, authorizationTimeout: number, preFetchedBlockData?: never, feeRate?: string): Promise<SignatureData> {
155
+ return this.Init.signSwapInitialization(signer, swapData, authorizationTimeout);
156
+ }
157
+
158
+ isValidInitAuthorization(sender: string, swapData: StarknetSwapData, {timeout, prefix, signature}, feeRate?: string, preFetchedData?: StarknetPreFetchVerification): Promise<Buffer> {
159
+ return this.Init.isSignatureValid(sender, swapData, timeout, prefix, signature, preFetchedData);
160
+ }
161
+
162
+ getInitAuthorizationExpiry(swapData: StarknetSwapData, {timeout, prefix, signature}, preFetchedData?: StarknetPreFetchVerification): Promise<number> {
163
+ return this.Init.getSignatureExpiry(timeout);
164
+ }
165
+
166
+ isInitAuthorizationExpired(swapData: StarknetSwapData, {timeout, prefix, signature}): Promise<boolean> {
167
+ return this.Init.isSignatureExpired(timeout);
168
+ }
169
+
170
+ getRefundSignature(signer: StarknetSigner, swapData: StarknetSwapData, authorizationTimeout: number): Promise<SignatureData> {
171
+ return this.Refund.signSwapRefund(signer, swapData, authorizationTimeout);
172
+ }
173
+
174
+ isValidRefundAuthorization(swapData: StarknetSwapData, {timeout, prefix, signature}): Promise<Buffer> {
175
+ return this.Refund.isSignatureValid(swapData, timeout, prefix, signature);
176
+ }
177
+
178
+ getDataSignature(signer: StarknetSigner, data: Buffer): Promise<string> {
179
+ return this.Chain.Signatures.getDataSignature(signer, data);
180
+ }
181
+
182
+ isValidDataSignature(data: Buffer, signature: string, publicKey: string): Promise<boolean> {
183
+ return this.Chain.Signatures.isValidDataSignature(data, signature, publicKey);
184
+ }
185
+
186
+ ////////////////////////////////////////////
187
+ //// Swap data utils
188
+ /**
189
+ * Checks whether the claim is claimable by us, that means not expired, we are claimer & the swap is commited
190
+ *
191
+ * @param signer
192
+ * @param data
193
+ */
194
+ async isClaimable(signer: string, data: StarknetSwapData): Promise<boolean> {
195
+ if(!data.isClaimer(signer)) return false;
196
+ if(await this.isExpired(signer, data)) return false;
197
+ return await this.isCommited(data);
198
+ }
199
+
200
+ /**
201
+ * Checks whether a swap is commited, i.e. the swap still exists on-chain and was not claimed nor refunded
202
+ *
203
+ * @param swapData
204
+ */
205
+ async isCommited(swapData: StarknetSwapData): Promise<boolean> {
206
+ const data = await this.contract.get_hash_state("0x"+swapData.getEscrowHash());
207
+ return Number(data.state)===ESCROW_STATE_COMMITTED;
208
+ }
209
+
210
+ /**
211
+ * Checks whether the swap is expired, takes into consideration possible on-chain time skew, therefore for claimer
212
+ * the swap expires a bit sooner than it should've & for the offerer it expires a bit later
213
+ *
214
+ * @param signer
215
+ * @param data
216
+ */
217
+ isExpired(signer: string, data: StarknetSwapData): Promise<boolean> {
218
+ let currentTimestamp: bigint = BigInt(Math.floor(Date.now()/1000));
219
+ if(data.isClaimer(signer)) currentTimestamp = currentTimestamp + BigInt(this.claimGracePeriod);
220
+ if(data.isOfferer(signer)) currentTimestamp = currentTimestamp - BigInt(this.refundGracePeriod);
221
+ return Promise.resolve(data.getExpiry() < currentTimestamp);
222
+ }
223
+
224
+ /**
225
+ * Checks if the swap is refundable by us, checks if we are offerer, if the swap is already expired & if the swap
226
+ * is still commited
227
+ *
228
+ * @param signer
229
+ * @param data
230
+ */
231
+ async isRequestRefundable(signer: string, data: StarknetSwapData): Promise<boolean> {
232
+ //Swap can only be refunded by the offerer
233
+ if(!data.isOfferer(signer)) return false;
234
+ if(!(await this.isExpired(signer, data))) return false;
235
+ return await this.isCommited(data);
236
+ }
237
+
238
+ getHashForTxId(txId: string, confirmations: number) {
239
+ return bigNumberishToBuffer(this.claimHandlersBySwapType[ChainSwapType.CHAIN_TXID].getCommitment({
240
+ txId,
241
+ confirmations,
242
+ btcRelay: this.btcRelay
243
+ }), 32);
244
+ }
245
+
246
+ /**
247
+ * Get the swap payment hash to be used for an on-chain swap, uses poseidon hash of the value
248
+ *
249
+ * @param outputScript output script required to claim the swap
250
+ * @param amount sats sent required to claim the swap
251
+ * @param confirmations
252
+ * @param nonce swap nonce uniquely identifying the transaction to prevent replay attacks
253
+ */
254
+ getHashForOnchain(outputScript: Buffer, amount: bigint, confirmations: number, nonce?: bigint): Buffer {
255
+ let result: BigNumberish;
256
+ if(nonce==null || nonce === 0n) {
257
+ result = this.claimHandlersBySwapType[ChainSwapType.CHAIN].getCommitment({
258
+ output: outputScript,
259
+ amount,
260
+ confirmations,
261
+ btcRelay: this.btcRelay
262
+ });
263
+ } else {
264
+ result = this.claimHandlersBySwapType[ChainSwapType.CHAIN_NONCED].getCommitment({
265
+ output: outputScript,
266
+ amount,
267
+ nonce,
268
+ confirmations,
269
+ btcRelay: this.btcRelay
270
+ });
271
+ }
272
+ return bigNumberishToBuffer(result, 32);
273
+ }
274
+
275
+ /**
276
+ * Get the swap payment hash to be used for a lightning htlc swap, uses poseidon hash of the sha256 hash of the preimage
277
+ *
278
+ * @param paymentHash payment hash of the HTLC
279
+ */
280
+ getHashForHtlc(paymentHash: Buffer): Buffer {
281
+ return bigNumberishToBuffer(this.claimHandlersBySwapType[ChainSwapType.HTLC].getCommitment(paymentHash), 32);
282
+ }
283
+
284
+ getExtraData(outputScript: Buffer, amount: bigint, confirmations: number, nonce?: bigint): Buffer {
285
+ if(nonce==null) nonce = 0n;
286
+ const txoHash = Buffer.from(sha256(Buffer.concat([
287
+ BigIntBufferUtils.toBuffer(amount, "le", 8),
288
+ outputScript
289
+ ])));
290
+ return Buffer.concat([
291
+ txoHash,
292
+ BigIntBufferUtils.toBuffer(nonce, "be", 8),
293
+ BigIntBufferUtils.toBuffer(BigInt(confirmations), "be", 2)
294
+ ]);
295
+ }
296
+
297
+
298
+ ////////////////////////////////////////////
299
+ //// Swap data getters
300
+ /**
301
+ * Gets the status of the specific swap, this also checks if we are offerer/claimer & checks for expiry (to see
302
+ * if swap is refundable)
303
+ *
304
+ * @param signer
305
+ * @param data
306
+ */
307
+ async getCommitStatus(signer: string, data: StarknetSwapData): Promise<SwapCommitState> {
308
+ const escrowHash = data.getEscrowHash();
309
+ const stateData = await this.contract.get_hash_state("0x"+escrowHash);
310
+ const state = Number(stateData.state);
311
+ const blockHeight = Number(stateData.finish_blockheight);
312
+ switch(state) {
313
+ case ESCROW_STATE_COMMITTED:
314
+ if(data.isOfferer(signer) && await this.isExpired(signer,data)) return {type: SwapCommitStateType.REFUNDABLE};
315
+ return {type: SwapCommitStateType.COMMITED};
316
+ case ESCROW_STATE_CLAIMED:
317
+ return {
318
+ type: SwapCommitStateType.PAID,
319
+ getTxBlock: async () => {
320
+ return {
321
+ blockTime: await this.Chain.Blocks.getBlockTime(blockHeight),
322
+ blockHeight: blockHeight
323
+ };
324
+ },
325
+ getClaimTxId: async () => {
326
+ const events = await this.Events.getContractBlockEvents(
327
+ ["escrow_manager::events::Claim"],
328
+ [null, null, null, "0x"+escrowHash],
329
+ blockHeight, blockHeight
330
+ );
331
+ return events.length===0 ? null : events[0].txHash;
332
+ },
333
+ getClaimResult: async () => {
334
+ const events = await this.Events.getContractBlockEvents(
335
+ ["escrow_manager::events::Claim"],
336
+ [null, null, null, "0x"+escrowHash],
337
+ blockHeight, blockHeight
338
+ );
339
+ if(events.length===0) return null;
340
+ const event = events[0];
341
+ const claimHandlerHex = toHex(event.params.claim_handler);
342
+ const claimHandler = this.claimHandlersByAddress[claimHandlerHex];
343
+ if(claimHandler==null) {
344
+ logger.warn("getCommitStatus(): getClaimResult("+escrowHash+"): Unknown claim handler with claim: "+claimHandlerHex);
345
+ return null;
346
+ }
347
+ const witnessResult = claimHandler.parseWitnessResult(event.params.witness_result);
348
+ return witnessResult;
349
+ }
350
+ };
351
+ default:
352
+ return {
353
+ type: await this.isExpired(signer, data) ? SwapCommitStateType.EXPIRED : SwapCommitStateType.NOT_COMMITED,
354
+ getTxBlock: async () => {
355
+ return {
356
+ blockTime: await this.Chain.Blocks.getBlockTime(blockHeight),
357
+ blockHeight: blockHeight
358
+ };
359
+ },
360
+ getClaimTxId: async () => {
361
+ const events = await this.Events.getContractBlockEvents(
362
+ ["escrow_manager::events::Refund"],
363
+ [null, null, null, "0x"+escrowHash],
364
+ blockHeight, blockHeight
365
+ );
366
+ return events.length===0 ? null : events[0].txHash;
367
+ }
368
+ };
369
+ }
370
+ }
371
+
372
+ /**
373
+ * Returns the data committed for a specific payment hash, or null if no data is currently commited for
374
+ * the specific swap
375
+ *
376
+ * @param paymentHashHex
377
+ */
378
+ async getCommitedData(paymentHashHex: string): Promise<StarknetSwapData> {
379
+ //TODO: Noop
380
+ return null;
381
+ }
382
+
383
+ ////////////////////////////////////////////
384
+ //// Swap data initializer
385
+ createSwapData(
386
+ type: ChainSwapType,
387
+ offerer: string,
388
+ claimer: string,
389
+ token: string,
390
+ amount: bigint,
391
+ paymentHash: string,
392
+ sequence: bigint,
393
+ expiry: bigint,
394
+ payIn: boolean,
395
+ payOut: boolean,
396
+ securityDeposit: bigint,
397
+ claimerBounty: bigint,
398
+ depositToken: string = this.Chain.Tokens.getNativeCurrencyAddress()
399
+ ): Promise<StarknetSwapData> {
400
+ return Promise.resolve(new StarknetSwapData(
401
+ offerer,
402
+ claimer,
403
+ token,
404
+ this.timelockRefundHandler.address,
405
+ this.claimHandlersBySwapType?.[type]?.address,
406
+ payOut,
407
+ payIn,
408
+ payIn, //For now track reputation for all payIn swaps
409
+ sequence,
410
+ "0x"+paymentHash,
411
+ toHex(expiry),
412
+ amount,
413
+ depositToken,
414
+ securityDeposit,
415
+ claimerBounty,
416
+ type,
417
+ null
418
+ ));
419
+ }
420
+
421
+ ////////////////////////////////////////////
422
+ //// Utils
423
+ async getBalance(signer: string, tokenAddress: string, inContract?: boolean): Promise<bigint> {
424
+ if(inContract) return await this.getIntermediaryBalance(signer, tokenAddress);
425
+
426
+ //TODO: For native token we should discount the cost of deploying an account if it is not deployed yet
427
+ return await this.Chain.getBalance(signer, tokenAddress);
428
+ }
429
+
430
+ getIntermediaryData(address: string, token: string): Promise<{
431
+ balance: bigint,
432
+ reputation: IntermediaryReputationType
433
+ }> {
434
+ return this.LpVault.getIntermediaryData(address, token);
435
+ }
436
+
437
+ getIntermediaryReputation(address: string, token: string): Promise<IntermediaryReputationType> {
438
+ return this.LpVault.getIntermediaryReputation(address, token);
439
+ }
440
+
441
+ getIntermediaryBalance(address: string, token: string): Promise<bigint> {
442
+ return this.LpVault.getIntermediaryBalance(address, token);
443
+ }
444
+
445
+ ////////////////////////////////////////////
446
+ //// Transaction initializers
447
+ async txsClaimWithSecret(
448
+ signer: string | StarknetSigner,
449
+ swapData: StarknetSwapData,
450
+ secret: string,
451
+ checkExpiry?: boolean,
452
+ initAta?: boolean,
453
+ feeRate?: string,
454
+ skipAtaCheck?: boolean
455
+ ): Promise<StarknetTx[]> {
456
+ return this.Claim.txsClaimWithSecret(typeof(signer)==="string" ? signer : signer.getAddress(), swapData, secret, checkExpiry, feeRate)
457
+ }
458
+
459
+ async txsClaimWithTxData(
460
+ signer: string | StarknetSigner,
461
+ swapData: StarknetSwapData,
462
+ tx: { blockhash: string, confirmations: number, txid: string, hex: string, height: number },
463
+ requiredConfirmations: number,
464
+ vout: number,
465
+ commitedHeader?: StarknetBtcStoredHeader,
466
+ synchronizer?: RelaySynchronizer<StarknetBtcStoredHeader, StarknetTx, any>,
467
+ initAta?: boolean,
468
+ feeRate?: string
469
+ ): Promise<StarknetTx[] | null> {
470
+ return this.Claim.txsClaimWithTxData(
471
+ typeof(signer)==="string" ? signer : signer.getAddress(),
472
+ swapData,
473
+ tx,
474
+ requiredConfirmations,
475
+ vout,
476
+ commitedHeader,
477
+ synchronizer,
478
+ feeRate
479
+ );
480
+ }
481
+
482
+ txsRefund(signer: string, swapData: StarknetSwapData, check?: boolean, initAta?: boolean, feeRate?: string): Promise<StarknetTx[]> {
483
+ return this.Refund.txsRefund(signer, swapData, check, feeRate);
484
+ }
485
+
486
+ txsRefundWithAuthorization(signer: string, swapData: StarknetSwapData, {timeout, prefix, signature}, check?: boolean, initAta?: boolean, feeRate?: string): Promise<StarknetTx[]> {
487
+ return this.Refund.txsRefundWithAuthorization(signer, swapData, timeout, prefix,signature, check, feeRate);
488
+ }
489
+
490
+ txsInit(sender: string, swapData: StarknetSwapData, {timeout, prefix, signature}, skipChecks?: boolean, feeRate?: string): Promise<StarknetTx[]> {
491
+ return this.Init.txsInit(sender, swapData, timeout, prefix, signature, skipChecks, feeRate);
492
+ }
493
+
494
+ txsWithdraw(signer: string, token: string, amount: bigint, feeRate?: string): Promise<StarknetTx[]> {
495
+ return this.LpVault.txsWithdraw(signer, token, amount, feeRate);
496
+ }
497
+
498
+ txsDeposit(signer: string, token: string, amount: bigint, feeRate?: string): Promise<StarknetTx[]> {
499
+ return this.LpVault.txsDeposit(signer, token, amount, feeRate);
500
+ }
501
+
502
+ ////////////////////////////////////////////
503
+ //// Executors
504
+ async claimWithSecret(
505
+ signer: StarknetSigner,
506
+ swapData: StarknetSwapData,
507
+ secret: string,
508
+ checkExpiry?: boolean,
509
+ initAta?: boolean,
510
+ txOptions?: TransactionConfirmationOptions
511
+ ): Promise<string> {
512
+ const result = await this.Claim.txsClaimWithSecret(signer.getAddress(), swapData, secret, checkExpiry, txOptions?.feeRate);
513
+ const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
514
+ return signature;
515
+ }
516
+
517
+ async claimWithTxData(
518
+ signer: StarknetSigner,
519
+ swapData: StarknetSwapData,
520
+ tx: { blockhash: string, confirmations: number, txid: string, hex: string, height: number },
521
+ requiredConfirmations: number,
522
+ vout: number,
523
+ commitedHeader?: StarknetBtcStoredHeader,
524
+ synchronizer?: RelaySynchronizer<StarknetBtcStoredHeader, StarknetTx, any>,
525
+ initAta?: boolean,
526
+ txOptions?: TransactionConfirmationOptions
527
+ ): Promise<string> {
528
+ const txs = await this.Claim.txsClaimWithTxData(
529
+ signer.getAddress(), swapData, tx, requiredConfirmations, vout,
530
+ commitedHeader, synchronizer, txOptions?.feeRate
531
+ );
532
+ if(txs===null) throw new Error("Btc relay not synchronized to required blockheight!");
533
+
534
+ //TODO: This doesn't return proper tx signature
535
+ const [signature] = await this.Chain.sendAndConfirm(signer, txs, txOptions?.waitForConfirmation, txOptions?.abortSignal);
536
+
537
+ return signature;
538
+ }
539
+
540
+ async refund(
541
+ signer: StarknetSigner,
542
+ swapData: StarknetSwapData,
543
+ check?: boolean,
544
+ initAta?: boolean,
545
+ txOptions?: TransactionConfirmationOptions
546
+ ): Promise<string> {
547
+ let result = await this.txsRefund(signer.getAddress(), swapData, check, initAta, txOptions?.feeRate);
548
+
549
+ const [signature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
550
+
551
+ return signature;
552
+ }
553
+
554
+ async refundWithAuthorization(
555
+ signer: StarknetSigner,
556
+ swapData: StarknetSwapData,
557
+ signature: SignatureData,
558
+ check?: boolean,
559
+ initAta?: boolean,
560
+ txOptions?: TransactionConfirmationOptions
561
+ ): Promise<string> {
562
+ let result = await this.txsRefundWithAuthorization(signer.getAddress(), swapData, signature, check, initAta, txOptions?.feeRate);
563
+
564
+ const [txSignature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
565
+
566
+ return txSignature;
567
+ }
568
+
569
+ async init(
570
+ signer: StarknetSigner,
571
+ swapData: StarknetSwapData,
572
+ signature: SignatureData,
573
+ skipChecks?: boolean,
574
+ txOptions?: TransactionConfirmationOptions
575
+ ): Promise<string> {
576
+ if(swapData.isPayIn()) {
577
+ if(!swapData.isOfferer(signer.getAddress())) throw new Error("Invalid signer provided!");
578
+ } else {
579
+ if(!swapData.isClaimer(signer.getAddress())) throw new Error("Invalid signer provided!");
580
+ }
581
+
582
+ let result = await this.txsInit(signer.getAddress(), swapData, signature, skipChecks, txOptions?.feeRate);
583
+
584
+ const [txSignature] = await this.Chain.sendAndConfirm(signer, result, txOptions?.waitForConfirmation, txOptions?.abortSignal);
585
+
586
+ return txSignature;
587
+ }
588
+
589
+ async withdraw(
590
+ signer: StarknetSigner,
591
+ token: string,
592
+ amount: bigint,
593
+ txOptions?: TransactionConfirmationOptions
594
+ ): Promise<string> {
595
+ const txs = await this.LpVault.txsWithdraw(signer.getAddress(), token, amount, txOptions?.feeRate);
596
+ const [txId] = await this.Chain.sendAndConfirm(signer, txs, txOptions?.waitForConfirmation, txOptions?.abortSignal, false);
597
+ return txId;
598
+ }
599
+
600
+ async deposit(
601
+ signer: StarknetSigner,
602
+ token: string,
603
+ amount: bigint,
604
+ txOptions?: TransactionConfirmationOptions
605
+ ): Promise<string> {
606
+ const txs = await this.LpVault.txsDeposit(signer.getAddress(), token, amount, txOptions?.feeRate);
607
+ const [txId] = await this.Chain.sendAndConfirm(signer, txs, txOptions?.waitForConfirmation, txOptions?.abortSignal, false);
608
+ return txId;
609
+ }
610
+
611
+ ////////////////////////////////////////////
612
+ //// Fees
613
+ getInitPayInFeeRate(offerer?: string, claimer?: string, token?: string, paymentHash?: string): Promise<string> {
614
+ return this.Chain.Fees.getFeeRate();
615
+ }
616
+
617
+ getInitFeeRate(offerer?: string, claimer?: string, token?: string, paymentHash?: string): Promise<string> {
618
+ return this.Chain.Fees.getFeeRate();
619
+ }
620
+
621
+ getRefundFeeRate(swapData: StarknetSwapData): Promise<string> {
622
+ return this.Chain.Fees.getFeeRate();
623
+ }
624
+
625
+ getClaimFeeRate(signer: string, swapData: StarknetSwapData): Promise<string> {
626
+ return this.Chain.Fees.getFeeRate();
627
+ }
628
+
629
+ getClaimFee(signer: string, swapData: StarknetSwapData, feeRate?: string): Promise<bigint> {
630
+ return this.Claim.getClaimFee(swapData, feeRate);
631
+ }
632
+
633
+ /**
634
+ * Get the estimated solana fee of the commit transaction
635
+ */
636
+ getCommitFee(signer: string, swapData: StarknetSwapData, feeRate?: string): Promise<bigint> {
637
+ return this.Init.getInitFee(swapData, feeRate);
638
+ }
639
+
640
+ /**
641
+ * Get the estimated solana transaction fee of the refund transaction
642
+ */
643
+ getRefundFee(signer: string, swapData: StarknetSwapData, feeRate?: string): Promise<bigint> {
644
+ return this.Refund.getRefundFee(swapData, feeRate);
645
+ }
646
+
647
+ }