@effectstream/utils 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.
- package/README.md +15 -10
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
# @effectstream/utils
|
|
2
2
|
|
|
3
|
-
Shared utilities for the EffectStream framework
|
|
3
|
+
Shared utilities for the EffectStream framework - chain-aware address
|
|
4
4
|
types and validators, TypeBox schemas, Effection-based concurrency
|
|
5
5
|
primitives, viem helpers, and small type-level utilities. No runtime
|
|
6
6
|
dependency on the rest of EffectStream; safe to use standalone in any
|
|
@@ -10,6 +10,11 @@ This is the bottom-of-stack package: `@effectstream/crypto`,
|
|
|
10
10
|
`@effectstream/concise`, `@effectstream/wallets`, and most node packages
|
|
11
11
|
depend on it.
|
|
12
12
|
|
|
13
|
+
- Shared chain-aware types, TypeBox schemas, viem helpers, Effection primitives.
|
|
14
|
+
- Bottom-of-stack: `crypto`, `concise`, `wallets`, and most node packages depend on it.
|
|
15
|
+
- Safe to use standalone, no runtime dependency on the rest of Effectstream.
|
|
16
|
+
- `AddressType` is the most-imported symbol from the package (~170 cross-package references).
|
|
17
|
+
|
|
13
18
|
## Install
|
|
14
19
|
|
|
15
20
|
```bash
|
|
@@ -54,13 +59,13 @@ state machine, and the batcher pulls something from here.
|
|
|
54
59
|
|
|
55
60
|
Address types and validators:
|
|
56
61
|
|
|
57
|
-
- `AddressType`
|
|
58
|
-
- `AddressValidator`
|
|
59
|
-
- `AddressAndType`
|
|
62
|
+
- `AddressType` - enum of chain identifiers (EVM, CARDANO, SUBSTRATE, ALGORAND, MINA, MIDNIGHT, AVAIL, POLKADOT, NEAR).
|
|
63
|
+
- `AddressValidator` - `Record<AddressType, TSchema>` of TypeBox validators, one per chain.
|
|
64
|
+
- `AddressAndType` - tagged-union shape for `{ type, address }` pairs.
|
|
60
65
|
|
|
61
66
|
TypeBox schemas:
|
|
62
67
|
|
|
63
|
-
- `TypeboxHelpers.{Evm,Cardano,Substrate,Algorand,Mina,Midnight,Avail,Polkadot,Near}`
|
|
68
|
+
- `TypeboxHelpers.{Evm,Cardano,Substrate,Algorand,Mina,Midnight,Avail,Polkadot,Near}` - `.Address`, `.BlockHash`, `.TxHash`, `.Signature`, `.PrivateKey`, plus chain-specific extras (`PolicyId`, `AssetName`, `Selector`, …).
|
|
64
69
|
- Plain primitives: `TypeboxHelpers.Uint256`, `BlockNumber`, `AbsoluteSlotNumber`, `EpochNumber`.
|
|
65
70
|
|
|
66
71
|
Type aliases (heavily imported as nominal types):
|
|
@@ -78,7 +83,7 @@ Result + binary helpers:
|
|
|
78
83
|
|
|
79
84
|
Decorators:
|
|
80
85
|
|
|
81
|
-
- `bound`
|
|
86
|
+
- `bound` - method-binding decorator (heavily used in classes that pass methods around).
|
|
82
87
|
|
|
83
88
|
Viem helpers:
|
|
84
89
|
|
|
@@ -90,9 +95,9 @@ Concurrency (Effection-based):
|
|
|
90
95
|
|
|
91
96
|
Subpath entries:
|
|
92
97
|
|
|
93
|
-
- `@effectstream/utils/node-env`
|
|
94
|
-
- `@effectstream/utils/runtime`
|
|
95
|
-
- `@effectstream/utils/runtime-spawn`
|
|
98
|
+
- `@effectstream/utils/node-env` - `dotenv`-aware env loader, for Node-only callers.
|
|
99
|
+
- `@effectstream/utils/runtime` - Effection runtime helpers.
|
|
100
|
+
- `@effectstream/utils/runtime-spawn` - child-process spawn helpers built on Effection.
|
|
96
101
|
|
|
97
102
|
## Examples
|
|
98
103
|
|
|
@@ -104,4 +109,4 @@ Runnable: [`src/binary-search.test.ts`](./src/binary-search.test.ts),
|
|
|
104
109
|
## Links
|
|
105
110
|
|
|
106
111
|
- Docs: https://effectstream.github.io/docs/packages/sdk/utils
|
|
107
|
-
- Source: https://github.com/
|
|
112
|
+
- Source: https://github.com/effectstream/effectstream/tree/main/packages/effectstream-sdk/utils
|
package/package.json
CHANGED
|
@@ -1,15 +1,15 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@effectstream/utils",
|
|
3
|
-
"version": "0.100.
|
|
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/
|
|
8
|
+
"url": "https://github.com/effectstream/effectstream",
|
|
9
9
|
"directory": "packages/effectstream-sdk/utils"
|
|
10
10
|
},
|
|
11
11
|
"bugs": {
|
|
12
|
-
"url": "https://github.com/
|
|
12
|
+
"url": "https://github.com/effectstream/effectstream/issues"
|
|
13
13
|
},
|
|
14
14
|
"exports": {
|
|
15
15
|
".": "./src/mod.ts",
|