@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
package/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2025 Spiko
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
package/README.md CHANGED
@@ -1,3 +1,13 @@
1
- # Temporary Holding Version
1
+ # `@effect-blockchain/starknet`
2
2
 
3
- This version is a temporary placeholder for this package. An operational version to replace this has been submitted for review and is awaiting a staged release.
3
+ Starknet blockchain toolkit for Effect.
4
+
5
+ ## Installation
6
+
7
+ ```bash
8
+ pnpm add @effect-blockchain/starknet effect starknet
9
+ ```
10
+
11
+ ## License
12
+
13
+ MIT
@@ -0,0 +1,29 @@
1
+ /**
2
+ * Starknet contract and account addresses.
3
+ *
4
+ * @since 0.1.0
5
+ */
6
+ import * as Schema from "effect/Schema";
7
+ /**
8
+ * A Starknet address: `0x` followed by 64 lowercase hex digits.
9
+ *
10
+ * Decoding lowercases the input and left-pads it with zeros, so `"0x32"` decodes
11
+ * to `"0x00…0032"`.
12
+ *
13
+ * @since 0.1.0
14
+ * @category schemas
15
+ */
16
+ export declare const StarknetAddress: Schema.brand<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>, "StarknetAddress">;
17
+ /**
18
+ * @since 0.1.0
19
+ * @category models
20
+ */
21
+ export type StarknetAddress = typeof StarknetAddress.Type;
22
+ /**
23
+ * The Starknet zero address.
24
+ *
25
+ * @since 0.1.0
26
+ * @category constants
27
+ */
28
+ export declare const NULL_ADDRESS: StarknetAddress;
29
+ //# sourceMappingURL=StarknetAddress.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StarknetAddress.d.ts","sourceRoot":"","sources":["../src/StarknetAddress.ts"],"names":[],"mappings":"AAAA;;;;GAIG;AACH,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAGvC;;;;;;;;GAQG;AACH,eAAO,MAAM,eAAe,4IAQ3B,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,OAAO,eAAe,CAAC,IAAI,CAAA;AAEzD;;;;;GAKG;AACH,eAAO,MAAM,YAAY,EAAE,eAE1B,CAAA"}
@@ -0,0 +1,29 @@
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.js";
8
+ /**
9
+ * A Starknet address: `0x` followed by 64 lowercase hex digits.
10
+ *
11
+ * Decoding lowercases the input and left-pads it with zeros, so `"0x32"` decodes
12
+ * to `"0x00…0032"`.
13
+ *
14
+ * @since 0.1.0
15
+ * @category schemas
16
+ */
17
+ export const StarknetAddress = /*#__PURE__*/PaddedFelt.pipe(/*#__PURE__*/Schema.brand("StarknetAddress"), /*#__PURE__*/Schema.annotate({
18
+ identifier: "StarknetAddress",
19
+ title: "Starknet address",
20
+ description: "a valid Starknet address, starting with 0x and followed by 64 hexadecimal characters e.g. \"0x0000000000000000000000000000000000000000000000000000000000000000\""
21
+ }));
22
+ /**
23
+ * The Starknet zero address.
24
+ *
25
+ * @since 0.1.0
26
+ * @category constants
27
+ */
28
+ export const NULL_ADDRESS = /*#__PURE__*/StarknetAddress.make("0x0000000000000000000000000000000000000000000000000000000000000000");
29
+ //# sourceMappingURL=StarknetAddress.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StarknetAddress.js","names":[],"sources":["../src/StarknetAddress.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;AAKA,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,SAAS,UAAU,QAAQ,0BAA0B;AAErD;;;;;;;;;AASA,OAAO,MAAM,eAAe,gBAAG,UAAU,CAAC,IAAI,cAC5C,MAAM,CAAC,KAAK,CAAC,iBAAiB,CAAC,eAC/B,MAAM,CAAC,QAAQ,CAAC;EACd,UAAU,EAAE,iBAAiB;EAC7B,KAAK,EAAE,kBAAkB;EACzB,WAAW,EACT;CACH,CAAC,CACH;AAQD;;;;;;AAMA,OAAO,MAAM,YAAY,gBAAoB,eAAe,CAAC,IAAI,CAC/D,oEAAoE,CACrE","ignoreList":[]}
@@ -0,0 +1,49 @@
1
+ import * as Schema from "effect/Schema";
2
+ /**
3
+ * A confirmed block header with its transaction hashes in block order, decoded from the raw JSON-RPC block (snake case
4
+ * keys, integers as `bigint`). `timestamp` is in Unix seconds. A pre-confirmed block (no block hash, no
5
+ * `ACCEPTED_ON_L2` or `ACCEPTED_ON_L1` status) does not decode.
6
+ *
7
+ * @example
8
+ * ```ts
9
+ * import type { StarknetEvent } from "@effect-blockchain/starknet/StarknetEvent"
10
+ * import * as StarknetRpc from "@effect-blockchain/starknet/StarknetRpc"
11
+ * import * as Effect from "effect/Effect"
12
+ *
13
+ * // the timestamp of each event, reading each block once
14
+ * const withTimestamps = (events: ReadonlyArray<StarknetEvent>) =>
15
+ * Effect.gen(function*() {
16
+ * const rpc = yield* StarknetRpc.StarknetRpc
17
+ * const blockNumbers = [...new Set(events.map((event) => event.blockNumber))]
18
+ * const blocks = yield* Effect.forEach(blockNumbers, (blockNumber) => rpc.getBlockWithTxHashes({ blockNumber }), {
19
+ * concurrency: 5
20
+ * })
21
+ * const timestamps = new Map(blocks.map((block) => [block.blockNumber, block.timestamp]))
22
+ * return events.map((event) => ({ event, timestamp: timestamps.get(event.blockNumber) }))
23
+ * })
24
+ * ```
25
+ *
26
+ * @since 0.1.0
27
+ * @category schemas
28
+ */
29
+ export declare const StarknetBlock: Schema.decodeTo<Schema.Struct<{
30
+ readonly blockNumber: Schema.decodeTo<Schema.BigInt, Schema.Int, never, never>;
31
+ readonly blockHash: Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>;
32
+ readonly parentHash: Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>;
33
+ readonly timestamp: Schema.decodeTo<Schema.BigInt, Schema.Int, never, never>;
34
+ readonly status: Schema.Literals<readonly ["ACCEPTED_ON_L2", "ACCEPTED_ON_L1"]>;
35
+ readonly transactions: Schema.$Array<Schema.brand<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>, "StarknetTransactionHash">>;
36
+ }>, Schema.Struct<{
37
+ readonly block_hash: Schema.toEncoded<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>>;
38
+ readonly block_number: Schema.toEncoded<Schema.decodeTo<Schema.BigInt, Schema.Int, never, never>>;
39
+ readonly parent_hash: Schema.toEncoded<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>>;
40
+ readonly status: Schema.toEncoded<Schema.Literals<readonly ["ACCEPTED_ON_L2", "ACCEPTED_ON_L1"]>>;
41
+ readonly timestamp: Schema.toEncoded<Schema.decodeTo<Schema.BigInt, Schema.Int, never, never>>;
42
+ readonly transactions: Schema.toEncoded<Schema.$Array<Schema.brand<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>, "StarknetTransactionHash">>>;
43
+ }>, never, never>;
44
+ /**
45
+ * @since 0.1.0
46
+ * @category models
47
+ */
48
+ export type StarknetBlock = typeof StarknetBlock.Type;
49
+ //# sourceMappingURL=StarknetBlock.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StarknetBlock.d.ts","sourceRoot":"","sources":["../src/StarknetBlock.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAIvC;;;;;;;;;;;;;;;;;;;;;;;;;;GA0BG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;iBAUzB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA"}
@@ -0,0 +1,52 @@
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.js";
9
+ import { StarknetTransactionHash } from "./StarknetTransactionHash.js";
10
+ /**
11
+ * A confirmed block header with its transaction hashes in block order, decoded from the raw JSON-RPC block (snake case
12
+ * keys, integers as `bigint`). `timestamp` is in Unix seconds. A pre-confirmed block (no block hash, no
13
+ * `ACCEPTED_ON_L2` or `ACCEPTED_ON_L1` status) does not decode.
14
+ *
15
+ * @example
16
+ * ```ts
17
+ * import type { StarknetEvent } from "@effect-blockchain/starknet/StarknetEvent"
18
+ * import * as StarknetRpc from "@effect-blockchain/starknet/StarknetRpc"
19
+ * import * as Effect from "effect/Effect"
20
+ *
21
+ * // the timestamp of each event, reading each block once
22
+ * const withTimestamps = (events: ReadonlyArray<StarknetEvent>) =>
23
+ * Effect.gen(function*() {
24
+ * const rpc = yield* StarknetRpc.StarknetRpc
25
+ * const blockNumbers = [...new Set(events.map((event) => event.blockNumber))]
26
+ * const blocks = yield* Effect.forEach(blockNumbers, (blockNumber) => rpc.getBlockWithTxHashes({ blockNumber }), {
27
+ * concurrency: 5
28
+ * })
29
+ * const timestamps = new Map(blocks.map((block) => [block.blockNumber, block.timestamp]))
30
+ * return events.map((event) => ({ event, timestamp: timestamps.get(event.blockNumber) }))
31
+ * })
32
+ * ```
33
+ *
34
+ * @since 0.1.0
35
+ * @category schemas
36
+ */
37
+ export const StarknetBlock = /*#__PURE__*/Schema.Struct({
38
+ blockNumber: BigIntFromInt,
39
+ blockHash: PaddedFelt,
40
+ parentHash: PaddedFelt,
41
+ timestamp: BigIntFromInt,
42
+ status: Schema.Literals(["ACCEPTED_ON_L2", "ACCEPTED_ON_L1"]),
43
+ transactions: Schema.Array(StarknetTransactionHash)
44
+ }).pipe(/*#__PURE__*/Schema.encodeKeys({
45
+ blockNumber: "block_number",
46
+ blockHash: "block_hash",
47
+ parentHash: "parent_hash"
48
+ }), /*#__PURE__*/Schema.annotate({
49
+ identifier: "StarknetBlock",
50
+ title: "Starknet block"
51
+ }));
52
+ //# sourceMappingURL=StarknetBlock.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StarknetBlock.js","names":[],"sources":["../src/StarknetBlock.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;AAKA,SAAS,aAAa,QAAQ,iCAAiC;AAC/D,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,SAAS,UAAU,QAAQ,0BAA0B;AACrD,SAAS,uBAAuB,QAAQ,8BAA8B;AAEtE;;;;;;;;;;;;;;;;;;;;;;;;;;;AA2BA,OAAO,MAAM,aAAa,gBAAG,MAAM,CAAC,MAAM,CAAC;EACzC,WAAW,EAAE,aAAa;EAC1B,SAAS,EAAE,UAAU;EACrB,UAAU,EAAE,UAAU;EACtB,SAAS,EAAE,aAAa;EACxB,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,gBAAgB,EAAE,gBAAgB,CAAC,CAAC;EAC7D,YAAY,EAAE,MAAM,CAAC,KAAK,CAAC,uBAAuB;CACnD,CAAC,CAAC,IAAI,cACL,MAAM,CAAC,UAAU,CAAC;EAAE,WAAW,EAAE,cAAc;EAAE,SAAS,EAAE,YAAY;EAAE,UAAU,EAAE;AAAa,CAAE,CAAC,eACtG,MAAM,CAAC,QAAQ,CAAC;EAAE,UAAU,EAAE,eAAe;EAAE,KAAK,EAAE;AAAgB,CAAE,CAAC,CAC1E","ignoreList":[]}
@@ -0,0 +1,34 @@
1
+ import * as Schema from "effect/Schema";
2
+ /**
3
+ * An event emitted by a contract in a block, decoded from the raw JSON-RPC event (snake case keys, felts as `0x` + 64
4
+ * lowercase hex digits). A pre-confirmed event (no block hash or block number) does not decode. `transactionIndex` and
5
+ * `eventIndex` (the event's position in its transaction) are only returned by RPC 0.10 and later.
6
+ *
7
+ * @since 0.1.0
8
+ * @category schemas
9
+ */
10
+ export declare const StarknetEvent: Schema.decodeTo<Schema.Struct<{
11
+ readonly fromAddress: Schema.brand<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>, "StarknetAddress">;
12
+ readonly keys: Schema.$Array<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>>;
13
+ readonly data: Schema.$Array<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>>;
14
+ readonly blockNumber: Schema.decodeTo<Schema.BigInt, Schema.Int, never, never>;
15
+ readonly blockHash: Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>;
16
+ readonly transactionHash: Schema.brand<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>, "StarknetTransactionHash">;
17
+ readonly transactionIndex: Schema.optionalKey<Schema.Int>;
18
+ readonly eventIndex: Schema.optionalKey<Schema.Int>;
19
+ }>, Schema.Struct<{
20
+ readonly block_hash: Schema.toEncoded<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>>;
21
+ readonly block_number: Schema.toEncoded<Schema.decodeTo<Schema.BigInt, Schema.Int, never, never>>;
22
+ readonly data: Schema.toEncoded<Schema.$Array<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>>>;
23
+ readonly event_index: Schema.toEncoded<Schema.optionalKey<Schema.Int>>;
24
+ readonly from_address: Schema.toEncoded<Schema.brand<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>, "StarknetAddress">>;
25
+ readonly keys: Schema.toEncoded<Schema.$Array<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>>>;
26
+ readonly transaction_hash: Schema.toEncoded<Schema.brand<Schema.decodeTo<Schema.String, Schema.decodeTo<Schema.String, Schema.String, never, never>, never, never>, "StarknetTransactionHash">>;
27
+ readonly transaction_index: Schema.toEncoded<Schema.optionalKey<Schema.Int>>;
28
+ }>, never, never>;
29
+ /**
30
+ * @since 0.1.0
31
+ * @category models
32
+ */
33
+ export type StarknetEvent = typeof StarknetEvent.Type;
34
+ //# sourceMappingURL=StarknetEvent.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StarknetEvent.d.ts","sourceRoot":"","sources":["../src/StarknetEvent.ts"],"names":[],"mappings":"AAMA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAKvC;;;;;;;GAOG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;iBAmBzB,CAAA;AAED;;;GAGG;AACH,MAAM,MAAM,aAAa,GAAG,OAAO,aAAa,CAAC,IAAI,CAAA"}
@@ -0,0 +1,39 @@
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.js";
9
+ import { StarknetAddress } from "./StarknetAddress.js";
10
+ import { StarknetTransactionHash } from "./StarknetTransactionHash.js";
11
+ /**
12
+ * An event emitted by a contract in a block, decoded from the raw JSON-RPC event (snake case keys, felts as `0x` + 64
13
+ * lowercase hex digits). A pre-confirmed event (no block hash or block number) does not decode. `transactionIndex` and
14
+ * `eventIndex` (the event's position in its transaction) are only returned by RPC 0.10 and later.
15
+ *
16
+ * @since 0.1.0
17
+ * @category schemas
18
+ */
19
+ export const StarknetEvent = /*#__PURE__*/Schema.Struct({
20
+ fromAddress: StarknetAddress,
21
+ keys: Schema.Array(PaddedFelt),
22
+ data: Schema.Array(PaddedFelt),
23
+ blockNumber: BigIntFromInt,
24
+ blockHash: PaddedFelt,
25
+ transactionHash: StarknetTransactionHash,
26
+ transactionIndex: Schema.optionalKey(Schema.Int),
27
+ eventIndex: Schema.optionalKey(Schema.Int)
28
+ }).pipe(/*#__PURE__*/Schema.encodeKeys({
29
+ fromAddress: "from_address",
30
+ blockNumber: "block_number",
31
+ blockHash: "block_hash",
32
+ transactionHash: "transaction_hash",
33
+ transactionIndex: "transaction_index",
34
+ eventIndex: "event_index"
35
+ }), /*#__PURE__*/Schema.annotate({
36
+ identifier: "StarknetEvent",
37
+ title: "Starknet event"
38
+ }));
39
+ //# sourceMappingURL=StarknetEvent.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StarknetEvent.js","names":[],"sources":["../src/StarknetEvent.ts"],"sourcesContent":[null],"mappings":"AAAA;;;;;AAKA,SAAS,aAAa,QAAQ,iCAAiC;AAC/D,OAAO,KAAK,MAAM,MAAM,eAAe;AACvC,SAAS,UAAU,QAAQ,0BAA0B;AACrD,SAAS,eAAe,QAAQ,sBAAsB;AACtD,SAAS,uBAAuB,QAAQ,8BAA8B;AAEtE;;;;;;;;AAQA,OAAO,MAAM,aAAa,gBAAG,MAAM,CAAC,MAAM,CAAC;EACzC,WAAW,EAAE,eAAe;EAC5B,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;EAC9B,IAAI,EAAE,MAAM,CAAC,KAAK,CAAC,UAAU,CAAC;EAC9B,WAAW,EAAE,aAAa;EAC1B,SAAS,EAAE,UAAU;EACrB,eAAe,EAAE,uBAAuB;EACxC,gBAAgB,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG,CAAC;EAChD,UAAU,EAAE,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,GAAG;CAC1C,CAAC,CAAC,IAAI,cACL,MAAM,CAAC,UAAU,CAAC;EAChB,WAAW,EAAE,cAAc;EAC3B,WAAW,EAAE,cAAc;EAC3B,SAAS,EAAE,YAAY;EACvB,eAAe,EAAE,kBAAkB;EACnC,gBAAgB,EAAE,mBAAmB;EACrC,UAAU,EAAE;CACb,CAAC,eACF,MAAM,CAAC,QAAQ,CAAC;EAAE,UAAU,EAAE,eAAe;EAAE,KAAK,EAAE;AAAgB,CAAE,CAAC,CAC1E","ignoreList":[]}
@@ -0,0 +1,157 @@
1
+ import * as Config from "effect/Config";
2
+ import * as Context from "effect/Context";
3
+ import * as Duration from "effect/Duration";
4
+ import * as Effect from "effect/Effect";
5
+ import * as Layer from "effect/Layer";
6
+ import * as Schedule from "effect/Schedule";
7
+ import * as Stream from "effect/Stream";
8
+ import type { StarknetAddress } from "./StarknetAddress.ts";
9
+ import type { StarknetEvent } from "./StarknetEvent.ts";
10
+ import type { StarknetEventsFilter } from "./StarknetRpc.ts";
11
+ import { StarknetRpc, StarknetRpcError } from "./StarknetRpc.ts";
12
+ /**
13
+ * A {@link StarknetIndexer} `fetchEvents` filter: a `starknet_getEvents` filter without its paging fields, over the
14
+ * inclusive block range `[fromBlock, toBlock]`.
15
+ *
16
+ * @since 0.1.0
17
+ * @category models
18
+ */
19
+ export type StarknetIndexerFilter = Omit<StarknetEventsFilter, "chunkSize" | "cursor">;
20
+ /**
21
+ * The events of `[fromBlock, toBlock]` (both inclusive), in chain order, emitted by
22
+ * {@link StarknetIndexer.Service.streamEvents}.
23
+ *
24
+ * A batch is emitted for every range, even without events. Delivery is at-least-once: save `batch.toBlock` once the
25
+ * batch is handled and resume from `toBlock + 1`.
26
+ *
27
+ * @since 0.1.0
28
+ * @category models
29
+ */
30
+ export interface StarknetIndexerBatch {
31
+ readonly fromBlock: bigint;
32
+ readonly toBlock: bigint;
33
+ readonly events: ReadonlyArray<StarknetEvent>;
34
+ }
35
+ /**
36
+ * The default `maxBlockRange`. Starknet nodes do not limit the block range of `starknet_getEvents` (they cap the page
37
+ * size), so a range only bounds the work a restart redoes: 10000 blocks is a few hours of mainnet.
38
+ *
39
+ * @since 0.1.0
40
+ * @category constants
41
+ */
42
+ export declare const DEFAULT_MAX_BLOCK_RANGE = 10000;
43
+ /**
44
+ * The {@link StarknetIndexer.Service.streamEvents} options.
45
+ *
46
+ * @since 0.1.0
47
+ * @category models
48
+ */
49
+ export interface StarknetIndexerStreamOptions {
50
+ readonly filter: Omit<StarknetIndexerFilter, "fromBlock" | "toBlock">;
51
+ readonly fromBlock: bigint;
52
+ /** The stream ends after the batch reaching it, and is empty when `fromBlock > toBlock`. */
53
+ readonly toBlock?: bigint | undefined;
54
+ /**
55
+ * When to read the head again once caught up, `Schedule.spaced(DEFAULT_POLL_INTERVAL)` by default. It restarts after
56
+ * each batch, and its end ends the stream: `Schedule.recurs(0)` drains to the head and stops.
57
+ */
58
+ readonly poll?: Schedule.Schedule<unknown> | undefined;
59
+ /** Retries a step failing with a transient reason ({@link JsonRpc.isTransient}) at the same block. Off by default. */
60
+ readonly retry?: Schedule.Schedule<unknown, StarknetRpcError> | undefined;
61
+ }
62
+ /**
63
+ * The STRK balance of an address in fri at the end of `block`, emitted by
64
+ * {@link StarknetIndexer.Service.streamNativeBalance}.
65
+ *
66
+ * @since 0.2.0
67
+ * @category models
68
+ */
69
+ export interface StarknetNativeBalance {
70
+ readonly block: bigint;
71
+ readonly balance: bigint;
72
+ }
73
+ /**
74
+ * The {@link StarknetIndexer.Service.streamNativeBalance} options: one sample every `step` blocks from `fromBlock`.
75
+ * `step` is a positive integer, `poll` and `retry` behave as in {@link StarknetIndexerStreamOptions}.
76
+ *
77
+ * @since 0.2.0
78
+ * @category models
79
+ */
80
+ export interface StarknetIndexerNativeBalanceOptions {
81
+ readonly address: StarknetAddress;
82
+ readonly fromBlock: bigint;
83
+ /** The stream ends after the last sample at or below it, and is empty when `fromBlock > toBlock`. */
84
+ readonly toBlock?: bigint | undefined;
85
+ readonly step: number;
86
+ readonly poll?: Schedule.Schedule<unknown> | undefined;
87
+ readonly retry?: Schedule.Schedule<unknown, StarknetRpcError> | undefined;
88
+ }
89
+ declare const StarknetIndexer_base: Context.ServiceClass<StarknetIndexer, "@effect-blockchain/starknet/StarknetIndexer", {
90
+ /** The latest block with at least `confirmations` blocks on top of it, never below 0. */
91
+ readonly lastConfirmedBlock: Effect.Effect<bigint, StarknetRpcError>;
92
+ /**
93
+ * Every event matching `filter` in `[fromBlock, toBlock]`, in chain order. `fromBlock > toBlock` returns no events.
94
+ * A `toBlock` above `lastConfirmedBlock` is accepted.
95
+ */
96
+ readonly fetchEvents: (filter: StarknetIndexerFilter) => Effect.Effect<ReadonlyArray<StarknetEvent>, StarknetRpcError>;
97
+ /**
98
+ * The events matching `filter` from `fromBlock` on, in batches of at most `maxBlockRange` confirmed blocks, following
99
+ * the confirmed head.
100
+ */
101
+ readonly streamEvents: (options: StarknetIndexerStreamOptions) => Stream.Stream<StarknetIndexerBatch, StarknetRpcError>;
102
+ /** The STRK balance of `address` in fri at the end of `block`. A `block` above `lastConfirmedBlock` is accepted. */
103
+ readonly fetchNativeBalance: (options: {
104
+ readonly address: StarknetAddress;
105
+ readonly block: bigint;
106
+ }) => Effect.Effect<bigint, StarknetRpcError>;
107
+ /**
108
+ * The STRK balance of `address` at `fromBlock`, `fromBlock + step`, `fromBlock + 2 * step`... one sample per step
109
+ * even when unchanged, following the confirmed head.
110
+ */
111
+ readonly streamNativeBalance: (options: StarknetIndexerNativeBalanceOptions) => Stream.Stream<StarknetNativeBalance, StarknetRpcError>;
112
+ }>;
113
+ /**
114
+ * @since 0.1.0
115
+ * @category services
116
+ */
117
+ export declare class StarknetIndexer extends StarknetIndexer_base {
118
+ }
119
+ /**
120
+ * The default `poll` spacing of {@link StarknetIndexer.Service.streamEvents}: 10 seconds.
121
+ *
122
+ * @since 0.1.0
123
+ * @category constants
124
+ */
125
+ export declare const DEFAULT_POLL_INTERVAL: Duration.Duration;
126
+ /**
127
+ * Builds a {@link StarknetIndexer} over the provided {@link StarknetRpc}.
128
+ *
129
+ * - `confirmations` defaults to {@link StarknetNetwork.defaultConfirmations} for the RPC's network.
130
+ * - `maxBlockRange` is the largest range in blocks, a positive integer, default {@link DEFAULT_MAX_BLOCK_RANGE}.
131
+ * - `chunkSize` is the `starknet_getEvents` page size, default 1000: lower it for a provider with a smaller cap.
132
+ *
133
+ * @since 0.1.0
134
+ * @category layers
135
+ */
136
+ export declare const layer: (options?: {
137
+ readonly confirmations?: number | undefined;
138
+ readonly maxBlockRange?: number | undefined;
139
+ readonly chunkSize?: number | undefined;
140
+ }) => Layer.Layer<StarknetIndexer, never, StarknetRpc>;
141
+ /**
142
+ * Builds an {@link StarknetIndexer} like {@link layer}, reading the options from `Config`.
143
+ *
144
+ * @example
145
+ * ```ts
146
+ * import * as StarknetIndexer from "@effect-blockchain/starknet/StarknetIndexer"
147
+ * import * as Config from "effect/Config"
148
+ *
149
+ * const IndexerLive = StarknetIndexer.layerConfig({ confirmations: Config.Int("STARKNET_CONFIRMATIONS") })
150
+ * ```
151
+ *
152
+ * @since 0.1.0
153
+ * @category layers
154
+ */
155
+ export declare const layerConfig: (options: Config.Wrap<NonNullable<Parameters<typeof layer>[0]>>) => Layer.Layer<StarknetIndexer, Config.ConfigError, StarknetRpc>;
156
+ export {};
157
+ //# sourceMappingURL=StarknetIndexer.d.ts.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"StarknetIndexer.d.ts","sourceRoot":"","sources":["../src/StarknetIndexer.ts"],"names":[],"mappings":"AA2DA,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,OAAO,MAAM,gBAAgB,CAAA;AACzC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AACvC,OAAO,KAAK,KAAK,MAAM,cAAc,CAAA;AAErC,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAA;AAC3C,OAAO,KAAK,MAAM,MAAM,eAAe,CAAA;AAEvC,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAA;AAC3D,OAAO,KAAK,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAA;AAEvD,OAAO,KAAK,EAAwB,oBAAoB,EAAE,MAAM,kBAAkB,CAAA;AAClF,OAAO,EAAE,WAAW,EAAE,gBAAgB,EAAE,MAAM,kBAAkB,CAAA;AAEhE;;;;;;GAMG;AACH,MAAM,MAAM,qBAAqB,GAAG,IAAI,CAAC,oBAAoB,EAAE,WAAW,GAAG,QAAQ,CAAC,CAAA;AAEtF;;;;;;;;;GASG;AACH,MAAM,WAAW,oBAAoB;IACnC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;IACxB,QAAQ,CAAC,MAAM,EAAE,aAAa,CAAC,aAAa,CAAC,CAAA;CAC9C;AAED;;;;;;GAMG;AACH,eAAO,MAAM,uBAAuB,QAAS,CAAA;AAE7C;;;;;GAKG;AACH,MAAM,WAAW,4BAA4B;IAC3C,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,qBAAqB,EAAE,WAAW,GAAG,SAAS,CAAC,CAAA;IACrE,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,4FAA4F;IAC5F,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC;;;OAGG;IACH,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,SAAS,CAAA;IACtD,sHAAsH;IACtH,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,GAAG,SAAS,CAAA;CAC1E;AAED;;;;;;GAMG;AACH,MAAM,WAAW,qBAAqB;IACpC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;IACtB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAA;CACzB;AAED;;;;;;GAMG;AACH,MAAM,WAAW,mCAAmC;IAClD,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAA;IACjC,QAAQ,CAAC,SAAS,EAAE,MAAM,CAAA;IAC1B,qGAAqG;IACrG,QAAQ,CAAC,OAAO,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IACrC,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAA;IACrB,QAAQ,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,CAAC,GAAG,SAAS,CAAA;IACtD,QAAQ,CAAC,KAAK,CAAC,EAAE,QAAQ,CAAC,QAAQ,CAAC,OAAO,EAAE,gBAAgB,CAAC,GAAG,SAAS,CAAA;CAC1E;;IAOC,yFAAyF;iCAC5D,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC;IACpE;;;OAGG;0BACmB,CAAC,MAAM,EAAE,qBAAqB,KAAK,MAAM,CAAC,MAAM,CAAC,aAAa,CAAC,aAAa,CAAC,EAAE,gBAAgB,CAAC;IACtH;;;OAGG;2BACoB,CACrB,OAAO,EAAE,4BAA4B,KAClC,MAAM,CAAC,MAAM,CAAC,oBAAoB,EAAE,gBAAgB,CAAC;IAC1D,oHAAoH;iCACvF,CAC3B,OAAO,EAAE;QAAE,QAAQ,CAAC,OAAO,EAAE,eAAe,CAAC;QAAC,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAA;KAAE,KACnE,MAAM,CAAC,MAAM,CAAC,MAAM,EAAE,gBAAgB,CAAC;IAC5C;;;OAGG;kCAC2B,CAC5B,OAAO,EAAE,mCAAmC,KACzC,MAAM,CAAC,MAAM,CAAC,qBAAqB,EAAE,gBAAgB,CAAC;;AA7B7D;;;GAGG;AACH,qBAAa,eAAgB,SAAQ,oBA0Bc;CAAG;AAEtD;;;;;GAKG;AACH,eAAO,MAAM,qBAAqB,EAAE,QAAQ,CAAC,QAA+B,CAAA;AAW5E;;;;;;;;;GASG;AACH,eAAO,MAAM,KAAK,aAAa;IAC7B,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3C,QAAQ,CAAC,aAAa,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;IAC3C,QAAQ,CAAC,SAAS,CAAC,EAAE,MAAM,GAAG,SAAS,CAAA;CACxC,KAAQ,KAAK,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,EAAE,WAAW,CA2HrD,CAAA;AAEH;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,WAAW,YACb,MAAM,CAAC,IAAI,CAAC,WAAW,CAAC,UAAU,CAAC,OAAO,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,KAC7D,KAAK,CAAC,KAAK,CAAC,eAAe,EAAE,MAAM,CAAC,WAAW,EAAE,WAAW,CACN,CAAA"}