@tari-project/tarijs 0.3.0 → 0.4.0

package/dist/providers/metamask/index.d.ts

@@ -1,30 +0,0 @@
-import { TariProvider } from "../index";
-import { SubmitTransactionRequest, TransactionResult, SubmitTransactionResponse, VaultBalances, TemplateDefinition, Substate, ListSubstatesResponse } from "../types";
-import { MetaMaskInpageProvider } from "@metamask/providers";
-import { Snap } from "./utils";
-import { Account } from "../types";
-import { SubstateType } from "@tari-project/typescript-bindings";
-export declare const MetamaskNotInstalled = "METAMASK_NOT_INSTALLED";
-export declare const MetamaskIsNotFlask = "METAMASK_IS_NOT_FLASK";
-export declare const TariSnapNotInstalled = "TARI_SNAP_NOT_INSTALLED";
-export declare class MetamaskTariProvider implements TariProvider {
-    providerName: string;
-    snapId: string;
-    snapVersion: string | undefined;
-    metamask: MetaMaskInpageProvider;
-    snap?: Snap;
-    metamaskConnected: boolean;
-    constructor(snapId: string, metamask: MetaMaskInpageProvider);
-    connect(): Promise<void>;
-    isConnected(): boolean;
-    createFreeTestCoins(account_id: number): Promise<Account>;
-    getAccount(): Promise<Account>;
-    getSubstate(substate_address: string): Promise<Substate>;
-    listSubstates(filter_by_template: string | null, filter_by_type: SubstateType | null, limit: number | null, offset: number | null): Promise<ListSubstatesResponse>;
-    submitTransaction(req: SubmitTransactionRequest): Promise<SubmitTransactionResponse>;
-    getTransactionResult(transactionId: string): Promise<TransactionResult>;
-    getPublicKey(_branch: string, index: number): Promise<string>;
-    getConfidentialVaultBalances(viewKeyId: number, vaultId: string, min?: number | null, max?: number | null): Promise<VaultBalances>;
-    getTemplateDefinition(template_address: string): Promise<TemplateDefinition>;
-    private metamaskRequest;
-}

package/dist/providers/metamask/index.js

@@ -1,168 +0,0 @@
-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.d.ts

@@ -1,38 +0,0 @@
-import { MetaMaskInpageProvider } from '@metamask/providers';
-export type GetSnapsResponse = Record<string, Snap>;
-export type Snap = {
-    permissionName: string;
-    id: string;
-    version: string;
-    initialPermissions: Record<string, unknown>;
-};
-/**
- * Get the installed snaps in MetaMask.
- *
- * @param provider - The MetaMask inpage provider.
- * @returns The snaps installed in MetaMask.
- */
-export declare const getSnaps: (provider: MetaMaskInpageProvider) => Promise<GetSnapsResponse>;
-/**
- * Connect a snap to MetaMask.
- *
- * @param snapId - The ID of the snap.
- * @param params - The params to pass with the snap to connect.
- */
-export declare const connectSnap: (provider: MetaMaskInpageProvider, snaps: Record<string, {
-    version?: string;
-}>) => Promise<void>;
-/**
- * Get the snap from MetaMask.
- *
- * @param version - The version of the snap to install (optional).
- * @returns The snap object returned by the extension.
- */
-export declare const getSnap: (provider: MetaMaskInpageProvider, snapId: string, version?: string) => Promise<Snap | undefined>;
-export declare const isLocalSnap: (snapId: string) => boolean;
-/**
- * Detect if the wallet injecting the ethereum object is MetaMask Flask.
- *
- * @returns True if the MetaMask version is Flask, false otherwise.
- */
-export declare const isFlask: (provider: MetaMaskInpageProvider) => Promise<boolean>;

package/dist/providers/metamask/utils.js

@@ -1,55 +0,0 @@
-/**
- * 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.d.ts

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

package/dist/providers/tari_universe/index.js

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

package/dist/providers/tari_universe/provider.d.ts

@@ -1,23 +0,0 @@
-import { SubmitTransactionRequest, TransactionResult, SubmitTransactionResponse, Account, Substate, TemplateDefinition, VaultBalances, ListSubstatesResponse } from "../types";
-import { TariUniverseProviderParameters, WindowSize } from "./types";
-import { TariProvider } from "../index";
-import { AccountsGetBalancesResponse, SubstateType } from "@tari-project/wallet_jrpc_client";
-export declare class TariUniverseProvider implements TariProvider {
-    params: TariUniverseProviderParameters;
-    providerName: string;
-    private __id;
-    constructor(params: TariUniverseProviderParameters);
-    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>;
-}

package/dist/providers/tari_universe/provider.js

@@ -1,89 +0,0 @@
-import { sendProviderCall } from "./utils";
-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 sendProviderCall(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() {
-        const { account_id, address, public_key } = await this.sendRequest({ methodName: "getAccount", args: [] });
-        const { balances } = await this.getAccountBalances(address);
-        return {
-            account_id,
-            address,
-            public_key,
-            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 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.d.ts

@@ -1,30 +0,0 @@
-import { TariPermissions } from "../wallet_daemon";
-import { TariUniverseProvider } from "./provider";
-export type TariUniverseProviderParameters = {
-    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 ProviderMethods = ExtractMethods<TariUniverseProvider>;
-export type ProviderMethodNames = keyof ProviderMethods;
-export type ProviderReturnType<T extends ProviderMethodNames> = Awaited<ReturnType<ProviderMethods[T]>>;
-export type ProviderRequest<T extends ProviderMethodNames> = {
-    id: number;
-    methodName: T;
-    args: Parameters<ProviderMethods[T]>;
-};
-export type ProviderResponse<T extends ProviderMethodNames> = {
-    id: number;
-    type: "provider-call";
-    result: ProviderReturnType<T>;
-    resultError?: string;
-};

package/dist/providers/tari_universe/types.js

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

package/dist/providers/tari_universe/utils.d.ts

@@ -1,2 +0,0 @@
-import { ProviderMethodNames, ProviderRequest, ProviderReturnType } from "./types";
-export declare function sendProviderCall<MethodName extends ProviderMethodNames>(req: Omit<ProviderRequest<MethodName>, "id">, id: number): Promise<ProviderReturnType<MethodName>>;

package/dist/providers/tari_universe/utils.js

@@ -1,16 +0,0 @@
-export function sendProviderCall(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 === "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" }, "*");
-    });
-}

package/dist/providers/types.d.ts

@@ -1,66 +0,0 @@
-import { FinalizeResult } from "@tari-project/typescript-bindings";
-export type SubstateMetadata = {
-    substate_id: string;
-    module_name: string | null;
-    version: number;
-    template_address: string | null;
-};
-export type SubstateRequirement = {
-    substate_id: string;
-    version?: number | null;
-};
-export type SubmitTransactionRequest = {
-    account_id: number;
-    instructions: object[];
-    fee_instructions: object[];
-    inputs: object[];
-    input_refs: object[];
-    required_substates: SubstateRequirement[];
-    is_dry_run: boolean;
-    min_epoch: number | null;
-    max_epoch: number | null;
-};
-export type SubmitTransactionResponse = {
-    transaction_id: string;
-};
-export type TransactionResult = {
-    transaction_id: string;
-    status: TransactionStatus;
-    result: FinalizeResult | null;
-};
-export declare enum TransactionStatus {
-    New = 0,
-    DryRun = 1,
-    Pending = 2,
-    Accepted = 3,
-    Rejected = 4,
-    InvalidTransaction = 5,
-    OnlyFeeAccepted = 6
-}
-export interface Account {
-    account_id: number;
-    address: string;
-    public_key: string;
-    resources: VaultData[];
-}
-export interface VaultData {
-    type: string;
-    balance: number;
-    resource_address: string;
-}
-export interface VaultBalances {
-    balances: Map<string, number | null>;
-}
-export interface TemplateDefinition {
-    [key: string]: any;
-}
-export interface Substate {
-    value: any;
-    address: {
-        substate_id: string;
-        version: number;
-    };
-}
-export type ListSubstatesResponse = {
-    substates: Array<SubstateMetadata>;
-};

package/dist/providers/types.js

@@ -1,10 +0,0 @@
-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.d.ts

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

package/dist/providers/wallet_daemon/index.js

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

package/dist/providers/wallet_daemon/provider.d.ts

@@ -1,35 +0,0 @@
-import { TariPermissions } from "./tari_permissions";
-import { TariProvider } from '../index';
-import { SubmitTransactionRequest, TransactionResult, SubmitTransactionResponse, VaultBalances, TemplateDefinition, Substate, ListSubstatesResponse } from "../types";
-import { Account } from "../types";
-import { WalletDaemonClient, SubstateType } from "@tari-project/wallet_jrpc_client";
-export declare const WalletDaemonNotConnected = "WALLET_DAEMON_NOT_CONNECTED";
-export declare const Unsupported = "UNSUPPORTED";
-export type WalletDaemonParameters = {
-    signalingServerUrl?: string;
-    permissions: TariPermissions;
-    optionalPermissions: TariPermissions;
-    webRtcConfig?: RTCConfiguration;
-    name?: string;
-    onConnection?: () => void;
-};
-export declare class WalletDaemonTariProvider implements TariProvider {
-    providerName: string;
-    params: WalletDaemonParameters;
-    client: WalletDaemonClient;
-    private constructor();
-    static build(params: WalletDaemonParameters): Promise<WalletDaemonTariProvider>;
-    get token(): string | undefined;
-    get tokenUrl(): string | undefined;
-    isConnected(): boolean;
-    createFreeTestCoins(): Promise<Account>;
-    getAccount(): Promise<Account>;
-    getAccountBalances(componentAddress: string): Promise<unknown>;
-    getSubstate(substate_id: 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>;
-}