@tari-project/wallet-daemon-signer 0.5.0

package/LICENSE

@@ -0,0 +1,29 @@
+BSD 3-Clause License
+
+Copyright (c) 2023, The Tari Developer Community
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its
+   contributors may be used to endorse or promote products derived from
+   this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

package/dist/index.d.ts

@@ -0,0 +1,3 @@
+export { TariConnection } from "./webrtc";
+export * from "@tari-project/tari-permissions";
+export * from "./signer";

package/dist/index.js

@@ -0,0 +1,3 @@
+export { TariConnection } from "./webrtc";
+export * from "@tari-project/tari-permissions";
+export * from "./signer";

package/dist/signer.d.ts

@@ -0,0 +1,43 @@
+import { TariPermissions } from "@tari-project/tari-permissions";
+import { SubmitTransactionRequest, TransactionResult, SubmitTransactionResponse, VaultBalances, TemplateDefinition, Substate, ListSubstatesResponse, TariSigner } from "@tari-project/tari-signer";
+import { Account } from "@tari-project/tari-signer";
+import { WalletDaemonClient, SubstateType, ListAccountNftRequest, ListAccountNftResponse } from "@tari-project/wallet_jrpc_client";
+export declare const WalletDaemonNotConnected = "WALLET_DAEMON_NOT_CONNECTED";
+export declare const Unsupported = "UNSUPPORTED";
+export interface WalletDaemonBaseParameters {
+    permissions: TariPermissions;
+    optionalPermissions?: TariPermissions;
+    onConnection?: () => void;
+}
+export interface WalletDaemonParameters extends WalletDaemonBaseParameters {
+    signalingServerUrl?: string;
+    webRtcConfig?: RTCConfiguration;
+    name?: string;
+}
+export interface WalletDaemonFetchParameters extends WalletDaemonBaseParameters {
+    serverUrl: string;
+}
+export declare class WalletDaemonTariSigner implements TariSigner {
+    signerName: string;
+    params: WalletDaemonParameters;
+    client: WalletDaemonClient;
+    private constructor();
+    static build(params: WalletDaemonParameters): Promise<WalletDaemonTariSigner>;
+    static buildFetchSigner(params: WalletDaemonFetchParameters): Promise<WalletDaemonTariSigner>;
+    private static buildPermissions;
+    private getWebRtcTransport;
+    get token(): string | undefined;
+    get tokenUrl(): string | undefined;
+    isConnected(): boolean;
+    createFreeTestCoins(): Promise<Account>;
+    getAccount(): Promise<Account>;
+    getAccountBalances(componentAddress: string): Promise<unknown>;
+    getSubstate(substateId: string): Promise<Substate>;
+    submitTransaction(req: SubmitTransactionRequest): Promise<SubmitTransactionResponse>;
+    getTransactionResult(transactionId: string): Promise<TransactionResult>;
+    getPublicKey(branch: string, index: number): Promise<string>;
+    getTemplateDefinition(template_address: string): Promise<TemplateDefinition>;
+    getConfidentialVaultBalances(viewKeyId: number, vaultId: string, min?: number | null, max?: number | null): Promise<VaultBalances>;
+    listSubstates(filter_by_template: string | null, filter_by_type: SubstateType | null, limit: number | null, offset: number | null): Promise<ListSubstatesResponse>;
+    getNftsList(req: ListAccountNftRequest): Promise<ListAccountNftResponse>;
+}

package/dist/signer.js

@@ -0,0 +1,183 @@
+import { TariPermissions } from "@tari-project/tari-permissions";
+import { TariConnection } from "./webrtc";
+import { WalletDaemonClient, substateIdToString, } from "@tari-project/wallet_jrpc_client";
+import { WebRtcRpcTransport } from "./webrtc_transport";
+import { convertStringToTransactionStatus } from "@tari-project/tarijs-types";
+export const WalletDaemonNotConnected = "WALLET_DAEMON_NOT_CONNECTED";
+export const Unsupported = "UNSUPPORTED";
+export class WalletDaemonTariSigner {
+    signerName = "WalletDaemon";
+    params;
+    client;
+    constructor(params, connection) {
+        this.params = params;
+        this.client = connection;
+    }
+    static async build(params) {
+        const allPermissions = WalletDaemonTariSigner.buildPermissions(params);
+        let connection = new TariConnection(params.signalingServerUrl, params.webRtcConfig);
+        const client = WalletDaemonClient.new(WebRtcRpcTransport.new(connection));
+        await connection.init(allPermissions, (conn) => {
+            params.onConnection?.();
+            if (conn.token) {
+                client.setToken(conn.token);
+            }
+        });
+        return new WalletDaemonTariSigner(params, client);
+    }
+    static async buildFetchSigner(params) {
+        const allPermissions = WalletDaemonTariSigner.buildPermissions(params);
+        const client = WalletDaemonClient.usingFetchTransport(params.serverUrl);
+        const plainPermissions = allPermissions.toJSON().flatMap((p) => (typeof p === "string" ? [p] : []));
+        const authResponse = await client.authRequest(plainPermissions);
+        await client.authAccept(authResponse, "WalletDaemon");
+        params.onConnection?.();
+        return new WalletDaemonTariSigner(params, client);
+    }
+    static buildPermissions(params) {
+        const allPermissions = new TariPermissions();
+        allPermissions.addPermissions(params.permissions);
+        if (params.optionalPermissions) {
+            allPermissions.addPermissions(params.optionalPermissions);
+        }
+        return allPermissions;
+    }
+    getWebRtcTransport() {
+        const transport = this.client.getTransport();
+        return transport instanceof WebRtcRpcTransport ? transport : undefined;
+    }
+    get token() {
+        return this.getWebRtcTransport()?.token();
+    }
+    get tokenUrl() {
+        if (!this.token) {
+            return undefined;
+        }
+        const name = (this.params.name && encodeURIComponent(this.params.name)) || "";
+        const token = this.token;
+        const permissions = JSON.stringify(this.params.permissions);
+        const optionalPermissions = JSON.stringify(this.params.optionalPermissions);
+        return `tari://${name}/${token}/${permissions}/${optionalPermissions}`;
+    }
+    isConnected() {
+        return this.getWebRtcTransport()?.isConnected() || true;
+    }
+    async createFreeTestCoins() {
+        const res = await this.client.createFreeTestCoins({
+            account: { Name: "template_web" },
+            amount: 1000000,
+            max_fee: null,
+            key_id: 0,
+        });
+        return {
+            account_id: res.account.key_index,
+            address: res.account.address.Component,
+            public_key: res.public_key,
+            resources: [],
+        };
+    }
+    async getAccount() {
+        const { account, public_key } = (await this.client.accountsGetDefault({}));
+        const address = typeof account.address === "object" ? account.address.Component : account.address;
+        const { balances } = await this.client.accountsGetBalances({
+            account: { ComponentAddress: address },
+            refresh: false,
+        });
+        return {
+            account_id: account.key_index,
+            address,
+            public_key,
+            // TODO: should be vaults not resources
+            resources: balances.map((b) => ({
+                type: b.resource_type,
+                resource_address: b.resource_address,
+                balance: b.balance + b.confidential_balance,
+                vault_id: typeof b.vault_address === "object" && "Vault" in b.vault_address ? b.vault_address.Vault : b.vault_address,
+                token_symbol: b.token_symbol,
+            })),
+        };
+    }
+    async getAccountBalances(componentAddress) {
+        return await this.client.accountsGetBalances({ account: { ComponentAddress: componentAddress }, refresh: true });
+    }
+    async getSubstate(substateId) {
+        // Wallet daemon expects a SubstateId as a string
+        const { value, record } = await this.client.substatesGet({ substate_id: substateId });
+        return {
+            value,
+            address: {
+                substate_id: substateIdToString(record.substate_id),
+                version: record.version,
+            },
+        };
+    }
+    async submitTransaction(req) {
+        const params = {
+            transaction: {
+                V1: {
+                    network: req.network,
+                    instructions: req.instructions,
+                    fee_instructions: req.fee_instructions,
+                    inputs: req.required_substates.map((s) => ({
+                        // TODO: Hmm The bindings want a SubstateId object, but the wallet only wants a string. Any is used to skip type checking here
+                        substate_id: s.substate_id,
+                        version: s.version ?? null,
+                    })),
+                    min_epoch: null,
+                    max_epoch: null,
+                    is_seal_signer_authorized: req.is_seal_signer_authorized,
+                },
+            },
+            signing_key_index: req.account_id,
+            autofill_inputs: [],
+            detect_inputs: true,
+            proof_ids: [],
+            detect_inputs_use_unversioned: req.detect_inputs_use_unversioned,
+        };
+        const res = await this.client.submitTransaction(params);
+        return { transaction_id: res.transaction_id };
+    }
+    async getTransactionResult(transactionId) {
+        const res = await this.client.getTransactionResult({ transaction_id: transactionId });
+        return {
+            transaction_id: transactionId,
+            status: convertStringToTransactionStatus(res.status),
+            result: res.result,
+        };
+    }
+    async getPublicKey(branch, index) {
+        const res = await this.client.createKey({ branch: branch, specific_index: index });
+        return res.public_key;
+    }
+    async getTemplateDefinition(template_address) {
+        let resp = await this.client.templatesGet({ template_address });
+        return resp.template_definition;
+    }
+    async getConfidentialVaultBalances(viewKeyId, vaultId, min = null, max = null) {
+        const res = await this.client.viewVaultBalance({
+            view_key_id: viewKeyId,
+            vault_id: vaultId,
+            minimum_expected_value: min,
+            maximum_expected_value: max,
+        });
+        return { balances: res.balances };
+    }
+    async listSubstates(filter_by_template, filter_by_type, limit, offset) {
+        const resp = await this.client.substatesList({
+            filter_by_template,
+            filter_by_type,
+            limit,
+            offset,
+        });
+        const substates = resp.substates.map((s) => ({
+            substate_id: typeof s.substate_id === "string" ? s.substate_id : substateIdToString(s.substate_id),
+            module_name: s.module_name,
+            version: s.version,
+            template_address: s.template_address,
+        }));
+        return { substates };
+    }
+    async getNftsList(req) {
+        return await this.client.nftsList(req);
+    }
+}

package/dist/webrtc.d.ts

@@ -0,0 +1,20 @@
+import { TariPermissions } from "@tari-project/tari-permissions";
+import { transports } from "@tari-project/wallet_jrpc_client";
+export declare class TariConnection {
+    private _peerConnection;
+    private _dataChannel;
+    private _signalingServer;
+    private _callbacks;
+    private _offer?;
+    private _walletToken;
+    onopen: (() => void) | undefined;
+    onConnection: ((conn: TariConnection) => void) | undefined;
+    constructor(signalig_server_url?: string, config?: RTCConfiguration);
+    get token(): string | undefined;
+    init(permissions: TariPermissions, onConnection: ((conn: TariConnection) => void) | undefined): Promise<void>;
+    private setAnswer;
+    private signalingServerPolling;
+    isConnected(): boolean;
+    sendMessage<T>(request: transports.RpcRequest, token: string | undefined, timeout_secs?: number | null): Promise<T>;
+    private config;
+}

package/dist/webrtc.js

@@ -0,0 +1,201 @@
+class SignaligServer {
+    _token;
+    _server_url;
+    constructor(server_url) {
+        console.log(server_url);
+        if (server_url !== undefined) {
+            this._server_url = server_url;
+        }
+        else {
+            this._server_url = "http://localhost:9100";
+        }
+    }
+    async initToken(permissions) {
+        this._token = await this.authLogin(permissions);
+    }
+    get token() {
+        return this._token;
+    }
+    async jsonRpc(method, token, params) {
+        console.log("jsonRpc", method, token, params);
+        let id = 0;
+        id += 1;
+        let address = this._server_url;
+        let headers = { "Content-Type": "application/json" };
+        if (token) {
+            headers["Authorization"] = `Bearer ${token}`;
+        }
+        let response = await fetch(address, {
+            method: "POST",
+            body: JSON.stringify({
+                method: method,
+                jsonrpc: "2.0",
+                id: id,
+                params: params || {},
+            }),
+            headers: headers,
+        });
+        let json = await response.json();
+        if (json.error) {
+            throw json.error;
+        }
+        return json.result;
+    }
+    async authLogin(permissions) {
+        return await this.jsonRpc("auth.login", undefined, permissions);
+    }
+    async storeIceCandidate(ice_candidate) {
+        return await this.jsonRpc("add.offer_ice_candidate", this._token, ice_candidate);
+    }
+    async storeOffer(offer) {
+        return await this.jsonRpc("add.offer", this._token, offer.sdp);
+    }
+    async getAnswer() {
+        return await this.jsonRpc("get.answer", this._token);
+    }
+    async getIceCandidates() {
+        return await this.jsonRpc("get.answer_ice_candidates", this._token);
+    }
+}
+export class TariConnection {
+    _peerConnection;
+    _dataChannel;
+    _signalingServer;
+    _callbacks;
+    _offer;
+    _walletToken;
+    // This is public so that user can directly set the onopen callback that will be called once the data channel is open.
+    onopen;
+    onConnection;
+    constructor(signalig_server_url, config) {
+        this._peerConnection = new RTCPeerConnection(config || this.config());
+        this._dataChannel = this._peerConnection.createDataChannel("tari-data");
+        this._signalingServer = new SignaligServer(signalig_server_url);
+        this._callbacks = {};
+    }
+    get token() {
+        if (this._walletToken) {
+            return this._walletToken;
+        }
+        return this._signalingServer.token;
+    }
+    async init(permissions, onConnection) {
+        this.onConnection = onConnection;
+        await this._signalingServer.initToken(permissions);
+        // Setup our receiving end
+        this._dataChannel.onmessage = (message) => {
+            let response = JSON.parse(message.data);
+            console.log("response", response);
+            if (!this._callbacks[response.id]) {
+                console.error("No callback found for id", response.id);
+                return;
+            }
+            // The response should contain id, to identify the Promise.resolve, that is waiting for this result
+            let [resolve, reject] = this._callbacks[response.id];
+            delete this._callbacks[response.id];
+            if (response.payload?.error) {
+                reject(new Error(response.payload.error));
+            }
+            else {
+                resolve(response.payload);
+            }
+        };
+        this._dataChannel.onopen = () => {
+            // This should be removed before the release, but it's good for debugging.
+            console.log("Data channel is open!");
+            this.sendMessage({ id: 0, jsonrpc: "2.0", method: "get.token", params: {} }, this._signalingServer.token)
+                .then((walletToken) => {
+                if (typeof walletToken !== "string") {
+                    throw Error("Received invalid JWT from wallet daemon");
+                }
+                console.log("Wallet JWT received: ", walletToken);
+                this._walletToken = walletToken;
+                if (this.onConnection) {
+                    this.onConnection(this);
+                }
+            });
+        };
+        this._peerConnection.onicecandidate = (event) => {
+            console.log("event", event);
+            if (event?.candidate) {
+                console.log("ICE ", event.candidate);
+                console.log("ICE ", typeof event.candidate);
+                // Store the ice candidates, so the other end can add them
+                this._signalingServer.storeIceCandidate(event.candidate).then((resp) => {
+                    // This should be removed before the release, but it's good for debugging.
+                    console.log("Candidate stored", resp);
+                });
+            }
+        };
+        // Create offer
+        this._offer = await this._peerConnection.createOffer();
+        // Set the offer as our local sdp, at this point it will start getting the ice candidates
+        this._peerConnection.setLocalDescription(this._offer);
+        // Store the offer so the other end can set it as a remote sdp
+        this._signalingServer.storeOffer(this._offer).then((resp) => {
+            // This should be removed before the release, but it's good for debugging.
+            console.log("Offer stored", resp);
+        });
+        await this.signalingServerPolling();
+    }
+    async setAnswer() {
+        // This is called once the other end got the offer and ices and created and store an answer and its ice candidates
+        // We get its answer sdp
+        let sdp = await this._signalingServer.getAnswer();
+        // And its ice candidates
+        let iceCandidates = await this._signalingServer.getIceCandidates();
+        // For us the answer is remote sdp
+        let answer = new RTCSessionDescription({ sdp, type: "answer" });
+        this._peerConnection.setRemoteDescription(answer);
+        // We add all the ice candidates to connect, the other end is doing the same with our ice candidates
+        for (const iceCandidate of iceCandidates) {
+            this._peerConnection.addIceCandidate(iceCandidate);
+        }
+    }
+    async signalingServerPolling() {
+        // no need to keep retrying if we are already connected to the wallet
+        if (this._peerConnection.connectionState === "connected") {
+            return;
+        }
+        try {
+            await this.setAnswer();
+        }
+        catch (error) {
+            // we don't need to do anything on error, as the execution will be retried later
+            console.error(error);
+        }
+        // try again later
+        setTimeout(async () => {
+            await this.signalingServerPolling();
+        }, 2000);
+    }
+    isConnected() {
+        return this._dataChannel.readyState === "open";
+    }
+    // If the last parameter has timeout property e.g. {timeout:1000}, it set the timeout for this call.
+    async sendMessage(request, token, timeout_secs = null) {
+        if (!this.isConnected) {
+            throw new Error("WALLET_DAEMON_NOT_CONNECTED");
+        }
+        // This should be removed before the release, but it's good for debugging.
+        console.log(request, "timeout", timeout_secs);
+        return new Promise((resolve, reject) => {
+            // We store the resolve callback for this request,
+            // so once the data channel receives a response we know where to return the data
+            this._callbacks[request.id] = [resolve, reject];
+            if (timeout_secs) {
+                // If the user set a timeout which set it here so the promise will be rejected if not fulfilled in time.
+                setTimeout(() => {
+                    delete this._callbacks[request.id];
+                    reject(new Error("Timeout"));
+                }, timeout_secs * 1000);
+            }
+            // Make the actual call to the wallet daemon
+            this._dataChannel.send(JSON.stringify({ token, ...request }));
+        });
+    }
+    // This is our default config, use can set their own stun/turn server in the constructor.
+    config() {
+        return { iceServers: [{ urls: "stun:stun.l.google.com:19302" }] };
+    }
+}

package/dist/webrtc_transport.d.ts

@@ -0,0 +1,10 @@
+import { transports } from "@tari-project/wallet_jrpc_client";
+import { TariConnection } from "./webrtc";
+export declare class WebRtcRpcTransport implements transports.RpcTransport {
+    connection: TariConnection;
+    constructor(connection: TariConnection);
+    static new(connection: TariConnection): WebRtcRpcTransport;
+    token(): string | undefined;
+    isConnected(): boolean;
+    sendRequest<T>(data: transports.RpcRequest, options: transports.RpcTransportOptions): Promise<T>;
+}

package/dist/webrtc_transport.js

@@ -0,0 +1,18 @@
+export class WebRtcRpcTransport {
+    connection;
+    constructor(connection) {
+        this.connection = connection;
+    }
+    static new(connection) {
+        return new WebRtcRpcTransport(connection);
+    }
+    token() {
+        return this.connection.token;
+    }
+    isConnected() {
+        return this.connection.isConnected();
+    }
+    sendRequest(data, options) {
+        return this.connection.sendMessage(data, options.token);
+    }
+}

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "@tari-project/wallet-daemon-signer",
+  "version": "0.5.0",
+  "description": "",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@tari-project/wallet_jrpc_client": "^1.5.1",
+    "@tari-project/tari-permissions": "^0.5.0",
+    "@tari-project/tari-signer": "^0.5.0",
+    "@tari-project/tarijs-types": "^0.5.0"
+  },
+  "devDependencies": {
+    "@types/node": "^22.13.1",
+    "typescript": "^5.0.4"
+  },
+  "files": [
+    "/dist"
+  ],
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "scripts": {
+    "build": "tsc -b"
+  }
+}