@atomiqlabs/chain-starknet 1.0.0-beta.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 (136) hide show
  1. package/LICENSE +201 -0
  2. package/dist/get_serialized_block.d.ts +1 -0
  3. package/dist/get_serialized_block.js +28 -0
  4. package/dist/index.d.ts +34 -0
  5. package/dist/index.js +50 -0
  6. package/dist/starknet/StarknetChainType.d.ts +9 -0
  7. package/dist/starknet/StarknetChainType.js +2 -0
  8. package/dist/starknet/StarknetInitializer.d.ts +18 -0
  9. package/dist/starknet/StarknetInitializer.js +49 -0
  10. package/dist/starknet/base/StarknetAction.d.ts +27 -0
  11. package/dist/starknet/base/StarknetAction.js +73 -0
  12. package/dist/starknet/base/StarknetBase.d.ts +34 -0
  13. package/dist/starknet/base/StarknetBase.js +29 -0
  14. package/dist/starknet/base/StarknetModule.d.ts +14 -0
  15. package/dist/starknet/base/StarknetModule.js +13 -0
  16. package/dist/starknet/base/modules/ERC20Abi.d.ts +755 -0
  17. package/dist/starknet/base/modules/ERC20Abi.js +1032 -0
  18. package/dist/starknet/base/modules/StarknetAccounts.d.ts +6 -0
  19. package/dist/starknet/base/modules/StarknetAccounts.js +24 -0
  20. package/dist/starknet/base/modules/StarknetAddresses.d.ts +9 -0
  21. package/dist/starknet/base/modules/StarknetAddresses.js +26 -0
  22. package/dist/starknet/base/modules/StarknetBlocks.d.ts +19 -0
  23. package/dist/starknet/base/modules/StarknetBlocks.js +49 -0
  24. package/dist/starknet/base/modules/StarknetEvents.d.ts +44 -0
  25. package/dist/starknet/base/modules/StarknetEvents.js +88 -0
  26. package/dist/starknet/base/modules/StarknetFees.d.ts +55 -0
  27. package/dist/starknet/base/modules/StarknetFees.js +102 -0
  28. package/dist/starknet/base/modules/StarknetSignatures.d.ts +30 -0
  29. package/dist/starknet/base/modules/StarknetSignatures.js +71 -0
  30. package/dist/starknet/base/modules/StarknetTokens.d.ts +67 -0
  31. package/dist/starknet/base/modules/StarknetTokens.js +97 -0
  32. package/dist/starknet/base/modules/StarknetTransactions.d.ts +87 -0
  33. package/dist/starknet/base/modules/StarknetTransactions.js +226 -0
  34. package/dist/starknet/btcrelay/BtcRelayAbi.d.ts +250 -0
  35. package/dist/starknet/btcrelay/BtcRelayAbi.js +341 -0
  36. package/dist/starknet/btcrelay/StarknetBtcRelay.d.ts +166 -0
  37. package/dist/starknet/btcrelay/StarknetBtcRelay.js +323 -0
  38. package/dist/starknet/btcrelay/headers/StarknetBtcHeader.d.ts +32 -0
  39. package/dist/starknet/btcrelay/headers/StarknetBtcHeader.js +74 -0
  40. package/dist/starknet/btcrelay/headers/StarknetBtcStoredHeader.d.ts +52 -0
  41. package/dist/starknet/btcrelay/headers/StarknetBtcStoredHeader.js +113 -0
  42. package/dist/starknet/contract/StarknetContractBase.d.ts +13 -0
  43. package/dist/starknet/contract/StarknetContractBase.js +18 -0
  44. package/dist/starknet/contract/modules/StarknetContractEvents.d.ts +40 -0
  45. package/dist/starknet/contract/modules/StarknetContractEvents.js +77 -0
  46. package/dist/starknet/events/StarknetChainEvents.d.ts +19 -0
  47. package/dist/starknet/events/StarknetChainEvents.js +51 -0
  48. package/dist/starknet/events/StarknetChainEventsBrowser.d.ts +73 -0
  49. package/dist/starknet/events/StarknetChainEventsBrowser.js +210 -0
  50. package/dist/starknet/swaps/EscrowManagerAbi.d.ts +445 -0
  51. package/dist/starknet/swaps/EscrowManagerAbi.js +601 -0
  52. package/dist/starknet/swaps/StarknetSwapContract.d.ts +215 -0
  53. package/dist/starknet/swaps/StarknetSwapContract.js +452 -0
  54. package/dist/starknet/swaps/StarknetSwapData.d.ts +74 -0
  55. package/dist/starknet/swaps/StarknetSwapData.js +316 -0
  56. package/dist/starknet/swaps/StarknetSwapModule.d.ts +9 -0
  57. package/dist/starknet/swaps/StarknetSwapModule.js +12 -0
  58. package/dist/starknet/swaps/handlers/IHandler.d.ts +13 -0
  59. package/dist/starknet/swaps/handlers/IHandler.js +2 -0
  60. package/dist/starknet/swaps/handlers/claim/ClaimHandlers.d.ts +13 -0
  61. package/dist/starknet/swaps/handlers/claim/ClaimHandlers.js +13 -0
  62. package/dist/starknet/swaps/handlers/claim/HashlockClaimHandler.d.ts +22 -0
  63. package/dist/starknet/swaps/handlers/claim/HashlockClaimHandler.js +44 -0
  64. package/dist/starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.d.ts +25 -0
  65. package/dist/starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.js +48 -0
  66. package/dist/starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.d.ts +26 -0
  67. package/dist/starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.js +40 -0
  68. package/dist/starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.d.ts +20 -0
  69. package/dist/starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.js +29 -0
  70. package/dist/starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler.d.ts +64 -0
  71. package/dist/starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler.js +86 -0
  72. package/dist/starknet/swaps/handlers/refund/TimelockRefundHandler.d.ts +17 -0
  73. package/dist/starknet/swaps/handlers/refund/TimelockRefundHandler.js +27 -0
  74. package/dist/starknet/swaps/modules/StarknetLpVault.d.ts +69 -0
  75. package/dist/starknet/swaps/modules/StarknetLpVault.js +122 -0
  76. package/dist/starknet/swaps/modules/StarknetSwapClaim.d.ts +53 -0
  77. package/dist/starknet/swaps/modules/StarknetSwapClaim.js +100 -0
  78. package/dist/starknet/swaps/modules/StarknetSwapInit.d.ts +84 -0
  79. package/dist/starknet/swaps/modules/StarknetSwapInit.js +164 -0
  80. package/dist/starknet/swaps/modules/StarknetSwapRefund.d.ts +64 -0
  81. package/dist/starknet/swaps/modules/StarknetSwapRefund.js +131 -0
  82. package/dist/starknet/swaps/modules/SwapClaim.d.ts +54 -0
  83. package/dist/starknet/swaps/modules/SwapClaim.js +115 -0
  84. package/dist/starknet/swaps/modules/SwapInit.d.ts +79 -0
  85. package/dist/starknet/swaps/modules/SwapInit.js +174 -0
  86. package/dist/starknet/swaps/modules/SwapRefund.d.ts +63 -0
  87. package/dist/starknet/swaps/modules/SwapRefund.js +149 -0
  88. package/dist/starknet/wallet/StarknetKeypairWallet.d.ts +6 -0
  89. package/dist/starknet/wallet/StarknetKeypairWallet.js +26 -0
  90. package/dist/starknet/wallet/StarknetSigner.d.ts +12 -0
  91. package/dist/starknet/wallet/StarknetSigner.js +46 -0
  92. package/dist/utils/Utils.d.ts +38 -0
  93. package/dist/utils/Utils.js +255 -0
  94. package/package.json +39 -0
  95. package/src/index.ts +41 -0
  96. package/src/starknet/StarknetChainType.ts +20 -0
  97. package/src/starknet/StarknetInitializer.ts +75 -0
  98. package/src/starknet/base/StarknetAction.ts +90 -0
  99. package/src/starknet/base/StarknetBase.ts +56 -0
  100. package/src/starknet/base/StarknetModule.ts +20 -0
  101. package/src/starknet/base/modules/ERC20Abi.ts +1029 -0
  102. package/src/starknet/base/modules/StarknetAccounts.ts +26 -0
  103. package/src/starknet/base/modules/StarknetAddresses.ts +23 -0
  104. package/src/starknet/base/modules/StarknetBlocks.ts +59 -0
  105. package/src/starknet/base/modules/StarknetEvents.ts +105 -0
  106. package/src/starknet/base/modules/StarknetFees.ts +136 -0
  107. package/src/starknet/base/modules/StarknetSignatures.ts +91 -0
  108. package/src/starknet/base/modules/StarknetTokens.ts +116 -0
  109. package/src/starknet/base/modules/StarknetTransactions.ts +254 -0
  110. package/src/starknet/btcrelay/BtcRelayAbi.ts +338 -0
  111. package/src/starknet/btcrelay/StarknetBtcRelay.ts +415 -0
  112. package/src/starknet/btcrelay/headers/StarknetBtcHeader.ts +101 -0
  113. package/src/starknet/btcrelay/headers/StarknetBtcStoredHeader.ts +142 -0
  114. package/src/starknet/contract/StarknetContractBase.ts +29 -0
  115. package/src/starknet/contract/modules/StarknetContractEvents.ts +108 -0
  116. package/src/starknet/events/StarknetChainEvents.ts +63 -0
  117. package/src/starknet/events/StarknetChainEventsBrowser.ts +289 -0
  118. package/src/starknet/swaps/EscrowManagerAbi.ts +600 -0
  119. package/src/starknet/swaps/StarknetSwapContract.ts +694 -0
  120. package/src/starknet/swaps/StarknetSwapData.ts +441 -0
  121. package/src/starknet/swaps/StarknetSwapModule.ts +17 -0
  122. package/src/starknet/swaps/handlers/IHandler.ts +20 -0
  123. package/src/starknet/swaps/handlers/claim/ClaimHandlers.ts +23 -0
  124. package/src/starknet/swaps/handlers/claim/HashlockClaimHandler.ts +54 -0
  125. package/src/starknet/swaps/handlers/claim/btc/BitcoinNoncedOutputClaimHandler.ts +73 -0
  126. package/src/starknet/swaps/handlers/claim/btc/BitcoinOutputClaimHandler.ts +67 -0
  127. package/src/starknet/swaps/handlers/claim/btc/BitcoinTxIdClaimHandler.ts +49 -0
  128. package/src/starknet/swaps/handlers/claim/btc/IBitcoinClaimHandler.ts +151 -0
  129. package/src/starknet/swaps/handlers/refund/TimelockRefundHandler.ts +39 -0
  130. package/src/starknet/swaps/modules/StarknetLpVault.ts +148 -0
  131. package/src/starknet/swaps/modules/StarknetSwapClaim.ts +142 -0
  132. package/src/starknet/swaps/modules/StarknetSwapInit.ts +226 -0
  133. package/src/starknet/swaps/modules/StarknetSwapRefund.ts +202 -0
  134. package/src/starknet/wallet/StarknetKeypairWallet.ts +34 -0
  135. package/src/starknet/wallet/StarknetSigner.ts +55 -0
  136. package/src/utils/Utils.ts +247 -0
@@ -0,0 +1,79 @@
1
+ import * as BN from "bn.js";
2
+ import { StarknetSwapData } from "../StarknetSwapData";
3
+ import { StarknetSwapModule } from "../StarknetSwapModule";
4
+ import { StarknetSigner } from "../../wallet/StarknetSigner";
5
+ import { StarknetTx } from "../../base/modules/StarknetTransactions";
6
+ export declare class SwapInit extends StarknetSwapModule {
7
+ private static readonly GasCosts;
8
+ /**
9
+ * bare Init action based on the data passed in swapData
10
+ *
11
+ * @param swapData
12
+ * @param timeout
13
+ * @param signature
14
+ * @private
15
+ */
16
+ private Init;
17
+ /**
18
+ * Returns auth prefix to be used with a specific swap, payIn=true & payIn=false use different prefixes (these
19
+ * actually have no meaning for the smart contract/solana program in the Solana case)
20
+ *
21
+ * @param swapData
22
+ * @private
23
+ */
24
+ private getAuthPrefix;
25
+ /**
26
+ * Signs swap initialization authorization, using data from preFetchedBlockData if provided & still valid (subject
27
+ * to SIGNATURE_PREFETCH_DATA_VALIDITY)
28
+ *
29
+ * @param signer
30
+ * @param swapData
31
+ * @param authorizationTimeout
32
+ * @public
33
+ */
34
+ signSwapInitialization(signer: StarknetSigner, swapData: StarknetSwapData, authorizationTimeout: number): Promise<{
35
+ prefix: string;
36
+ timeout: string;
37
+ signature: string;
38
+ }>;
39
+ /**
40
+ * Checks whether the provided signature data is valid, using preFetchedData if provided and still valid
41
+ *
42
+ * @param swapData
43
+ * @param timeout
44
+ * @param prefix
45
+ * @param signature
46
+ * @public
47
+ */
48
+ isSignatureValid(swapData: StarknetSwapData, timeout: string, prefix: string, signature: string): Promise<null>;
49
+ /**
50
+ * Gets expiry of the provided signature data, this is a minimum of slot expiry & swap signature expiry
51
+ *
52
+ * @param timeout
53
+ * @public
54
+ */
55
+ getSignatureExpiry(timeout: string): Promise<number>;
56
+ /**
57
+ * Checks whether signature is expired for good, uses expiry + grace period
58
+ *
59
+ * @param timeout
60
+ * @public
61
+ */
62
+ isSignatureExpired(timeout: string): Promise<boolean>;
63
+ /**
64
+ * Creates init transaction with a valid signature from an LP
65
+ *
66
+ * @param swapData swap to initialize
67
+ * @param timeout init signature timeout
68
+ * @param prefix init signature prefix
69
+ * @param signature init signature
70
+ * @param skipChecks whether to skip signature validity checks
71
+ * @param feeRate fee rate to use for the transaction
72
+ */
73
+ txsInit(swapData: StarknetSwapData, timeout: string, prefix: string, signature: string, skipChecks?: boolean, feeRate?: string): Promise<StarknetTx[]>;
74
+ /**
75
+ * Get the estimated solana fee of the init transaction, this includes the required deposit for creating swap PDA
76
+ * and also deposit for ATAs
77
+ */
78
+ getInitFee(swapData?: StarknetSwapData, feeRate?: string): Promise<BN>;
79
+ }
@@ -0,0 +1,174 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.SwapInit = void 0;
13
+ const base_1 = require("@atomiqlabs/base");
14
+ const BN = require("bn.js");
15
+ const Utils_1 = require("../../../utils/Utils");
16
+ const buffer_1 = require("buffer");
17
+ const StarknetAction_1 = require("../../base/StarknetAction");
18
+ const StarknetSwapModule_1 = require("../StarknetSwapModule");
19
+ const StarknetFees_1 = require("../../base/modules/StarknetFees");
20
+ const Initialize = [
21
+ { name: 'Swap hash', type: 'felt' },
22
+ { name: 'Timeout', type: 'timestamp' }
23
+ ];
24
+ class SwapInit extends StarknetSwapModule_1.StarknetSwapModule {
25
+ /**
26
+ * bare Init action based on the data passed in swapData
27
+ *
28
+ * @param swapData
29
+ * @param timeout
30
+ * @param signature
31
+ * @private
32
+ */
33
+ Init(swapData, timeout, signature) {
34
+ return new StarknetAction_1.StarknetAction(swapData.payIn ? swapData.offerer : swapData.claimer, this.root, this.contract.populateTransaction.initialize(swapData.toEscrowStruct(), signature, (0, Utils_1.toBigInt)(timeout), swapData.extraData == null || swapData.extraData === "" ? [] : (0, Utils_1.bufferToBytes31Span)(buffer_1.Buffer.from(swapData.extraData, "hex")).map(Utils_1.toHex)), swapData.payIn ? SwapInit.GasCosts.INIT_PAY_IN : SwapInit.GasCosts.INIT);
35
+ }
36
+ /**
37
+ * Returns auth prefix to be used with a specific swap, payIn=true & payIn=false use different prefixes (these
38
+ * actually have no meaning for the smart contract/solana program in the Solana case)
39
+ *
40
+ * @param swapData
41
+ * @private
42
+ */
43
+ getAuthPrefix(swapData) {
44
+ return swapData.isPayIn() ? "claim_initialize" : "initialize";
45
+ }
46
+ /**
47
+ * Signs swap initialization authorization, using data from preFetchedBlockData if provided & still valid (subject
48
+ * to SIGNATURE_PREFETCH_DATA_VALIDITY)
49
+ *
50
+ * @param signer
51
+ * @param swapData
52
+ * @param authorizationTimeout
53
+ * @public
54
+ */
55
+ signSwapInitialization(signer, swapData, authorizationTimeout) {
56
+ return __awaiter(this, void 0, void 0, function* () {
57
+ const authTimeout = Math.floor(Date.now() / 1000) + authorizationTimeout;
58
+ const signature = yield this.root.Signatures.signTypedMessage(signer, Initialize, "Initialize", {
59
+ "Swap hash": (0, Utils_1.toHex)(swapData.getEscrowHash()),
60
+ "Timeout": (0, Utils_1.toHex)(authTimeout)
61
+ });
62
+ return {
63
+ prefix: this.getAuthPrefix(swapData),
64
+ timeout: authorizationTimeout.toString(10),
65
+ signature
66
+ };
67
+ });
68
+ }
69
+ /**
70
+ * Checks whether the provided signature data is valid, using preFetchedData if provided and still valid
71
+ *
72
+ * @param swapData
73
+ * @param timeout
74
+ * @param prefix
75
+ * @param signature
76
+ * @public
77
+ */
78
+ isSignatureValid(swapData, timeout, prefix, signature) {
79
+ return __awaiter(this, void 0, void 0, function* () {
80
+ const sender = swapData.isPayIn() ? swapData.offerer : swapData.claimer;
81
+ const signer = swapData.isPayIn() ? swapData.claimer : swapData.offerer;
82
+ if (!swapData.isPayIn() && (yield this.root.isExpired(sender.toString(), swapData))) {
83
+ throw new base_1.SignatureVerificationError("Swap will expire too soon!");
84
+ }
85
+ if (prefix !== this.getAuthPrefix(swapData))
86
+ throw new base_1.SignatureVerificationError("Invalid prefix");
87
+ const currentTimestamp = new BN(Math.floor(Date.now() / 1000));
88
+ const timeoutBN = new BN(timeout);
89
+ const isExpired = timeoutBN.sub(currentTimestamp).lt(new BN(this.root.authGracePeriod));
90
+ if (isExpired)
91
+ throw new base_1.SignatureVerificationError("Authorization expired!");
92
+ const valid = yield this.root.Signatures.isValidSignature(signature, signer, Initialize, "Initialize", {
93
+ "Swap hash": (0, Utils_1.toHex)(swapData.getEscrowHash()),
94
+ "Timeout": (0, Utils_1.toHex)(timeoutBN)
95
+ });
96
+ if (!valid)
97
+ throw new base_1.SignatureVerificationError("Invalid signature!");
98
+ return null;
99
+ });
100
+ }
101
+ /**
102
+ * Gets expiry of the provided signature data, this is a minimum of slot expiry & swap signature expiry
103
+ *
104
+ * @param timeout
105
+ * @public
106
+ */
107
+ getSignatureExpiry(timeout) {
108
+ return __awaiter(this, void 0, void 0, function* () {
109
+ const now = Date.now();
110
+ const timeoutExpiryTime = (parseInt(timeout) - this.root.authGracePeriod) * 1000;
111
+ if (timeoutExpiryTime < now)
112
+ return 0;
113
+ return timeoutExpiryTime;
114
+ });
115
+ }
116
+ /**
117
+ * Checks whether signature is expired for good, uses expiry + grace period
118
+ *
119
+ * @param timeout
120
+ * @public
121
+ */
122
+ isSignatureExpired(timeout) {
123
+ return __awaiter(this, void 0, void 0, function* () {
124
+ return (parseInt(timeout) + this.root.authGracePeriod) * 1000 < Date.now();
125
+ });
126
+ }
127
+ /**
128
+ * Creates init transaction with a valid signature from an LP
129
+ *
130
+ * @param swapData swap to initialize
131
+ * @param timeout init signature timeout
132
+ * @param prefix init signature prefix
133
+ * @param signature init signature
134
+ * @param skipChecks whether to skip signature validity checks
135
+ * @param feeRate fee rate to use for the transaction
136
+ */
137
+ txsInit(swapData, timeout, prefix, signature, skipChecks, feeRate) {
138
+ return __awaiter(this, void 0, void 0, function* () {
139
+ const sender = swapData.isPayIn() ? swapData.offerer : swapData.claimer;
140
+ if (!skipChecks) {
141
+ const [_, payStatus] = yield Promise.all([
142
+ (0, Utils_1.tryWithRetries)(() => this.isSignatureValid(swapData, timeout, prefix, signature), this.retryPolicy, (e) => e instanceof base_1.SignatureVerificationError),
143
+ (0, Utils_1.tryWithRetries)(() => this.root.getCommitStatus(sender, swapData), this.retryPolicy)
144
+ ]);
145
+ if (payStatus !== base_1.SwapCommitStatus.NOT_COMMITED)
146
+ throw new base_1.SwapDataVerificationError("Invoice already being paid for or paid");
147
+ }
148
+ feeRate !== null && feeRate !== void 0 ? feeRate : (feeRate = yield this.root.Fees.getFeeRate());
149
+ const initAction = this.Init(swapData, new BN(timeout), JSON.parse(signature));
150
+ if (swapData.payIn)
151
+ initAction.addAction(this.root.Tokens.Approve(sender, this.contract.address, swapData.token, swapData.amount), 0); //Add erc20 approve
152
+ if (!swapData.getTotalDeposit().isZero())
153
+ initAction.addAction(this.root.Tokens.Approve(sender, this.contract.address, swapData.feeToken, swapData.getTotalDeposit()), 0); //Add deposit erc20 approve
154
+ this.logger.debug("txsInitPayIn(): create swap init TX, swap: " + swapData.getClaimHash() +
155
+ " feerate: " + feeRate);
156
+ return [yield initAction.tx(feeRate)];
157
+ });
158
+ }
159
+ /**
160
+ * Get the estimated solana fee of the init transaction, this includes the required deposit for creating swap PDA
161
+ * and also deposit for ATAs
162
+ */
163
+ getInitFee(swapData, feeRate) {
164
+ return __awaiter(this, void 0, void 0, function* () {
165
+ feeRate !== null && feeRate !== void 0 ? feeRate : (feeRate = yield this.root.Fees.getFeeRate());
166
+ return StarknetFees_1.StarknetFees.getGasFee(swapData.payIn ? SwapInit.GasCosts.INIT_PAY_IN.l1 : SwapInit.GasCosts.INIT.l1, feeRate);
167
+ });
168
+ }
169
+ }
170
+ exports.SwapInit = SwapInit;
171
+ SwapInit.GasCosts = {
172
+ INIT: { l1: 500, l2: 0 },
173
+ INIT_PAY_IN: { l1: 1000, l2: 0 },
174
+ };
@@ -0,0 +1,63 @@
1
+ import * as BN from "bn.js";
2
+ import { StarknetSwapModule } from "../StarknetSwapModule";
3
+ import { StarknetSwapData } from "../StarknetSwapData";
4
+ import { StarknetSwapContract } from "../StarknetSwapContract";
5
+ import { StarknetTx } from "../../base/modules/StarknetTransactions";
6
+ import { StarknetSigner } from "../../wallet/StarknetSigner";
7
+ export declare class SwapRefund extends StarknetSwapModule {
8
+ private static readonly GasCosts;
9
+ /**
10
+ * Action for generic Refund instruction
11
+ *
12
+ * @param signer
13
+ * @param swapData
14
+ * @param witness
15
+ * @param handlerGas
16
+ * @constructor
17
+ * @private
18
+ */
19
+ private Refund;
20
+ /**
21
+ * Action for cooperative refunding with signature
22
+ *
23
+ * @param sender
24
+ * @param swapData
25
+ * @param timeout
26
+ * @param signature
27
+ * @constructor
28
+ * @private
29
+ */
30
+ private RefundWithSignature;
31
+ constructor(root: StarknetSwapContract);
32
+ signSwapRefund(signer: StarknetSigner, swapData: StarknetSwapData, authorizationTimeout: number): Promise<{
33
+ prefix: string;
34
+ timeout: string;
35
+ signature: string;
36
+ }>;
37
+ isSignatureValid(swapData: StarknetSwapData, timeout: string, prefix: string, signature: string): Promise<null>;
38
+ /**
39
+ * Creates transactions required for refunding timed out swap
40
+ *
41
+ * @param swapData swap data to refund
42
+ * @param check whether to check if swap is already expired and refundable
43
+ * @param feeRate fee rate to be used for the transactions
44
+ * @param witnessData
45
+ */
46
+ txsRefund<T>(swapData: StarknetSwapData, check?: boolean, feeRate?: string, witnessData?: T): Promise<StarknetTx[]>;
47
+ /**
48
+ * Creates transactions required for refunding the swap with authorization signature, also unwraps WSOL to SOL
49
+ *
50
+ * @param swapData swap data to refund
51
+ * @param timeout signature timeout
52
+ * @param prefix signature prefix of the counterparty
53
+ * @param signature signature of the counterparty
54
+ * @param check whether to check if swap is committed before attempting refund
55
+ * @param feeRate fee rate to be used for the transactions
56
+ */
57
+ txsRefundWithAuthorization(swapData: StarknetSwapData, timeout: string, prefix: string, signature: string, check?: boolean, feeRate?: string): Promise<StarknetTx[]>;
58
+ /**
59
+ * Get the estimated solana transaction fee of the refund transaction, in the worst case scenario in case where the
60
+ * ATA needs to be initialized again (i.e. adding the ATA rent exempt lamports to the fee)
61
+ */
62
+ getRefundFee(swapData: StarknetSwapData, feeRate?: string): Promise<BN>;
63
+ }
@@ -0,0 +1,149 @@
1
+ "use strict";
2
+ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
3
+ function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
4
+ return new (P || (P = Promise))(function (resolve, reject) {
5
+ function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
6
+ function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
7
+ function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
8
+ step((generator = generator.apply(thisArg, _arguments || [])).next());
9
+ });
10
+ };
11
+ Object.defineProperty(exports, "__esModule", { value: true });
12
+ exports.SwapRefund = void 0;
13
+ const base_1 = require("@atomiqlabs/base");
14
+ const BN = require("bn.js");
15
+ const Utils_1 = require("../../../utils/Utils");
16
+ const StarknetSwapModule_1 = require("../StarknetSwapModule");
17
+ const StarknetAction_1 = require("../../base/StarknetAction");
18
+ const StarknetFees_1 = require("../../base/modules/StarknetFees");
19
+ const Refund = [
20
+ { name: 'Swap hash', type: 'felt' },
21
+ { name: 'Timeout', type: 'timestamp' }
22
+ ];
23
+ class SwapRefund extends StarknetSwapModule_1.StarknetSwapModule {
24
+ /**
25
+ * Action for generic Refund instruction
26
+ *
27
+ * @param signer
28
+ * @param swapData
29
+ * @param witness
30
+ * @param handlerGas
31
+ * @constructor
32
+ * @private
33
+ */
34
+ Refund(signer, swapData, witness, handlerGas) {
35
+ return new StarknetAction_1.StarknetAction(signer, this.root, this.contract.populateTransaction.refund(swapData.toEscrowStruct(), witness), (0, StarknetAction_1.sumStarknetGas)(swapData.payIn ? SwapRefund.GasCosts.REFUND_PAY_OUT : SwapRefund.GasCosts.REFUND, handlerGas));
36
+ }
37
+ /**
38
+ * Action for cooperative refunding with signature
39
+ *
40
+ * @param sender
41
+ * @param swapData
42
+ * @param timeout
43
+ * @param signature
44
+ * @constructor
45
+ * @private
46
+ */
47
+ RefundWithSignature(sender, swapData, timeout, signature) {
48
+ return new StarknetAction_1.StarknetAction(sender, this.root, this.contract.populateTransaction.cooperative_refund(swapData.toEscrowStruct(), signature, BigInt(timeout)), swapData.payIn ? SwapRefund.GasCosts.REFUND_PAY_OUT : SwapRefund.GasCosts.REFUND);
49
+ }
50
+ constructor(root) {
51
+ super(root);
52
+ }
53
+ signSwapRefund(signer, swapData, authorizationTimeout) {
54
+ return __awaiter(this, void 0, void 0, function* () {
55
+ const authPrefix = "refund";
56
+ const authTimeout = Math.floor(Date.now() / 1000) + authorizationTimeout;
57
+ const signature = yield this.root.Signatures.signTypedMessage(signer, Refund, "Refund", {
58
+ "Swap hash": (0, Utils_1.toHex)(swapData.getEscrowHash()),
59
+ "Timeout": (0, Utils_1.toHex)(authTimeout)
60
+ });
61
+ return {
62
+ prefix: authPrefix,
63
+ timeout: authTimeout.toString(10),
64
+ signature: signature
65
+ };
66
+ });
67
+ }
68
+ isSignatureValid(swapData, timeout, prefix, signature) {
69
+ return __awaiter(this, void 0, void 0, function* () {
70
+ if (prefix !== "refund")
71
+ throw new base_1.SignatureVerificationError("Invalid prefix");
72
+ const expiryTimestamp = new BN(timeout);
73
+ const currentTimestamp = new BN(Math.floor(Date.now() / 1000));
74
+ const isExpired = expiryTimestamp.sub(currentTimestamp).lt(new BN(this.root.authGracePeriod));
75
+ if (isExpired)
76
+ throw new base_1.SignatureVerificationError("Authorization expired!");
77
+ const valid = yield this.root.Signatures.isValidSignature(signature, swapData.claimer, Refund, "Refund", {
78
+ "Swap hash": (0, Utils_1.toHex)(swapData.getEscrowHash()),
79
+ "Timeout": (0, Utils_1.toHex)(expiryTimestamp)
80
+ });
81
+ if (!valid) {
82
+ throw new base_1.SignatureVerificationError("Invalid signature!");
83
+ }
84
+ return null;
85
+ });
86
+ }
87
+ /**
88
+ * Creates transactions required for refunding timed out swap
89
+ *
90
+ * @param swapData swap data to refund
91
+ * @param check whether to check if swap is already expired and refundable
92
+ * @param feeRate fee rate to be used for the transactions
93
+ * @param witnessData
94
+ */
95
+ txsRefund(swapData, check, feeRate, witnessData) {
96
+ return __awaiter(this, void 0, void 0, function* () {
97
+ const refundHandler = this.root.refundHandlersByAddress[swapData.refundHandler.toLowerCase()];
98
+ if (refundHandler == null)
99
+ throw new Error("Invalid refund handler");
100
+ if (check && !(yield (0, Utils_1.tryWithRetries)(() => this.root.isRequestRefundable(swapData.offerer.toString(), swapData), this.retryPolicy))) {
101
+ throw new base_1.SwapDataVerificationError("Not refundable yet!");
102
+ }
103
+ feeRate !== null && feeRate !== void 0 ? feeRate : (feeRate = yield this.root.Fees.getFeeRate());
104
+ const { initialTxns, witness } = yield refundHandler.getWitness(swapData.offerer, swapData, witnessData, feeRate);
105
+ const action = this.Refund(swapData.offerer, swapData, witness, refundHandler.getGas(swapData));
106
+ yield action.addToTxs(initialTxns, feeRate);
107
+ this.logger.debug("txsRefund(): creating refund transaction, swap: " + swapData.getClaimHash());
108
+ return initialTxns;
109
+ });
110
+ }
111
+ /**
112
+ * Creates transactions required for refunding the swap with authorization signature, also unwraps WSOL to SOL
113
+ *
114
+ * @param swapData swap data to refund
115
+ * @param timeout signature timeout
116
+ * @param prefix signature prefix of the counterparty
117
+ * @param signature signature of the counterparty
118
+ * @param check whether to check if swap is committed before attempting refund
119
+ * @param feeRate fee rate to be used for the transactions
120
+ */
121
+ txsRefundWithAuthorization(swapData, timeout, prefix, signature, check, feeRate) {
122
+ return __awaiter(this, void 0, void 0, function* () {
123
+ if (check && !(yield (0, Utils_1.tryWithRetries)(() => this.root.isCommited(swapData), this.retryPolicy))) {
124
+ throw new base_1.SwapDataVerificationError("Not correctly committed");
125
+ }
126
+ yield (0, Utils_1.tryWithRetries)(() => this.isSignatureValid(swapData, timeout, prefix, signature), this.retryPolicy, (e) => e instanceof base_1.SignatureVerificationError);
127
+ const action = this.RefundWithSignature(swapData.offerer, swapData, timeout, JSON.parse(signature));
128
+ feeRate !== null && feeRate !== void 0 ? feeRate : (feeRate = yield this.root.Fees.getFeeRate());
129
+ this.logger.debug("txsRefundWithAuthorization(): creating refund transaction, swap: " + swapData.getClaimHash() +
130
+ " auth expiry: " + timeout + " signature: " + signature);
131
+ return [yield action.tx(feeRate)];
132
+ });
133
+ }
134
+ /**
135
+ * Get the estimated solana transaction fee of the refund transaction, in the worst case scenario in case where the
136
+ * ATA needs to be initialized again (i.e. adding the ATA rent exempt lamports to the fee)
137
+ */
138
+ getRefundFee(swapData, feeRate) {
139
+ return __awaiter(this, void 0, void 0, function* () {
140
+ feeRate !== null && feeRate !== void 0 ? feeRate : (feeRate = yield this.root.Fees.getFeeRate());
141
+ return StarknetFees_1.StarknetFees.getGasFee(swapData.payIn ? SwapRefund.GasCosts.REFUND_PAY_OUT.l1 : SwapRefund.GasCosts.REFUND.l1, feeRate);
142
+ });
143
+ }
144
+ }
145
+ exports.SwapRefund = SwapRefund;
146
+ SwapRefund.GasCosts = {
147
+ REFUND: { l1: 750, l2: 0 },
148
+ REFUND_PAY_OUT: { l1: 1250, l2: 0 }
149
+ };
@@ -0,0 +1,6 @@
1
+ import { Account, DeployAccountContractPayload, Provider } from "starknet";
2
+ export declare class StarknetKeypairWallet extends Account {
3
+ readonly publicKey: string;
4
+ constructor(provider: Provider, privateKey: string);
5
+ getDeploymentData(): DeployAccountContractPayload;
6
+ }
@@ -0,0 +1,26 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.StarknetKeypairWallet = void 0;
4
+ const starknet_1 = require("starknet");
5
+ const Utils_1 = require("../../utils/Utils");
6
+ const OZaccountClassHash = '0x066358a3bf5515033abe327a433e2947f9ee8dcd500ccb260f710b47039ebd36';
7
+ //Openzeppelin Account wallet
8
+ class StarknetKeypairWallet extends starknet_1.Account {
9
+ constructor(provider, privateKey) {
10
+ const publicKey = starknet_1.ec.starkCurve.getStarkKey((0, Utils_1.toHex)(privateKey));
11
+ // Calculate future address of the account
12
+ const OZaccountConstructorCallData = starknet_1.CallData.compile({ publicKey });
13
+ const OZcontractAddress = starknet_1.hash.calculateContractAddressFromHash(publicKey, OZaccountClassHash, OZaccountConstructorCallData, 0);
14
+ super(provider, OZcontractAddress, privateKey, "1");
15
+ this.publicKey = publicKey;
16
+ }
17
+ getDeploymentData() {
18
+ return {
19
+ classHash: OZaccountClassHash,
20
+ constructorCalldata: starknet_1.CallData.compile({ publicKey: this.publicKey }),
21
+ addressSalt: this.publicKey,
22
+ contractAddress: this.address
23
+ };
24
+ }
25
+ }
26
+ exports.StarknetKeypairWallet = StarknetKeypairWallet;
@@ -0,0 +1,12 @@
1
+ import { AbstractSigner } from "@atomiqlabs/base";
2
+ import { Account, DeployAccountContractPayload } from "starknet";
3
+ export declare class StarknetSigner implements AbstractSigner {
4
+ account: Account;
5
+ isDeployed: boolean;
6
+ constructor(account: Account);
7
+ getPublicKey(): Promise<string>;
8
+ getAddress(): string;
9
+ isWalletAccount(): boolean;
10
+ getNonce(): Promise<bigint>;
11
+ checkAndGetDeployPayload(nonce?: bigint): Promise<DeployAccountContractPayload | null>;
12
+ }
@@ -0,0 +1,46 @@
1
+ "use strict";
2
+ Object.defineProperty(exports, "__esModule", { value: true });
3
+ exports.StarknetSigner = void 0;
4
+ const Utils_1 = require("../../utils/Utils");
5
+ class StarknetSigner {
6
+ constructor(account) {
7
+ this.isDeployed = null;
8
+ this.account = account;
9
+ }
10
+ getPublicKey() {
11
+ return this.account.signer.getPubKey();
12
+ }
13
+ getAddress() {
14
+ return (0, Utils_1.toHex)(this.account.address);
15
+ }
16
+ isWalletAccount() {
17
+ return this.account.walletProvider != null;
18
+ }
19
+ //TODO: Introduce proper nonce management!
20
+ async getNonce() {
21
+ try {
22
+ return BigInt(await this.account.getNonceForAddress(this.getAddress()));
23
+ }
24
+ catch (e) {
25
+ if (e.message != null && e.message.includes("20: Contract not found")) {
26
+ return BigInt(0);
27
+ }
28
+ throw e;
29
+ }
30
+ }
31
+ async checkAndGetDeployPayload(nonce) {
32
+ if (this.isDeployed)
33
+ return null;
34
+ const _account = this.account;
35
+ if (_account.getDeploymentData != null) {
36
+ //Check if deployed
37
+ nonce ?? (nonce = BigInt(await this.getNonce()));
38
+ this.isDeployed = nonce != BigInt(0);
39
+ if (!this.isDeployed) {
40
+ return _account.getDeploymentData();
41
+ }
42
+ }
43
+ return null;
44
+ }
45
+ }
46
+ exports.StarknetSigner = StarknetSigner;
@@ -0,0 +1,38 @@
1
+ /// <reference types="node" />
2
+ import { BigNumberish, Uint256 } from "starknet";
3
+ import { StarknetTx } from "../starknet/base/modules/StarknetTransactions";
4
+ import { Buffer } from "buffer";
5
+ import { StarknetSwapData } from "../starknet/swaps/StarknetSwapData";
6
+ import { IClaimHandler } from "../starknet/swaps/handlers/claim/ClaimHandlers";
7
+ export declare function isUint256(val: any): val is Uint256;
8
+ export declare function timeoutPromise(timeoutMillis: number, abortSignal?: AbortSignal): Promise<void>;
9
+ export declare function onceAsync<T>(executor: () => Promise<T>): () => Promise<T>;
10
+ export declare function getLogger(prefix: string): {
11
+ debug: (msg: any, ...args: any[]) => void;
12
+ info: (msg: any, ...args: any[]) => void;
13
+ warn: (msg: any, ...args: any[]) => void;
14
+ error: (msg: any, ...args: any[]) => void;
15
+ };
16
+ export declare function tryWithRetries<T>(func: () => Promise<T>, retryPolicy?: {
17
+ maxRetries?: number;
18
+ delay?: number;
19
+ exponential?: boolean;
20
+ }, errorAllowed?: (e: any) => boolean, abortSignal?: AbortSignal): Promise<T>;
21
+ export declare function toHex(value: number | bigint | string | Buffer, length?: number): string;
22
+ export declare function calculateHash(tx: StarknetTx): string;
23
+ export declare function u32ArrayToBuffer(arr: BigNumberish[]): Buffer;
24
+ export declare function bufferToU32Array(buffer: Buffer): number[];
25
+ export declare function u32ReverseEndianness(value: number): number;
26
+ export declare function bigNumberishToBuffer(value: BigNumberish | Uint256, length: number): Buffer;
27
+ export declare function toBigInt(value: BigNumberish | Uint256): bigint;
28
+ export declare function bytes31SpanToBuffer(span: BigNumberish[], length: number): Buffer;
29
+ export declare function bufferToBytes31Span(buffer: Buffer, startIndex?: number, endIndex?: number): BigNumberish[];
30
+ export declare function bufferToByteArray(buffer: Buffer, startIndex?: number, endIndex?: number): BigNumberish[];
31
+ export declare function poseidonHashRange(buffer: Buffer, startIndex?: number, endIndex?: number): BigNumberish;
32
+ export declare function parseInitFunctionCalldata(calldata: BigNumberish[], claimHandler: IClaimHandler<any, any>): {
33
+ escrow: StarknetSwapData;
34
+ signature: BigNumberish[];
35
+ timeout: bigint;
36
+ extraData: BigNumberish[];
37
+ };
38
+ export declare function findLastIndex<T>(array: T[], callback: (value: T, index: number) => boolean): number;