@tari-project/tarijs 0.1.20 → 0.1.22

package/dist/providers/index.js

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

package/dist/providers/metamask/index.js

@@ -0,0 +1,169 @@
+import { TransactionStatus, } from "../types";
+import { connectSnap, getSnap, isFlask } from "./utils";
+export const MetamaskNotInstalled = 'METAMASK_NOT_INSTALLED';
+export const MetamaskIsNotFlask = 'METAMASK_IS_NOT_FLASK';
+export const TariSnapNotInstalled = 'TARI_SNAP_NOT_INSTALLED';
+export class MetamaskTariProvider {
+    providerName = "Metamask";
+    snapId;
+    snapVersion;
+    metamask;
+    snap;
+    metamaskConnected;
+    constructor(snapId, metamask) {
+        this.snapId = snapId;
+        this.snapVersion = undefined;
+        this.metamask = metamask;
+        this.metamaskConnected = false;
+    }
+    async connect() {
+        // check that the metamask provider is valid
+        if (!this.metamask || !this.metamask.isMetaMask) {
+            throw MetamaskNotInstalled;
+        }
+        // check that flask is installed
+        if (!isFlask(this.metamask)) {
+            throw MetamaskIsNotFlask;
+        }
+        // connect to the tari snap
+        // this will request MetaMask the installation of the tari snap if it's not already installed
+        await connectSnap(this.metamask, { [this.snapId]: { version: this.snapVersion } });
+        // store the tari snap reference
+        const snap = await getSnap(this.metamask, this.snapId);
+        if (!snap) {
+            // this should olny happen if the user didn't accept the tari snap in the previous step
+            throw TariSnapNotInstalled;
+        }
+        this.snap = snap;
+        this.metamaskConnected = true;
+    }
+    isConnected() {
+        return this.metamaskConnected;
+    }
+    async createFreeTestCoins(account_id) {
+        const res = await this.metamaskRequest('getFreeTestCoins', {
+            amount: 1000000,
+            account_id,
+            fee: 2000
+        });
+        return {
+            account_id,
+            address: res.address,
+            public_key: res.public_key,
+            resources: []
+        };
+    }
+    async getAccount() {
+        return await this.metamaskRequest('getAccountData', { account_id: 0 });
+    }
+    async getSubstate(substate_address) {
+        const { substate, address: substate_id, version } = await this.metamaskRequest('getSubstate', { substate_address });
+        return { value: substate, address: { substate_id, version } };
+    }
+    async listSubstates(filter_by_template, filter_by_type, limit, offset) {
+        const res = await this.metamaskRequest('listSubstates', {
+            filter_by_template,
+            filter_by_type,
+            limit,
+            offset,
+        });
+        return res;
+    }
+    async submitTransaction(req) {
+        const params = {
+            instructions: req.instructions,
+            fee_instructions: req.fee_instructions,
+            input_refs: req.input_refs,
+            required_substates: req.required_substates || [],
+            is_dry_run: req.is_dry_run,
+        };
+        const resp = await this.metamaskRequest('sendTransaction', params);
+        if (!resp) {
+            throw new Error("Failed to submit transaction to metamask snap: empty response");
+        }
+        if (resp.error) {
+            throw new Error(`Failed to submit transaction to metamask snap: ${resp.error}`);
+        }
+        return { transaction_id: resp.transaction_id };
+    }
+    async getTransactionResult(transactionId) {
+        // This request returns the response from the indexer get_transaction_result request
+        const resp = await this.metamaskRequest('getTransactionResult', { transaction_id: transactionId });
+        if (!resp) {
+            throw new Error("Failed to get transaction result from metamask snap: empty response");
+        }
+        if (resp.result === "Pending") {
+            return {
+                transaction_id: transactionId,
+                status: TransactionStatus.Pending,
+                result: null
+            };
+        }
+        if (!resp?.result?.Finalized) {
+            throw new Error("Transaction result was not pending nor finalized");
+        }
+        const newStatus = convertToStatus(resp.result.Finalized);
+        return {
+            transaction_id: transactionId,
+            status: newStatus,
+            result: resp.result.Finalized.execution_result.finalize
+        };
+    }
+    async getPublicKey(_branch, index) {
+        const resp = await this.metamaskRequest('getPublicKey', { index });
+        if (!resp) {
+            throw new Error("Failed to get public key from metamask snap: empty response");
+        }
+        return resp.public_key;
+    }
+    async getConfidentialVaultBalances(viewKeyId, vaultId, min = null, max = null) {
+        const res = await this.metamaskRequest('getConfidentialVaultBalances', {
+            view_key_id: viewKeyId,
+            vault_id: vaultId,
+            minimum_expected_value: min,
+            maximum_expected_value: max,
+        });
+        return { balances: res };
+    }
+    getTemplateDefinition(template_address) {
+        return this.metamaskRequest('getTemplateDefinition', { template_address })
+            .then(resp => {
+            if (!resp) {
+                throw new Error("Template not found");
+            }
+            return resp.definition;
+        });
+    }
+    async metamaskRequest(method, params) {
+        console.log("Metamask request:", method, params);
+        const resp = await this.metamask.request({
+            method: 'wallet_invokeSnap',
+            params: {
+                snapId: this.snapId,
+                request: {
+                    method,
+                    params
+                }
+            },
+        });
+        console.log("Metamask response:", resp);
+        if (!resp) {
+            throw new Error("Metamask request failed: empty response");
+        }
+        return resp;
+    }
+}
+function convertToStatus(result) {
+    // Ref: https://github.com/tari-project/tari-dan/blob/bb0b31139b770aacd7bb49af865543aa4a9e2de4/dan_layer/wallet/sdk/src/apis/transaction.rs
+    if (result.final_decision !== "Commit") {
+        return TransactionStatus.Rejected;
+    }
+    // if (!result?.result?.Finalized) {
+    //     throw new Error("Transaction result was finalized but no result was returned");
+    // }
+    //
+    // if (result.finalize.AcceptFeeRejectRest) {
+    //     return TransactionStatus.OnlyFeeAccepted;
+    // }
+    return TransactionStatus.Accepted;
+}

package/dist/providers/metamask/utils.js

@@ -0,0 +1,55 @@
+/**
+ * Get the installed snaps in MetaMask.
+ *
+ * @param provider - The MetaMask inpage provider.
+ * @returns The snaps installed in MetaMask.
+ */
+export const getSnaps = async (provider) => (await provider.request({
+    method: 'wallet_getSnaps',
+}));
+/**
+ * Connect a snap to MetaMask.
+ *
+ * @param snapId - The ID of the snap.
+ * @param params - The params to pass with the snap to connect.
+ */
+export const connectSnap = async (provider, snaps) => {
+    await provider.request({
+        method: 'wallet_requestSnaps',
+        params: snaps,
+    });
+};
+/**
+ * Get the snap from MetaMask.
+ *
+ * @param version - The version of the snap to install (optional).
+ * @returns The snap object returned by the extension.
+ */
+export const getSnap = async (provider, snapId, version) => {
+    try {
+        const snaps = await getSnaps(provider);
+        return Object.values(snaps).find((snap) => snap.id === snapId && (!version || snap.version === version));
+    }
+    catch (e) {
+        console.log('Failed to obtain installed snap', e);
+        return undefined;
+    }
+};
+export const isLocalSnap = (snapId) => snapId.startsWith('local:');
+/**
+ * Detect if the wallet injecting the ethereum object is MetaMask Flask.
+ *
+ * @returns True if the MetaMask version is Flask, false otherwise.
+ */
+export const isFlask = async (provider) => {
+    try {
+        const clientVersion = await provider.request({
+            method: 'web3_clientVersion',
+        });
+        const isFlaskDetected = clientVersion?.includes('flask');
+        return Boolean(provider && isFlaskDetected);
+    }
+    catch {
+        return false;
+    }
+};

package/dist/providers/tari_universe/index.js

@@ -0,0 +1,3 @@
+export * from "../wallet_daemon/tari_permissions";
+export * from "./provider";
+export * from "./types";

package/dist/providers/tari_universe/provider.js

@@ -0,0 +1,88 @@
+export class TariUniverseProvider {
+    params;
+    providerName = "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 new Promise(function (resolve, reject) {
+            const event_ref = function (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 === "provider-call") {
+                    window.removeEventListener("message", event_ref);
+                    resolve(resp.data.result);
+                }
+            };
+            window.addEventListener("message", event_ref, false);
+            window.parent.postMessage({ ...req, id, type: "provider-call" }, "*");
+        });
+    }
+    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] });
+    }
+}

package/dist/providers/tari_universe/types.js

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

package/dist/{src/providers → providers}/types.d.ts

@@ -1,3 +1,4 @@
+import { FinalizeResult } from "@tari-project/typescript-bindings";
 export type SubstateMetadata = {
     substate_id: string;
     module_name: string | null;
@@ -25,7 +26,7 @@ export type SubmitTransactionResponse = {
 export type TransactionResult = {
     transaction_id: string;
     status: TransactionStatus;
-    result: object | null;
+    result: FinalizeResult | null;
 };
 export declare enum TransactionStatus {
     New = 0,

package/dist/providers/types.js

@@ -0,0 +1,10 @@
+export var TransactionStatus;
+(function (TransactionStatus) {
+    TransactionStatus[TransactionStatus["New"] = 0] = "New";
+    TransactionStatus[TransactionStatus["DryRun"] = 1] = "DryRun";
+    TransactionStatus[TransactionStatus["Pending"] = 2] = "Pending";
+    TransactionStatus[TransactionStatus["Accepted"] = 3] = "Accepted";
+    TransactionStatus[TransactionStatus["Rejected"] = 4] = "Rejected";
+    TransactionStatus[TransactionStatus["InvalidTransaction"] = 5] = "InvalidTransaction";
+    TransactionStatus[TransactionStatus["OnlyFeeAccepted"] = 6] = "OnlyFeeAccepted";
+})(TransactionStatus || (TransactionStatus = {}));

package/dist/providers/wallet_daemon/index.js

@@ -0,0 +1,3 @@
+export { TariConnection } from "./webrtc";
+export * from "./tari_permissions";
+export * from "./provider";

package/dist/providers/wallet_daemon/provider.js

@@ -0,0 +1,173 @@
+import { TariPermissions, } from "./tari_permissions";
+import { TariConnection } from "./webrtc";
+import { TransactionStatus, } from "../types";
+import { WalletDaemonClient, stringToSubstateId, substateIdToString, } from "@tari-project/wallet_jrpc_client";
+import { WebRtcRpcTransport } from "./webrtc_transport";
+export const WalletDaemonNotConnected = 'WALLET_DAEMON_NOT_CONNECTED';
+export const Unsupported = 'UNSUPPORTED';
+export class WalletDaemonTariProvider {
+    providerName = "WalletDaemon";
+    params;
+    client;
+    constructor(params, connection) {
+        this.params = params;
+        this.client = connection;
+    }
+    static async build(params) {
+        const allPermissions = new TariPermissions();
+        allPermissions.addPermissions(params.permissions);
+        allPermissions.addPermissions(params.optionalPermissions);
+        console.log({ allPermissions });
+        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 WalletDaemonTariProvider(params, client);
+    }
+    get token() {
+        return this.client.getTransport().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.client.getTransport().isConnected();
+    }
+    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 { balances } = await this.client.accountsGetBalances({ account: { ComponentAddress: account.address.Component }, refresh: false });
+        return {
+            account_id: account.key_index,
+            address: account.address.Component,
+            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: ('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(substate_id) {
+        const substateId = stringToSubstateId(substate_id);
+        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: null,
+            signing_key_index: req.account_id,
+            fee_instructions: req.fee_instructions,
+            instructions: req.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
+            })),
+            input_refs: [],
+            override_inputs: false,
+            is_dry_run: req.is_dry_run,
+            proof_ids: [],
+            min_epoch: null,
+            max_epoch: null,
+        };
+        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: substateIdToString(s.substate_id),
+            module_name: s.module_name,
+            version: s.version,
+            template_address: s.template_address
+        }));
+        return { substates };
+    }
+}
+function convertStringToTransactionStatus(status) {
+    switch (status) {
+        case "New":
+            return TransactionStatus.New;
+        case "DryRun":
+            return TransactionStatus.DryRun;
+        case "Pending":
+            return TransactionStatus.Pending;
+        case "Accepted":
+            return TransactionStatus.Accepted;
+        case "Rejected":
+            return TransactionStatus.Rejected;
+        case "InvalidTransaction":
+            return TransactionStatus.InvalidTransaction;
+        case "OnlyFeeAccepted":
+            return TransactionStatus.OnlyFeeAccepted;
+        default:
+            throw new Error(`Unknown status: ${status}`);
+    }
+}