@atomiqlabs/chain-starknet 3.0.0-dev.8 → 4.0.0-dev.3

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