@solarpunkltd/swarm-id 0.8.2 → 0.10.0

package/README.md

@@ -4,10 +4,11 @@ TypeScript library for integrating Swarm ID authentication and Bee API operation
 
 ## Overview
 
-The Swarm ID library provides a secure, iframe-based authentication system for Swarm applications. It consists of two main components:
+The Swarm ID library provides a secure, iframe-based authentication system for Swarm applications. It consists of three main components:
 
 1. **SwarmIdClient** — For parent windows/dApps to interact with the authentication system
-2. **SwarmIdProxy** — Runs in the iframe, handles authentication and proxies Bee API calls
+2. **SwarmIdProxy** — Runs in the hidden iframe, handles authentication and proxies Bee API calls
+3. **SwarmIdButtonFrame**: the visible Swarm ID button a dApp mounts, whose click opens the connect window
 
 Authentication is handled by the SvelteKit identity management UI ([ui](../ui/)).
 
@@ -53,12 +54,21 @@ const client = new SwarmIdClient({
 // 2. Initialize (creates hidden iframe; populates client.connectionInfo)
 await client.initialize()
 
-// 3a. Option A: Use iframe authentication button
-// The iframe will show a connect/disconnect button automatically
+// 3. Show Swarm ID's button. It is a small frame of Swarm ID's own that fills
+//    the container, and its click opens the connect window. A site on another
+//    site than Swarm ID can sign in no other way, because the browser keeps
+//    Swarm ID's frames apart from Swarm ID's storage there and lets a frame
+//    open a window only from its own click. Unmounting it keeps the session.
+const button = client.mountButton(document.getElementById("sign-in")!, {
+  action: "sign-in", // or "change-stamp" for a person signed in
+  config: { text: "Sign in", backgroundColor: "#000", borderRadius: "6px" },
+  onWindowChange: (state) => console.log("Swarm ID window:", state),
+})
+await button.ready
 
-// 3b. Option B: Manual authentication with connect()
-// Opens the authentication page in a new window/tab (useful for custom UI)
-await client.connect()
+// connect() opens the same window from your own control, but only where your
+// site shares Swarm ID's storage. Elsewhere it refuses with button-required.
+// Sign out stays a library call with no window: await client.disconnect()
 
 // 4. Read current connection state synchronously
 const info = client.connectionInfo

package/dist/bus/account-bus.d.ts

@@ -24,6 +24,12 @@ export interface BusTransport {
      * departures to report, which is a truthful answer rather than a gap.
      */
     onPeerLeft?(handler: (peerId: string) => void): () => void;
+    /**
+     * A peer joined the room. Optional for the same reason. The room keeps no
+     * mailbox, so this is what lets a context already in it tell a newcomer
+     * what it missed.
+     */
+    onPeerJoined?(handler: (peerId: string) => void): () => void;
     close(): void;
 }
 /** Restricts a publish to transports that stay inside this browser profile. */
@@ -63,6 +69,7 @@ export declare class AccountBus {
     private transports;
     private handlers;
     private peerLeftHandlers;
+    private peerJoinedHandlers;
     private transportUnsubscribers;
     private closed;
     constructor(transports: BusTransport[]);
@@ -98,6 +105,11 @@ export declare class AccountBus {
      * it is the one departure signal that survives a tab being closed.
      */
     onPeerLeft(handler: (peerId: string) => void): () => void;
+    /**
+     * A peer joined the room, by the name the delivering transport uses for it,
+     * the same name its messages arrive under.
+     */
+    onPeerJoined(handler: (peerId: string) => void): () => void;
     /** Idempotent, and terminal: a closed bus neither publishes nor attaches. */
     close(): void;
     private dispatch;

package/dist/bus/messages.d.ts

@@ -26,9 +26,15 @@ export declare const AccountDeltaMessageSchema: z.ZodObject<{
             settings: z.ZodOptional<z.ZodObject<{
                 appSessionDuration: z.ZodOptional<z.ZodNumber>;
             }, z.core.$strip>>;
+            walletLink: z.ZodOptional<z.ZodObject<{
+                message: z.ZodString;
+                walletSignature: z.ZodString;
+                accountSignature: z.ZodString;
+            }, z.core.$strip>>;
             accountNameAt: z.ZodOptional<z.ZodNumber>;
             defaultStampAt: z.ZodOptional<z.ZodNumber>;
             settingsAt: z.ZodOptional<z.ZodNumber>;
+            walletLinkAt: z.ZodOptional<z.ZodNumber>;
             createdAt: z.ZodNumber;
             lastModified: z.ZodNumber;
             devices: z.ZodDefault<z.ZodArray<z.ZodObject<{
@@ -164,9 +170,15 @@ export declare const BusMessageSchema: z.ZodDiscriminatedUnion<[z.ZodObject<{
             settings: z.ZodOptional<z.ZodObject<{
                 appSessionDuration: z.ZodOptional<z.ZodNumber>;
             }, z.core.$strip>>;
+            walletLink: z.ZodOptional<z.ZodObject<{
+                message: z.ZodString;
+                walletSignature: z.ZodString;
+                accountSignature: z.ZodString;
+            }, z.core.$strip>>;
             accountNameAt: z.ZodOptional<z.ZodNumber>;
             defaultStampAt: z.ZodOptional<z.ZodNumber>;
             settingsAt: z.ZodOptional<z.ZodNumber>;
+            walletLinkAt: z.ZodOptional<z.ZodNumber>;
             createdAt: z.ZodNumber;
             lastModified: z.ZodNumber;
             devices: z.ZodDefault<z.ZodArray<z.ZodObject<{

package/dist/bus/signaling-transport.d.ts

@@ -22,6 +22,7 @@ export declare class SignalingTransport implements BusTransport {
     private peers;
     private handlers;
     private peerLeftHandlers;
+    private peerJoinedHandlers;
     private closed;
     private reconnectDelayMs;
     private reconnectTimer;
@@ -34,6 +35,7 @@ export declare class SignalingTransport implements BusTransport {
     publish(message: BusMessageInput): void;
     subscribe(handler: (raw: unknown, from?: string) => void): () => void;
     onPeerLeft(handler: (peerId: string) => void): () => void;
+    onPeerJoined(handler: (peerId: string) => void): () => void;
     /**
      * Stops reconnecting at once, but lets in-flight publishes reach the wire
      * first: `deliver` awaits envelope encryption, and callers announce a

package/dist/chunks/ccip-BEanftc1.js

@@ -0,0 +1,2 @@
+import{B as e,g as a,s as t,d as s,i as r,l as n,a as o,c,b as i,e as d,f as l,h as u,H as p,j as f}from"./index-BbRV2bja.js";import"./chat-binding-gSvKTm5l.js";class h extends e{constructor({callbackSelector:e,cause:t,data:s,extraData:r,sender:n,urls:o}){super(t.shortMessage||"An error occurred while fetching for an offchain result.",{cause:t,metaMessages:[...t.metaMessages||[],t.metaMessages?.length?"":[],"Offchain Gateway Call:",o&&["  Gateway URL(s):",...o.map(e=>`    ${a(e)}`)],`  Sender: ${n}`,`  Data: ${s}`,`  Callback selector: ${e}`,`  Extra data: ${r}`].flat(),name:"OffchainLookupError"})}}class g extends e{constructor({result:e,url:s}){super("Offchain gateway response is malformed. Response data must be a hex value.",{metaMessages:[`Gateway URL: ${a(s)}`,`Response: ${t(e)}`],name:"OffchainLookupResponseMalformedError"})}}class m extends e{constructor({sender:e,to:a}){super("Reverted sender address does not match target contract address (`to`).",{metaMessages:[`Contract address: ${a}`,`OffchainLookup sender address: ${e}`],name:"OffchainLookupSenderMismatchError"})}}const y="0x556f1830",w={name:"OffchainLookup",type:"error",inputs:[{name:"sender",type:"address"},{name:"urls",type:"string[]"},{name:"callData",type:"bytes"},{name:"callbackFunction",type:"bytes4"},{name:"extraData",type:"bytes"}]};async function b(e,{blockNumber:a,blockTag:t,data:p,requestOptions:f,to:g}){const{args:y}=s({data:p,abi:[w]}),[b,k,x,T,$]=y,{ccipRead:q}=e,L=q&&"function"==typeof q?.request?q.request:O;try{if(!r(g,b))throw new m({sender:b,to:g});const s=k.includes(n)?await o({data:x,ccipRequest:e=>L({...e,requestOptions:f})}):await L({data:x,requestOptions:f,sender:b,urls:k}),{data:l}=await c(e,{blockNumber:a,blockTag:t,data:i([T,d([{type:"bytes"},{type:"bytes"}],[s,$])]),requestOptions:f,to:g});return l}catch(e){if(f?.signal?.aborted)throw l(f.signal);if(u(e))throw e;throw new h({callbackSelector:T,cause:e,data:p,extraData:$,sender:b,urls:k})}}async function O({data:e,requestOptions:a,sender:s,urls:r}){let n=new Error("An unknown error occurred.");for(let o=0;o<r.length;o++){if(a?.signal?.aborted)throw l(a.signal);const c=r[o],i=c.includes("{data}")?"GET":"POST",d="POST"===i?{data:e,sender:s}:void 0,h="POST"===i?{"Content-Type":"application/json"}:{};try{const r=await fetch(c.replace("{sender}",s.toLowerCase()).replace("{data}",e),{body:JSON.stringify(d),headers:h,method:i,...a?.signal?{signal:a.signal}:{}});let o;if(o=r.headers.get("Content-Type")?.startsWith("application/json")?(await r.json()).data:await r.text(),!r.ok){n=new p({body:d,details:o?.error?t(o.error):r.statusText,headers:r.headers,status:r.status,url:c});continue}if(!f(o)){n=new g({result:o,url:c});continue}return o}catch(e){if(a?.signal?.aborted)throw l(a.signal);if(u(e))throw e;n=new p({body:d,details:e.message,url:c})}}throw n}export{O as ccipRequest,b as offchainLookup,w as offchainLookupAbiItem,y as offchainLookupSignature};
+//# sourceMappingURL=ccip-BEanftc1.js.map

package/dist/chunks/ccip-BEanftc1.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ccip-BEanftc1.js","sources":["../../../node_modules/.pnpm/viem@2.55.13_typescript@5.8.3_zod@4.1.13/node_modules/viem/_esm/errors/ccip.js","../../../node_modules/.pnpm/viem@2.55.13_typescript@5.8.3_zod@4.1.13/node_modules/viem/_esm/utils/ccip.js"],"sourcesContent":["import { stringify } from '../utils/stringify.js';\nimport { BaseError } from './base.js';\nimport { getUrl } from './utils.js';\nexport class OffchainLookupError extends BaseError {\n    constructor({ callbackSelector, cause, data, extraData, sender, urls, }) {\n        super(cause.shortMessage ||\n            'An error occurred while fetching for an offchain result.', {\n            cause,\n            metaMessages: [\n                ...(cause.metaMessages || []),\n                cause.metaMessages?.length ? '' : [],\n                'Offchain Gateway Call:',\n                urls && [\n                    '  Gateway URL(s):',\n                    ...urls.map((url) => `    ${getUrl(url)}`),\n                ],\n                `  Sender: ${sender}`,\n                `  Data: ${data}`,\n                `  Callback selector: ${callbackSelector}`,\n                `  Extra data: ${extraData}`,\n            ].flat(),\n            name: 'OffchainLookupError',\n        });\n    }\n}\nexport class OffchainLookupResponseMalformedError extends BaseError {\n    constructor({ result, url }) {\n        super('Offchain gateway response is malformed. Response data must be a hex value.', {\n            metaMessages: [\n                `Gateway URL: ${getUrl(url)}`,\n                `Response: ${stringify(result)}`,\n            ],\n            name: 'OffchainLookupResponseMalformedError',\n        });\n    }\n}\nexport class OffchainLookupSenderMismatchError extends BaseError {\n    constructor({ sender, to }) {\n        super('Reverted sender address does not match target contract address (`to`).', {\n            metaMessages: [\n                `Contract address: ${to}`,\n                `OffchainLookup sender address: ${sender}`,\n            ],\n            name: 'OffchainLookupSenderMismatchError',\n        });\n    }\n}\n//# sourceMappingURL=ccip.js.map","import { call } from '../actions/public/call.js';\nimport { OffchainLookupError, OffchainLookupResponseMalformedError, OffchainLookupSenderMismatchError, } from '../errors/ccip.js';\nimport { HttpRequestError, } from '../errors/request.js';\nimport { getAbortError, isAbortError } from '../errors/utils.js';\nimport { decodeErrorResult } from './abi/decodeErrorResult.js';\nimport { encodeAbiParameters } from './abi/encodeAbiParameters.js';\nimport { isAddressEqual } from './address/isAddressEqual.js';\nimport { concat } from './data/concat.js';\nimport { isHex } from './data/isHex.js';\nimport { localBatchGatewayRequest, localBatchGatewayUrl, } from './ens/localBatchGatewayRequest.js';\nimport { stringify } from './stringify.js';\nexport const offchainLookupSignature = '0x556f1830';\nexport const offchainLookupAbiItem = {\n    name: 'OffchainLookup',\n    type: 'error',\n    inputs: [\n        {\n            name: 'sender',\n            type: 'address',\n        },\n        {\n            name: 'urls',\n            type: 'string[]',\n        },\n        {\n            name: 'callData',\n            type: 'bytes',\n        },\n        {\n            name: 'callbackFunction',\n            type: 'bytes4',\n        },\n        {\n            name: 'extraData',\n            type: 'bytes',\n        },\n    ],\n};\nexport async function offchainLookup(client, { blockNumber, blockTag, data, requestOptions, to, }) {\n    const { args } = decodeErrorResult({\n        data,\n        abi: [offchainLookupAbiItem],\n    });\n    const [sender, urls, callData, callbackSelector, extraData] = args;\n    const { ccipRead } = client;\n    const ccipRequest_ = ccipRead && typeof ccipRead?.request === 'function'\n        ? ccipRead.request\n        : ccipRequest;\n    try {\n        if (!isAddressEqual(to, sender))\n            throw new OffchainLookupSenderMismatchError({ sender, to });\n        const result = urls.includes(localBatchGatewayUrl)\n            ? await localBatchGatewayRequest({\n                data: callData,\n                ccipRequest: (parameters) => ccipRequest_({ ...parameters, requestOptions }),\n            })\n            : await ccipRequest_({ data: callData, requestOptions, sender, urls });\n        const { data: data_ } = await call(client, {\n            blockNumber,\n            blockTag,\n            data: concat([\n                callbackSelector,\n                encodeAbiParameters([{ type: 'bytes' }, { type: 'bytes' }], [result, extraData]),\n            ]),\n            requestOptions,\n            to,\n        });\n        return data_;\n    }\n    catch (err) {\n        if (requestOptions?.signal?.aborted)\n            throw getAbortError(requestOptions.signal);\n        if (isAbortError(err))\n            throw err;\n        throw new OffchainLookupError({\n            callbackSelector,\n            cause: err,\n            data,\n            extraData,\n            sender,\n            urls,\n        });\n    }\n}\nexport async function ccipRequest({ data, requestOptions, sender, urls, }) {\n    let error = new Error('An unknown error occurred.');\n    for (let i = 0; i < urls.length; i++) {\n        if (requestOptions?.signal?.aborted)\n            throw getAbortError(requestOptions.signal);\n        const url = urls[i];\n        const method = url.includes('{data}') ? 'GET' : 'POST';\n        const body = method === 'POST' ? { data, sender } : undefined;\n        const headers = method === 'POST' ? { 'Content-Type': 'application/json' } : {};\n        try {\n            const response = await fetch(url.replace('{sender}', sender.toLowerCase()).replace('{data}', data), {\n                body: JSON.stringify(body),\n                headers,\n                method,\n                ...(requestOptions?.signal ? { signal: requestOptions.signal } : {}),\n            });\n            let result;\n            if (response.headers.get('Content-Type')?.startsWith('application/json')) {\n                result = (await response.json()).data;\n            }\n            else {\n                result = (await response.text());\n            }\n            if (!response.ok) {\n                error = new HttpRequestError({\n                    body,\n                    details: result?.error\n                        ? stringify(result.error)\n                        : response.statusText,\n                    headers: response.headers,\n                    status: response.status,\n                    url,\n                });\n                continue;\n            }\n            if (!isHex(result)) {\n                error = new OffchainLookupResponseMalformedError({\n                    result,\n                    url,\n                });\n                continue;\n            }\n            return result;\n        }\n        catch (err) {\n            if (requestOptions?.signal?.aborted)\n                throw getAbortError(requestOptions.signal);\n            if (isAbortError(err))\n                throw err;\n            error = new HttpRequestError({\n                body,\n                details: err.message,\n                url,\n            });\n        }\n    }\n    throw error;\n}\n//# sourceMappingURL=ccip.js.map"],"names":["OffchainLookupError","BaseError","constructor","callbackSelector","cause","data","extraData","sender","urls","super","shortMessage","metaMessages","length","map","url","getUrl","flat","name","OffchainLookupResponseMalformedError","result","stringify","OffchainLookupSenderMismatchError","to","offchainLookupSignature","offchainLookupAbiItem","type","inputs","async","offchainLookup","client","blockNumber","blockTag","requestOptions","args","decodeErrorResult","abi","callData","ccipRead","ccipRequest_","request","ccipRequest","isAddressEqual","includes","localBatchGatewayUrl","localBatchGatewayRequest","parameters","data_","call","concat","encodeAbiParameters","err","signal","aborted","getAbortError","isAbortError","error","Error","i","method","body","undefined","headers","response","fetch","replace","toLowerCase","JSON","get","startsWith","json","text","ok","HttpRequestError","details","statusText","status","isHex","message"],"mappings":"iKAGO,MAAMA,UAA4BC,EACrC,WAAAC,EAAYC,iBAAEA,EAAgBC,MAAEA,EAAKC,KAAEA,EAAIC,UAAEA,EAASC,OAAEA,EAAMC,KAAEA,IAC5DC,MAAML,EAAMM,cACR,2DAA4D,CAC5DN,QACAO,aAAc,IACNP,EAAMO,cAAgB,GAC1BP,EAAMO,cAAcC,OAAS,GAAK,GAClC,yBACAJ,GAAQ,CACJ,uBACGA,EAAKK,IAAKC,GAAQ,OAAOC,EAAOD,OAEvC,aAAaP,IACb,WAAWF,IACX,wBAAwBF,IACxB,iBAAiBG,KACnBU,OACFC,KAAM,uBAEd,EAEG,MAAMC,UAA6CjB,EACtD,WAAAC,EAAYiB,OAAEA,EAAML,IAAEA,IAClBL,MAAM,6EAA8E,CAChFE,aAAc,CACV,gBAAgBI,EAAOD,KACvB,aAAaM,EAAUD,MAE3BF,KAAM,wCAEd,EAEG,MAAMI,UAA0CpB,EACnD,WAAAC,EAAYK,OAAEA,EAAMe,GAAEA,IAClBb,MAAM,yEAA0E,CAC5EE,aAAc,CACV,qBAAqBW,IACrB,kCAAkCf,KAEtCU,KAAM,qCAEd,EClCQ,MAACM,EAA0B,aAC1BC,EAAwB,CACjCP,KAAM,iBACNQ,KAAM,QACNC,OAAQ,CACJ,CACIT,KAAM,SACNQ,KAAM,WAEV,CACIR,KAAM,OACNQ,KAAM,YAEV,CACIR,KAAM,WACNQ,KAAM,SAEV,CACIR,KAAM,mBACNQ,KAAM,UAEV,CACIR,KAAM,YACNQ,KAAM,WAIXE,eAAeC,EAAeC,GAAQC,YAAEA,EAAWC,SAAEA,EAAQ1B,KAAEA,EAAI2B,eAAEA,EAAcV,GAAEA,IACxF,MAAMW,KAAEA,GAASC,EAAkB,CAC/B7B,OACA8B,IAAK,CAACX,MAEHjB,EAAQC,EAAM4B,EAAUjC,EAAkBG,GAAa2B,GACxDI,SAAEA,GAAaR,EACfS,EAAeD,GAAyC,mBAAtBA,GAAUE,QAC5CF,EAASE,QACTC,EACN,IACI,IAAKC,EAAenB,EAAIf,GACpB,MAAM,IAAIc,EAAkC,CAAEd,SAAQe,OAC1D,MAAMH,EAASX,EAAKkC,SAASC,SACjBC,EAAyB,CAC7BvC,KAAM+B,EACNI,YAAcK,GAAeP,EAAa,IAAKO,EAAYb,2BAEvDM,EAAa,CAAEjC,KAAM+B,EAAUJ,iBAAgBzB,SAAQC,UAC3DH,KAAMyC,SAAgBC,EAAKlB,EAAQ,CACvCC,cACAC,WACA1B,KAAM2C,EAAO,CACT7C,EACA8C,EAAoB,CAAC,CAAExB,KAAM,SAAW,CAAEA,KAAM,UAAY,CAACN,EAAQb,MAEzE0B,iBACAV,OAEJ,OAAOwB,CACX,CACA,MAAOI,GACH,GAAIlB,GAAgBmB,QAAQC,QACxB,MAAMC,EAAcrB,EAAemB,QACvC,GAAIG,EAAaJ,GACb,MAAMA,EACV,MAAM,IAAIlD,EAAoB,CAC1BG,mBACAC,MAAO8C,EACP7C,OACAC,YACAC,SACAC,QAER,CACJ,CACOmB,eAAea,GAAYnC,KAAEA,EAAI2B,eAAEA,EAAczB,OAAEA,EAAMC,KAAEA,IAC9D,IAAI+C,EAAQ,IAAIC,MAAM,8BACtB,IAAK,IAAIC,EAAI,EAAGA,EAAIjD,EAAKI,OAAQ6C,IAAK,CAClC,GAAIzB,GAAgBmB,QAAQC,QACxB,MAAMC,EAAcrB,EAAemB,QACvC,MAAMrC,EAAMN,EAAKiD,GACXC,EAAS5C,EAAI4B,SAAS,UAAY,MAAQ,OAC1CiB,EAAkB,SAAXD,EAAoB,CAAErD,OAAME,eAAWqD,EAC9CC,EAAqB,SAAXH,EAAoB,CAAE,eAAgB,oBAAuB,CAAA,EAC7E,IACI,MAAMI,QAAiBC,MAAMjD,EAAIkD,QAAQ,WAAYzD,EAAO0D,eAAeD,QAAQ,SAAU3D,GAAO,CAChGsD,KAAMO,KAAK9C,UAAUuC,GACrBE,UACAH,YACI1B,GAAgBmB,OAAS,CAAEA,OAAQnB,EAAemB,QAAW,KAErE,IAAIhC,EAOJ,GALIA,EADA2C,EAASD,QAAQM,IAAI,iBAAiBC,WAAW,2BACjCN,EAASO,QAAQhE,WAGjByD,EAASQ,QAExBR,EAASS,GAAI,CACdhB,EAAQ,IAAIiB,EAAiB,CACzBb,OACAc,QAAStD,GAAQoC,MACXnC,EAAUD,EAAOoC,OACjBO,EAASY,WACfb,QAASC,EAASD,QAClBc,OAAQb,EAASa,OACjB7D,QAEJ,QACJ,CACA,IAAK8D,EAAMzD,GAAS,CAChBoC,EAAQ,IAAIrC,EAAqC,CAC7CC,SACAL,QAEJ,QACJ,CACA,OAAOK,CACX,CACA,MAAO+B,GACH,GAAIlB,GAAgBmB,QAAQC,QACxB,MAAMC,EAAcrB,EAAemB,QACvC,GAAIG,EAAaJ,GACb,MAAMA,EACVK,EAAQ,IAAIiB,EAAiB,CACzBb,OACAc,QAASvB,EAAI2B,QACb/D,OAER,CACJ,CACA,MAAMyC,CACV","x_google_ignoreList":[0,1]}