@atomiqlabs/chain-starknet 5.0.2 → 5.1.0

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