@xyo-network/xl1-react-client-sdk 5.5.4 → 5.6.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/README.md +8 -0
- package/dist/browser/client/components/connected/ApprovedLakeSelector.d.ts.map +1 -1
- package/dist/browser/client/components/connected/RequestPermissionsButton.d.ts.map +1 -1
- package/dist/browser/client/context/in-page/Provider.d.ts +3 -0
- package/dist/browser/client/context/in-page/Provider.d.ts.map +1 -1
- package/dist/browser/client/context/in-page/lib/buildGateway.d.ts +1 -1
- package/dist/browser/client/hooks/helpers/getXyoClient.d.ts +5 -5
- package/dist/browser/client/hooks/helpers/getXyoClient.d.ts.map +1 -1
- package/dist/browser/client/index.mjs +53 -17
- package/dist/browser/client/index.mjs.map +2 -2
- package/dist/browser/index.mjs +53 -17
- package/dist/browser/index.mjs.map +2 -2
- package/package.json +31 -31
package/README.md
CHANGED
|
@@ -78,6 +78,14 @@ For read-only dApps that should work before wallet connection, mount
|
|
|
78
78
|
on React cleanup or `pagehide`; wallet gateways still take precedence when
|
|
79
79
|
connected.
|
|
80
80
|
|
|
81
|
+
Wallet discovery is bounded platform activity. `listenForClientInjection`
|
|
82
|
+
returns an idempotent disposer and removes its listener and timeout before a
|
|
83
|
+
success or timeout callback. `getXyoClient(timeout, signal)` accepts optional
|
|
84
|
+
cancellation; abort releases discovery resources and rejects with the error
|
|
85
|
+
reason (a non-Error reason is retained as the cause of an AbortError). `useClientFromWallet` owns that cancellation and its separate late
|
|
86
|
+
injection listener until unmount. Discovery only observes the injected client;
|
|
87
|
+
it does not request permissions or sign actions.
|
|
88
|
+
|
|
81
89
|
## Documentation
|
|
82
90
|
|
|
83
91
|
Public subpaths:
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"ApprovedLakeSelector.d.ts","sourceRoot":"","sources":["../../../../../src/client/components/connected/ApprovedLakeSelector.tsx"],"names":[],"mappings":"AAMA,OAAO,KAEN,MAAM,OAAO,CAAA;AAKd,8DAA8D;AAC9D,MAAM,WAAW,yBAAyB;IACxC,gGAAgG;IAChG,UAAU,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAC/B,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gEAAgE;IAChE,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IAC9B,+EAA+E;IAC/E,UAAU,EAAE,MAAM,CAAA;IAClB,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,EAAE,KAAK,CAAC,EAAE,CAAC,yBAAyB,
|
|
1
|
+
{"version":3,"file":"ApprovedLakeSelector.d.ts","sourceRoot":"","sources":["../../../../../src/client/components/connected/ApprovedLakeSelector.tsx"],"names":[],"mappings":"AAMA,OAAO,KAEN,MAAM,OAAO,CAAA;AAKd,8DAA8D;AAC9D,MAAM,WAAW,yBAAyB;IACxC,gGAAgG;IAChG,UAAU,EAAE,QAAQ,GAAG,QAAQ,CAAA;IAC/B,sCAAsC;IACtC,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,gEAAgE;IAChE,QAAQ,EAAE,CAAC,EAAE,EAAE,MAAM,KAAK,IAAI,CAAA;IAC9B,+EAA+E;IAC/E,UAAU,EAAE,MAAM,CAAA;IAClB,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;GASG;AACH,eAAO,MAAM,oBAAoB,EAAE,KAAK,CAAC,EAAE,CAAC,yBAAyB,CA+GpE,CAAA"}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"RequestPermissionsButton.d.ts","sourceRoot":"","sources":["../../../../../src/client/components/connected/RequestPermissionsButton.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE/C,OAAO,KAAK,EAAqB,iBAAiB,EAAE,MAAM,wCAAwC,CAAA;AAClG,OAAO,KAEN,MAAM,OAAO,CAAA;AAMd,kEAAkE;AAClE,MAAM,WAAW,6BAA8B,SAAQ,UAAU;IAC/D,iDAAiD;IACjD,WAAW,EAAE,iBAAiB,EAAE,CAAA;IAChC,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,wBAAwB,EAAE,KAAK,CAAC,EAAE,CAAC,6BAA6B,
|
|
1
|
+
{"version":3,"file":"RequestPermissionsButton.d.ts","sourceRoot":"","sources":["../../../../../src/client/components/connected/RequestPermissionsButton.tsx"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,eAAe,CAAA;AAE/C,OAAO,KAAK,EAAqB,iBAAiB,EAAE,MAAM,wCAAwC,CAAA;AAClG,OAAO,KAEN,MAAM,OAAO,CAAA;AAMd,kEAAkE;AAClE,MAAM,WAAW,6BAA8B,SAAQ,UAAU;IAC/D,iDAAiD;IACjD,WAAW,EAAE,iBAAiB,EAAE,CAAA;IAChC,sEAAsE;IACtE,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;;;;;;;;;;;;;;;;;;;;GAsBG;AACH,eAAO,MAAM,wBAAwB,EAAE,KAAK,CAAC,EAAE,CAAC,6BAA6B,CAgH5E,CAAA"}
|
|
@@ -50,6 +50,9 @@ export interface InPageGatewaysProviderProps extends PropsWithChildren {
|
|
|
50
50
|
* - Every gateway is resolved once through browser-kit and shares one
|
|
51
51
|
* immutable provider graph with its XL1 system actor. The page owns each
|
|
52
52
|
* session until React cleanup or `pagehide`.
|
|
53
|
+
* - When a page returns from the back/forward cache (`pageshow` with
|
|
54
|
+
* `persisted`), the stopped systems are replaced: the provider clears
|
|
55
|
+
* both maps and relaunches every network.
|
|
53
56
|
* - When `signerTransport` changes identity mid-life, the provider clears
|
|
54
57
|
* all cached gateways and errors synchronously during render (via
|
|
55
58
|
* `previousSignerTransport` state) so consumers never see gateways
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"Provider.d.ts","sourceRoot":"","sources":["../../../../../src/client/context/in-page/Provider.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,KAAK,EACV,wBAAwB,EACX,YAAY,EAAE,mBAAmB,EAC/C,MAAM,sBAAsB,CAAA;AAE7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAA;AAC9C,OAAO,KAGN,MAAM,OAAO,CAAA;AAKd,OAAO,EACL,KAAK,gBAAgB,EAGtB,MAAM,gBAAgB,CAAA;AAKvB,iEAAiE;AACjE,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IAEpE,kGAAkG;IAClG,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,4FAA4F;IAC5F,aAAa,CAAC,EAAE,eAAe,CAAA;IAE/B,mEAAmE;IACnE,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC,gFAAgF;IAChF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB,4DAA4D;IAC5D,eAAe,CAAC,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAAA;IAEnD,qFAAqF;IACrF,SAAS,CAAC,EAAE,gBAAgB,CAAA;CAC7B;AAED
|
|
1
|
+
{"version":3,"file":"Provider.d.ts","sourceRoot":"","sources":["../../../../../src/client/context/in-page/Provider.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,eAAe,EAAE,MAAM,kBAAkB,CAAA;AACvD,OAAO,KAAK,EACV,wBAAwB,EACX,YAAY,EAAE,mBAAmB,EAC/C,MAAM,sBAAsB,CAAA;AAE7B,OAAO,KAAK,EAAE,iBAAiB,EAAE,MAAM,OAAO,CAAA;AAC9C,OAAO,KAGN,MAAM,OAAO,CAAA;AAKd,OAAO,EACL,KAAK,gBAAgB,EAGtB,MAAM,gBAAgB,CAAA;AAKvB,iEAAiE;AACjE,MAAM,WAAW,2BAA4B,SAAQ,iBAAiB;IAEpE,kGAAkG;IAClG,aAAa,CAAC,EAAE,MAAM,CAAA;IAEtB,4FAA4F;IAC5F,aAAa,CAAC,EAAE,eAAe,CAAA;IAE/B,mEAAmE;IACnE,aAAa,CAAC,EAAE,wBAAwB,CAAA;IACxC,gFAAgF;IAChF,gBAAgB,CAAC,EAAE,MAAM,CAAA;IAEzB,4DAA4D;IAC5D,eAAe,CAAC,EAAE,YAAY,CAAC,mBAAmB,CAAC,CAAA;IAEnD,qFAAqF;IACrF,SAAS,CAAC,EAAE,gBAAgB,CAAA;CAC7B;AAED;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GA0DG;AACH,eAAO,MAAM,sBAAsB,EAAE,KAAK,CAAC,EAAE,CAAC,2BAA2B,CAkHxE,CAAA"}
|
|
@@ -13,7 +13,7 @@ export type GatewayTransport = 'rpc' | 'rest';
|
|
|
13
13
|
* REST is opt-in.
|
|
14
14
|
* - **`'rest'`** — chain reads come from the network's static REST/S3 layout (the
|
|
15
15
|
* `<gatewayName>.xyo.space` root, blocks./state./indexes. subdomains derived from it), while
|
|
16
|
-
* transaction submission goes to the RPC
|
|
16
|
+
* transaction submission goes to the RPC URL. The local network is the exception — it reads a
|
|
17
17
|
* path-based layout (`/blocks`, `/state`, `/indexes`) served by `localEndpoint`, since there is
|
|
18
18
|
* no published `local.xyo.space` host.
|
|
19
19
|
*
|
|
@@ -1,8 +1,8 @@
|
|
|
1
1
|
import type { XyoClient } from '@xyo-network/xl1-sdk';
|
|
2
|
-
/** Waits for
|
|
3
|
-
export declare const listenForClientInjection: (onClientReady: () => void, timeout: number, onTimeout: () => void) => void;
|
|
4
|
-
type
|
|
5
|
-
/** Returns the injected wallet client, or
|
|
6
|
-
export declare function getXyoClient(timeout?: number): Promise<
|
|
2
|
+
/** Waits once for wallet injection. The returned disposer also cancels the timeout. */
|
|
3
|
+
export declare const listenForClientInjection: (onClientReady: () => void, timeout: number, onTimeout: () => void) => () => void;
|
|
4
|
+
type WalletClientResult = XyoClient | undefined | null;
|
|
5
|
+
/** Returns the injected wallet client, or null on absence/timeout; abort releases discovery. */
|
|
6
|
+
export declare function getXyoClient(timeout?: number, signal?: AbortSignal): Promise<WalletClientResult>;
|
|
7
7
|
export {};
|
|
8
8
|
//# sourceMappingURL=getXyoClient.d.ts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"getXyoClient.d.ts","sourceRoot":"","sources":["../../../../../src/client/hooks/helpers/getXyoClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAQrD,
|
|
1
|
+
{"version":3,"file":"getXyoClient.d.ts","sourceRoot":"","sources":["../../../../../src/client/hooks/helpers/getXyoClient.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,sBAAsB,CAAA;AAQrD,uFAAuF;AACvF,eAAO,MAAM,wBAAwB,GAAI,eAAe,MAAM,IAAI,EAAE,SAAS,MAAM,EAAE,WAAW,MAAM,IAAI,KAAG,MAAM,IAoBlH,CAAA;AAED,KAAK,kBAAkB,GAAG,SAAS,GAAG,SAAS,GAAG,IAAI,CAAA;AAWtD,gGAAgG;AAChG,wBAAsB,YAAY,CAAC,OAAO,SAA0B,EAAE,MAAM,CAAC,EAAE,WAAW,GAAG,OAAO,CAAC,kBAAkB,CAAC,CA2BvH"}
|
|
@@ -75,31 +75,57 @@ var hasXyoClient = () => {
|
|
|
75
75
|
return "client" in globalThis.xyo;
|
|
76
76
|
};
|
|
77
77
|
var listenForClientInjection = (onClientReady, timeout, onTimeout) => {
|
|
78
|
-
let
|
|
78
|
+
let active = true;
|
|
79
|
+
const dispose = () => {
|
|
80
|
+
if (!active) return;
|
|
81
|
+
active = false;
|
|
82
|
+
removeEventListener("xyo:plugin-ready", listener);
|
|
83
|
+
clearTimeout(timer);
|
|
84
|
+
};
|
|
79
85
|
const listener = () => {
|
|
86
|
+
if (!active) return;
|
|
87
|
+
dispose();
|
|
80
88
|
onClientReady();
|
|
81
|
-
resolved = true;
|
|
82
89
|
};
|
|
83
90
|
addEventListener("xyo:plugin-ready", listener);
|
|
84
|
-
setTimeout(() => {
|
|
85
|
-
if (
|
|
86
|
-
|
|
87
|
-
}
|
|
88
|
-
removeEventListener("xyo:plugin-ready", listener);
|
|
91
|
+
const timer = setTimeout(() => {
|
|
92
|
+
if (!active) return;
|
|
93
|
+
dispose();
|
|
89
94
|
onTimeout();
|
|
90
95
|
}, timeout);
|
|
96
|
+
return dispose;
|
|
91
97
|
};
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
|
|
98
|
+
var WalletDiscoveryAbortError = class extends Error {
|
|
99
|
+
name = "AbortError";
|
|
100
|
+
};
|
|
101
|
+
function discoveryAbortError(reason) {
|
|
102
|
+
if (reason instanceof Error) return reason;
|
|
103
|
+
return new WalletDiscoveryAbortError("Wallet discovery aborted", { cause: reason });
|
|
104
|
+
}
|
|
105
|
+
async function getXyoClient(timeout = CLIENT_LISTENER_TIMEOUT, signal) {
|
|
106
|
+
if (signal?.aborted === true) throw discoveryAbortError(signal.reason);
|
|
107
|
+
if (isUndefined(globalThis.xyo)) return null;
|
|
108
|
+
if (hasXyoClient()) return globalThis.xyo.client;
|
|
109
|
+
return await new Promise((resolve, reject) => {
|
|
110
|
+
let dispose = () => {
|
|
111
|
+
};
|
|
112
|
+
const cleanup = () => {
|
|
113
|
+
dispose();
|
|
114
|
+
signal?.removeEventListener("abort", onAbort);
|
|
115
|
+
};
|
|
116
|
+
const onAbort = () => {
|
|
117
|
+
cleanup();
|
|
118
|
+
reject(discoveryAbortError(signal?.reason));
|
|
119
|
+
};
|
|
120
|
+
signal?.addEventListener("abort", onAbort, { once: true });
|
|
121
|
+
dispose = listenForClientInjection(
|
|
98
122
|
() => {
|
|
99
|
-
|
|
123
|
+
cleanup();
|
|
124
|
+
resolve(globalThis.xyo?.client ?? null);
|
|
100
125
|
},
|
|
101
126
|
timeout,
|
|
102
127
|
() => {
|
|
128
|
+
cleanup();
|
|
103
129
|
resolve(null);
|
|
104
130
|
}
|
|
105
131
|
);
|
|
@@ -117,6 +143,7 @@ var useClientFromWallet = (timeout) => {
|
|
|
117
143
|
const [state, setState] = useState(initialState);
|
|
118
144
|
useEffect(() => {
|
|
119
145
|
let cancelled = false;
|
|
146
|
+
const controller = new AbortController();
|
|
120
147
|
const initialize = async () => {
|
|
121
148
|
setState((prev) => {
|
|
122
149
|
if (prev.isLoading) return prev;
|
|
@@ -128,7 +155,7 @@ var useClientFromWallet = (timeout) => {
|
|
|
128
155
|
});
|
|
129
156
|
try {
|
|
130
157
|
if (cancelled) return;
|
|
131
|
-
const client = await getXyoClient(timeout);
|
|
158
|
+
const client = await getXyoClient(timeout, controller.signal);
|
|
132
159
|
if (!cancelled) {
|
|
133
160
|
if (client === null) {
|
|
134
161
|
setState({
|
|
@@ -167,7 +194,6 @@ var useClientFromWallet = (timeout) => {
|
|
|
167
194
|
error: null
|
|
168
195
|
});
|
|
169
196
|
};
|
|
170
|
-
const controller = new AbortController();
|
|
171
197
|
addEventListener("xyo:plugin-ready", onPluginReady, { signal: controller.signal });
|
|
172
198
|
return () => {
|
|
173
199
|
cancelled = true;
|
|
@@ -2259,6 +2285,7 @@ var InPageGatewaysProvider = ({
|
|
|
2259
2285
|
const [gateways, setGateways] = useState15({});
|
|
2260
2286
|
const [errors, setErrors] = useState15({});
|
|
2261
2287
|
const [previousSignerTransport, setPreviousSignerTransport] = useState15(signerTransport);
|
|
2288
|
+
const [pageGeneration, setPageGeneration] = useState15(0);
|
|
2262
2289
|
const clearAll = useCallback6(() => {
|
|
2263
2290
|
setGateways({});
|
|
2264
2291
|
setErrors({});
|
|
@@ -2267,6 +2294,15 @@ var InPageGatewaysProvider = ({
|
|
|
2267
2294
|
clearAll();
|
|
2268
2295
|
setPreviousSignerTransport(signerTransport);
|
|
2269
2296
|
}
|
|
2297
|
+
useEffect5(() => {
|
|
2298
|
+
const controller = new AbortController();
|
|
2299
|
+
addEventListener("pageshow", (event) => {
|
|
2300
|
+
if (!event.persisted) return;
|
|
2301
|
+
clearAll();
|
|
2302
|
+
setPageGeneration((generation) => generation + 1);
|
|
2303
|
+
}, { signal: controller.signal });
|
|
2304
|
+
return () => controller.abort();
|
|
2305
|
+
}, [clearAll]);
|
|
2270
2306
|
useEffect5(() => {
|
|
2271
2307
|
let cancelled = false;
|
|
2272
2308
|
const ownedSystems = [];
|
|
@@ -2325,7 +2361,7 @@ var InPageGatewaysProvider = ({
|
|
|
2325
2361
|
for (const owned of ownedSystems) owned.disposePageLifecycle();
|
|
2326
2362
|
void Promise.allSettled(ownedSystems.map(async (owned) => await owned.system.stop()));
|
|
2327
2363
|
};
|
|
2328
|
-
}, [localEndpoint, signerAccount, signerFactory, signerProviderId, signerTransport, transport]);
|
|
2364
|
+
}, [localEndpoint, pageGeneration, signerAccount, signerFactory, signerProviderId, signerTransport, transport]);
|
|
2329
2365
|
const value = useMemo6(() => {
|
|
2330
2366
|
const value2 = {
|
|
2331
2367
|
clearAll,
|