@effectstream/ord 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 +45 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,45 @@
|
|
|
1
|
+
# @effectstream/ord
|
|
2
|
+
|
|
3
|
+
A pinned [`ord`](https://github.com/ordinals/ord) binary, packaged for
|
|
4
|
+
npm. Installing this drops a versioned `ord` CLI into
|
|
5
|
+
`node_modules/.bin` for EffectStream's Bitcoin / Ordinals dev workflows.
|
|
6
|
+
|
|
7
|
+
- Pinned `ord` CLI for Bitcoin / Ordinals dev workflows.
|
|
8
|
+
- Pairs with `@effectstream/bitcoin-core` for an `ord`-indexed view of local regtest.
|
|
9
|
+
- Linux / macOS, x64 and arm64.
|
|
10
|
+
- Used by Ordinals-aware templates and E2E tests.
|
|
11
|
+
|
|
12
|
+
## Install
|
|
13
|
+
|
|
14
|
+
```bash
|
|
15
|
+
bun add @effectstream/ord
|
|
16
|
+
# or
|
|
17
|
+
npm install @effectstream/ord
|
|
18
|
+
```
|
|
19
|
+
|
|
20
|
+
## Standalone usage
|
|
21
|
+
|
|
22
|
+
Once installed:
|
|
23
|
+
|
|
24
|
+
```bash
|
|
25
|
+
# Inspect an inscription via the bundled binary
|
|
26
|
+
bunx ord --regtest server --help
|
|
27
|
+
|
|
28
|
+
# Or invoke through this package
|
|
29
|
+
bun run --bun @effectstream/ord/start -- --regtest server
|
|
30
|
+
```
|
|
31
|
+
|
|
32
|
+
The package downloads the pinned tarball for your platform on first
|
|
33
|
+
invocation.
|
|
34
|
+
|
|
35
|
+
## Inside EffectStream
|
|
36
|
+
|
|
37
|
+
The Bitcoin orchestrator step pairs this with `@effectstream/bitcoin-core`
|
|
38
|
+
to expose an `ord`-indexed view of the local regtest chain, used by
|
|
39
|
+
Ordinals-aware templates and E2E tests.
|
|
40
|
+
|
|
41
|
+
## Links
|
|
42
|
+
|
|
43
|
+
- Docs: https://effectstream.github.io/docs/packages/binaries/ord
|
|
44
|
+
- Source: https://github.com/effectstream/effectstream/tree/main/packages/binaries/ord
|
|
45
|
+
- Upstream `ord`: https://github.com/ordinals/ord
|