@effectstream/avail-contracts 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 +48 -0
- package/package.json +1 -1
package/README.md
ADDED
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
# @effectstream/avail-contracts
|
|
2
|
+
|
|
3
|
+
Contract-interface package for Avail (data-availability layer) inside
|
|
4
|
+
EffectStream. Reserved as the home for Avail-side bindings, helpers, and
|
|
5
|
+
deployment scripts that an EffectStream app might use when posting data
|
|
6
|
+
blobs to or syncing rollup inputs from Avail.
|
|
7
|
+
|
|
8
|
+
- Reserved namespace for Avail-side bindings, helpers, and deployment scripts.
|
|
9
|
+
- Ships intentionally empty today: `mod.ts` re-exports nothing.
|
|
10
|
+
- Mirrors the per-chain "contracts" slot used by EVM, Midnight, Cardano, Bitcoin.
|
|
11
|
+
- For sync-side Avail support today, see `@effectstream/sync` and the Avail binary wrappers.
|
|
12
|
+
|
|
13
|
+
## Install
|
|
14
|
+
|
|
15
|
+
```bash
|
|
16
|
+
bun add @effectstream/avail-contracts
|
|
17
|
+
# or
|
|
18
|
+
npm install @effectstream/avail-contracts
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
## Standalone usage
|
|
22
|
+
|
|
23
|
+
This package is intentionally empty today. It ships so that `@effectstream/sync` and `@effectstream/orchestrator` can declare a stable dependency on the Avail integration namespace; concrete exports (message-encoding helpers, address utilities) land here as the Avail integration grows.
|
|
24
|
+
|
|
25
|
+
For sync-side Avail support today, see:
|
|
26
|
+
|
|
27
|
+
- `@effectstream/sync` — `AvailFetcher`, `AvailSyncState`.
|
|
28
|
+
- `@effectstream/npm-avail-node`, `@effectstream/npm-avail-light-client` — pinned binary wrappers.
|
|
29
|
+
- [`e2e/avail/`](https://github.com/effectstream/effectstream/tree/main/e2e/avail) — Avail-side E2E suite.
|
|
30
|
+
|
|
31
|
+
## Inside EffectStream
|
|
32
|
+
|
|
33
|
+
The package's role inside the framework is the per-chain "contracts"
|
|
34
|
+
slot, mirroring the structure already used by `@effectstream/evm-contracts`,
|
|
35
|
+
`@effectstream/midnight-contracts`, `@effectstream/cardano-contracts`,
|
|
36
|
+
and `@effectstream/bitcoin-contracts`.
|
|
37
|
+
|
|
38
|
+
## Key exports
|
|
39
|
+
|
|
40
|
+
None at present — the module currently re-exports nothing. Watch the
|
|
41
|
+
`mod.ts` for future entry points, or open an issue if you need a specific
|
|
42
|
+
helper.
|
|
43
|
+
|
|
44
|
+
## Links
|
|
45
|
+
|
|
46
|
+
- Docs: https://effectstream.github.io/docs/packages/chains/avail-contracts
|
|
47
|
+
- Source: https://github.com/effectstream/effectstream/tree/main/packages/chains/avail-contracts
|
|
48
|
+
- Avail docs: https://docs.availproject.org/
|