@effectstream/midnight-contracts 0.103.0 → 0.103.1
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 -0
- package/package.json +2 -2
package/README.md
CHANGED
|
@@ -123,6 +123,21 @@ The circuit list is enumerated automatically from the contract's compiled `keys/
|
|
|
123
123
|
- `deployMidnightContractPhased(...)`: the phased deploy routine `deployMidnightContract` delegates to when `phasedVerifierKeys` is set. Exported for advanced callers that already have built providers and a wallet.
|
|
124
124
|
- `DeployConfig`, `NetworkUrls`: input types.
|
|
125
125
|
|
|
126
|
+
Wallet and dust helpers, exported from the package root:
|
|
127
|
+
|
|
128
|
+
- `buildWalletFacade(...)`: builds the wallet facade the deploy and batcher paths run on.
|
|
129
|
+
- `registerNightForDust(...)`, `getInitialDustState(...)`: register NIGHT to generate dust and read the starting state.
|
|
130
|
+
- `waitForDustFunds(wallet, opts)` / `waitForDustFundsWithRetry(...)`: block until a wallet has spendable dust — the step that makes a freshly funded wallet usable.
|
|
131
|
+
- `saveDustState(...)` / `loadDustState(...)`: persist and restore dust state across restarts, avoiding a re-sync.
|
|
132
|
+
- `resolveFacadeDustBalance(...)`: current dust balance for a facade.
|
|
133
|
+
|
|
134
|
+
Other subpaths:
|
|
135
|
+
|
|
136
|
+
- `@effectstream/midnight-contracts/wallet-info` - wallet inspection plus the dust-state persistence helpers above, and `resolveWalletSyncTimeoutMs()`.
|
|
137
|
+
- `@effectstream/midnight-contracts/midnight-env` - `midnightNetworkConfig` (the resolved `{ id, indexer, indexerWS, node, proofServer }` endpoints, env-overridable), `MidnightNetworkConfig`, and `isExternalProofServerConfigured`.
|
|
138
|
+
- `@effectstream/midnight-contracts/ledger-from-tx-state` - `midnightLedgerFromTxStateHex(...)` and the `MidnightLedgerFn` / `MidnightContractStateDeserializer` types, for decoding contract ledger state from a serialized transaction state.
|
|
139
|
+
- `@effectstream/midnight-contracts/types` - shared types.
|
|
140
|
+
|
|
126
141
|
## Examples
|
|
127
142
|
|
|
128
143
|
End-to-end usage in templates:
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@effectstream/midnight-contracts",
|
|
3
|
-
"version": "0.103.
|
|
3
|
+
"version": "0.103.1",
|
|
4
4
|
"license": "(MIT OR Apache-2.0)",
|
|
5
5
|
"homepage": "https://effectstream.github.io/docs/",
|
|
6
6
|
"repository": {
|
|
@@ -21,7 +21,7 @@
|
|
|
21
21
|
"./types": "./src/types.ts"
|
|
22
22
|
},
|
|
23
23
|
"dependencies": {
|
|
24
|
-
"@effectstream/utils": "0.103.
|
|
24
|
+
"@effectstream/utils": "0.103.1",
|
|
25
25
|
"@scure/bip39": "^2.0.1",
|
|
26
26
|
"dotenv": "^16.4.7",
|
|
27
27
|
"rxjs": "^7.8.2",
|