@canton-network/core-splice-provider 0.1.0

package/README.md

@@ -0,0 +1 @@
+# splice-provider

package/dist/SpliceProvider.d.ts

@@ -0,0 +1,19 @@
+import { RequestPayload } from '@canton-network/core-types';
+export type EventListener<T> = (...args: T[]) => void;
+export interface SpliceProvider {
+    request<T>(args: RequestPayload): Promise<T>;
+    on<T>(event: string, listener: EventListener<T>): SpliceProvider;
+    emit<T>(event: string, ...args: T[]): boolean;
+    removeListener<T>(event: string, listenerToRemove: EventListener<T>): SpliceProvider;
+}
+export declare abstract class SpliceProviderBase implements SpliceProvider {
+    listeners: {
+        [event: string]: EventListener<unknown>[];
+    };
+    constructor();
+    abstract request<T>(args: RequestPayload): Promise<T>;
+    on<T>(event: string, listener: EventListener<T>): SpliceProvider;
+    emit<T>(event: string, ...args: T[]): boolean;
+    removeListener<T>(event: string, listenerToRemove: EventListener<T>): SpliceProvider;
+}
+//# sourceMappingURL=SpliceProvider.d.ts.map

package/dist/SpliceProvider.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpliceProvider.d.ts","sourceRoot":"","sources":["../src/SpliceProvider.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAA;AAE3D,MAAM,MAAM,aAAa,CAAC,CAAC,IAAI,CAAC,GAAG,IAAI,EAAE,CAAC,EAAE,KAAK,IAAI,CAAA;AAErD,MAAM,WAAW,cAAc;IAC3B,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC,CAAA;IAC5C,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,cAAc,CAAA;IAChE,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO,CAAA;IAC7C,cAAc,CAAC,CAAC,EACZ,KAAK,EAAE,MAAM,EACb,gBAAgB,EAAE,aAAa,CAAC,CAAC,CAAC,GACnC,cAAc,CAAA;CACpB;AAED,8BAAsB,kBAAmB,YAAW,cAAc;IAC9D,SAAS,EAAE;QAAE,CAAC,KAAK,EAAE,MAAM,GAAG,aAAa,CAAC,OAAO,CAAC,EAAE,CAAA;KAAE,CAAA;;IAMxD,QAAQ,CAAC,OAAO,CAAC,CAAC,EAAE,IAAI,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;IAG9C,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,QAAQ,EAAE,aAAa,CAAC,CAAC,CAAC,GAAG,cAAc;IAUhE,IAAI,CAAC,CAAC,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,IAAI,EAAE,CAAC,EAAE,GAAG,OAAO;IAQ7C,cAAc,CAAC,CAAC,EACnB,KAAK,EAAE,MAAM,EACb,gBAAgB,EAAE,aAAa,CAAC,CAAC,CAAC,GACnC,cAAc;CASpB"}

package/dist/SpliceProvider.js

@@ -0,0 +1,28 @@
+export class SpliceProviderBase {
+    listeners;
+    constructor() {
+        this.listeners = {}; // Event listeners
+    }
+    // Event handling
+    on(event, listener) {
+        if (!this.listeners[event]) {
+            this.listeners[event] = [];
+        }
+        const listeners = this.listeners[event];
+        listeners.push(listener);
+        return this;
+    }
+    emit(event, ...args) {
+        if (this.listeners[event]) {
+            this.listeners[event].forEach((listener) => listener(...args));
+            return true;
+        }
+        return false;
+    }
+    removeListener(event, listenerToRemove) {
+        if (!this.listeners[event])
+            return this;
+        this.listeners[event] = this.listeners[event].filter((listener) => listener !== listenerToRemove);
+        return this;
+    }
+}

package/dist/SpliceProviderHttp.d.ts

@@ -0,0 +1,12 @@
+import { RequestPayload } from '@canton-network/core-types';
+import { SpliceProviderBase } from './SpliceProvider';
+export declare class SpliceProviderHttp extends SpliceProviderBase {
+    private url;
+    private sessionToken?;
+    private socket;
+    private transport;
+    private openSocket;
+    constructor(url: URL, sessionToken?: string);
+    request<T>({ method, params }: RequestPayload): Promise<T>;
+}
+//# sourceMappingURL=SpliceProviderHttp.d.ts.map

package/dist/SpliceProviderHttp.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpliceProviderHttp.d.ts","sourceRoot":"","sources":["../src/SpliceProviderHttp.ts"],"names":[],"mappings":"AAAA,OAAO,EAGH,cAAc,EAEjB,MAAM,4BAA4B,CAAA;AACnC,OAAO,EAAE,kBAAkB,EAAE,MAAM,kBAAkB,CAAA;AAIrD,qBAAa,kBAAmB,SAAQ,kBAAkB;IA6BlD,OAAO,CAAC,GAAG;IA5Bf,OAAO,CAAC,YAAY,CAAC,CAAQ;IAC7B,OAAO,CAAC,MAAM,CAAQ;IACtB,OAAO,CAAC,SAAS,CAAe;IAEhC,OAAO,CAAC,UAAU;gBAwBN,GAAG,EAAE,GAAG,EAChB,YAAY,CAAC,EAAE,MAAM;IAyCZ,OAAO,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;CAa1E"}

package/dist/SpliceProviderHttp.js

@@ -0,0 +1,72 @@
+import { HttpTransport, isSpliceMessageEvent, WalletEvent, } from '@canton-network/core-types';
+import { SpliceProviderBase } from './SpliceProvider';
+import { io } from 'socket.io-client';
+import { popupHref } from '@canton-network/core-wallet-ui-components';
+export class SpliceProviderHttp extends SpliceProviderBase {
+    url;
+    sessionToken;
+    socket;
+    transport;
+    openSocket(url) {
+        // Assumes the RPC URL is on /rpc, and the socket URL is the same but without the /rpc path.
+        const socketUrl = new URL(url.href);
+        socketUrl.pathname = '';
+        if (this.socket) {
+            this.socket.disconnect();
+        }
+        const socket = io(socketUrl.href, {
+            forceNew: true,
+            auth: {
+                token: `Bearer ${this.sessionToken}`,
+            },
+        });
+        socket.onAny((event, ...args) => {
+            this.emit(event, ...args);
+        });
+        return socket;
+    }
+    constructor(url, sessionToken) {
+        super();
+        this.url = url;
+        if (sessionToken)
+            this.sessionToken = sessionToken;
+        this.transport = new HttpTransport(url, sessionToken);
+        this.socket = this.openSocket(url);
+        // Listen for the auth success event sent from the WK UI popup to the SDK running in the parent window.
+        window.addEventListener('message', async (event) => {
+            if (!isSpliceMessageEvent(event))
+                return;
+            if (event.data.type === WalletEvent.SPLICE_WALLET_IDP_AUTH_SUCCESS) {
+                this.sessionToken = event.data.token;
+                this.transport = new HttpTransport(url, this.sessionToken);
+                console.log(`SpliceProviderHttp: setting sessionToken to ${this.sessionToken}`);
+                this.openSocket(this.url);
+                // We requery the status explicitly here, as it's not guaranteed that the socket will be open & authenticated
+                // before the `onConnected` event is fired from the `addSession` RPC call. The dappApi.StatusResult and
+                // dappApi.OnConnectedEvent are mapped manually to avoid dependency.
+                this.request({ method: 'status' }).then((status) => {
+                    const statusResult = status;
+                    this.emit('onConnected', {
+                        kernel: statusResult.kernel,
+                        chainId: statusResult.chainId,
+                        sessionToken: this.sessionToken,
+                    });
+                });
+            }
+        });
+    }
+    async request({ method, params }) {
+        const response = await this.transport.submit({ method, params });
+        if ('error' in response)
+            throw new Error(response.error.message);
+        const result = response.result;
+        if (method === 'prepareExecute') {
+            const { userUrl } = result;
+            if (!userUrl) {
+                throw new Error('No userUrl provided in response');
+            }
+            popupHref(userUrl);
+        }
+        return result;
+    }
+}

package/dist/SpliceProviderWindow.d.ts

@@ -0,0 +1,8 @@
+import { RequestPayload } from '@canton-network/core-types';
+import { SpliceProviderBase } from './SpliceProvider.js';
+export declare class SpliceProviderWindow extends SpliceProviderBase {
+    private transport;
+    constructor();
+    request<T>({ method, params }: RequestPayload): Promise<T>;
+}
+//# sourceMappingURL=SpliceProviderWindow.d.ts.map

package/dist/SpliceProviderWindow.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"SpliceProviderWindow.d.ts","sourceRoot":"","sources":["../src/SpliceProviderWindow.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,cAAc,EAAmB,MAAM,4BAA4B,CAAA;AAC5E,OAAO,EAAE,kBAAkB,EAAE,MAAM,qBAAqB,CAAA;AAExD,qBAAa,oBAAqB,SAAQ,kBAAkB;IACxD,OAAO,CAAC,SAAS,CAAiB;;IAOrB,OAAO,CAAC,CAAC,EAAE,EAAE,MAAM,EAAE,MAAM,EAAE,EAAE,cAAc,GAAG,OAAO,CAAC,CAAC,CAAC;CAI1E"}

package/dist/SpliceProviderWindow.js

@@ -0,0 +1,13 @@
+import { WindowTransport } from '@canton-network/core-types';
+import { SpliceProviderBase } from './SpliceProvider.js';
+export class SpliceProviderWindow extends SpliceProviderBase {
+    transport;
+    constructor() {
+        super();
+        this.transport = new WindowTransport(window);
+    }
+    async request({ method, params }) {
+        const response = await this.transport.submit({ method, params });
+        return response.result;
+    }
+}

package/dist/index.d.ts

@@ -0,0 +1,15 @@
+import { SpliceProvider } from './SpliceProvider';
+declare global {
+    interface Window {
+        splice?: SpliceProvider;
+        canton?: SpliceProvider;
+        ethereum?: SpliceProvider;
+    }
+}
+export declare enum ProviderType {
+    WINDOW = 0,
+    HTTP = 1
+}
+export declare function injectSpliceProvider(providerType: ProviderType, url?: URL, sessionToken?: string): SpliceProvider;
+export * from './SpliceProvider';
+//# 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,OAAO,EAAE,cAAc,EAAE,MAAM,kBAAkB,CAAA;AAIjD,OAAO,CAAC,MAAM,CAAC;IACX,UAAU,MAAM;QACZ,MAAM,CAAC,EAAE,cAAc,CAAA;QACvB,MAAM,CAAC,EAAE,cAAc,CAAA;QACvB,QAAQ,CAAC,EAAE,cAAc,CAAA;KAC5B;CACJ;AAED,oBAAY,YAAY;IACpB,MAAM,IAAA;IACN,IAAI,IAAA;CACP;AAED,wBAAgB,oBAAoB,CAChC,YAAY,EAAE,YAAY,EAC1B,GAAG,CAAC,EAAE,GAAG,EACT,YAAY,CAAC,EAAE,MAAM,GACtB,cAAc,CA2BhB;AAED,cAAc,kBAAkB,CAAA"}

package/dist/index.js

@@ -0,0 +1,31 @@
+import { SpliceProviderHttp } from './SpliceProviderHttp';
+import { SpliceProviderWindow } from './SpliceProviderWindow';
+export var ProviderType;
+(function (ProviderType) {
+    ProviderType[ProviderType["WINDOW"] = 0] = "WINDOW";
+    ProviderType[ProviderType["HTTP"] = 1] = "HTTP";
+})(ProviderType || (ProviderType = {}));
+export function injectSpliceProvider(providerType, url, sessionToken) {
+    // Check if the provider is already injected
+    const existing = window.splice || window.canton || window.ethereum;
+    if (existing)
+        return existing;
+    // Inject the SpliceProvider instance
+    if (providerType === ProviderType.WINDOW) {
+        window.splice = new SpliceProviderWindow();
+    }
+    else if (providerType === ProviderType.HTTP) {
+        if (!url || !(url instanceof URL)) {
+            throw new Error('Invalid URL for HTTP provider. Please provide a valid URL instance.');
+        }
+        window.splice = new SpliceProviderHttp(url, sessionToken);
+    }
+    else {
+        throw new Error('Invalid provider type. Use ProviderType.WINDOW or ProviderType.HTTP.');
+    }
+    window.canton = window.splice; // For compatibility with Canton dApps
+    window.ethereum = window.splice; // For EIP-1193 compatibility
+    console.log('Splice provider injected successfully.');
+    return window.splice;
+}
+export * from './SpliceProvider';

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@canton-network/core-splice-provider",
+  "version": "0.1.0",
+  "type": "module",
+  "description": "A JavaScript Splice Provider API (EIP-1193 compliant).",
+  "repository": "https://github.com/hyperledger-labs/splice-wallet-kernel",
+  "license": "Apache-2.0",
+  "author": "Marc Juchli <marc.juchli@digitalasset.com>",
+  "packageManager": "yarn@4.9.2",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -b",
+    "dev": "tsc -b --watch",
+    "clean": "tsc -b --clean; rm -rf dist"
+  },
+  "devDependencies": {
+    "typescript": "^5.8.3"
+  },
+  "dependencies": {
+    "@canton-network/core-types": "^0.1.0",
+    "@canton-network/core-wallet-ui-components": "^0.1.0",
+    "socket.io-client": "^4.8.1"
+  },
+  "files": [
+    "dist/*"
+  ],
+  "publishConfig": {
+    "access": "public"
+  }
+}