@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,245 @@
1
+ /**
2
+ * Starknet event indexing on top of {@link StarknetRpc}: the last confirmed block, the events of a contract over a
3
+ * block range, and a stream of them following the confirmed head.
4
+ *
5
+ * A range is split into ranges of at most `maxBlockRange` blocks, each paged with `starknet_getEvents` (`chunkSize`
6
+ * events per page) until its continuation token is absent. A cursor page is pinned to the endpoint that issued it, so
7
+ * when it fails the range restarts once from its first page, through the fallback again. Any other failure fails the whole call and drops the
8
+ * events already read: the caller retries the same range.
9
+ *
10
+ * @example
11
+ * ```ts
12
+ * import type { StarknetIndexerFilter } from "@effect-blockchain/starknet/StarknetIndexer"
13
+ * import { StarknetIndexer } from "@effect-blockchain/starknet/StarknetIndexer"
14
+ * import * as Effect from "effect/Effect"
15
+ * import * as Schedule from "effect/Schedule"
16
+ * import * as Stream from "effect/Stream"
17
+ *
18
+ * declare const filter: Omit<StarknetIndexerFilter, "fromBlock" | "toBlock">
19
+ * declare const cursor: bigint
20
+ * declare const save: (block: bigint) => Effect.Effect<void>
21
+ *
22
+ * const program = Effect.gen(function*() {
23
+ * const indexer = yield* StarknetIndexer
24
+ * // once caught up, read the head after 1 s, 2 s, 4 s... at most every minute
25
+ * const poll = Schedule.min([Schedule.exponential("1 second"), Schedule.spaced("1 minute")])
26
+ * yield* indexer.streamEvents({ filter, fromBlock: cursor + BigInt(1), poll }).pipe(
27
+ * Stream.runForEach((batch) => save(batch.toBlock))
28
+ * )
29
+ * })
30
+ * ```
31
+ *
32
+ * The STRK balance of an address, in fri, is read at one block or sampled every `step` blocks:
33
+ *
34
+ * @example
35
+ * ```ts
36
+ * import type { StarknetAddress } from "@effect-blockchain/starknet/StarknetAddress"
37
+ * import { StarknetIndexer } from "@effect-blockchain/starknet/StarknetIndexer"
38
+ * import * as Effect from "effect/Effect"
39
+ * import * as Stream from "effect/Stream"
40
+ *
41
+ * declare const address: StarknetAddress
42
+ *
43
+ * // the balance every 1000 blocks from block 1000000 to 1010000
44
+ * const balances = Effect.gen(function*() {
45
+ * const indexer = yield* StarknetIndexer
46
+ * return yield* indexer.streamNativeBalance({
47
+ * address,
48
+ * fromBlock: BigInt(1_000_000),
49
+ * toBlock: BigInt(1_010_000),
50
+ * step: 1000
51
+ * }).pipe(Stream.runCollect)
52
+ * })
53
+ * ```
54
+ *
55
+ * @since 0.1.0
56
+ */
57
+ import * as JsonRpc from "@effect-blockchain/core/JsonRpc";
58
+ import * as Arr from "effect/Array";
59
+ import * as BigInt_ from "effect/BigInt";
60
+ import * as Config from "effect/Config";
61
+ import * as Context from "effect/Context";
62
+ import * as Duration from "effect/Duration";
63
+ import * as Effect from "effect/Effect";
64
+ import * as Layer from "effect/Layer";
65
+ import * as Option from "effect/Option";
66
+ import * as Schedule from "effect/Schedule";
67
+ import * as Stream from "effect/Stream";
68
+ import * as Confirmations from "./internal/confirmations.js";
69
+ import * as StarknetNetwork from "./StarknetNetwork.js";
70
+ import { StarknetRpc, StarknetRpcError } from "./StarknetRpc.js";
71
+ /**
72
+ * The default `maxBlockRange`. Starknet nodes do not limit the block range of `starknet_getEvents` (they cap the page
73
+ * size), so a range only bounds the work a restart redoes: 10000 blocks is a few hours of mainnet.
74
+ *
75
+ * @since 0.1.0
76
+ * @category constants
77
+ */
78
+ export const DEFAULT_MAX_BLOCK_RANGE = 10_000;
79
+ /**
80
+ * @since 0.1.0
81
+ * @category services
82
+ */
83
+ export class StarknetIndexer extends /*#__PURE__*/Context.Service()("@effect-blockchain/starknet/StarknetIndexer") {}
84
+ /**
85
+ * The default `poll` spacing of {@link StarknetIndexer.Service.streamEvents}: 10 seconds.
86
+ *
87
+ * @since 0.1.0
88
+ * @category constants
89
+ */
90
+ export const DEFAULT_POLL_INTERVAL = /*#__PURE__*/Duration.seconds(10);
91
+ // sn_keccak("balanceOf"), the ERC-20 entry point selector
92
+ const BALANCE_OF = "0x02e4263afad30923c891518314c3c95dbe830a16874e8abc5777a9a20b54c76e";
93
+ /**
94
+ * Builds a {@link StarknetIndexer} over the provided {@link StarknetRpc}.
95
+ *
96
+ * - `confirmations` defaults to {@link StarknetNetwork.defaultConfirmations} for the RPC's network.
97
+ * - `maxBlockRange` is the largest range in blocks, a positive integer, default {@link DEFAULT_MAX_BLOCK_RANGE}.
98
+ * - `chunkSize` is the `starknet_getEvents` page size, default 1000: lower it for a provider with a smaller cap.
99
+ *
100
+ * @since 0.1.0
101
+ * @category layers
102
+ */
103
+ export const layer = (options = {}) => Layer.effect(StarknetIndexer, Effect.gen(function* () {
104
+ const rpc = yield* StarknetRpc;
105
+ const maxBlockRange = options.maxBlockRange ?? DEFAULT_MAX_BLOCK_RANGE;
106
+ if (!Number.isSafeInteger(maxBlockRange) || maxBlockRange < 1) {
107
+ return yield* Effect.die(new RangeError(`maxBlockRange must be a positive integer, got ${maxBlockRange}`));
108
+ }
109
+ const size = BigInt(maxBlockRange);
110
+ const lastConfirmedBlock = Confirmations.lastConfirmedBlock(rpc, options.confirmations).pipe(Effect.withSpan("StarknetIndexer.lastConfirmedBlock"));
111
+ const fetchEvents = Effect.fn("StarknetIndexer.fetchEvents")(filter => Effect.forEach(filter.fromBlock > filter.toBlock ? [] : Arr.makeBy(Number((filter.toBlock - filter.fromBlock) / size) + 1, i => filter.fromBlock + BigInt(i) * size), fromBlock => {
112
+ const toBlock = BigInt_.min(fromBlock + size - BigInt(1), filter.toBlock);
113
+ const range = {
114
+ ...filter,
115
+ fromBlock,
116
+ toBlock,
117
+ chunkSize: options.chunkSize
118
+ };
119
+ // a cursor page has no fallback: when it fails, the range restarts once from its first page
120
+ return Stream.paginate(Option.none(), cursor => rpc.getEvents({
121
+ ...range,
122
+ cursor: Option.getOrUndefined(cursor)
123
+ }).pipe(Effect.mapBoth({
124
+ onFailure: error => Option.isNone(cursor) ? error : {
125
+ cursorPage: error
126
+ },
127
+ onSuccess: page => [page.events, Option.map(Option.fromUndefinedOr(page.cursor), Option.some)]
128
+ }))).pipe(Stream.runCollect, Effect.retry({
129
+ times: 1,
130
+ while: error => "cursorPage" in error
131
+ }), Effect.mapError(error => "cursorPage" in error ? error.cursorPage : error));
132
+ }).pipe(Effect.map(Arr.flatten)));
133
+ // the head last read is reused while it covers `next` (the confirmed head only moves forward), else polled
134
+ const confirmedFor = (next, head, poll) => next <= head ? Effect.succeed(head) : lastConfirmedBlock.pipe(Effect.repeat({
135
+ schedule: poll,
136
+ until: confirmed => confirmed >= next
137
+ }));
138
+ const retrying = (step, retry) => retry === undefined ? step : state => Effect.retry(step(state), {
139
+ schedule: retry,
140
+ while: error => JsonRpc.isTransient(error.reason)
141
+ });
142
+ const fetchNativeBalance = Effect.fn("StarknetIndexer.fetchNativeBalance")(({
143
+ address,
144
+ block
145
+ }) => rpc.call({
146
+ contractAddress: StarknetNetwork.STRK_TOKEN_ADDRESS,
147
+ entryPointSelector: BALANCE_OF,
148
+ calldata: [address],
149
+ blockNumber: block
150
+ }).pipe(Effect.flatMap(felts => felts.length === 2 ? Effect.succeed(BigInt(felts[0]) + (BigInt(felts[1]) << BigInt(128))) : Effect.fail(new StarknetRpcError({
151
+ reason: new JsonRpc.InvalidResponse(),
152
+ method: "starknet_call",
153
+ endpoint: "StarknetIndexer",
154
+ cause: new Error(`balanceOf returned ${felts.length} felts, expected a u256 (low, high)`)
155
+ })))));
156
+ return StarknetIndexer.of({
157
+ lastConfirmedBlock,
158
+ fetchEvents,
159
+ fetchNativeBalance,
160
+ streamNativeBalance: ({
161
+ address,
162
+ fromBlock,
163
+ poll = Schedule.spaced(DEFAULT_POLL_INTERVAL),
164
+ retry,
165
+ step,
166
+ toBlock
167
+ }) => {
168
+ if (!Number.isSafeInteger(step) || step < 1) {
169
+ return Stream.die(new RangeError(`step must be a positive integer, got ${step}`));
170
+ }
171
+ if (toBlock !== undefined && fromBlock > toBlock) return Stream.empty;
172
+ const size = BigInt(step);
173
+ const sample = ({
174
+ head,
175
+ next
176
+ }) => confirmedFor(next, head, poll).pipe(Effect.flatMap(confirmed => {
177
+ if (next > confirmed) return Effect.succeed([[], Option.none()]);
178
+ return fetchNativeBalance({
179
+ address,
180
+ block: next
181
+ }).pipe(Effect.map(balance => [[{
182
+ block: next,
183
+ balance
184
+ }], toBlock !== undefined && next + size > toBlock ? Option.none() : Option.some({
185
+ next: next + size,
186
+ head: confirmed
187
+ })]));
188
+ }));
189
+ return Stream.paginate({
190
+ next: fromBlock,
191
+ head: fromBlock - BigInt(1)
192
+ }, retrying(sample, retry));
193
+ },
194
+ streamEvents: ({
195
+ filter,
196
+ fromBlock,
197
+ poll = Schedule.spaced(DEFAULT_POLL_INTERVAL),
198
+ retry,
199
+ toBlock
200
+ }) => {
201
+ if (toBlock !== undefined && fromBlock > toBlock) return Stream.empty;
202
+ const step = ({
203
+ head,
204
+ next
205
+ }) => confirmedFor(next, head, poll).pipe(Effect.flatMap(confirmed => {
206
+ const cap = toBlock === undefined ? confirmed : BigInt_.min(confirmed, toBlock);
207
+ if (next > cap) return Effect.succeed([[], Option.none()]);
208
+ const end = BigInt_.min(next + size - BigInt(1), cap);
209
+ return fetchEvents({
210
+ ...filter,
211
+ fromBlock: next,
212
+ toBlock: end
213
+ }).pipe(Effect.map(events => [[{
214
+ fromBlock: next,
215
+ toBlock: end,
216
+ events
217
+ }], end === toBlock ? Option.none() : Option.some({
218
+ next: end + BigInt(1),
219
+ head: confirmed
220
+ })]));
221
+ }));
222
+ // a head below `fromBlock`: the first step reads it
223
+ return Stream.paginate({
224
+ next: fromBlock,
225
+ head: fromBlock - BigInt(1)
226
+ }, retrying(step, retry));
227
+ }
228
+ });
229
+ }));
230
+ /**
231
+ * Builds an {@link StarknetIndexer} like {@link layer}, reading the options from `Config`.
232
+ *
233
+ * @example
234
+ * ```ts
235
+ * import * as StarknetIndexer from "@effect-blockchain/starknet/StarknetIndexer"
236
+ * import * as Config from "effect/Config"
237
+ *
238
+ * const IndexerLive = StarknetIndexer.layerConfig({ confirmations: Config.Int("STARKNET_CONFIRMATIONS") })
239
+ * ```
240
+ *
241
+ * @since 0.1.0
242
+ * @category layers
243
+ */
244
+ export const layerConfig = options => Layer.unwrap(Effect.map(Config.unwrap(options), layer));
245
+ //# sourceMappingURL=StarknetIndexer.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StarknetIndexer.js","names":[],"sources":["../src/StarknetIndexer.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAwDA,OAAO,KAAK,OAAO,MAAM,iCAAiC;AAC1D,OAAO,KAAK,GAAG,MAAM,cAAc;AACnC,OAAO,KAAK,OAAO,MAAM,eAAe;AACxC,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,OAAO,MAAM,gBAAgB;AACzC,OAAO,KAAK,QAAQ,MAAM,iBAAiB;AAC3C,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,KAAK,MAAM,cAAc;AACrC,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,QAAQ,MAAM,iBAAiB;AAC3C,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,OAAO,KAAK,aAAa,MAAM,6BAA6B;AAG5D,OAAO,KAAK,eAAe,MAAM,sBAAsB;AAEvD,SAAS,WAAW,EAAE,gBAAgB,QAAQ,kBAAkB;AA2BhE;;;;;;;AAOA,OAAO,MAAM,uBAAuB,GAAG,MAAM;AAmD7C;;;;AAIA,OAAM,MAAO,eAAgB,sBAAQ,OAAO,CAAC,OAAO,EA0BhD,CAAC,6CAA6C,CAAC;AAEnD;;;;;;AAMA,OAAO,MAAM,qBAAqB,gBAAsB,QAAQ,CAAC,OAAO,CAAC,EAAE,CAAC;AAE5E;AACA,MAAM,UAAU,GAAG,oEAAoE;AAQvF;;;;;;;;;;AAUA,OAAO,MAAM,KAAK,GAAG,CAAC,OAAO,GAIzB,EAAE,KACJ,KAAK,CAAC,MAAM,CACV,eAAe,EACf,MAAM,CAAC,GAAG,CAAC,aAAS;EAClB,MAAM,GAAG,GAAG,OAAO,WAAW;EAC9B,MAAM,aAAa,GAAG,OAAO,CAAC,aAAa,IAAI,uBAAuB;EACtE,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,IAAI,aAAa,GAAG,CAAC,EAAE;IAC7D,OAAO,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,iDAAiD,aAAa,EAAE,CAAC,CAAC;EAC5G;EACA,MAAM,IAAI,GAAG,MAAM,CAAC,aAAa,CAAC;EAClC,MAAM,kBAAkB,GAAG,aAAa,CAAC,kBAAkB,CAAC,GAAG,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC,IAAI,CAC1F,MAAM,CAAC,QAAQ,CAAC,oCAAoC,CAAC,CACtD;EACD,MAAM,WAAW,GAAG,MAAM,CAAC,EAAE,CAAC,6BAA6B,CAAC,CAAE,MAA6B,IACzF,MAAM,CAAC,OAAO,CACZ,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,OAAO,GAAG,EAAE,GAAG,GAAG,CAAC,MAAM,CACjD,MAAM,CAAC,CAAC,MAAM,CAAC,OAAO,GAAG,MAAM,CAAC,SAAS,IAAI,IAAI,CAAC,GAAG,CAAC,EACrD,CAAC,IAAK,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAC3C,EACA,SAAS,IAAI;IACZ,MAAM,OAAO,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,GAAG,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,MAAM,CAAC,OAAO,CAAC;IACzE,MAAM,KAAK,GAAG;MAAE,GAAG,MAAM;MAAE,SAAS;MAAE,OAAO;MAAE,SAAS,EAAE,OAAO,CAAC;IAAS,CAAE;IAC7E;IACA,OAAO,MAAM,CAAC,QAAQ,CACpB,MAAM,CAAC,IAAI,EAAwB,EAClC,MAAM,IACL,GAAG,CAAC,SAAS,CAAC;MAAE,GAAG,KAAK;MAAE,MAAM,EAAE,MAAM,CAAC,cAAc,CAAC,MAAM;IAAC,CAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAC;MACrF,SAAS,EAAG,KAAK,IAAK,MAAM,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,KAAK,GAAG;QAAE,UAAU,EAAE;MAAK,CAAE;MAC3E,SAAS,EAAG,IAAI,IACd,CAAC,IAAI,CAAC,MAAM,EAAE,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,eAAe,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,IAAI,CAAC;KAC7E,CAAC,CAAC,CACN,CAAC,IAAI,CACJ,MAAM,CAAC,UAAU,EACjB,MAAM,CAAC,KAAK,CAAC;MAAE,KAAK,EAAE,CAAC;MAAE,KAAK,EAAG,KAAK,IAAK,YAAY,IAAI;IAAK,CAAE,CAAC,EACnE,MAAM,CAAC,QAAQ,CAAE,KAAK,IAAK,YAAY,IAAI,KAAK,GAAG,KAAK,CAAC,UAAU,GAAG,KAAK,CAAC,CAC7E;EACH,CAAC,CACF,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC,CAChC;EACD;EACA,MAAM,YAAY,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,IAAgC,KAChF,IAAI,IAAI,IAAI,GACR,MAAM,CAAC,OAAO,CAAC,IAAI,CAAC,GACpB,kBAAkB,CAAC,IAAI,CAAC,MAAM,CAAC,MAAM,CAAC;IAAE,QAAQ,EAAE,IAAI;IAAE,KAAK,EAAG,SAAS,IAAK,SAAS,IAAI;EAAI,CAAE,CAAC,CAAC;EACzG,MAAM,QAAQ,GAAG,CACf,IAAsD,EACtD,KAA+D,KAE/D,KAAK,KAAK,SAAS,GACf,IAAI,GACH,KAAQ,IACT,MAAM,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE;IAAE,QAAQ,EAAE,KAAK;IAAE,KAAK,EAAG,KAAK,IAAK,OAAO,CAAC,WAAW,CAAC,KAAK,CAAC,MAAM;EAAC,CAAE,CAAC;EACzG,MAAM,kBAAkB,GAAG,MAAM,CAAC,EAAE,CAAC,oCAAoC,CAAC,CACxE,CAAC;IAAE,OAAO;IAAE;EAAK,CAAiE,KAChF,GAAG,CAAC,IAAI,CAAC;IACP,eAAe,EAAE,eAAe,CAAC,kBAAkB;IACnD,kBAAkB,EAAE,UAAU;IAC9B,QAAQ,EAAE,CAAC,OAAO,CAAC;IACnB,WAAW,EAAE;GACd,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAE,KAAK,IAC3B,KAAK,CAAC,MAAM,KAAK,CAAC,GACd,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,IAAI,MAAM,CAAC,GAAG,CAAC,CAAC,CAAC,GACpE,MAAM,CAAC,IAAI,CACX,IAAI,gBAAgB,CAAC;IACnB,MAAM,EAAE,IAAI,OAAO,CAAC,eAAe,EAAE;IACrC,MAAM,EAAE,eAAe;IACvB,QAAQ,EAAE,iBAAiB;IAC3B,KAAK,EAAE,IAAI,KAAK,CAAC,sBAAsB,KAAK,CAAC,MAAM,qCAAqC;GACzF,CAAC,CACH,CACJ,CAAC,CACL;EACD,OAAO,eAAe,CAAC,EAAE,CAAC;IACxB,kBAAkB;IAClB,WAAW;IACX,kBAAkB;IAClB,mBAAmB,EAAE,CACnB;MAAE,OAAO;MAAE,SAAS;MAAE,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC;MAAE,KAAK;MAAE,IAAI;MAAE;IAAO,CAAE,KACzF;MACF,IAAI,CAAC,MAAM,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,IAAI,GAAG,CAAC,EAAE;QAC3C,OAAO,MAAM,CAAC,GAAG,CAAC,IAAI,UAAU,CAAC,wCAAwC,IAAI,EAAE,CAAC,CAAC;MACnF;MACA,IAAI,OAAO,KAAK,SAAS,IAAI,SAAS,GAAG,OAAO,EAAE,OAAO,MAAM,CAAC,KAAK;MACrE,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC;MACzB,MAAM,MAAM,GAAG,CACb;QAAE,IAAI;QAAE;MAAI,CAAkB,KAK9B,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAE,SAAS,IAAI;QAC/D,IAAI,IAAI,GAAG,SAAS,EAAE,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAChE,OAAO,kBAAkB,CAAC;UAAE,OAAO;UAAE,KAAK,EAAE;QAAI,CAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAE,OAAO,IAAK,CAC/E,CAAC;UAAE,KAAK,EAAE,IAAI;UAAE;QAAO,CAAE,CAAC,EAC1B,OAAO,KAAK,SAAS,IAAI,IAAI,GAAG,IAAI,GAAG,OAAO,GAC1C,MAAM,CAAC,IAAI,EAAE,GACb,MAAM,CAAC,IAAI,CAAC;UAAE,IAAI,EAAE,IAAI,GAAG,IAAI;UAAE,IAAI,EAAE;QAAS,CAAE,CAAC,CACxD,CAAC,CAAC;MACL,CAAC,CAAC,CAAC;MACL,OAAO,MAAM,CAAC,QAAQ,CAAC;QAAE,IAAI,EAAE,SAAS;QAAE,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC,CAAC;MAAC,CAAE,EAAE,QAAQ,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;IACnG,CAAC;IACD,YAAY,EAAE,CAAC;MAAE,MAAM;MAAE,SAAS;MAAE,IAAI,GAAG,QAAQ,CAAC,MAAM,CAAC,qBAAqB,CAAC;MAAE,KAAK;MAAE;IAAO,CAAE,KAAI;MACrG,IAAI,OAAO,KAAK,SAAS,IAAI,SAAS,GAAG,OAAO,EAAE,OAAO,MAAM,CAAC,KAAK;MACrE,MAAM,IAAI,GAAG,CACX;QAAE,IAAI;QAAE;MAAI,CAAkB,KAK9B,YAAY,CAAC,IAAI,EAAE,IAAI,EAAE,IAAI,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,OAAO,CAAE,SAAS,IAAI;QAC/D,MAAM,GAAG,GAAG,OAAO,KAAK,SAAS,GAAG,SAAS,GAAG,OAAO,CAAC,GAAG,CAAC,SAAS,EAAE,OAAO,CAAC;QAC/E,IAAI,IAAI,GAAG,GAAG,EAAE,OAAO,MAAM,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,MAAM,CAAC,IAAI,EAAE,CAAC,CAAC;QAC1D,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,IAAI,GAAG,IAAI,GAAG,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC;QACrD,OAAO,WAAW,CAAC;UAAE,GAAG,MAAM;UAAE,SAAS,EAAE,IAAI;UAAE,OAAO,EAAE;QAAG,CAAE,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,GAAG,CAAE,MAAM,IAAK,CAC3F,CAAC;UAAE,SAAS,EAAE,IAAI;UAAE,OAAO,EAAE,GAAG;UAAE;QAAM,CAAE,CAAC,EAC3C,GAAG,KAAK,OAAO,GAAG,MAAM,CAAC,IAAI,EAAE,GAAG,MAAM,CAAC,IAAI,CAAC;UAAE,IAAI,EAAE,GAAG,GAAG,MAAM,CAAC,CAAC,CAAC;UAAE,IAAI,EAAE;QAAS,CAAE,CAAC,CAC1F,CAAC,CAAC;MACL,CAAC,CAAC,CAAC;MACL;MACA,OAAO,MAAM,CAAC,QAAQ,CAAC;QAAE,IAAI,EAAE,SAAS;QAAE,IAAI,EAAE,SAAS,GAAG,MAAM,CAAC,CAAC;MAAC,CAAE,EAAE,QAAQ,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IACjG;GACD,CAAC;AACJ,CAAC,CAAC,CACH;AAEH;;;;;;;;;;;;;;AAcA,OAAO,MAAM,WAAW,GACtB,OAA8D,IAE9D,KAAK,CAAC,MAAM,CAAC,MAAM,CAAC,GAAG,CAAC,MAAM,CAAC,MAAM,CAAC,OAAO,CAAC,EAAE,KAAK,CAAC,CAAC","ignoreList":[]}
@@ -0,0 +1,72 @@
1
+ /**
2
+ * Named Starknet networks and their chain IDs.
3
+ *
4
+ * @since 0.1.0
5
+ */
6
+ import * as Schema from "effect/Schema";
7
+ import { StarknetAddress } from "./StarknetAddress.ts";
8
+ /**
9
+ * @since 0.1.0
10
+ * @category constants
11
+ */
12
+ export declare const mainnets: readonly ["Starknet"];
13
+ /**
14
+ * @since 0.1.0
15
+ * @category constants
16
+ */
17
+ export declare const testnets: readonly ["StarknetSepolia"];
18
+ /**
19
+ * Every supported network, mainnets first.
20
+ *
21
+ * @since 0.1.0
22
+ * @category constants
23
+ */
24
+ export declare const networks: readonly ["Starknet", "StarknetSepolia"];
25
+ /**
26
+ * @since 0.1.0
27
+ * @category schemas
28
+ */
29
+ export declare const StarknetNetwork: Schema.Literals<readonly ["Starknet", "StarknetSepolia"]>;
30
+ /**
31
+ * @since 0.1.0
32
+ * @category models
33
+ */
34
+ export type StarknetNetwork = typeof StarknetNetwork.Type;
35
+ /**
36
+ * A Starknet chain ID, the short string `starknet_chainId` returns.
37
+ *
38
+ * @since 0.1.0
39
+ * @category schemas
40
+ */
41
+ export declare const StarknetChainId: Schema.Literals<readonly ["SN_MAIN", "SN_SEPOLIA"]>;
42
+ /**
43
+ * @since 0.1.0
44
+ * @category models
45
+ */
46
+ export type StarknetChainId = typeof StarknetChainId.Type;
47
+ /**
48
+ * @since 0.1.0
49
+ * @category conversions
50
+ */
51
+ export declare const toChainId: (network: StarknetNetwork) => StarknetChainId;
52
+ /**
53
+ * Default number of confirmations an indexer waits for on each network, on top of the latest accepted block.
54
+ *
55
+ * @since 0.1.0
56
+ * @category getters
57
+ */
58
+ export declare const defaultConfirmations: (network: StarknetNetwork) => number;
59
+ /**
60
+ * The STRK token contract, the token Starknet fees are paid in, counted in fri (10^-18 STRK). The same address on
61
+ * mainnet and Sepolia: https://docs.starknet.io/resources/chain-info
62
+ *
63
+ * @since 0.2.0
64
+ * @category constants
65
+ */
66
+ export declare const STRK_TOKEN_ADDRESS: StarknetAddress;
67
+ /**
68
+ * @since 0.1.0
69
+ * @category predicates
70
+ */
71
+ export declare const isTestnet: (network: StarknetNetwork) => boolean;
72
+ //# sourceMappingURL=StarknetNetwork.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StarknetNetwork.d.ts","sourceRoot":"","sources":["../src/StarknetNetwork.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAEtD;;;GAGG;AACH,eAAO,MAAM,QAAQ,YAAI,UAAU,CAAU,CAAA;AAE7C;;;GAGG;AACH,eAAO,MAAM,QAAQ,YAAI,iBAAiB,CAAU,CAAA;AAEpD;;;;;GAKG;AACH,eAAO,MAAM,QAAQ,0CAAsC,CAAA;AAE3D;;;GAGG;AACH,eAAO,MAAM,eAAe,2DAI1B,CAAA;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,eAAe,qDAI1B,CAAA;AAEF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAOzD;;;GAGG;AACH,eAAO,MAAM,SAAS,YAAa,eAAe,KAAG,eAAoC,CAAA;AAEzF;;;;;GAKG;AACH,eAAO,MAAM,oBAAoB,YAAa,eAAe,KAAG,MAS/D,CAAA;AAED;;;;;;GAMG;AACH,eAAO,MAAM,kBAAkB,EAAE,eAEhC,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,SAAS,YAAa,eAAe,KAAG,OACW,CAAA"}
@@ -0,0 +1,83 @@
1
+ /**
2
+ * Named Starknet networks and their chain IDs.
3
+ *
4
+ * @since 0.1.0
5
+ */
6
+ import * as Schema from "effect/Schema";
7
+ import { StarknetAddress } from "./StarknetAddress.js";
8
+ /**
9
+ * @since 0.1.0
10
+ * @category constants
11
+ */
12
+ export const mainnets = ["Starknet"];
13
+ /**
14
+ * @since 0.1.0
15
+ * @category constants
16
+ */
17
+ export const testnets = ["StarknetSepolia"];
18
+ /**
19
+ * Every supported network, mainnets first.
20
+ *
21
+ * @since 0.1.0
22
+ * @category constants
23
+ */
24
+ export const networks = [...mainnets, ...testnets];
25
+ /**
26
+ * @since 0.1.0
27
+ * @category schemas
28
+ */
29
+ export const StarknetNetwork = /*#__PURE__*/Schema.Literals(networks).annotate({
30
+ identifier: "StarknetNetwork",
31
+ title: "Starknet network",
32
+ description: "a Starknet network name: \"Starknet\" (mainnet) or \"StarknetSepolia\" (testnet)"
33
+ });
34
+ /**
35
+ * A Starknet chain ID, the short string `starknet_chainId` returns.
36
+ *
37
+ * @since 0.1.0
38
+ * @category schemas
39
+ */
40
+ export const StarknetChainId = /*#__PURE__*/Schema.Literals(["SN_MAIN", "SN_SEPOLIA"]).annotate({
41
+ identifier: "StarknetChainId",
42
+ title: "Starknet chain ID",
43
+ description: "a Starknet chain ID as a short string: \"SN_MAIN\" or \"SN_SEPOLIA\""
44
+ });
45
+ const chainIds = {
46
+ Starknet: "SN_MAIN",
47
+ StarknetSepolia: "SN_SEPOLIA"
48
+ };
49
+ /**
50
+ * @since 0.1.0
51
+ * @category conversions
52
+ */
53
+ export const toChainId = network => chainIds[network];
54
+ /**
55
+ * Default number of confirmations an indexer waits for on each network, on top of the latest accepted block.
56
+ *
57
+ * @since 0.1.0
58
+ * @category getters
59
+ */
60
+ export const defaultConfirmations = network => {
61
+ switch (network) {
62
+ // ACCEPTED_ON_L2 blocks are "finalized by the consensus protocol": https://docs.starknet.io/learn/protocol/transactions
63
+ case "Starknet":
64
+ return 0;
65
+ // same protocol and finality rules as mainnet: https://docs.starknet.io/learn/protocol/transactions
66
+ case "StarknetSepolia":
67
+ return 0;
68
+ }
69
+ };
70
+ /**
71
+ * The STRK token contract, the token Starknet fees are paid in, counted in fri (10^-18 STRK). The same address on
72
+ * mainnet and Sepolia: https://docs.starknet.io/resources/chain-info
73
+ *
74
+ * @since 0.2.0
75
+ * @category constants
76
+ */
77
+ export const STRK_TOKEN_ADDRESS = /*#__PURE__*/StarknetAddress.make("0x04718f5a0fc34cc1af16a1cdee98ffb20c31f5cd61d6ab07201858f4287c938d");
78
+ /**
79
+ * @since 0.1.0
80
+ * @category predicates
81
+ */
82
+ export const isTestnet = network => testnets.includes(network);
83
+ //# sourceMappingURL=StarknetNetwork.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StarknetNetwork.js","names":[],"sources":["../src/StarknetNetwork.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;AAKA,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,SAAS,eAAe,QAAQ,sBAAsB;AAEtD;;;;AAIA,OAAO,MAAM,QAAQ,GAAG,CAAC,UAAU,CAAU;AAE7C;;;;AAIA,OAAO,MAAM,QAAQ,GAAG,CAAC,iBAAiB,CAAU;AAEpD;;;;;;AAMA,OAAO,MAAM,QAAQ,GAAG,CAAC,GAAG,QAAQ,EAAE,GAAG,QAAQ,CAAU;AAE3D;;;;AAIA,OAAO,MAAM,eAAe,gBAAG,MAAM,CAAC,QAAQ,CAAC,QAAQ,CAAC,CAAC,QAAQ,CAAC;EAChE,UAAU,EAAE,iBAAiB;EAC7B,KAAK,EAAE,kBAAkB;EACzB,WAAW,EAAE;CACd,CAAC;AAQF;;;;;;AAMA,OAAO,MAAM,eAAe,gBAAG,MAAM,CAAC,QAAQ,CAAC,CAAC,SAAS,EAAE,YAAY,CAAC,CAAC,CAAC,QAAQ,CAAC;EACjF,UAAU,EAAE,iBAAiB;EAC7B,KAAK,EAAE,mBAAmB;EAC1B,WAAW,EAAE;CACd,CAAC;AAQF,MAAM,QAAQ,GAA6C;EACzD,QAAQ,EAAE,SAAS;EACnB,eAAe,EAAE;CAClB;AAED;;;;AAIA,OAAO,MAAM,SAAS,GAAI,OAAwB,IAAsB,QAAQ,CAAC,OAAO,CAAC;AAEzF;;;;;;AAMA,OAAO,MAAM,oBAAoB,GAAI,OAAwB,IAAY;EACvE,QAAQ,OAAO;IACb;IACA,KAAK,UAAU;MACb,OAAO,CAAC;IACV;IACA,KAAK,iBAAiB;MACpB,OAAO,CAAC;EACZ;AACF,CAAC;AAED;;;;;;;AAOA,OAAO,MAAM,kBAAkB,gBAAoB,eAAe,CAAC,IAAI,CACrE,oEAAoE,CACrE;AAED;;;;AAIA,OAAO,MAAM,SAAS,GAAI,OAAwB,IAC/C,QAA2C,CAAC,QAAQ,CAAC,OAAO,CAAC","ignoreList":[]}