@sigil-oss/connect 0.2.0

package/CHANGELOG.md

@@ -0,0 +1,11 @@
+# @sigil-oss/connect
+
+## 0.2.0
+
+### Minor Changes
+
+- 2ee6687: Initial release scaffold for the Sigil Connect SDK, including typed deep-link request builders, envelope signing helpers, tests, and Changesets-based publish automation.
+
+All notable changes to this package will be documented in this file.
+
+The format is based on Changesets and follows semver.

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Sigil
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,255 @@
+# `@sigil-oss/connect`
+
+Framework-agnostic TypeScript SDK for launching Sigil deep-link requests.
+
+`@sigil-oss/connect` gives web apps, desktop apps, and hybrid frontends a small typed layer for interacting with the Sigil wallet without depending on React, Vue, Svelte, or any framework runtime.
+
+Use it to:
+
+- build valid `sigil://` request URLs
+- create typed `transfer`, `connect`, `sign_message`, `verify_message`, and `sc_call` requests
+- attach callback URLs safely
+- generate signed request proofs for trusted Sigil flows
+
+---
+
+## Install
+
+```bash
+bun add @sigil-oss/connect
+```
+
+or
+
+```bash
+npm install @sigil-oss/connect
+```
+
+---
+
+## Why This Package Exists
+
+Sigil itself is a desktop wallet.
+
+This package is the companion SDK for dApps and tools that want to hand requests off to Sigil in a predictable, typed, cross-framework way. It keeps request construction in sync with the wallet’s current deep-link model, including:
+
+- request envelopes
+- callback handling
+- nonce / expiry defaults
+- optional signed proof metadata
+
+---
+
+## Quick Start
+
+```ts
+import {
+  createTransferRequest,
+  createEnvelope,
+  buildSigilUrl,
+} from "@sigil-oss/connect";
+
+const request = createTransferRequest({
+  type: "transfer",
+  dapp: {
+    name: "Demo App",
+    origin: "https://demo.app",
+  },
+  to: "UVYAOYTNYCRBVFBHNFIJUEOUEPEDIDUWWEAXKFSJEBJVASCQEROJOVOEEATL",
+  amount: "1000",
+});
+
+const envelope = createEnvelope(request, {
+  callback: "https://demo.app/api/sigil/callback",
+});
+
+const url = buildSigilUrl(envelope);
+```
+
+You can then:
+
+- assign `url` to a button or anchor
+- call `window.location.assign(url)`
+- use `launchSigilRequest(envelope)` in browser environments
+
+---
+
+## Request Builders
+
+The package exposes typed helpers for the current Sigil request model:
+
+- `createTransferRequest()`
+- `createScCallRequest()`
+- `createSignMessageRequest()`
+- `createVerifyMessageRequest()`
+- `createConnectRequest()`
+
+All builders:
+
+- require an HTTPS `dapp.origin`
+- generate a nonce by default
+- generate a short-lived expiry by default
+
+You can override nonce or expiry when needed.
+
+---
+
+## Envelope Model
+
+Sigil now accepts request envelopes, not only flat request payloads.
+
+```ts
+interface SigilEnvelope {
+  request: SigilRequest;
+  callback?: string | null;
+  proof?: SigilProof;
+}
+```
+
+Build one with:
+
+```ts
+const envelope = createEnvelope(request, {
+  callback: "https://demo.app/api/callback",
+});
+```
+
+Then encode it into a deep link:
+
+```ts
+const url = buildSigilUrl(envelope);
+```
+
+If you need compatibility with older callback query handling, you can include the legacy `cb` parameter too:
+
+```ts
+const url = buildSigilUrl(envelope, {
+  includeLegacyCallbackParam: true,
+});
+```
+
+---
+
+## Signed Requests
+
+If your integration uses Sigil’s signed trust flow, you can attach an ES256 proof:
+
+```ts
+import {
+  createConnectRequest,
+  createEnvelope,
+  signEnvelope,
+} from "@sigil-oss/connect";
+
+const request = createConnectRequest({
+  type: "connect",
+  dapp: {
+    name: "Trusted Demo",
+    origin: "https://demo.app",
+  },
+  permissions: ["transfer", "sign_message"],
+});
+
+const envelope = createEnvelope(request, {
+  callback: "https://demo.app/api/callback",
+});
+
+const signed = await signEnvelope(envelope, {
+  issuer: "demo.app",
+  privateJwk,
+  publicJwk,
+  includePublicJwk: true,
+});
+```
+
+Related helpers:
+
+- `serializeSignedRequestPayload()`
+- `hashSignedRequestPayload()`
+- `signEnvelope()`
+
+---
+
+## Browser Helper
+
+To launch Sigil directly from a browser context:
+
+```ts
+import { launchSigilRequest } from "@sigil-oss/connect";
+
+launchSigilRequest(envelope);
+```
+
+This helper throws when used outside a browser environment.
+
+---
+
+## API Surface
+
+### URL and request helpers
+
+- `createNonce()`
+- `createExpiry()`
+- `withRequestDefaults()`
+- `createEnvelope()`
+- `encodeEnvelope()`
+- `buildSigilUrl()`
+- `openSigilUrl()`
+- `launchSigilRequest()`
+
+### Validation helpers
+
+- `isAllowedCallbackUrl()`
+
+### Signing helpers
+
+- `serializeSignedRequestPayload()`
+- `hashSignedRequestPayload()`
+- `signEnvelope()`
+
+### Types
+
+- `SigilRequest`
+- `SigilEnvelope`
+- `SigilProof`
+- `SigilPermission`
+- `SigilTransferRequest`
+- `SigilScCallRequest`
+- `SigilSignMessageRequest`
+- `SigilVerifyMessageRequest`
+- `SigilConnectRequest`
+
+---
+
+## Compatibility Notes
+
+- `dapp.origin` must use `https://`
+- callback URLs must use `https://`, except `http://localhost` and `http://127.0.0.1`
+- the generated deep links target Sigil’s current `sigil://v1/request?d=...` format
+- this package is framework-agnostic, but browser-launch helpers require `window`
+
+---
+
+## Local Development
+
+```bash
+bun install
+bun run check
+```
+
+---
+
+## Release Flow
+
+This package uses Changesets.
+
+- add a changeset for each user-facing package change
+- merge to `main`
+- let the GitHub release workflow open or update the release PR
+- publish through the Changesets action with `NPM_TOKEN`
+
+---
+
+## License
+
+MIT

package/TESTING.md

@@ -0,0 +1,110 @@
+# `@sigil-oss/connect` Testing Guide
+
+Release checklist for the Sigil Connect SDK.
+
+This package is small, but it sits directly on the wallet handoff boundary. Treat request-format drift and callback-policy regressions as release blockers.
+
+---
+
+## Required Checks
+
+Run before every release:
+
+```bash
+bun install
+bun run check
+```
+
+This covers:
+
+- TypeScript typecheck
+- unit tests
+- production build output
+
+---
+
+## Core Scenarios
+
+### Request builders
+
+Verify all request helpers produce the expected shape:
+
+- `createTransferRequest`
+- `createScCallRequest`
+- `createSignMessageRequest`
+- `createVerifyMessageRequest`
+- `createConnectRequest`
+
+Checks:
+
+- `nonce` is generated when omitted
+- `exp` is generated when omitted
+- custom `nonce` and `exp` are preserved when provided
+- `dapp.origin` rejects non-HTTPS values
+
+### Envelope helpers
+
+Verify:
+
+- `createEnvelope()` accepts valid callback URLs
+- invalid callback URLs throw
+- `encodeEnvelope()` returns a base64url payload
+- `buildSigilUrl()` produces `sigil://v1/request?d=...`
+- legacy callback query param is only included when requested
+
+### Browser launch helper
+
+Verify:
+
+- `launchSigilRequest()` returns the final URL
+- browser-only helper throws cleanly in a non-browser environment
+
+### Signed request helpers
+
+Verify:
+
+- `serializeSignedRequestPayload()` is stable
+- `hashSignedRequestPayload()` is deterministic
+- `signEnvelope()` emits `proof.algorithm = "ES256"`
+- signed proof includes `payload_hash`
+- optional `public_jwk` inclusion works
+
+---
+
+## Cross-Compatibility Pass
+
+Before publishing, validate one generated URL against a current installed Sigil build.
+
+At minimum:
+
+1. Generate a `transfer` request URL with this package.
+2. Open it against Sigil.
+3. Confirm Sigil shows the request review screen.
+4. Repeat for `connect` and `sign_message`.
+
+If Sigil rejects the payload, do not ship until the package and wallet are back in sync.
+
+---
+
+## Regression Risks To Watch
+
+Treat these as high risk:
+
+- wallet request-envelope shape changes
+- callback policy changes
+- signed proof serialization drift
+- request type field renames
+- accidental Node-only or browser-only runtime assumptions in shared helpers
+
+---
+
+## Release Exit Criteria
+
+Do not publish if any of these fail:
+
+- package fails `bun run check`
+- built `dist/` output is missing JS or `.d.ts`
+- generated deep links no longer open current Sigil builds
+- non-HTTPS origin validation regresses
+- callback URL policy regresses
+- signing helper output becomes incompatible with Sigil trust verification

package/dist/index.d.ts

@@ -0,0 +1,97 @@
+export type SigilPermission = "transfer" | "sc_call" | "sign_message";
+export type SigilRequestType = "transfer" | "sc_call" | "sign_message" | "verify_message" | "connect";
+export interface SigilDappMeta {
+    name?: string;
+    origin: string;
+    icon?: string;
+}
+export interface SigilBaseRequest {
+    type: SigilRequestType;
+    dapp: SigilDappMeta;
+    nonce: string;
+    exp?: number;
+}
+export interface SigilTransferRequest extends SigilBaseRequest {
+    type: "transfer";
+    to: string;
+    amount: string | number;
+    from?: string;
+    tick_offset?: number;
+}
+export interface SigilScCallRequest extends SigilBaseRequest {
+    type: "sc_call";
+    contract_index: number;
+    input_type: number;
+    from?: string;
+    amount?: string | number;
+    payload?: string;
+    tick_offset?: number;
+}
+export interface SigilSignMessageRequest extends SigilBaseRequest {
+    type: "sign_message";
+    message: string;
+    from?: string;
+    data?: string;
+}
+export interface SigilVerifyMessageRequest extends SigilBaseRequest {
+    type: "verify_message";
+    message: string;
+    data?: string;
+    signature: string;
+    public_key: string;
+}
+export interface SigilConnectRequest extends SigilBaseRequest {
+    type: "connect";
+    permissions?: SigilPermission[];
+}
+export type SigilRequest = SigilTransferRequest | SigilScCallRequest | SigilSignMessageRequest | SigilVerifyMessageRequest | SigilConnectRequest;
+export interface SigilProof {
+    version: 1;
+    algorithm: "ES256";
+    issuer: string;
+    key_id?: string;
+    payload_hash: string;
+    signature: string;
+    public_jwk?: JsonWebKey;
+}
+export interface SigilEnvelope {
+    request: SigilRequest;
+    callback?: string | null;
+    proof?: SigilProof;
+}
+export interface SigilUrlOptions {
+    includeLegacyCallbackParam?: boolean;
+}
+export interface SigilRequestDefaults {
+    nonce?: string;
+    exp?: number;
+    ttlSeconds?: number;
+}
+export interface SigilProofOptions {
+    issuer: string;
+    keyId?: string;
+    privateJwk: JsonWebKey;
+    includePublicJwk?: boolean;
+    publicJwk?: JsonWebKey;
+}
+export declare function isAllowedCallbackUrl(value: string): boolean;
+export declare function createNonce(): string;
+export declare function createExpiry(ttlSeconds?: number): number;
+export declare function withRequestDefaults<T extends Omit<SigilRequest, "nonce" | "exp">>(request: T, defaults?: SigilRequestDefaults): T & Pick<SigilBaseRequest, "nonce" | "exp">;
+export declare function createTransferRequest(request: Omit<SigilTransferRequest, "nonce" | "exp">, defaults?: SigilRequestDefaults): SigilTransferRequest;
+export declare function createScCallRequest(request: Omit<SigilScCallRequest, "nonce" | "exp">, defaults?: SigilRequestDefaults): SigilScCallRequest;
+export declare function createSignMessageRequest(request: Omit<SigilSignMessageRequest, "nonce" | "exp">, defaults?: SigilRequestDefaults): SigilSignMessageRequest;
+export declare function createVerifyMessageRequest(request: Omit<SigilVerifyMessageRequest, "nonce" | "exp">, defaults?: SigilRequestDefaults): SigilVerifyMessageRequest;
+export declare function createConnectRequest(request: Omit<SigilConnectRequest, "nonce" | "exp">, defaults?: SigilRequestDefaults): SigilConnectRequest;
+export declare function createEnvelope(request: SigilRequest, options?: {
+    callback?: string | null;
+    proof?: SigilProof;
+}): SigilEnvelope;
+export declare function encodeEnvelope(envelope: SigilEnvelope): string;
+export declare function buildSigilUrl(envelope: SigilEnvelope, options?: SigilUrlOptions): string;
+export declare function openSigilUrl(url: string): void;
+export declare function launchSigilRequest(envelope: SigilEnvelope, options?: SigilUrlOptions): string;
+export declare function serializeSignedRequestPayload(envelope: Pick<SigilEnvelope, "request" | "callback">): string;
+export declare function hashSignedRequestPayload(envelope: Pick<SigilEnvelope, "request" | "callback">): Promise<string>;
+export declare function signEnvelope(envelope: SigilEnvelope, options: SigilProofOptions): Promise<SigilEnvelope>;
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,MAAM,MAAM,eAAe,GAAG,UAAU,GAAG,SAAS,GAAG,cAAc,CAAC;AACtE,MAAM,MAAM,gBAAgB,GACxB,UAAU,GACV,SAAS,GACT,cAAc,GACd,gBAAgB,GAChB,SAAS,CAAC;AAEd,MAAM,WAAW,aAAa;IAC5B,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,MAAM,CAAC;IACf,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,gBAAgB,CAAC;IACvB,IAAI,EAAE,aAAa,CAAC;IACpB,KAAK,EAAE,MAAM,CAAC;IACd,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,WAAW,oBAAqB,SAAQ,gBAAgB;IAC5D,IAAI,EAAE,UAAU,CAAC;IACjB,EAAE,EAAE,MAAM,CAAC;IACX,MAAM,EAAE,MAAM,GAAG,MAAM,CAAC;IACxB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAmB,SAAQ,gBAAgB;IAC1D,IAAI,EAAE,SAAS,CAAC;IAChB,cAAc,EAAE,MAAM,CAAC;IACvB,UAAU,EAAE,MAAM,CAAC;IACnB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,MAAM,CAAC,EAAE,MAAM,GAAG,MAAM,CAAC;IACzB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,WAAW,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,uBAAwB,SAAQ,gBAAgB;IAC/D,IAAI,EAAE,cAAc,CAAC;IACrB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,MAAM,WAAW,yBAA0B,SAAQ,gBAAgB;IACjE,IAAI,EAAE,gBAAgB,CAAC;IACvB,OAAO,EAAE,MAAM,CAAC;IAChB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,mBAAoB,SAAQ,gBAAgB;IAC3D,IAAI,EAAE,SAAS,CAAC;IAChB,WAAW,CAAC,EAAE,eAAe,EAAE,CAAC;CACjC;AAED,MAAM,MAAM,YAAY,GACpB,oBAAoB,GACpB,kBAAkB,GAClB,uBAAuB,GACvB,yBAAyB,GACzB,mBAAmB,CAAC;AAExB,MAAM,WAAW,UAAU;IACzB,OAAO,EAAE,CAAC,CAAC;IACX,SAAS,EAAE,OAAO,CAAC;IACnB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,YAAY,EAAE,MAAM,CAAC;IACrB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,CAAC,EAAE,UAAU,CAAC;CACzB;AAED,MAAM,WAAW,aAAa;IAC5B,OAAO,EAAE,YAAY,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IACzB,KAAK,CAAC,EAAE,UAAU,CAAC;CACpB;AAED,MAAM,WAAW,eAAe;IAC9B,0BAA0B,CAAC,EAAE,OAAO,CAAC;CACtC;AAED,MAAM,WAAW,oBAAoB;IACnC,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,GAAG,CAAC,EAAE,MAAM,CAAC;IACb,UAAU,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,iBAAiB;IAChC,MAAM,EAAE,MAAM,CAAC;IACf,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,UAAU,EAAE,UAAU,CAAC;IACvB,gBAAgB,CAAC,EAAE,OAAO,CAAC;IAC3B,SAAS,CAAC,EAAE,UAAU,CAAC;CACxB;AAkCD,wBAAgB,oBAAoB,CAAC,KAAK,EAAE,MAAM,GAAG,OAAO,CAS3D;AAmBD,wBAAgB,WAAW,IAAI,MAAM,CAEpC;AAED,wBAAgB,YAAY,CAAC,UAAU,SAAyB,GAAG,MAAM,CAKxE;AAED,wBAAgB,mBAAmB,CAAC,CAAC,SAAS,IAAI,CAAC,YAAY,EAAE,OAAO,GAAG,KAAK,CAAC,EAC/E,OAAO,EAAE,CAAC,EACV,QAAQ,GAAE,oBAAyB,GAClC,CAAC,GAAG,IAAI,CAAC,gBAAgB,EAAE,OAAO,GAAG,KAAK,CAAC,CAO7C;AAED,wBAAgB,qBAAqB,CACnC,OAAO,EAAE,IAAI,CAAC,oBAAoB,EAAE,OAAO,GAAG,KAAK,CAAC,EACpD,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,oBAAoB,CAEtB;AAED,wBAAgB,mBAAmB,CACjC,OAAO,EAAE,IAAI,CAAC,kBAAkB,EAAE,OAAO,GAAG,KAAK,CAAC,EAClD,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,kBAAkB,CAEpB;AAED,wBAAgB,wBAAwB,CACtC,OAAO,EAAE,IAAI,CAAC,uBAAuB,EAAE,OAAO,GAAG,KAAK,CAAC,EACvD,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,uBAAuB,CAEzB;AAED,wBAAgB,0BAA0B,CACxC,OAAO,EAAE,IAAI,CAAC,yBAAyB,EAAE,OAAO,GAAG,KAAK,CAAC,EACzD,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,yBAAyB,CAE3B;AAED,wBAAgB,oBAAoB,CAClC,OAAO,EAAE,IAAI,CAAC,mBAAmB,EAAE,OAAO,GAAG,KAAK,CAAC,EACnD,QAAQ,CAAC,EAAE,oBAAoB,GAC9B,mBAAmB,CAErB;AAED,wBAAgB,cAAc,CAC5B,OAAO,EAAE,YAAY,EACrB,OAAO,GAAE;IAAE,QAAQ,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAAC,KAAK,CAAC,EAAE,UAAU,CAAA;CAAO,GAC7D,aAAa,CASf;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,aAAa,GAAG,MAAM,CAK9D;AAED,wBAAgB,aAAa,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,GAAE,eAAoB,GAAG,MAAM,CAS5F;AAED,wBAAgB,YAAY,CAAC,GAAG,EAAE,MAAM,GAAG,IAAI,CAK9C;AAED,wBAAgB,kBAAkB,CAAC,QAAQ,EAAE,aAAa,EAAE,OAAO,CAAC,EAAE,eAAe,GAAG,MAAM,CAI7F;AAED,wBAAgB,6BAA6B,CAC3C,QAAQ,EAAE,IAAI,CAAC,aAAa,EAAE,SAAS,GAAG,UAAU,CAAC,GACpD,MAAM,CAKR;AAED,wBAAsB,wBAAwB,CAC5C,QAAQ,EAAE,IAAI,CAAC,aAAa,EAAE,SAAS,GAAG,UAAU,CAAC,GACpD,OAAO,CAAC,MAAM,CAAC,CAOjB;AAED,wBAAsB,YAAY,CAChC,QAAQ,EAAE,aAAa,EACvB,OAAO,EAAE,iBAAiB,GACzB,OAAO,CAAC,aAAa,CAAC,CA6BxB"}

package/dist/index.js

@@ -0,0 +1,156 @@
+const DEFAULT_EXPIRY_SECONDS = 300;
+function bytesToBase64Url(bytes) {
+    if (typeof Buffer !== "undefined") {
+        return Buffer.from(bytes)
+            .toString("base64")
+            .replace(/\+/g, "-")
+            .replace(/\//g, "_")
+            .replace(/=+$/g, "");
+    }
+    let binary = "";
+    for (const byte of bytes)
+        binary += String.fromCharCode(byte);
+    return btoa(binary).replace(/\+/g, "-").replace(/\//g, "_").replace(/=+$/g, "");
+}
+function stringToBase64Url(value) {
+    return bytesToBase64Url(new TextEncoder().encode(value));
+}
+function assertValidDappOrigin(origin) {
+    let url;
+    try {
+        url = new URL(origin);
+    }
+    catch {
+        throw new Error("dApp origin must be a valid URL");
+    }
+    if (url.protocol !== "https:") {
+        throw new Error("dApp origin must use HTTPS");
+    }
+}
+export function isAllowedCallbackUrl(value) {
+    try {
+        const url = new URL(value);
+        const host = url.hostname.toLowerCase();
+        const isLocal = host === "localhost" || host === "127.0.0.1";
+        return url.protocol === "https:" || (url.protocol === "http:" && isLocal);
+    }
+    catch {
+        return false;
+    }
+}
+function canonicalize(value) {
+    if (Array.isArray(value)) {
+        return `[${value.map((item) => canonicalize(item)).join(",")}]`;
+    }
+    if (value && typeof value === "object") {
+        const entries = Object.entries(value)
+            .sort(([a], [b]) => a.localeCompare(b))
+            .map(([key, entry]) => `${JSON.stringify(key)}:${canonicalize(entry)}`);
+        return `{${entries.join(",")}}`;
+    }
+    return JSON.stringify(value);
+}
+function unixNow() {
+    return Math.floor(Date.now() / 1000);
+}
+export function createNonce() {
+    return globalThis.crypto.randomUUID().replace(/-/g, "");
+}
+export function createExpiry(ttlSeconds = DEFAULT_EXPIRY_SECONDS) {
+    if (!Number.isFinite(ttlSeconds) || ttlSeconds <= 0) {
+        throw new Error("ttlSeconds must be a positive number");
+    }
+    return unixNow() + Math.floor(ttlSeconds);
+}
+export function withRequestDefaults(request, defaults = {}) {
+    assertValidDappOrigin(request.dapp.origin);
+    return {
+        ...request,
+        nonce: defaults.nonce ?? createNonce(),
+        exp: defaults.exp ?? createExpiry(defaults.ttlSeconds),
+    };
+}
+export function createTransferRequest(request, defaults) {
+    return withRequestDefaults(request, defaults);
+}
+export function createScCallRequest(request, defaults) {
+    return withRequestDefaults(request, defaults);
+}
+export function createSignMessageRequest(request, defaults) {
+    return withRequestDefaults(request, defaults);
+}
+export function createVerifyMessageRequest(request, defaults) {
+    return withRequestDefaults(request, defaults);
+}
+export function createConnectRequest(request, defaults) {
+    return withRequestDefaults(request, defaults);
+}
+export function createEnvelope(request, options = {}) {
+    if (options.callback && !isAllowedCallbackUrl(options.callback)) {
+        throw new Error("Callback URL must use HTTPS or localhost HTTP");
+    }
+    return {
+        request,
+        callback: options.callback ?? null,
+        proof: options.proof,
+    };
+}
+export function encodeEnvelope(envelope) {
+    if (envelope.callback && !isAllowedCallbackUrl(envelope.callback)) {
+        throw new Error("Callback URL must use HTTPS or localhost HTTP");
+    }
+    return stringToBase64Url(JSON.stringify(envelope));
+}
+export function buildSigilUrl(envelope, options = {}) {
+    const payload = encodeEnvelope(envelope);
+    const params = new URLSearchParams({ d: payload });
+    if (options.includeLegacyCallbackParam && envelope.callback) {
+        params.set("cb", envelope.callback);
+    }
+    return `sigil://v1/request?${params.toString()}`;
+}
+export function openSigilUrl(url) {
+    if (typeof window === "undefined") {
+        throw new Error("openSigilUrl can only be used in a browser environment");
+    }
+    window.location.assign(url);
+}
+export function launchSigilRequest(envelope, options) {
+    const url = buildSigilUrl(envelope, options);
+    openSigilUrl(url);
+    return url;
+}
+export function serializeSignedRequestPayload(envelope) {
+    return canonicalize({
+        request: envelope.request,
+        callback: envelope.callback ?? null,
+    });
+}
+export async function hashSignedRequestPayload(envelope) {
+    const payload = serializeSignedRequestPayload(envelope);
+    const digest = await globalThis.crypto.subtle.digest("SHA-256", new TextEncoder().encode(payload));
+    return bytesToBase64Url(new Uint8Array(digest));
+}
+export async function signEnvelope(envelope, options) {
+    const payload = serializeSignedRequestPayload(envelope);
+    const payloadHash = await hashSignedRequestPayload(envelope);
+    const key = await globalThis.crypto.subtle.importKey("jwk", options.privateJwk, { name: "ECDSA", namedCurve: "P-256" }, false, ["sign"]);
+    const signature = await globalThis.crypto.subtle.sign({ name: "ECDSA", hash: "SHA-256" }, key, new TextEncoder().encode(payload));
+    return {
+        ...envelope,
+        proof: {
+            version: 1,
+            algorithm: "ES256",
+            issuer: options.issuer,
+            key_id: options.keyId,
+            payload_hash: payloadHash,
+            signature: bytesToBase64Url(new Uint8Array(signature)),
+            public_jwk: options.includePublicJwk ? options.publicJwk ?? derivePublicJwk(options.privateJwk) : undefined,
+        },
+    };
+}
+function derivePublicJwk(privateJwk) {
+    const { d: _discarded, key_ops: _ops, ...rest } = privateJwk;
+    return rest;
+}
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAoGA,MAAM,sBAAsB,GAAG,GAAG,CAAC;AAEnC,SAAS,gBAAgB,CAAC,KAAiB;IACzC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC;aACtB,QAAQ,CAAC,QAAQ,CAAC;aAClB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC;aACnB,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACzB,CAAC;IAED,IAAI,MAAM,GAAG,EAAE,CAAC;IAChB,KAAK,MAAM,IAAI,IAAI,KAAK;QAAE,MAAM,IAAI,MAAM,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC;IAC9D,OAAO,IAAI,CAAC,MAAM,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,GAAG,CAAC,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AAClF,CAAC;AAED,SAAS,iBAAiB,CAAC,KAAa;IACtC,OAAO,gBAAgB,CAAC,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC;AAC3D,CAAC;AAED,SAAS,qBAAqB,CAAC,MAAc;IAC3C,IAAI,GAAQ,CAAC;IACb,IAAI,CAAC;QACH,GAAG,GAAG,IAAI,GAAG,CAAC,MAAM,CAAC,CAAC;IACxB,CAAC;IAAC,MAAM,CAAC;QACP,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAC;IACrD,CAAC;IACD,IAAI,GAAG,CAAC,QAAQ,KAAK,QAAQ,EAAE,CAAC;QAC9B,MAAM,IAAI,KAAK,CAAC,4BAA4B,CAAC,CAAC;IAChD,CAAC;AACH,CAAC;AAED,MAAM,UAAU,oBAAoB,CAAC,KAAa;IAChD,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;QAC3B,MAAM,IAAI,GAAG,GAAG,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;QACxC,MAAM,OAAO,GAAG,IAAI,KAAK,WAAW,IAAI,IAAI,KAAK,WAAW,CAAC;QAC7D,OAAO,GAAG,CAAC,QAAQ,KAAK,QAAQ,IAAI,CAAC,GAAG,CAAC,QAAQ,KAAK,OAAO,IAAI,OAAO,CAAC,CAAC;IAC5E,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,KAAK,CAAC;IACf,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,KAAc;IAClC,IAAI,KAAK,CAAC,OAAO,CAAC,KAAK,CAAC,EAAE,CAAC;QACzB,OAAO,IAAI,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAClE,CAAC;IACD,IAAI,KAAK,IAAI,OAAO,KAAK,KAAK,QAAQ,EAAE,CAAC;QACvC,MAAM,OAAO,GAAG,MAAM,CAAC,OAAO,CAAC,KAAgC,CAAC;aAC7D,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,aAAa,CAAC,CAAC,CAAC,CAAC;aACtC,GAAG,CAAC,CAAC,CAAC,GAAG,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC;QAC1E,OAAO,IAAI,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC;IAClC,CAAC;IACD,OAAO,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED,SAAS,OAAO;IACd,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,CAAC;AACvC,CAAC;AAED,MAAM,UAAU,WAAW;IACzB,OAAO,UAAU,CAAC,MAAM,CAAC,UAAU,EAAE,CAAC,OAAO,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;AAC1D,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,UAAU,GAAG,sBAAsB;IAC9D,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,UAAU,CAAC,IAAI,UAAU,IAAI,CAAC,EAAE,CAAC;QACpD,MAAM,IAAI,KAAK,CAAC,sCAAsC,CAAC,CAAC;IAC1D,CAAC;IACD,OAAO,OAAO,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC;AAC5C,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,OAAU,EACV,WAAiC,EAAE;IAEnC,qBAAqB,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IAC3C,OAAO;QACL,GAAG,OAAO;QACV,KAAK,EAAE,QAAQ,CAAC,KAAK,IAAI,WAAW,EAAE;QACtC,GAAG,EAAE,QAAQ,CAAC,GAAG,IAAI,YAAY,CAAC,QAAQ,CAAC,UAAU,CAAC;KACvD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB,CACnC,OAAoD,EACpD,QAA+B;IAE/B,OAAO,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,mBAAmB,CACjC,OAAkD,EAClD,QAA+B;IAE/B,OAAO,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,wBAAwB,CACtC,OAAuD,EACvD,QAA+B;IAE/B,OAAO,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,0BAA0B,CACxC,OAAyD,EACzD,QAA+B;IAE/B,OAAO,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,oBAAoB,CAClC,OAAmD,EACnD,QAA+B;IAE/B,OAAO,mBAAmB,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;AAChD,CAAC;AAED,MAAM,UAAU,cAAc,CAC5B,OAAqB,EACrB,UAA4D,EAAE;IAE9D,IAAI,OAAO,CAAC,QAAQ,IAAI,CAAC,oBAAoB,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;QAChE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IACD,OAAO;QACL,OAAO;QACP,QAAQ,EAAE,OAAO,CAAC,QAAQ,IAAI,IAAI;QAClC,KAAK,EAAE,OAAO,CAAC,KAAK;KACrB,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,cAAc,CAAC,QAAuB;IACpD,IAAI,QAAQ,CAAC,QAAQ,IAAI,CAAC,oBAAoB,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC;QAClE,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAC;IACnE,CAAC;IACD,OAAO,iBAAiB,CAAC,IAAI,CAAC,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC;AACrD,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,QAAuB,EAAE,UAA2B,EAAE;IAClF,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAC;IACzC,MAAM,MAAM,GAAG,IAAI,eAAe,CAAC,EAAE,CAAC,EAAE,OAAO,EAAE,CAAC,CAAC;IAEnD,IAAI,OAAO,CAAC,0BAA0B,IAAI,QAAQ,CAAC,QAAQ,EAAE,CAAC;QAC5D,MAAM,CAAC,GAAG,CAAC,IAAI,EAAE,QAAQ,CAAC,QAAQ,CAAC,CAAC;IACtC,CAAC;IAED,OAAO,sBAAsB,MAAM,CAAC,QAAQ,EAAE,EAAE,CAAC;AACnD,CAAC;AAED,MAAM,UAAU,YAAY,CAAC,GAAW;IACtC,IAAI,OAAO,MAAM,KAAK,WAAW,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,wDAAwD,CAAC,CAAC;IAC5E,CAAC;IACD,MAAM,CAAC,QAAQ,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC;AAC9B,CAAC;AAED,MAAM,UAAU,kBAAkB,CAAC,QAAuB,EAAE,OAAyB;IACnF,MAAM,GAAG,GAAG,aAAa,CAAC,QAAQ,EAAE,OAAO,CAAC,CAAC;IAC7C,YAAY,CAAC,GAAG,CAAC,CAAC;IAClB,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,6BAA6B,CAC3C,QAAqD;IAErD,OAAO,YAAY,CAAC;QAClB,OAAO,EAAE,QAAQ,CAAC,OAAO;QACzB,QAAQ,EAAE,QAAQ,CAAC,QAAQ,IAAI,IAAI;KACpC,CAAC,CAAC;AACL,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,wBAAwB,CAC5C,QAAqD;IAErD,MAAM,OAAO,GAAG,6BAA6B,CAAC,QAAQ,CAAC,CAAC;IACxD,MAAM,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,MAAM,CAClD,SAAS,EACT,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAClC,CAAC;IACF,OAAO,gBAAgB,CAAC,IAAI,UAAU,CAAC,MAAM,CAAC,CAAC,CAAC;AAClD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,YAAY,CAChC,QAAuB,EACvB,OAA0B;IAE1B,MAAM,OAAO,GAAG,6BAA6B,CAAC,QAAQ,CAAC,CAAC;IACxD,MAAM,WAAW,GAAG,MAAM,wBAAwB,CAAC,QAAQ,CAAC,CAAC;IAC7D,MAAM,GAAG,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,SAAS,CAClD,KAAK,EACL,OAAO,CAAC,UAAU,EAClB,EAAE,IAAI,EAAE,OAAO,EAAE,UAAU,EAAE,OAAO,EAAE,EACtC,KAAK,EACL,CAAC,MAAM,CAAC,CACT,CAAC;IAEF,MAAM,SAAS,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,MAAM,CAAC,IAAI,CACnD,EAAE,IAAI,EAAE,OAAO,EAAE,IAAI,EAAE,SAAS,EAAE,EAClC,GAAG,EACH,IAAI,WAAW,EAAE,CAAC,MAAM,CAAC,OAAO,CAAC,CAClC,CAAC;IAEF,OAAO;QACL,GAAG,QAAQ;QACX,KAAK,EAAE;YACL,OAAO,EAAE,CAAC;YACV,SAAS,EAAE,OAAO;YAClB,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,MAAM,EAAE,OAAO,CAAC,KAAK;YACrB,YAAY,EAAE,WAAW;YACzB,SAAS,EAAE,gBAAgB,CAAC,IAAI,UAAU,CAAC,SAAS,CAAC,CAAC;YACtD,UAAU,EAAE,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,OAAO,CAAC,SAAS,IAAI,eAAe,CAAC,OAAO,CAAC,UAAU,CAAC,CAAC,CAAC,CAAC,SAAS;SAC5G;KACF,CAAC;AACJ,CAAC;AAED,SAAS,eAAe,CAAC,UAAsB;IAC7C,MAAM,EAAE,CAAC,EAAE,UAAU,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,IAAI,EAAE,GAAG,UAAU,CAAC;IAC7D,OAAO,IAAI,CAAC;AACd,CAAC"}

package/package.json

@@ -0,0 +1,63 @@
+{
+  "name": "@sigil-oss/connect",
+  "version": "0.2.0",
+  "description": "Framework-agnostic TypeScript SDK for launching and signing Sigil deep-link requests.",
+  "type": "module",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/sigil-oss/sigil.connect.git"
+  },
+  "homepage": "https://github.com/sigil-oss/sigil.connect#readme",
+  "bugs": {
+    "url": "https://github.com/sigil-oss/sigil.connect/issues"
+  },
+  "keywords": [
+    "sigil",
+    "qubic",
+    "wallet",
+    "deeplink",
+    "sdk",
+    "typescript"
+  ],
+  "sideEffects": false,
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md",
+    "LICENSE",
+    "TESTING.md"
+  ],
+  "main": "./dist/index.js",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.js",
+      "default": "./dist/index.js"
+    }
+  },
+  "engines": {
+    "bun": ">=1.1.0",
+    "node": ">=18"
+  },
+  "publishConfig": {
+    "access": "public",
+    "provenance": true
+  },
+  "scripts": {
+    "build": "tsc -p tsconfig.build.json",
+    "lint": "tsc --noEmit -p tsconfig.json",
+    "test": "bun test",
+    "check": "bun run lint && bun run test && bun run build",
+    "changeset": "changeset",
+    "version": "changeset version",
+    "prepublishOnly": "bun run check"
+  },
+  "devDependencies": {
+    "@changesets/cli": "^2.29.6",
+    "@types/bun": "latest",
+    "typescript": "^5.8.3"
+  }
+}