@tari-project/tari-universe-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 * from "@tari-project/tari-permissions";
+export * from "./signer";
+export * from "./types";

package/dist/index.js

@@ -0,0 +1,3 @@
+export * from "@tari-project/tari-permissions";
+export * from "./signer";
+export * from "./types";

package/dist/signer.d.ts

@@ -0,0 +1,24 @@
+import { SubmitTransactionResponse, Account, Substate, TemplateDefinition, VaultBalances, ListSubstatesResponse, SubmitTransactionRequest, TariSigner, TransactionResult } from "@tari-project/tari-signer";
+import { TariUniverseSignerParameters, WindowSize, ListAccountNftFromBalancesRequest } from "./types";
+import { AccountsGetBalancesResponse, ListAccountNftRequest, ListAccountNftResponse, SubstateType } from "@tari-project/wallet_jrpc_client";
+export declare class TariUniverseSigner implements TariSigner {
+    params: TariUniverseSignerParameters;
+    signerName: string;
+    private __id;
+    constructor(params: TariUniverseSignerParameters);
+    private sendRequest;
+    isConnected(): boolean;
+    getPublicKey(): Promise<string>;
+    listSubstates(filter_by_template: string | null, filter_by_type: SubstateType | null, limit: number | null, offset: number | null): Promise<ListSubstatesResponse>;
+    getConfidentialVaultBalances(viewKeyId: number, vaultId: string, min: number | null, max: number | null): Promise<VaultBalances>;
+    createFreeTestCoins(): Promise<void>;
+    requestParentSize(): Promise<WindowSize>;
+    getAccount(): Promise<Account>;
+    getAccountBalances(componentAddress: string): Promise<AccountsGetBalancesResponse>;
+    getSubstate(substate_id: string): Promise<Substate>;
+    submitTransaction(req: SubmitTransactionRequest): Promise<SubmitTransactionResponse>;
+    getTransactionResult(transactionId: string): Promise<TransactionResult>;
+    getTemplateDefinition(template_address: string): Promise<TemplateDefinition>;
+    getNftsList(req: ListAccountNftRequest): Promise<ListAccountNftResponse>;
+    getNftsFromAccountBalances(req: ListAccountNftFromBalancesRequest): Promise<ListAccountNftResponse>;
+}

package/dist/signer.js

@@ -0,0 +1,82 @@
+import { sendSignerCall } from "./utils";
+export class TariUniverseSigner {
+    params;
+    signerName = "TariUniverse";
+    __id = 0;
+    constructor(params) {
+        this.params = params;
+        const filterResizeEvent = function (event) {
+            if (event.data && event.data.type === "resize") {
+                const resizeEvent = new CustomEvent("resize", {
+                    detail: { width: event.data.width, height: event.data.height },
+                });
+                window.dispatchEvent(resizeEvent);
+            }
+        };
+        window.addEventListener("message", (event) => filterResizeEvent(event), false);
+    }
+    async sendRequest(req) {
+        const id = ++this.__id;
+        return sendSignerCall(req, id);
+    }
+    isConnected() {
+        return true;
+    }
+    getPublicKey() {
+        return this.sendRequest({ methodName: "getPublicKey", args: [] });
+    }
+    async listSubstates(filter_by_template, filter_by_type, limit, offset) {
+        return this.sendRequest({
+            methodName: "listSubstates",
+            args: [filter_by_template, filter_by_type, limit, offset],
+        });
+    }
+    getConfidentialVaultBalances(viewKeyId, vaultId, min, max) {
+        return this.sendRequest({
+            methodName: "getConfidentialVaultBalances",
+            args: [viewKeyId, vaultId, min, max],
+        });
+    }
+    async createFreeTestCoins() {
+        return this.sendRequest({ methodName: "createFreeTestCoins", args: [] });
+    }
+    requestParentSize() {
+        return this.sendRequest({ methodName: "requestParentSize", args: [] });
+    }
+    async getAccount() {
+        return this.sendRequest({ methodName: "getAccount", args: [] });
+    }
+    async getAccountBalances(componentAddress) {
+        return this.sendRequest({
+            methodName: "getAccountBalances",
+            args: [componentAddress],
+        });
+    }
+    async getSubstate(substate_id) {
+        return this.sendRequest({
+            methodName: "getSubstate",
+            args: [substate_id],
+        });
+    }
+    async submitTransaction(req) {
+        return this.sendRequest({
+            methodName: "submitTransaction",
+            args: [req],
+        });
+    }
+    async getTransactionResult(transactionId) {
+        return this.sendRequest({
+            methodName: "getTransactionResult",
+            args: [transactionId],
+        });
+    }
+    async getTemplateDefinition(template_address) {
+        return this.sendRequest({ methodName: "getTemplateDefinition", args: [template_address] });
+    }
+    async getNftsList(req) {
+        return this.sendRequest({ methodName: "getNftsList", args: [req] });
+    }
+    async getNftsFromAccountBalances(req) {
+        return this.sendRequest({ methodName: "getNftsFromAccountBalances", args: [req] });
+    }
+}

package/dist/types.d.ts

@@ -0,0 +1,34 @@
+import { TariPermissions } from "@tari-project/tari-permissions";
+import { TariUniverseSigner } from "./signer";
+import { BalanceEntry } from "@tari-project/typescript-bindings";
+export type TariUniverseSignerParameters = {
+    permissions: TariPermissions;
+    optionalPermissions: TariPermissions;
+    name?: string;
+    onConnection?: () => void;
+};
+export type WindowSize = {
+    width: number;
+    height: number;
+};
+export type PickMatching<T, V> = {
+    [K in keyof T as T[K] extends V ? K : never]: T[K];
+};
+export type ExtractMethods<T> = PickMatching<T, Function>;
+export type SignerMethods = ExtractMethods<TariUniverseSigner>;
+export type SignerMethodNames = keyof SignerMethods;
+export type SignerReturnType<T extends SignerMethodNames> = Awaited<ReturnType<SignerMethods[T]>>;
+export type SignerRequest<T extends SignerMethodNames> = {
+    id: number;
+    methodName: T;
+    args: Parameters<SignerMethods[T]>;
+};
+export type SignerResponse<T extends SignerMethodNames> = {
+    id: number;
+    type: "signer-call";
+    result: SignerReturnType<T>;
+    resultError?: string;
+};
+export interface ListAccountNftFromBalancesRequest {
+    balances: Array<BalanceEntry>;
+}

package/dist/types.js

@@ -0,0 +1 @@
+export {};

package/dist/utils.d.ts

@@ -0,0 +1,2 @@
+import { SignerMethodNames, SignerRequest, SignerReturnType } from "./types";
+export declare function sendSignerCall<MethodName extends SignerMethodNames>(req: Omit<SignerRequest<MethodName>, "id">, id: number): Promise<SignerReturnType<MethodName>>;

package/dist/utils.js

@@ -0,0 +1,16 @@
+export function sendSignerCall(req, id) {
+    return new Promise((resolve, reject) => {
+        const event_ref = (resp) => {
+            if (resp.data.resultError) {
+                window.removeEventListener("message", event_ref);
+                reject(resp.data.resultError);
+            }
+            if (resp && resp.data && resp.data.id && resp.data.id === id && resp.data.type === "signer-call") {
+                window.removeEventListener("message", event_ref);
+                resolve(resp.data.result);
+            }
+        };
+        window.addEventListener("message", event_ref, false);
+        window.parent.postMessage({ ...req, id, type: "signer-call" }, "*");
+    });
+}

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "@tari-project/tari-universe-signer",
+  "version": "0.5.0",
+  "description": "",
+  "type": "module",
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "@tari-project/typescript-bindings": "^1.5.1",
+    "@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"
+  }
+}