@effect-blockchain/starknet 0.0.0-stage → 0.2.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 (78) hide show
  1. package/LICENSE +21 -0
  2. package/README.md +12 -2
  3. package/dist/StarknetAddress.d.ts +29 -0
  4. package/dist/StarknetAddress.d.ts.map +1 -0
  5. package/dist/StarknetAddress.js +29 -0
  6. package/dist/StarknetAddress.js.map +1 -0
  7. package/dist/StarknetBlock.d.ts +49 -0
  8. package/dist/StarknetBlock.d.ts.map +1 -0
  9. package/dist/StarknetBlock.js +52 -0
  10. package/dist/StarknetBlock.js.map +1 -0
  11. package/dist/StarknetEvent.d.ts +34 -0
  12. package/dist/StarknetEvent.d.ts.map +1 -0
  13. package/dist/StarknetEvent.js +39 -0
  14. package/dist/StarknetEvent.js.map +1 -0
  15. package/dist/StarknetIndexer.d.ts +157 -0
  16. package/dist/StarknetIndexer.d.ts.map +1 -0
  17. package/dist/StarknetIndexer.js +245 -0
  18. package/dist/StarknetIndexer.js.map +1 -0
  19. package/dist/StarknetNetwork.d.ts +72 -0
  20. package/dist/StarknetNetwork.d.ts.map +1 -0
  21. package/dist/StarknetNetwork.js +83 -0
  22. package/dist/StarknetNetwork.js.map +1 -0
  23. package/dist/StarknetRelayer.d.ts +273 -0
  24. package/dist/StarknetRelayer.d.ts.map +1 -0
  25. package/dist/StarknetRelayer.js +352 -0
  26. package/dist/StarknetRelayer.js.map +1 -0
  27. package/dist/StarknetRpc.d.ts +306 -0
  28. package/dist/StarknetRpc.d.ts.map +1 -0
  29. package/dist/StarknetRpc.js +281 -0
  30. package/dist/StarknetRpc.js.map +1 -0
  31. package/dist/StarknetSigner.d.ts +75 -0
  32. package/dist/StarknetSigner.d.ts.map +1 -0
  33. package/dist/StarknetSigner.js +84 -0
  34. package/dist/StarknetSigner.js.map +1 -0
  35. package/dist/StarknetTransaction.d.ts +74 -0
  36. package/dist/StarknetTransaction.d.ts.map +1 -0
  37. package/dist/StarknetTransaction.js +2 -0
  38. package/dist/StarknetTransaction.js.map +1 -0
  39. package/dist/StarknetTransactionHash.d.ts +22 -0
  40. package/dist/StarknetTransactionHash.d.ts.map +1 -0
  41. package/dist/StarknetTransactionHash.js +22 -0
  42. package/dist/StarknetTransactionHash.js.map +1 -0
  43. package/dist/index.d.ts +44 -0
  44. package/dist/index.d.ts.map +1 -0
  45. package/dist/index.js +45 -0
  46. package/dist/index.js.map +1 -0
  47. package/dist/internal/PaddedFelt.d.ts +2 -0
  48. package/dist/internal/PaddedFelt.d.ts.map +1 -0
  49. package/dist/internal/PaddedFelt.js +15 -0
  50. package/dist/internal/PaddedFelt.js.map +1 -0
  51. package/dist/internal/confirmations.d.ts +2 -0
  52. package/dist/internal/confirmations.d.ts.map +1 -0
  53. package/dist/internal/confirmations.js +13 -0
  54. package/dist/internal/confirmations.js.map +1 -0
  55. package/dist/internal/rpcMethods.d.ts +2 -0
  56. package/dist/internal/rpcMethods.d.ts.map +1 -0
  57. package/dist/internal/rpcMethods.js +225 -0
  58. package/dist/internal/rpcMethods.js.map +1 -0
  59. package/dist/internal/transactionHash.d.ts +2 -0
  60. package/dist/internal/transactionHash.d.ts.map +1 -0
  61. package/dist/internal/transactionHash.js +60 -0
  62. package/dist/internal/transactionHash.js.map +1 -0
  63. package/package.json +66 -3
  64. package/src/StarknetAddress.ts +42 -0
  65. package/src/StarknetBlock.ts +54 -0
  66. package/src/StarknetEvent.ts +45 -0
  67. package/src/StarknetIndexer.ts +363 -0
  68. package/src/StarknetNetwork.ts +107 -0
  69. package/src/StarknetRelayer.ts +437 -0
  70. package/src/StarknetRpc.ts +524 -0
  71. package/src/StarknetSigner.ts +115 -0
  72. package/src/StarknetTransaction.ts +68 -0
  73. package/src/StarknetTransactionHash.ts +31 -0
  74. package/src/index.ts +55 -0
  75. package/src/internal/PaddedFelt.ts +18 -0
  76. package/src/internal/confirmations.ts +17 -0
  77. package/src/internal/rpcMethods.ts +224 -0
  78. package/src/internal/transactionHash.ts +64 -0
@@ -0,0 +1,225 @@
1
+ import * as JsonRpc from "@effect-blockchain/core/JsonRpc";
2
+ import { identity } from "effect/Function";
3
+ import * as Option from "effect/Option";
4
+ import * as Predicate from "effect/Predicate";
5
+ import * as Schema from "effect/Schema";
6
+ import * as SchemaTransformation from "effect/SchemaTransformation";
7
+ import { StarknetAddress } from "../StarknetAddress.js";
8
+ import { StarknetBlock } from "../StarknetBlock.js";
9
+ import { StarknetEvent } from "../StarknetEvent.js";
10
+ import { StarknetTransactionHash } from "../StarknetTransactionHash.js";
11
+ import { PaddedFelt } from "./PaddedFelt.js";
12
+ // by-name params: every method sends an object, `{}` when it takes none
13
+ const make = method => method;
14
+ const NoParams = /*#__PURE__*/Schema.Struct({});
15
+ const decodeShortString = felt => {
16
+ const hex = BigInt(felt).toString(16);
17
+ return hex.padStart(hex.length + hex.length % 2, "0").replace(/../g, byte => String.fromCharCode(parseInt(byte, 16)));
18
+ };
19
+ const encodeShortString = text => `0x${Array.from(text, char => char.charCodeAt(0).toString(16).padStart(2, "0")).join("")}`;
20
+ // a chain ID is a short string encoded as a felt: "0x534e5f4d41494e" is "SN_MAIN"
21
+ const ShortStringFromFelt = /*#__PURE__*/Schema.String.check(Schema.isPattern(/^0x[0-9a-fA-F]{1,64}$/)).pipe(/*#__PURE__*/Schema.decodeTo(Schema.String, /*#__PURE__*/SchemaTransformation.transform({
22
+ decode: decodeShortString,
23
+ encode: encodeShortString
24
+ })));
25
+ // params accept any felt (`0x1`), results are normalized to 64 digits
26
+ const Felt = /*#__PURE__*/Schema.toEncoded(PaddedFelt);
27
+ const BlockId = /*#__PURE__*/Schema.Struct({
28
+ block_number: JsonRpc.BigIntFromInt
29
+ });
30
+ /** @internal */
31
+ export const chainId = /*#__PURE__*/make({
32
+ name: "starknet_chainId",
33
+ params: NoParams,
34
+ result: ShortStringFromFelt
35
+ });
36
+ /** @internal */
37
+ export const blockNumber = /*#__PURE__*/make({
38
+ name: "starknet_blockNumber",
39
+ params: NoParams,
40
+ result: JsonRpc.BigIntFromInt
41
+ });
42
+ /** @internal */
43
+ export const getBlockWithTxHashes = /*#__PURE__*/make({
44
+ name: "starknet_getBlockWithTxHashes",
45
+ params: /*#__PURE__*/Schema.Struct({
46
+ block_id: BlockId
47
+ }),
48
+ // a pre-confirmed block has no block hash and does not decode
49
+ result: StarknetBlock
50
+ });
51
+ /** @internal */
52
+ export const call = /*#__PURE__*/make({
53
+ name: "starknet_call",
54
+ params: /*#__PURE__*/Schema.Struct({
55
+ request: /*#__PURE__*/Schema.Struct({
56
+ contract_address: StarknetAddress,
57
+ entry_point_selector: Felt,
58
+ calldata: /*#__PURE__*/Schema.Array(Felt)
59
+ }),
60
+ block_id: BlockId
61
+ }),
62
+ result: /*#__PURE__*/Schema.Array(PaddedFelt)
63
+ });
64
+ /** @internal */
65
+ export const getEvents = /*#__PURE__*/make({
66
+ name: "starknet_getEvents",
67
+ params: /*#__PURE__*/Schema.Struct({
68
+ filter: /*#__PURE__*/Schema.Struct({
69
+ address: StarknetAddress,
70
+ from_block: BlockId,
71
+ to_block: BlockId,
72
+ keys: /*#__PURE__*/Schema.optionalKey(/*#__PURE__*/Schema.Array(/*#__PURE__*/Schema.Array(Felt))),
73
+ chunk_size: Schema.Int,
74
+ continuation_token: /*#__PURE__*/Schema.optionalKey(Schema.String)
75
+ })
76
+ }),
77
+ result: /*#__PURE__*/Schema.Struct({
78
+ events: /*#__PURE__*/Schema.Array(StarknetEvent),
79
+ continuation_token: /*#__PURE__*/Schema.optionalKey(Schema.String)
80
+ })
81
+ });
82
+ /** @internal */
83
+ export const getTransactionStatus = /*#__PURE__*/make({
84
+ name: "starknet_getTransactionStatus",
85
+ params: /*#__PURE__*/Schema.Struct({
86
+ transaction_hash: StarknetTransactionHash
87
+ }),
88
+ result: /*#__PURE__*/Schema.Struct({
89
+ finalityStatus: Schema.Literals(["RECEIVED", "CANDIDATE", "PRE_CONFIRMED", "ACCEPTED_ON_L2", "ACCEPTED_ON_L1"]),
90
+ executionStatus: Schema.optionalKey(Schema.Literals(["SUCCEEDED", "REVERTED"])),
91
+ // starknet-devnet 0.7.1 answers `"failure_reason": null` for a transaction that did not revert
92
+ failureReason: Schema.optionalKey(Schema.NullOr(Schema.String)).pipe(Schema.decodeTo(Schema.optionalKey(Schema.String), SchemaTransformation.transformOptional({
93
+ decode: Option.filter(Predicate.isNotNull),
94
+ encode: identity
95
+ })))
96
+ }).pipe(/*#__PURE__*/Schema.encodeKeys({
97
+ finalityStatus: "finality_status",
98
+ executionStatus: "execution_status",
99
+ failureReason: "failure_reason"
100
+ }))
101
+ });
102
+ /** @internal */
103
+ export const getTransactionReceipt = /*#__PURE__*/make({
104
+ name: "starknet_getTransactionReceipt",
105
+ params: /*#__PURE__*/Schema.Struct({
106
+ transaction_hash: StarknetTransactionHash
107
+ }),
108
+ // a pre-confirmed receipt has no block hash and does not decode
109
+ result: /*#__PURE__*/Schema.Struct({
110
+ transactionHash: StarknetTransactionHash,
111
+ blockNumber: JsonRpc.BigIntFromInt,
112
+ blockHash: PaddedFelt,
113
+ events: Schema.Array(Schema.Struct({
114
+ fromAddress: StarknetAddress,
115
+ keys: Schema.Array(PaddedFelt),
116
+ data: Schema.Array(PaddedFelt)
117
+ }).pipe(Schema.encodeKeys({
118
+ fromAddress: "from_address"
119
+ })))
120
+ }).pipe(/*#__PURE__*/Schema.encodeKeys({
121
+ transactionHash: "transaction_hash",
122
+ blockNumber: "block_number",
123
+ blockHash: "block_hash"
124
+ }))
125
+ });
126
+ // a felt holding an integer: a nonce, an amount of gas, a price
127
+ const BigIntFromFelt = /*#__PURE__*/Schema.String.check(Schema.isPattern(/^0x[0-9a-fA-F]{1,64}$/)).pipe(/*#__PURE__*/Schema.decodeTo(Schema.BigInt, /*#__PURE__*/SchemaTransformation.transform({
128
+ decode: BigInt,
129
+ encode: value => `0x${value.toString(16)}`
130
+ })));
131
+ const BlockTag = /*#__PURE__*/Schema.Literals(["latest", "pre_confirmed"]);
132
+ const ResourceBound = /*#__PURE__*/Schema.Struct({
133
+ max_amount: BigIntFromFelt,
134
+ max_price_per_unit: BigIntFromFelt
135
+ });
136
+ const v3 = {
137
+ version: /*#__PURE__*/Schema.Literal("0x3"),
138
+ signature: /*#__PURE__*/Schema.Array(Felt),
139
+ nonce: BigIntFromFelt,
140
+ resource_bounds: /*#__PURE__*/Schema.Struct({
141
+ l1_gas: ResourceBound,
142
+ l2_gas: ResourceBound,
143
+ l1_data_gas: ResourceBound
144
+ }),
145
+ tip: BigIntFromFelt,
146
+ paymaster_data: /*#__PURE__*/Schema.Tuple([]),
147
+ nonce_data_availability_mode: /*#__PURE__*/Schema.Literal("L1"),
148
+ fee_data_availability_mode: /*#__PURE__*/Schema.Literal("L1")
149
+ };
150
+ const InvokeTransaction = /*#__PURE__*/Schema.Struct({
151
+ type: /*#__PURE__*/Schema.Literal("INVOKE"),
152
+ sender_address: StarknetAddress,
153
+ calldata: /*#__PURE__*/Schema.Array(Felt),
154
+ account_deployment_data: /*#__PURE__*/Schema.Tuple([]),
155
+ ...v3
156
+ });
157
+ const DeployAccountTransaction = /*#__PURE__*/Schema.Struct({
158
+ type: /*#__PURE__*/Schema.Literal("DEPLOY_ACCOUNT"),
159
+ class_hash: Felt,
160
+ contract_address_salt: Felt,
161
+ constructor_calldata: /*#__PURE__*/Schema.Array(Felt),
162
+ ...v3
163
+ });
164
+ /** @internal */
165
+ export const getNonce = /*#__PURE__*/make({
166
+ name: "starknet_getNonce",
167
+ params: /*#__PURE__*/Schema.Struct({
168
+ block_id: BlockTag,
169
+ contract_address: StarknetAddress
170
+ }),
171
+ result: BigIntFromFelt
172
+ });
173
+ /** @internal */
174
+ export const estimateFee = /*#__PURE__*/make({
175
+ name: "starknet_estimateFee",
176
+ params: /*#__PURE__*/Schema.Struct({
177
+ request: /*#__PURE__*/Schema.NonEmptyArray(/*#__PURE__*/Schema.Union([InvokeTransaction, DeployAccountTransaction])),
178
+ simulation_flags: /*#__PURE__*/Schema.Array(/*#__PURE__*/Schema.Literal("SKIP_VALIDATE")),
179
+ block_id: BlockTag
180
+ }),
181
+ result: /*#__PURE__*/Schema.NonEmptyArray(/*#__PURE__*/Schema.Struct({
182
+ l1GasConsumed: BigIntFromFelt,
183
+ l1GasPrice: BigIntFromFelt,
184
+ l1DataGasConsumed: BigIntFromFelt,
185
+ l1DataGasPrice: BigIntFromFelt,
186
+ l2GasConsumed: BigIntFromFelt,
187
+ l2GasPrice: BigIntFromFelt,
188
+ overallFee: BigIntFromFelt
189
+ }).pipe(/*#__PURE__*/Schema.encodeKeys({
190
+ l1GasConsumed: "l1_gas_consumed",
191
+ l1GasPrice: "l1_gas_price",
192
+ l1DataGasConsumed: "l1_data_gas_consumed",
193
+ l1DataGasPrice: "l1_data_gas_price",
194
+ l2GasConsumed: "l2_gas_consumed",
195
+ l2GasPrice: "l2_gas_price",
196
+ overallFee: "overall_fee"
197
+ })))
198
+ });
199
+ /** @internal */
200
+ export const addInvokeTransaction = /*#__PURE__*/make({
201
+ name: "starknet_addInvokeTransaction",
202
+ params: /*#__PURE__*/Schema.Struct({
203
+ invoke_transaction: InvokeTransaction
204
+ }),
205
+ result: /*#__PURE__*/Schema.Struct({
206
+ transactionHash: StarknetTransactionHash
207
+ }).pipe(/*#__PURE__*/Schema.encodeKeys({
208
+ transactionHash: "transaction_hash"
209
+ }))
210
+ });
211
+ /** @internal */
212
+ export const addDeployAccountTransaction = /*#__PURE__*/make({
213
+ name: "starknet_addDeployAccountTransaction",
214
+ params: /*#__PURE__*/Schema.Struct({
215
+ deploy_account_transaction: DeployAccountTransaction
216
+ }),
217
+ result: /*#__PURE__*/Schema.Struct({
218
+ transactionHash: StarknetTransactionHash,
219
+ contractAddress: StarknetAddress
220
+ }).pipe(/*#__PURE__*/Schema.encodeKeys({
221
+ transactionHash: "transaction_hash",
222
+ contractAddress: "contract_address"
223
+ }))
224
+ });
225
+ //# sourceMappingURL=rpcMethods.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"rpcMethods.js","names":[],"sources":["../../src/internal/rpcMethods.ts"],"sourcesContent":[null],"mappings":"AAAA,OAAO,KAAK,OAAO,MAAM,iCAAiC;AAC1D,SAAS,QAAQ,QAAQ,iBAAiB;AAC1C,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,SAAS,MAAM,kBAAkB;AAC7C,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,oBAAoB,MAAM,6BAA6B;AACnE,SAAS,eAAe,QAAQ,uBAAuB;AACvD,SAAS,aAAa,QAAQ,qBAAqB;AACnD,SAAS,aAAa,QAAQ,qBAAqB;AACnD,SAAS,uBAAuB,QAAQ,+BAA+B;AACvE,SAAS,UAAU,QAAQ,iBAAiB;AAE5C;AACA,MAAM,IAAI,GAAoB,MAAsC,IAAqC,MAAM;AAE/G,MAAM,QAAQ,gBAAG,MAAM,CAAC,MAAM,CAAC,EAAE,CAAC;AAElC,MAAM,iBAAiB,GAAI,IAAY,IAAI;EACzC,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC;EACrC,OAAO,GAAG,CAAC,QAAQ,CAAC,GAAG,CAAC,MAAM,GAAG,GAAG,CAAC,MAAM,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC,OAAO,CAC3D,KAAK,EACJ,IAAI,IAAK,MAAM,CAAC,YAAY,CAAC,QAAQ,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,CAClD;AACH,CAAC;AAED,MAAM,iBAAiB,GAAI,IAAY,IACrC,KAAK,KAAK,CAAC,IAAI,CAAC,IAAI,EAAG,IAAI,IAAK,IAAI,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC,EAAE;AAE9F;AACA,MAAM,mBAAmB,gBAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,cAC7F,MAAM,CAAC,QAAQ,CACb,MAAM,CAAC,MAAM,eACb,oBAAoB,CAAC,SAAS,CAAC;EAAE,MAAM,EAAE,iBAAiB;EAAE,MAAM,EAAE;AAAiB,CAAE,CAAC,CACzF,CACF;AAED;AACA,MAAM,IAAI,gBAAG,MAAM,CAAC,SAAS,CAAC,UAAU,CAAC;AAEzC,MAAM,OAAO,gBAAG,MAAM,CAAC,MAAM,CAAC;EAAE,YAAY,EAAE,OAAO,CAAC;AAAa,CAAE,CAAC;AAEtE;AACA,OAAO,MAAM,OAAO,gBAAG,IAAI,CAAC;EAAE,IAAI,EAAE,kBAAkB;EAAE,MAAM,EAAE,QAAQ;EAAE,MAAM,EAAE;AAAmB,CAAE,CAAC;AAExG;AACA,OAAO,MAAM,WAAW,gBAAG,IAAI,CAAC;EAAE,IAAI,EAAE,sBAAsB;EAAE,MAAM,EAAE,QAAQ;EAAE,MAAM,EAAE,OAAO,CAAC;AAAa,CAAE,CAAC;AAElH;AACA,OAAO,MAAM,oBAAoB,gBAAG,IAAI,CAAC;EACvC,IAAI,EAAE,+BAA+B;EACrC,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IAAE,QAAQ,EAAE;EAAO,CAAE,CAAC;EAC5C;EACA,MAAM,EAAE;CACT,CAAC;AAEF;AACA,OAAO,MAAM,IAAI,gBAAG,IAAI,CAAC;EACvB,IAAI,EAAE,eAAe;EACrB,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IACpB,OAAO,eAAE,MAAM,CAAC,MAAM,CAAC;MACrB,gBAAgB,EAAE,eAAe;MACjC,oBAAoB,EAAE,IAAI;MAC1B,QAAQ,eAAE,MAAM,CAAC,KAAK,CAAC,IAAI;KAC5B,CAAC;IACF,QAAQ,EAAE;GACX,CAAC;EACF,MAAM,eAAE,MAAM,CAAC,KAAK,CAAC,UAAU;CAChC,CAAC;AAEF;AACA,OAAO,MAAM,SAAS,gBAAG,IAAI,CAAC;EAC5B,IAAI,EAAE,oBAAoB;EAC1B,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IACpB,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;MACpB,OAAO,EAAE,eAAe;MACxB,UAAU,EAAE,OAAO;MACnB,QAAQ,EAAE,OAAO;MACjB,IAAI,eAAE,MAAM,CAAC,WAAW,cAAC,MAAM,CAAC,KAAK,cAAC,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC;MAC1D,UAAU,EAAE,MAAM,CAAC,GAAG;MACtB,kBAAkB,eAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM;KACrD;GACF,CAAC;EACF,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IACpB,MAAM,eAAE,MAAM,CAAC,KAAK,CAAC,aAAa,CAAC;IACnC,kBAAkB,eAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM;GACrD;CACF,CAAC;AAEF;AACA,OAAO,MAAM,oBAAoB,gBAAG,IAAI,CAAC;EACvC,IAAI,EAAE,+BAA+B;EACrC,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IAAE,gBAAgB,EAAE;EAAuB,CAAE,CAAC;EACpE,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IACpB,cAAc,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,UAAU,EAAE,WAAW,EAAE,eAAe,EAAE,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;IAC/G,eAAe,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,QAAQ,CAAC,CAAC,WAAW,EAAE,UAAU,CAAC,CAAC,CAAC;IAC/E;IACA,aAAa,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAClE,MAAM,CAAC,QAAQ,CACb,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,MAAM,CAAC,EACjC,oBAAoB,CAAC,iBAAiB,CAAwB;MAC5D,MAAM,EAAE,MAAM,CAAC,MAAM,CAAC,SAAS,CAAC,SAAS,CAAC;MAC1C,MAAM,EAAE;KACT,CAAC,CACH;GAEJ,CAAC,CAAC,IAAI,cACL,MAAM,CAAC,UAAU,CAAC;IAChB,cAAc,EAAE,iBAAiB;IACjC,eAAe,EAAE,kBAAkB;IACnC,aAAa,EAAE;GAChB,CAAC;CAEL,CAAC;AAEF;AACA,OAAO,MAAM,qBAAqB,gBAAG,IAAI,CAAC;EACxC,IAAI,EAAE,gCAAgC;EACtC,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IAAE,gBAAgB,EAAE;EAAuB,CAAE,CAAC;EACpE;EACA,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IACpB,eAAe,EAAE,uBAAuB;IACxC,WAAW,EAAE,OAAO,CAAC,aAAa;IAClC,SAAS,EAAE,UAAU;IACrB,MAAM,EAAE,MAAM,CAAC,KAAK,CAClB,MAAM,CAAC,MAAM,CAAC;MAAE,WAAW,EAAE,eAAe;MAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;MAAE,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU;IAAC,CAAE,CAAC,CAC5G,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC;MAAE,WAAW,EAAE;IAAc,CAAE,CAAC,CAAC;GAE9D,CAAC,CAAC,IAAI,cACL,MAAM,CAAC,UAAU,CAAC;IAAE,eAAe,EAAE,kBAAkB;IAAE,WAAW,EAAE,cAAc;IAAE,SAAS,EAAE;EAAY,CAAE,CAAC;CAEnH,CAAC;AAEF;AACA,MAAM,cAAc,gBAAG,MAAM,CAAC,MAAM,CAAC,KAAK,CAAC,MAAM,CAAC,SAAS,CAAC,uBAAuB,CAAC,CAAC,CAAC,IAAI,cACxF,MAAM,CAAC,QAAQ,CACb,MAAM,CAAC,MAAM,eACb,oBAAoB,CAAC,SAAS,CAAC;EAAE,MAAM,EAAE,MAAM;EAAE,MAAM,EAAG,KAAK,IAAK,KAAK,KAAK,CAAC,QAAQ,CAAC,EAAE,CAAC;AAAE,CAAE,CAAC,CACjG,CACF;AAED,MAAM,QAAQ,gBAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,QAAQ,EAAE,eAAe,CAAC,CAAC;AAE7D,MAAM,aAAa,gBAAG,MAAM,CAAC,MAAM,CAAC;EAAE,UAAU,EAAE,cAAc;EAAE,kBAAkB,EAAE;AAAc,CAAE,CAAC;AAEvG,MAAM,EAAE,GAAG;EACT,OAAO,eAAE,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC;EAC9B,SAAS,eAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;EAC7B,KAAK,EAAE,cAAc;EACrB,eAAe,eAAE,MAAM,CAAC,MAAM,CAAC;IAAE,MAAM,EAAE,aAAa;IAAE,MAAM,EAAE,aAAa;IAAE,WAAW,EAAE;EAAa,CAAE,CAAC;EAC5G,GAAG,EAAE,cAAc;EACnB,cAAc,eAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;EAChC,4BAA4B,eAAE,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC;EAClD,0BAA0B,eAAE,MAAM,CAAC,OAAO,CAAC,IAAI;CAChD;AAED,MAAM,iBAAiB,gBAAG,MAAM,CAAC,MAAM,CAAC;EACtC,IAAI,eAAE,MAAM,CAAC,OAAO,CAAC,QAAQ,CAAC;EAC9B,cAAc,EAAE,eAAe;EAC/B,QAAQ,eAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;EAC5B,uBAAuB,eAAE,MAAM,CAAC,KAAK,CAAC,EAAE,CAAC;EACzC,GAAG;CACJ,CAAC;AAEF,MAAM,wBAAwB,gBAAG,MAAM,CAAC,MAAM,CAAC;EAC7C,IAAI,eAAE,MAAM,CAAC,OAAO,CAAC,gBAAgB,CAAC;EACtC,UAAU,EAAE,IAAI;EAChB,qBAAqB,EAAE,IAAI;EAC3B,oBAAoB,eAAE,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC;EACxC,GAAG;CACJ,CAAC;AAEF;AACA,OAAO,MAAM,QAAQ,gBAAG,IAAI,CAAC;EAC3B,IAAI,EAAE,mBAAmB;EACzB,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IAAE,QAAQ,EAAE,QAAQ;IAAE,gBAAgB,EAAE;EAAe,CAAE,CAAC;EAChF,MAAM,EAAE;CACT,CAAC;AAEF;AACA,OAAO,MAAM,WAAW,gBAAG,IAAI,CAAC;EAC9B,IAAI,EAAE,sBAAsB;EAC5B,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IACpB,OAAO,eAAE,MAAM,CAAC,aAAa,cAAC,MAAM,CAAC,KAAK,CAAC,CAAC,iBAAiB,EAAE,wBAAwB,CAAC,CAAC,CAAC;IAC1F,gBAAgB,eAAE,MAAM,CAAC,KAAK,cAAC,MAAM,CAAC,OAAO,CAAC,eAAe,CAAC,CAAC;IAC/D,QAAQ,EAAE;GACX,CAAC;EACF,MAAM,eAAE,MAAM,CAAC,aAAa,cAC1B,MAAM,CAAC,MAAM,CAAC;IACZ,aAAa,EAAE,cAAc;IAC7B,UAAU,EAAE,cAAc;IAC1B,iBAAiB,EAAE,cAAc;IACjC,cAAc,EAAE,cAAc;IAC9B,aAAa,EAAE,cAAc;IAC7B,UAAU,EAAE,cAAc;IAC1B,UAAU,EAAE;GACb,CAAC,CAAC,IAAI,cAAC,MAAM,CAAC,UAAU,CAAC;IACxB,aAAa,EAAE,iBAAiB;IAChC,UAAU,EAAE,cAAc;IAC1B,iBAAiB,EAAE,sBAAsB;IACzC,cAAc,EAAE,mBAAmB;IACnC,aAAa,EAAE,iBAAiB;IAChC,UAAU,EAAE,cAAc;IAC1B,UAAU,EAAE;GACb,CAAC,CAAC;CAEN,CAAC;AAEF;AACA,OAAO,MAAM,oBAAoB,gBAAG,IAAI,CAAC;EACvC,IAAI,EAAE,+BAA+B;EACrC,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IAAE,kBAAkB,EAAE;EAAiB,CAAE,CAAC;EAChE,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IAAE,eAAe,EAAE;EAAuB,CAAE,CAAC,CAAC,IAAI,cACtE,MAAM,CAAC,UAAU,CAAC;IAAE,eAAe,EAAE;EAAkB,CAAE,CAAC;CAE7D,CAAC;AAEF;AACA,OAAO,MAAM,2BAA2B,gBAAG,IAAI,CAAC;EAC9C,IAAI,EAAE,sCAAsC;EAC5C,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IAAE,0BAA0B,EAAE;EAAwB,CAAE,CAAC;EAC/E,MAAM,eAAE,MAAM,CAAC,MAAM,CAAC;IAAE,eAAe,EAAE,uBAAuB;IAAE,eAAe,EAAE;EAAe,CAAE,CAAC,CAAC,IAAI,cACxG,MAAM,CAAC,UAAU,CAAC;IAAE,eAAe,EAAE,kBAAkB;IAAE,eAAe,EAAE;EAAkB,CAAE,CAAC;CAElG,CAAC","ignoreList":[]}
@@ -0,0 +1,2 @@
1
+ export {};
2
+ //# sourceMappingURL=transactionHash.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transactionHash.d.ts","sourceRoot":"","sources":["../../src/internal/transactionHash.ts"],"names":[],"mappings":""}
@@ -0,0 +1,60 @@
1
+ import * as Schema from "effect/Schema";
2
+ import { constants, EDAMode, hash } from "starknet";
3
+ import { StarknetAddress } from "../StarknetAddress.js";
4
+ import { StarknetTransactionHash } from "../StarknetTransactionHash.js";
5
+ /**
6
+ * The address a `DEPLOY_ACCOUNT` transaction deploys to. Throws on a value that is not a felt.
7
+ *
8
+ * @internal
9
+ */
10
+ export const deployAddress = transaction => Schema.decodeSync(StarknetAddress)(
11
+ // an account deploys itself: the deployer address is 0
12
+ hash.calculateContractAddressFromHash(transaction.contractAddressSalt, transaction.classHash, [...transaction.constructorCalldata], 0));
13
+ /**
14
+ * The V3 transaction hash (Poseidon), which is what an account signs. Throws on a value that is not a felt.
15
+ *
16
+ * @internal
17
+ */
18
+ export const transactionHash = transaction => {
19
+ const {
20
+ l1DataGas,
21
+ l1Gas,
22
+ l2Gas
23
+ } = transaction.resourceBounds;
24
+ const common = {
25
+ version: "0x3",
26
+ chainId: constants.StarknetChainId[transaction.chainId],
27
+ nonce: transaction.nonce,
28
+ nonceDataAvailabilityMode: EDAMode.L1,
29
+ feeDataAvailabilityMode: EDAMode.L1,
30
+ resourceBounds: {
31
+ l1_gas: {
32
+ max_amount: l1Gas.maxAmount,
33
+ max_price_per_unit: l1Gas.maxPricePerUnit
34
+ },
35
+ l2_gas: {
36
+ max_amount: l2Gas.maxAmount,
37
+ max_price_per_unit: l2Gas.maxPricePerUnit
38
+ },
39
+ l1_data_gas: {
40
+ max_amount: l1DataGas.maxAmount,
41
+ max_price_per_unit: l1DataGas.maxPricePerUnit
42
+ }
43
+ },
44
+ tip: transaction.tip,
45
+ paymasterData: []
46
+ };
47
+ return Schema.decodeSync(StarknetTransactionHash)(transaction.type === "INVOKE" ? hash.calculateInvokeTransactionHash({
48
+ ...common,
49
+ senderAddress: transaction.senderAddress,
50
+ compiledCalldata: [...transaction.calldata],
51
+ accountDeploymentData: []
52
+ }) : hash.calculateDeployAccountTransactionHash({
53
+ ...common,
54
+ contractAddress: deployAddress(transaction),
55
+ classHash: transaction.classHash,
56
+ compiledConstructorCalldata: [...transaction.constructorCalldata],
57
+ salt: transaction.contractAddressSalt
58
+ }));
59
+ };
60
+ //# sourceMappingURL=transactionHash.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"transactionHash.js","names":[],"sources":["../../src/internal/transactionHash.ts"],"sourcesContent":[null],"mappings":"AAAA,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,SAAS,SAAS,EAAE,OAAO,EAAE,IAAI,QAAQ,UAAU;AACnD,SAAS,eAAe,QAAQ,uBAAuB;AAEvD,SAAS,uBAAuB,QAAQ,+BAA+B;AAEvE;;;;;AAKA,OAAO,MAAM,aAAa,GACxB,WAAgH,IAEhH,MAAM,CAAC,UAAU,CAAC,eAAe,CAAC;AAChC;AACA,IAAI,CAAC,gCAAgC,CACnC,WAAW,CAAC,mBAAmB,EAC/B,WAAW,CAAC,SAAS,EACrB,CAAC,GAAG,WAAW,CAAC,mBAAmB,CAAC,EACpC,CAAC,CACF,CACF;AAEH;;;;;AAKA,OAAO,MAAM,eAAe,GAC1B,WAA+G,IACpF;EAC3B,MAAM;IAAE,SAAS;IAAE,KAAK;IAAE;EAAK,CAAE,GAAG,WAAW,CAAC,cAAc;EAC9D,MAAM,MAAM,GAAG;IACb,OAAO,EAAE,KAAc;IACvB,OAAO,EAAE,SAAS,CAAC,eAAe,CAAC,WAAW,CAAC,OAAO,CAAC;IACvD,KAAK,EAAE,WAAW,CAAC,KAAK;IACxB,yBAAyB,EAAE,OAAO,CAAC,EAAE;IACrC,uBAAuB,EAAE,OAAO,CAAC,EAAE;IACnC,cAAc,EAAE;MACd,MAAM,EAAE;QAAE,UAAU,EAAE,KAAK,CAAC,SAAS;QAAE,kBAAkB,EAAE,KAAK,CAAC;MAAe,CAAE;MAClF,MAAM,EAAE;QAAE,UAAU,EAAE,KAAK,CAAC,SAAS;QAAE,kBAAkB,EAAE,KAAK,CAAC;MAAe,CAAE;MAClF,WAAW,EAAE;QAAE,UAAU,EAAE,SAAS,CAAC,SAAS;QAAE,kBAAkB,EAAE,SAAS,CAAC;MAAe;KAC9F;IACD,GAAG,EAAE,WAAW,CAAC,GAAG;IACpB,aAAa,EAAE;GAChB;EACD,OAAO,MAAM,CAAC,UAAU,CAAC,uBAAuB,CAAC,CAC/C,WAAW,CAAC,IAAI,KAAK,QAAQ,GACzB,IAAI,CAAC,8BAA8B,CAAC;IACpC,GAAG,MAAM;IACT,aAAa,EAAE,WAAW,CAAC,aAAa;IACxC,gBAAgB,EAAE,CAAC,GAAG,WAAW,CAAC,QAAQ,CAAC;IAC3C,qBAAqB,EAAE;GACxB,CAAC,GACA,IAAI,CAAC,qCAAqC,CAAC;IAC3C,GAAG,MAAM;IACT,eAAe,EAAE,aAAa,CAAC,WAAW,CAAC;IAC3C,SAAS,EAAE,WAAW,CAAC,SAAS;IAChC,2BAA2B,EAAE,CAAC,GAAG,WAAW,CAAC,mBAAmB,CAAC;IACjE,IAAI,EAAE,WAAW,CAAC;GACnB,CAAC,CACL;AACH,CAAC","ignoreList":[]}
package/package.json CHANGED
@@ -1,6 +1,69 @@
1
1
  {
2
2
  "name": "@effect-blockchain/starknet",
3
- "version": "0.0.0-stage",
4
- "stub": true,
5
- "description": "Temporary package placeholder for staged publishing"
3
+ "version": "0.2.0",
4
+ "description": "Starknet blockchain toolkit for Effect",
5
+ "keywords": [
6
+ "typescript",
7
+ "effect",
8
+ "blockchain",
9
+ "starknet"
10
+ ],
11
+ "homepage": "https://github.com/spiko-tech/effect-blockchain",
12
+ "bugs": {
13
+ "url": "https://github.com/spiko-tech/effect-blockchain/issues"
14
+ },
15
+ "repository": {
16
+ "type": "git",
17
+ "url": "https://github.com/spiko-tech/effect-blockchain.git",
18
+ "directory": "packages/starknet"
19
+ },
20
+ "license": "MIT",
21
+ "sideEffects": [],
22
+ "type": "module",
23
+ "exports": {
24
+ "./package.json": "./package.json",
25
+ ".": "./dist/index.js",
26
+ "./*": "./dist/*.js",
27
+ "./internal/*": null,
28
+ "./index": null,
29
+ "./*/index": null
30
+ },
31
+ "files": [
32
+ "src/**/*.ts",
33
+ "dist/**/*.js",
34
+ "dist/**/*.js.map",
35
+ "dist/**/*.d.ts",
36
+ "dist/**/*.d.ts.map"
37
+ ],
38
+ "dependencies": {
39
+ "@effect-blockchain/core": "^0.1.0"
40
+ },
41
+ "devDependencies": {
42
+ "@effect/vitest": "4.1.0",
43
+ "effect": "4.1.0",
44
+ "starknet": "^8.9.2"
45
+ },
46
+ "peerDependencies": {
47
+ "effect": "^4.0.0",
48
+ "starknet": "^8.9.2"
49
+ },
50
+ "publishConfig": {
51
+ "access": "public",
52
+ "provenance": true
53
+ },
54
+ "tags": [
55
+ "typescript",
56
+ "effect",
57
+ "blockchain",
58
+ "starknet"
59
+ ],
60
+ "scripts": {
61
+ "codegen": "node ../../scripts/codegen.mjs . 'src/**/index.ts'",
62
+ "build": "tsc -b tsconfig.json tsconfig.release.json && pnpm babel",
63
+ "babel": "babel dist --plugins annotate-pure-calls --out-dir dist --source-maps",
64
+ "check": "tsc -b tsconfig.json",
65
+ "test": "vitest",
66
+ "coverage": "vitest --coverage",
67
+ "record-fixtures": "node --env-file-if-exists=../../.env scripts/record-fixtures.ts"
68
+ }
6
69
  }
@@ -0,0 +1,42 @@
1
+ /**
2
+ * Starknet contract and account addresses.
3
+ *
4
+ * @since 0.1.0
5
+ */
6
+ import * as Schema from "effect/Schema"
7
+ import { PaddedFelt } from "./internal/PaddedFelt.ts"
8
+
9
+ /**
10
+ * A Starknet address: `0x` followed by 64 lowercase hex digits.
11
+ *
12
+ * Decoding lowercases the input and left-pads it with zeros, so `"0x32"` decodes
13
+ * to `"0x00…0032"`.
14
+ *
15
+ * @since 0.1.0
16
+ * @category schemas
17
+ */
18
+ export const StarknetAddress = PaddedFelt.pipe(
19
+ Schema.brand("StarknetAddress"),
20
+ Schema.annotate({
21
+ identifier: "StarknetAddress",
22
+ title: "Starknet address",
23
+ description:
24
+ "a valid Starknet address, starting with 0x and followed by 64 hexadecimal characters e.g. \"0x0000000000000000000000000000000000000000000000000000000000000000\""
25
+ })
26
+ )
27
+
28
+ /**
29
+ * @since 0.1.0
30
+ * @category models
31
+ */
32
+ export type StarknetAddress = typeof StarknetAddress.Type
33
+
34
+ /**
35
+ * The Starknet zero address.
36
+ *
37
+ * @since 0.1.0
38
+ * @category constants
39
+ */
40
+ export const NULL_ADDRESS: StarknetAddress = StarknetAddress.make(
41
+ "0x0000000000000000000000000000000000000000000000000000000000000000"
42
+ )
@@ -0,0 +1,54 @@
1
+ /**
2
+ * Starknet blocks, as returned by `starknet_getBlockWithTxHashes`.
3
+ *
4
+ * @since 0.1.0
5
+ */
6
+ import { BigIntFromInt } from "@effect-blockchain/core/JsonRpc"
7
+ import * as Schema from "effect/Schema"
8
+ import { PaddedFelt } from "./internal/PaddedFelt.ts"
9
+ import { StarknetTransactionHash } from "./StarknetTransactionHash.ts"
10
+
11
+ /**
12
+ * A confirmed block header with its transaction hashes in block order, decoded from the raw JSON-RPC block (snake case
13
+ * keys, integers as `bigint`). `timestamp` is in Unix seconds. A pre-confirmed block (no block hash, no
14
+ * `ACCEPTED_ON_L2` or `ACCEPTED_ON_L1` status) does not decode.
15
+ *
16
+ * @example
17
+ * ```ts
18
+ * import type { StarknetEvent } from "@effect-blockchain/starknet/StarknetEvent"
19
+ * import * as StarknetRpc from "@effect-blockchain/starknet/StarknetRpc"
20
+ * import * as Effect from "effect/Effect"
21
+ *
22
+ * // the timestamp of each event, reading each block once
23
+ * const withTimestamps = (events: ReadonlyArray<StarknetEvent>) =>
24
+ * Effect.gen(function*() {
25
+ * const rpc = yield* StarknetRpc.StarknetRpc
26
+ * const blockNumbers = [...new Set(events.map((event) => event.blockNumber))]
27
+ * const blocks = yield* Effect.forEach(blockNumbers, (blockNumber) => rpc.getBlockWithTxHashes({ blockNumber }), {
28
+ * concurrency: 5
29
+ * })
30
+ * const timestamps = new Map(blocks.map((block) => [block.blockNumber, block.timestamp]))
31
+ * return events.map((event) => ({ event, timestamp: timestamps.get(event.blockNumber) }))
32
+ * })
33
+ * ```
34
+ *
35
+ * @since 0.1.0
36
+ * @category schemas
37
+ */
38
+ export const StarknetBlock = Schema.Struct({
39
+ blockNumber: BigIntFromInt,
40
+ blockHash: PaddedFelt,
41
+ parentHash: PaddedFelt,
42
+ timestamp: BigIntFromInt,
43
+ status: Schema.Literals(["ACCEPTED_ON_L2", "ACCEPTED_ON_L1"]),
44
+ transactions: Schema.Array(StarknetTransactionHash)
45
+ }).pipe(
46
+ Schema.encodeKeys({ blockNumber: "block_number", blockHash: "block_hash", parentHash: "parent_hash" }),
47
+ Schema.annotate({ identifier: "StarknetBlock", title: "Starknet block" })
48
+ )
49
+
50
+ /**
51
+ * @since 0.1.0
52
+ * @category models
53
+ */
54
+ export type StarknetBlock = typeof StarknetBlock.Type
@@ -0,0 +1,45 @@
1
+ /**
2
+ * Starknet events, as returned by `starknet_getEvents`.
3
+ *
4
+ * @since 0.1.0
5
+ */
6
+ import { BigIntFromInt } from "@effect-blockchain/core/JsonRpc"
7
+ import * as Schema from "effect/Schema"
8
+ import { PaddedFelt } from "./internal/PaddedFelt.ts"
9
+ import { StarknetAddress } from "./StarknetAddress.ts"
10
+ import { StarknetTransactionHash } from "./StarknetTransactionHash.ts"
11
+
12
+ /**
13
+ * An event emitted by a contract in a block, decoded from the raw JSON-RPC event (snake case keys, felts as `0x` + 64
14
+ * lowercase hex digits). A pre-confirmed event (no block hash or block number) does not decode. `transactionIndex` and
15
+ * `eventIndex` (the event's position in its transaction) are only returned by RPC 0.10 and later.
16
+ *
17
+ * @since 0.1.0
18
+ * @category schemas
19
+ */
20
+ export const StarknetEvent = Schema.Struct({
21
+ fromAddress: StarknetAddress,
22
+ keys: Schema.Array(PaddedFelt),
23
+ data: Schema.Array(PaddedFelt),
24
+ blockNumber: BigIntFromInt,
25
+ blockHash: PaddedFelt,
26
+ transactionHash: StarknetTransactionHash,
27
+ transactionIndex: Schema.optionalKey(Schema.Int),
28
+ eventIndex: Schema.optionalKey(Schema.Int)
29
+ }).pipe(
30
+ Schema.encodeKeys({
31
+ fromAddress: "from_address",
32
+ blockNumber: "block_number",
33
+ blockHash: "block_hash",
34
+ transactionHash: "transaction_hash",
35
+ transactionIndex: "transaction_index",
36
+ eventIndex: "event_index"
37
+ }),
38
+ Schema.annotate({ identifier: "StarknetEvent", title: "Starknet event" })
39
+ )
40
+
41
+ /**
42
+ * @since 0.1.0
43
+ * @category models
44
+ */
45
+ export type StarknetEvent = typeof StarknetEvent.Type