@effectstream/node-sdk 0.100.15 → 0.100.17

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 (2) hide show
  1. package/README.md +22 -17
  2. package/package.json +15 -15
package/README.md CHANGED
@@ -5,6 +5,11 @@ An umbrella package that re-exports every EffectStream runtime piece
5
5
  schemas) under stable subpaths. Depend on this if you want a single
6
6
  name; import the underlying packages directly if you prefer.
7
7
 
8
+ - Umbrella package: every Effectstream node piece reachable from one dependency.
9
+ - Stable subpaths re-exporting the underlying packages (`/runtime`, `/sm`, `/db`, `/config`, ...).
10
+ - Depend on this if you want a single name; import the underlying packages directly if you prefer.
11
+ - Subpaths are thin re-exports, identical semantics to the source packages.
12
+
8
13
  ## Install
9
14
 
10
15
  ```bash
@@ -24,7 +29,7 @@ import { getConnection } from "@effectstream/node-sdk/db";
24
29
  import { ConfigBuilder, ConfigNetworkType } from "@effectstream/node-sdk/config";
25
30
  ```
26
31
 
27
- The subpaths are thin re-exports — semantics are identical to importing
32
+ The subpaths are thin re-exports - semantics are identical to importing
28
33
  from the underlying packages.
29
34
 
30
35
  ## Inside EffectStream
@@ -41,30 +46,30 @@ the corresponding package:
41
46
 
42
47
  ## Subpath exports
43
48
 
44
- - `@effectstream/node-sdk/runtime` — `init`, `start`, `StartConfig`, `DBMigrations`.
45
- - `@effectstream/node-sdk/sm` — `Stm`, state-machine types and helpers.
46
- - `@effectstream/node-sdk/sm/builtin` — built-in primitive type tags (ERC20, ERC721, ERC1155, Cardano transfer/mint-burn/pool-delegation, Midnight generic, NEAR, Avail, Celestia, …).
47
- - `@effectstream/node-sdk/sm/grammar` — concise/grammar parsing utilities.
48
- - `@effectstream/node-sdk/sync` — `genSyncProtocols`, per-chain fetcher classes.
49
- - `@effectstream/node-sdk/db` — `getConnection`, query helpers, snapshot utilities.
50
- - `@effectstream/node-sdk/db/start-pglite`, `./db/apply-migrations`, `./db/db-wait`, `./db/pgtyped-update`, `./db/version` — DB operations scripts.
51
- - `@effectstream/node-sdk/db-emulator` — in-memory test DB migration runner.
52
- - `@effectstream/node-sdk/event-server` — local MQTT broker.
53
- - `@effectstream/node-sdk/config` — `ConfigBuilder` and friends.
54
- - `@effectstream/node-sdk/chain-types`, `./precompile`, `./concise`, `./coroutine` — pass-throughs to the same-named SDK packages.
55
- - `@effectstream/node-sdk/utils`, `./utils/node-env`, `./utils/runtime` — utility helpers.
49
+ - `@effectstream/node-sdk/runtime`: `init`, `start`, `StartConfig`, `DBMigrations`.
50
+ - `@effectstream/node-sdk/sm`: `Stm` plus state-machine types and helpers.
51
+ - `@effectstream/node-sdk/sm/builtin` ships built-in primitive type tags (ERC20, ERC721, ERC1155, Cardano transfer/mint-burn/pool-delegation, Midnight generic, NEAR, Avail, Celestia, ...).
52
+ - `@effectstream/node-sdk/sm/grammar`: concise/grammar parsing utilities.
53
+ - `@effectstream/node-sdk/sync` - `genSyncProtocols` and per-chain fetcher classes.
54
+ - `@effectstream/node-sdk/db`: `getConnection`, query helpers, snapshot utilities.
55
+ - `@effectstream/node-sdk/db/start-pglite`, `./db/apply-migrations`, `./db/db-wait`, `./db/pgtyped-update`, `./db/version`: DB operations scripts.
56
+ - `@effectstream/node-sdk/db-emulator`: in-memory test DB migration runner.
57
+ - `@effectstream/node-sdk/event-server`: local MQTT broker.
58
+ - `@effectstream/node-sdk/config`: `ConfigBuilder` and friends.
59
+ - `@effectstream/node-sdk/chain-types`, `./precompile`, `./concise`, `./coroutine` are pass-throughs to the same-named SDK packages.
60
+ - `@effectstream/node-sdk/utils`, `./utils/node-env`, `./utils/runtime`: utility helpers.
56
61
 
57
62
  ## Examples
58
63
 
59
- Runnable: [`test/examples.test.ts`](./test/examples.test.ts) — verifies
64
+ Runnable: [`test/examples.test.ts`](./test/examples.test.ts) - verifies
60
65
  each subpath resolves.
61
66
 
62
67
  For full working nodes, see:
63
68
 
64
- - [`templates/minimal/`](https://github.com/PaimaStudios/paima-engine/tree/main/templates/minimal)
65
- - [`templates/dice/`](https://github.com/PaimaStudios/paima-engine/tree/main/templates/dice)
69
+ - [`templates/minimal/`](https://github.com/effectstream/effectstream/tree/main/templates/minimal)
70
+ - [`templates/dice/`](https://github.com/effectstream/effectstream/tree/main/templates/dice)
66
71
 
67
72
  ## Links
68
73
 
69
74
  - Docs: https://effectstream.github.io/docs/packages/node/node-sdk
70
- - Source: https://github.com/PaimaStudios/paima-engine/tree/main/packages/node-sdk/node
75
+ - Source: https://github.com/effectstream/effectstream/tree/main/packages/node-sdk/node
package/package.json CHANGED
@@ -1,15 +1,15 @@
1
1
  {
2
2
  "name": "@effectstream/node-sdk",
3
- "version": "0.100.15",
3
+ "version": "0.100.17",
4
4
  "license": "MIT",
5
5
  "homepage": "https://effectstream.github.io/docs/",
6
6
  "repository": {
7
7
  "type": "git",
8
- "url": "https://github.com/PaimaStudios/paima-engine",
8
+ "url": "https://github.com/effectstream/effectstream",
9
9
  "directory": "packages/node-sdk/node"
10
10
  },
11
11
  "bugs": {
12
- "url": "https://github.com/PaimaStudios/paima-engine/issues"
12
+ "url": "https://github.com/effectstream/effectstream/issues"
13
13
  },
14
14
  "exports": {
15
15
  ".": {
@@ -83,18 +83,18 @@
83
83
  }
84
84
  },
85
85
  "dependencies": {
86
- "@effectstream/runtime": "0.100.15",
87
- "@effectstream/sm": "0.100.15",
88
- "@effectstream/sync": "0.100.15",
89
- "@effectstream/db": "0.100.15",
90
- "@effectstream/db-emulator": "0.100.15",
91
- "@effectstream/coroutine": "0.100.15",
92
- "@effectstream/event-server": "0.100.15",
93
- "@effectstream/config": "0.100.15",
94
- "@effectstream/chain-types": "0.100.15",
95
- "@effectstream/precompile": "0.100.15",
96
- "@effectstream/utils": "0.100.15",
97
- "@effectstream/concise": "0.100.15"
86
+ "@effectstream/runtime": "0.100.17",
87
+ "@effectstream/sm": "0.100.17",
88
+ "@effectstream/sync": "0.100.17",
89
+ "@effectstream/db": "0.100.17",
90
+ "@effectstream/db-emulator": "0.100.17",
91
+ "@effectstream/coroutine": "0.100.17",
92
+ "@effectstream/event-server": "0.100.17",
93
+ "@effectstream/config": "0.100.17",
94
+ "@effectstream/chain-types": "0.100.17",
95
+ "@effectstream/precompile": "0.100.17",
96
+ "@effectstream/utils": "0.100.17",
97
+ "@effectstream/concise": "0.100.17"
98
98
  },
99
99
  "description": "Main application node SDK for EffectStream"
100
100
  }