@ninsei-labs/sdk 0.58.0 → 0.59.0
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/CHANGELOG.md +6 -0
- package/README.md +37 -24
- package/THIRD_PARTY_NOTICES.md +7 -4
- package/assets/vendors/MANIFEST.json +1 -1
- package/assets/vendors/sdk/sdk-browser.js +4 -6
- package/engine/core/config.js +2 -2
- package/engine/core/deployments.generated.js +33 -0
- package/engine/monero/scan.js +56 -8
- package/index.d.ts +84 -25
- package/package.json +4 -4
- package/src/index.mjs +3 -3
- package/src/public/networks.d.ts +9 -0
- package/src/public/networks.mjs +1 -0
- package/src/public/xmr.d.ts +8 -0
- package/src/public/xmr.mjs +1 -1
- package/src/quotePolicy.mjs +44 -11
- package/src/quotes.mjs +18 -11
- package/src/record.mjs +4 -0
- package/src/swaps.mjs +292 -73
- package/src/version.mjs +1 -1
- package/src/witness-slice.mjs +84 -0
- package/src/xmr-arrival.mjs +221 -120
package/CHANGELOG.md
CHANGED
|
@@ -1,3 +1,9 @@
|
|
|
1
|
+
## 0.59.0 — 2026-11-11
|
|
2
|
+
|
|
3
|
+
- `FACTORY_HISTORY` is generated from the reviewed deployment manifests and `deployments/history/<vm>/<network>.json`. It lists the current factory as `live` and older factories as `retired`, each with its deployment block and release tag, so a recovery page can find old orders without a second hand-written address table.
|
|
4
|
+
- The deployment pin check is part of the full `pnpm run check` battery; it verifies the generated pins, the current `CHAINS`/`KNOWN_FACTORY_CODES` values, and the order and uniqueness of the factory history.
|
|
5
|
+
- The EVM deployment history for `arbitrum-sepolia` carries the two factories before `contracts-testnet-2026.11.04`; the current factory comes from the reviewed manifest.
|
|
6
|
+
|
|
1
7
|
## 0.58.0 — 2026-11-10
|
|
2
8
|
|
|
3
9
|
- `swaps.verifyArrivalShadow` runs the exact arrival walk and the fixed-slice witness-v1 walk side by side. The witness request carries only `{version, network, grid, slice}` (20 blocks aligned to multiples of 20), never the start height, payout block, txid or order id; a node without `protocol: "witness-v1"` is refused rather than guessed. The exact verdict still decides, so this is the staging path before an independent operator serves the protocol.
|
package/README.md
CHANGED
|
@@ -22,7 +22,7 @@ Report suspected vulnerabilities through GitHub's private **Report a vulnerabili
|
|
|
22
22
|
The supported versions, scope, response targets, safe-harbor rules and disclosure process are in
|
|
23
23
|
[`SECURITY.md`](SECURITY.md).
|
|
24
24
|
|
|
25
|
-
## State (0.
|
|
25
|
+
## State (0.59.0)
|
|
26
26
|
|
|
27
27
|
| Surface | State |
|
|
28
28
|
|---|---|
|
|
@@ -36,7 +36,7 @@ The supported versions, scope, response targets, safe-harbor rules and disclosur
|
|
|
36
36
|
| `swaps.start` | holds the order: guards → recovery file and the person's confirmation → order → locking funds → **watching the Monero address**; no backend is required; returns the named state `step: "xmr-incoming"` |
|
|
37
37
|
| `swaps.watch` | waits for XMR at the joint address with the CLIENT's own check: `verify` carries the joint address, view secret, spend public key and witness nodes. Arrived — returns the fact (amount, confirmations, txid); did not wait — a refusal with `xmr-timeout`; funds barred by `unlock_time` — `xmr-locked`; the maker DECLINED — `SwapDeclinedWatch` (`declined: true`, `terminal: "declined"`), every action off; with expectations and a wallet, places the ready mark after the arrival |
|
|
38
38
|
| `swaps.verifyArrivalShadow` | the staging path for witness-v1: runs the exact walk and the fixed-slice walk side by side, without changing ready or refund. The slice request carries only the grid and slice; a node must name `protocol: "witness-v1"` |
|
|
39
|
-
| `swaps.startSell` / `swaps.sellClaim` / `swaps.claimViaRelay` | a sell is recorded from the verified relay offer; `sellClaim` claims from the claimer's own wallet, `claimViaRelay` claims with no wallet through the
|
|
39
|
+
| `swaps.startSell` / `swaps.sellClaim` / `swaps.claimViaRelay` | a sell is recorded from the verified relay offer; `sellClaim` claims from the claimer's own wallet, `claimViaRelay` claims with no wallet through the client's ordered sender list, paid by the signed `claimTip` |
|
|
40
40
|
| `wallet.balances` | works: the native coin and tokens, in minimal units |
|
|
41
41
|
|
|
42
42
|
What is not ready names itself with the code `not-implemented` with the fields `surface` and `stage`: an empty
|
|
@@ -155,9 +155,9 @@ interface's: this package holds no user-facing string.
|
|
|
155
155
|
### Errors (`error.code`, `SdkError.code`)
|
|
156
156
|
|
|
157
157
|
`not-implemented`, `bad-input`, `wallet-not-connected`, `wallet-rejected`, `wrong-chain`, `quote-unavailable`,
|
|
158
|
-
`quote-refused`, `
|
|
159
|
-
`
|
|
160
|
-
`insufficient-funds`, `unknown`.
|
|
158
|
+
`quote-refused`, `quote-too-short`, `quote-expired`, `address-denied`, `quote-stale`, `recovery-declined`,
|
|
159
|
+
`recovery-failed`, `storage-unavailable`, `xmr-address-mismatch`, `server-unavailable`, `server-refused`,
|
|
160
|
+
`claim-unknown`, `xmr-timeout`, `xmr-locked`, `contract-reverted`, `insufficient-funds`, `unknown`.
|
|
161
161
|
|
|
162
162
|
Three refusals that are easy to merge into one are named DIFFERENTLY, because the advice differs:
|
|
163
163
|
`server-unavailable` — the service did not answer (retry); `server-refused` — it answered and did not accept (its
|
|
@@ -179,9 +179,15 @@ in the package; a host that needs an indicative book keeps it in the host.
|
|
|
179
179
|
```js
|
|
180
180
|
const offer = await sdk.quotes.firmRelay({ relayUrl, features, order, side: "ask", recoveryKey, xmrAmount });
|
|
181
181
|
offer.orderQuote; // the signed quote the factory takes
|
|
182
|
-
offer.startRequest; // quote, order, orderQuote, counterparty
|
|
182
|
+
offer.startRequest; // quote, order, orderQuote, counterparty, recovery salt and predicted escrow for swaps.start
|
|
183
183
|
```
|
|
184
184
|
|
|
185
|
+
A buy quote must keep `LOCK_START_MARGIN_SEC` (30 s) plus `START_PREP_SEC` (15 s) after the relay answer has been
|
|
186
|
+
verified. `quotes.firmRelay` refuses a shorter one with `quote-too-short` before a confirmation is shown, and returns
|
|
187
|
+
`remainingSec` / `confirmBySec` so the host can show the time left and disable its button. A bid quote is checked only
|
|
188
|
+
for its own expiry: the node has already funded the escrow and the client opens no wallet. The lock step then checks only
|
|
189
|
+
the 30 s margin: the preparation was already spent between the answer and the send.
|
|
190
|
+
|
|
185
191
|
## Selling and claiming
|
|
186
192
|
|
|
187
193
|
A bid is a sale of XMR. `quotes.firmRelay({ side: "bid", claimTip, ... })` returns the signed quote, the escrow,
|
|
@@ -203,23 +209,29 @@ relay submits the half and is paid from the claim itself. No wallet is created o
|
|
|
203
209
|
signed by the client:
|
|
204
210
|
|
|
205
211
|
```js
|
|
206
|
-
const sell = await sdk.swaps.startSell({ offer
|
|
207
|
-
const claimed = await sdk.swaps.claimViaRelay({ id: sell.id
|
|
208
|
-
|
|
209
|
-
claimed.
|
|
210
|
-
claimed.
|
|
212
|
+
const sell = await sdk.swaps.startSell({ offer });
|
|
213
|
+
const claimed = await sdk.swaps.claimViaRelay({ id: sell.id,
|
|
214
|
+
claimSenders: [relaySender, ...otherListedMakers] });
|
|
215
|
+
if (claimed.state === "claimed") {
|
|
216
|
+
claimed.txid; // the claim transaction, or null when the escrow itself showed claimed
|
|
217
|
+
claimed.from; // the sender node's claim sender
|
|
218
|
+
claimed.tipWei; // the signed tip paid out of the claim
|
|
219
|
+
} else {
|
|
220
|
+
claimed.secondsLeft; // no sender landed it: claim yourself before t1
|
|
221
|
+
}
|
|
211
222
|
```
|
|
212
223
|
|
|
213
|
-
`
|
|
214
|
-
|
|
215
|
-
|
|
216
|
-
|
|
224
|
+
`claimSenders` is the client's ordered list: the relay's own sender first, then other listed makers. The SDK tries
|
|
225
|
+
one sender at a time for a 15-30 s slot. A refusal moves on at once; a txid is not success - the SDK reads the
|
|
226
|
+
escrow until it says `claimed` or the slot ends. The deal's maker and its quote-key owner are refused before the
|
|
227
|
+
half leaves the client. When the list is exhausted the result is `state: "claim-yourself"` with `t1` and
|
|
228
|
+
`secondsLeft`. The old scalar `claimSender` remains a one-element fallback for callers written before the list.
|
|
217
229
|
|
|
218
|
-
`claimViaRelay` reads the sell record made by `startSell` and requires a positive `claimTip`, the
|
|
219
|
-
|
|
220
|
-
|
|
221
|
-
|
|
222
|
-
|
|
230
|
+
`claimViaRelay` reads the sell record made by `startSell` and requires a positive `claimTip`, the escrow and the
|
|
231
|
+
half. It posts to the relay origin stored with the record; an optional `relayUrl` may repeat that origin but a
|
|
232
|
+
different one is refused. A node refusal keeps its code under `quote-refused.params.code`. A timeout or a body
|
|
233
|
+
without a real transaction hash is `claim-unknown`: the claim may have been sent, so the SDK reads the escrow and
|
|
234
|
+
moves on only after the slot. Only an escrow that reads `claimed` is success.
|
|
223
235
|
|
|
224
236
|
`actions.claim` is unchanged: it still sends only from the claimer's own wallet, because the half is revealed by
|
|
225
237
|
whoever sends the claim.
|
|
@@ -301,10 +313,11 @@ receipt, a receipt without `OrderCreated`, or an event from another factory is `
|
|
|
301
313
|
hash, and `swaps.start` does not save an escrow or retire a recovery number in that state.
|
|
302
314
|
|
|
303
315
|
The predicted escrow and its salt are written to the pending record before the funding transaction is sent. A retry
|
|
304
|
-
after a late receipt or a process restart finds that record by
|
|
305
|
-
does not build a second side or send a second deposit. An explicit wallet
|
|
306
|
-
person can sign again. A transaction that was already mined is stopped by
|
|
307
|
-
mempool can make the resend revert and cost gas, but cannot create a second
|
|
316
|
+
after a late receipt or a process restart finds that record by the salt, the chain, the factory and the predicted
|
|
317
|
+
escrow, and reads the same transaction; it does not build a second side or send a second deposit. An explicit wallet
|
|
318
|
+
rejection clears the pending mark so the person can sign again. A transaction that was already mined is stopped by
|
|
319
|
+
the escrow state guard; one still in the mempool can make the resend revert and cost gas, but cannot create a second
|
|
320
|
+
deposit.
|
|
308
321
|
|
|
309
322
|
The wallet adapter accepts the standard Monero network names (`mainnet`, `stagenet`, `testnet`, `fakechain`) and
|
|
310
323
|
still checks the address shape, so a mainnet withdrawal is not refused because the demo registry lists only
|
package/THIRD_PARTY_NOTICES.md
CHANGED
|
@@ -6,7 +6,7 @@ It is generated from the installed production tree; do not edit it by hand.
|
|
|
6
6
|
Generated by `tools/third-party-notices.mjs`. Licences accepted by the project are listed in
|
|
7
7
|
[LICENSE-POLICY.md](LICENSE-POLICY.md).
|
|
8
8
|
|
|
9
|
-
## @hpke/chacha20poly1305 1.8.
|
|
9
|
+
## @hpke/chacha20poly1305 1.8.1
|
|
10
10
|
|
|
11
11
|
License: MIT
|
|
12
12
|
Source: git+https://github.com/dajiaji/hpke-js.git
|
|
@@ -17,6 +17,8 @@ Source: git+https://github.com/dajiaji/hpke-js.git
|
|
|
17
17
|
MIT License
|
|
18
18
|
|
|
19
19
|
Copyright (c) 2023 Ajitomi Daisuke
|
|
20
|
+
Copyright (c) 2022 Paul Miller (https://paulmillr.com)
|
|
21
|
+
Copyright (c) 2016 Thomas Pornin <pornin@bolet.org>
|
|
20
22
|
|
|
21
23
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
22
24
|
of this software and associated documentation files (the "Software"), to deal
|
|
@@ -37,7 +39,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
37
39
|
SOFTWARE.
|
|
38
40
|
```
|
|
39
41
|
|
|
40
|
-
## @hpke/common 1.
|
|
42
|
+
## @hpke/common 1.13.0
|
|
41
43
|
|
|
42
44
|
License: MIT
|
|
43
45
|
Source: git+https://github.com/dajiaji/hpke-js.git
|
|
@@ -68,7 +70,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
68
70
|
SOFTWARE.
|
|
69
71
|
```
|
|
70
72
|
|
|
71
|
-
## @hpke/core 1.10.
|
|
73
|
+
## @hpke/core 1.10.1
|
|
72
74
|
|
|
73
75
|
License: MIT
|
|
74
76
|
Source: git+https://github.com/dajiaji/hpke-js.git
|
|
@@ -99,7 +101,7 @@ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
|
|
|
99
101
|
SOFTWARE.
|
|
100
102
|
```
|
|
101
103
|
|
|
102
|
-
## @hpke/dhkem-x25519 1.8.
|
|
104
|
+
## @hpke/dhkem-x25519 1.8.1
|
|
103
105
|
|
|
104
106
|
License: MIT
|
|
105
107
|
Source: git+https://github.com/dajiaji/hpke-js.git
|
|
@@ -110,6 +112,7 @@ Source: git+https://github.com/dajiaji/hpke-js.git
|
|
|
110
112
|
MIT License
|
|
111
113
|
|
|
112
114
|
Copyright (c) 2023 Ajitomi Daisuke
|
|
115
|
+
Copyright (c) 2022 Paul Miller (https://paulmillr.com)
|
|
113
116
|
|
|
114
117
|
Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
115
118
|
of this software and associated documentation files (the "Software"), to deal
|
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"note": "Pinned browser bundles. A change to one of these files must be accompanied by a matching SHA-256 here and a rebuild of the page's asset registry.",
|
|
4
4
|
"bundles": {
|
|
5
5
|
"sdk/sdk-browser.js": {
|
|
6
|
-
"sha256": "
|
|
6
|
+
"sha256": "563587be187b41651725d0192234b0341ad6d183f23c7e3aac92487360f44a6e",
|
|
7
7
|
"source": "sdk/src (facade, adapters, recovery)"
|
|
8
8
|
}
|
|
9
9
|
}
|