@effectstream/near-sandbox 0.100.14 → 0.100.16
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.
- package/README.md +46 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# @effectstream/near-sandbox
|
|
2
|
+
|
|
3
|
+
NPM wrapper around the
|
|
4
|
+
[NEAR sandbox](https://github.com/near/sandbox) binary — a single-node
|
|
5
|
+
NEAR chain for local development. Installs a pinned version into
|
|
6
|
+
`node_modules/.bin/near-sandbox` so the orchestrator can boot it
|
|
7
|
+
without each developer fetching it separately.
|
|
8
|
+
|
|
9
|
+
- Pinned NEAR sandbox binary, a single-node NEAR chain for local dev.
|
|
10
|
+
- `init` then `run`, both via `bunx`.
|
|
11
|
+
- Consumed by `@effectstream/sync`'s `NearFetcher`.
|
|
12
|
+
- Used by the orchestrator's NEAR step for end-to-end local testing.
|
|
13
|
+
|
|
14
|
+
## Install
|
|
15
|
+
|
|
16
|
+
```bash
|
|
17
|
+
bun add @effectstream/near-sandbox
|
|
18
|
+
# or
|
|
19
|
+
npm install @effectstream/near-sandbox
|
|
20
|
+
```
|
|
21
|
+
|
|
22
|
+
The package downloads the pinned tarball for your OS/arch on install.
|
|
23
|
+
|
|
24
|
+
## Standalone usage
|
|
25
|
+
|
|
26
|
+
```bash
|
|
27
|
+
# Initialise + start a local NEAR sandbox
|
|
28
|
+
bunx near-sandbox init
|
|
29
|
+
bunx near-sandbox run
|
|
30
|
+
|
|
31
|
+
# Or invoke through this package
|
|
32
|
+
bun run --bun @effectstream/near-sandbox/start -- run
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## Inside EffectStream
|
|
36
|
+
|
|
37
|
+
The orchestrator's NEAR step starts the sandbox alongside the
|
|
38
|
+
EffectStream sync layer for end-to-end local testing of NEAR-side
|
|
39
|
+
integrations. On the runtime side, `@effectstream/sync`'s `NearFetcher`
|
|
40
|
+
consumes the sandbox's RPC.
|
|
41
|
+
|
|
42
|
+
## Links
|
|
43
|
+
|
|
44
|
+
- Docs: https://effectstream.github.io/docs/packages/binaries/near-sandbox
|
|
45
|
+
- Source: https://github.com/effectstream/effectstream/tree/main/packages/binaries/near-sandbox
|
|
46
|
+
- Upstream NEAR sandbox: https://github.com/near/sandbox
|