@tari-project/tarijs 0.3.1 → 0.4.1

package/dist/providers/walletconnect/index.js

@@ -1,221 +0,0 @@
-import { TransactionStatus, } from "../types";
-import UniversalProvider from '@walletconnect/universal-provider';
-import { WalletConnectModal } from '@walletconnect/modal';
-import { substateIdToString } from "@tari-project/wallet_jrpc_client";
-const walletConnectParams = {
-    requiredNamespaces: {
-        tari: {
-            methods: [
-                'tari_getSubstate',
-                'tari_getDefaultAccount',
-                'tari_getAccountBalances',
-                'tari_submitTransaction',
-                'tari_getTransactionResult',
-                'tari_getTemplate',
-                'tari_createKey',
-                'tari_viewConfidentialVaultBalance',
-                'tari_createFreeTestCoins',
-                'tari_listSubstates'
-            ],
-            chains: [
-                'tari:devnet',
-            ],
-            events: ['chainChanged", "accountsChanged']
-        }
-    }
-};
-export class WalletConnectTariProvider {
-    providerName = "WalletConnect";
-    projectId;
-    wcProvider;
-    wcSession;
-    constructor(projectId) {
-        this.projectId = projectId;
-        this.wcProvider = null;
-        this.wcSession = null;
-    }
-    async connect() {
-        if (this.wcProvider && this.wcSession)
-            return;
-        // initialize WalletConnect
-        const projectId = this.projectId;
-        this.wcProvider = await UniversalProvider.init({
-            projectId,
-            // TODO: parameterize the relay URL
-            relayUrl: 'wss://relay.walletconnect.com'
-        });
-        // open UI modal with the connection URI
-        const { uri, approval } = await this.wcProvider.client.connect(walletConnectParams);
-        const walletConnectModal = new WalletConnectModal({
-            projectId
-        });
-        if (uri) {
-            walletConnectModal.openModal({ uri });
-        }
-        // wait for the wallet to approve the connection
-        console.log("waiting for session approval from the wallet app");
-        const session = await approval();
-        // at this point session is open
-        console.log("session approved by the wallet");
-        this.wcSession = session;
-    }
-    async sendRequest(method, params) {
-        if (!this.wcProvider) {
-            throw "WalletConnect provider not initialized";
-        }
-        if (!this.wcSession) {
-            throw "WalletConnect session not initialized";
-        }
-        const requestResult = await this.wcProvider.client.request({
-            topic: this.wcSession.topic,
-            chainId: 'tari:devnet',
-            request: {
-                method,
-                params
-            }
-        });
-        console.log({ requestResult });
-        return requestResult;
-    }
-    isConnected() {
-        // TODO: check status in the session
-        return this.wcSession !== null;
-    }
-    async getAccount() {
-        const { account, public_key } = await this.sendRequest('tari_getDefaultAccount', {});
-        const { balances } = await this.sendRequest('tari_getAccountBalances', { account: { ComponentAddress: account.address }, refresh: false
-        });
-        return {
-            account_id: account.key_index,
-            address: account.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 getSubstate(substate_address) {
-        const method = 'tari_getSubstate';
-        const params = { substate_id: substate_address };
-        const { value, record } = await this.sendRequest(method, params);
-        return {
-            value,
-            address: {
-                substate_id: record.substate_id,
-                version: record.version
-            }
-        };
-    }
-    async listSubstates(filter_by_template, filter_by_type, limit, offset) {
-        const method = 'tari_listSubstates';
-        const params = {
-            filter_by_template,
-            filter_by_type,
-            limit,
-            offset
-        };
-        const res = await this.sendRequest(method, params);
-        const substates = res.substates.map((s) => ({
-            substate_id: substateIdToString(s.substate_id),
-            module_name: s.module_name,
-            version: s.version,
-            template_address: s.template_address
-        }));
-        return { substates };
-    }
-    async createFreeTestCoins() {
-        const method = 'tari_createFreeTestCoins';
-        const params = {
-            account: { Name: "template_web" },
-            amount: 1000000,
-            max_fee: null,
-            key_id: 0
-        };
-        const res = await this.sendRequest(method, params);
-        return {
-            account_id: res.account.key_index,
-            address: res.account.address.Component,
-            public_key: res.public_key,
-            resources: []
-        };
-    }
-    async submitTransaction(req) {
-        const method = 'tari_submitTransaction';
-        const params = {
-            transaction: {
-                V1: {
-                    network: req.network,
-                    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 ?? 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.sendRequest(method, params);
-        return { transaction_id: res.transaction_id };
-    }
-    async getTransactionResult(transactionId) {
-        const res = await this.sendRequest('tari_getTransactionResult', { transaction_id: transactionId });
-        return {
-            transaction_id: transactionId,
-            status: convertStringToTransactionStatus(res.status),
-            result: res.result,
-        };
-    }
-    async getTemplateDefinition(template_address) {
-        let resp = await this.sendRequest('tari_getTemplate', { template_address });
-        return resp.template_definition;
-    }
-    async getPublicKey(branch, index) {
-        const res = await this.sendRequest('tari_createKey', { branch: branch, specific_index: index });
-        return res.public_key;
-    }
-    async getConfidentialVaultBalances(viewKeyId, vaultId, min, max) {
-        const method = 'tari_viewConfidentialVaultBalance';
-        const params = {
-            view_key_id: viewKeyId,
-            vault_id: vaultId,
-            minimum_expected_value: min,
-            maximum_expected_value: max,
-        };
-        const res = await this.sendRequest(method, params);
-        return { balances: res.balances };
-    }
-}
-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}`);
-    }
-}

package/dist/templates/Account.d.ts

@@ -1,65 +0,0 @@
-import { ConfidentialWithdrawProof, NonFungibleId, ResourceAddress } from "@tari-project/typescript-bindings";
-import { Amount } from "../builders/types/Amount";
-import { TariMethodDefinition, WorkspaceArg } from "../builders/types";
-import { TemplateFactory } from "./TemplateFactory";
-/**
- * Adds a fee instruction that calls the "take_fee" method on a component.
- * This method must exist and return a Bucket with containing revealed confidential XTR resource.
- * This allows the fee to originate from sources other than the transaction sender's account.
- * The fee instruction will lock up the "max_fee" amount for the duration of the transaction.
- * @param componentAddress
- * @param maxFee
- * @returns
- */
-interface PayFeeMethod extends TariMethodDefinition {
-    methodName: "pay_fee";
-    args?: [Amount];
-}
-interface PayFeeConfidentialMethod extends TariMethodDefinition {
-    methodName: "pay_fee_confidential";
-    args?: [ConfidentialWithdrawProof];
-}
-interface WithdrawMethod extends TariMethodDefinition {
-    methodName: "withdraw";
-    args?: [string, Amount];
-}
-interface DepositMethod extends TariMethodDefinition {
-    methodName: "deposit";
-    args?: WorkspaceArg[];
-}
-interface CreateProofForResourceMethod extends TariMethodDefinition {
-    methodName: "create_proof_for_resource";
-    args?: [ResourceAddress];
-}
-interface CreateProofByAmountMethod extends TariMethodDefinition {
-    methodName: "create_proof_by_amount";
-    args?: [ResourceAddress, Amount];
-}
-interface CreateProofByNonFungibleIdsMethod extends TariMethodDefinition {
-    methodName: "create_proof_by_non_fungible_ids";
-    args?: [ResourceAddress, NonFungibleId[]];
-}
-interface BalanceMethod extends TariMethodDefinition {
-    methodName: "balance";
-    args?: [ResourceAddress];
-}
-interface GetBalancesMethod extends TariMethodDefinition {
-    methodName: "get_balances";
-    args?: [];
-}
-export declare class AccountTemplate extends TemplateFactory {
-    templateAddress: string;
-    deposit: DepositMethod;
-    withdraw: WithdrawMethod;
-    createProofByAmount: CreateProofByAmountMethod;
-    createProofByNonFungibleIds: CreateProofByNonFungibleIdsMethod;
-    createProofForResource: CreateProofForResourceMethod;
-    balance: BalanceMethod;
-    getBalances: GetBalancesMethod;
-    payFee: PayFeeMethod;
-    payFeeConfidential: PayFeeConfidentialMethod;
-    constructor(templateAddress: string);
-    protected _initFunctions(): void;
-    protected _initMethods(): void;
-}
-export {};

package/dist/templates/Account.js

@@ -1,31 +0,0 @@
-import { TemplateFactory } from "./TemplateFactory";
-export class AccountTemplate extends TemplateFactory {
-    templateAddress;
-    deposit;
-    withdraw;
-    createProofByAmount;
-    createProofByNonFungibleIds;
-    createProofForResource;
-    balance;
-    getBalances;
-    payFee;
-    payFeeConfidential;
-    constructor(templateAddress) {
-        super(templateAddress);
-        this.templateAddress = templateAddress;
-        this._initFunctions();
-        this._initMethods();
-    }
-    _initFunctions() { }
-    _initMethods() {
-        this.deposit = this._defineMethod("deposit");
-        this.withdraw = this._defineMethod("withdraw");
-        this.createProofByAmount = this._defineMethod("create_proof_by_amount");
-        this.createProofByNonFungibleIds = this._defineMethod("create_proof_by_non_fungible_ids");
-        this.createProofForResource = this._defineMethod("create_proof_for_resource");
-        this.balance = this._defineMethod("balance");
-        this.getBalances = this._defineMethod("get_balances");
-        this.payFee = this._defineMethod("pay_fee");
-        this.payFeeConfidential = this._defineMethod("pay_fee_confidential");
-    }
-}

package/dist/templates/Pool.d.ts

@@ -1,30 +0,0 @@
-import { TariMethodDefinition } from "../builders/types/Builder";
-import { WorkspaceArg } from "../builders/types/Workspace";
-import { TemplateFactory } from "./TemplateFactory";
-interface CreatePool extends TariMethodDefinition {
-    methodName: "create_pool";
-    args?: [string, string];
-}
-interface AddLiquidityMethod extends TariMethodDefinition {
-    methodName: "add_liquidity";
-    args?: WorkspaceArg[];
-}
-interface RemoveLiquidityMethod extends TariMethodDefinition {
-    methodName: "remove_liquidity";
-    args?: WorkspaceArg[];
-}
-interface SwapMethod extends TariMethodDefinition {
-    methodName: "swap";
-    args?: (WorkspaceArg | string)[];
-}
-export declare class PoolTemplate extends TemplateFactory {
-    templateAddress: string;
-    createPool: CreatePool;
-    addLiquidity: AddLiquidityMethod;
-    removeLiquidity: RemoveLiquidityMethod;
-    swap: SwapMethod;
-    constructor(templateAddress: string);
-    protected _initFunctions(): void;
-    protected _initMethods(): void;
-}
-export {};

package/dist/templates/Pool.js

@@ -1,20 +0,0 @@
-import { TemplateFactory } from "./TemplateFactory";
-export class PoolTemplate extends TemplateFactory {
-    templateAddress;
-    createPool;
-    addLiquidity;
-    removeLiquidity;
-    swap;
-    constructor(templateAddress) {
-        super(templateAddress);
-        this.templateAddress = templateAddress;
-        this._initFunctions();
-        this._initMethods();
-    }
-    _initFunctions() { }
-    _initMethods() {
-        this.addLiquidity = this._defineMethod("add_liquidity");
-        this.removeLiquidity = this._defineMethod("remove_liquidity");
-        this.swap = this._defineMethod("swap");
-    }
-}

package/dist/templates/Tariswap.d.ts

@@ -1,65 +0,0 @@
-import { Amount, ConfidentialWithdrawProof, ResourceAddress } from "../builders/types";
-import { TariFunctionDefinition, TariMethodDefinition, WorkspaceArg } from "../builders/types";
-import { TemplateFactory } from "./TemplateFactory";
-interface NewPoolFunction extends TariFunctionDefinition {
-    functionName: "new";
-    args?: [ResourceAddress, ResourceAddress, Amount];
-}
-interface MintFunction extends TariFunctionDefinition {
-    functionName: "mint";
-    args?: [Amount];
-}
-interface MintWithSymbolFunction extends TariFunctionDefinition {
-    functionName: "mint_with_symbol";
-    args?: [Amount, string];
-}
-interface PayFeeMethod extends TariMethodDefinition {
-    methodName: "pay_fee";
-    args?: [string];
-}
-interface PayFeeConfidentialMethod extends TariMethodDefinition {
-    methodName: "pay_fee_confidential";
-    args?: [ConfidentialWithdrawProof];
-}
-interface TotalSupplyMethod extends TariMethodDefinition {
-    methodName: "total_supply";
-    args?: [];
-}
-interface WithdrawMethod extends TariMethodDefinition {
-    methodName: "withdraw";
-    args?: [string, string];
-}
-interface AddLiquidityMethod extends TariMethodDefinition {
-    methodName: "add_liquidity";
-    args?: WorkspaceArg[];
-}
-interface RemoveLiquidityMethod extends TariMethodDefinition {
-    methodName: "remove_liquidity";
-    args?: WorkspaceArg[];
-}
-interface DepositMethod extends TariMethodDefinition {
-    methodName: "deposit";
-    args?: WorkspaceArg[];
-}
-interface SwapMethod extends TariMethodDefinition {
-    methodName: "swap";
-    args?: (WorkspaceArg | string)[];
-}
-export declare class TariswapTemplate extends TemplateFactory {
-    templateAddress: string;
-    newPool: NewPoolFunction;
-    mint: MintFunction;
-    mintWithSymbol: MintWithSymbolFunction;
-    totalSupply: TotalSupplyMethod;
-    payFee: PayFeeMethod;
-    payFeeConfidential: PayFeeConfidentialMethod;
-    withdraw: WithdrawMethod;
-    addLiquidity: AddLiquidityMethod;
-    removeLiquidity: RemoveLiquidityMethod;
-    deposit: DepositMethod;
-    swap: SwapMethod;
-    constructor(templateAddress: string);
-    protected _initFunctions(): void;
-    protected _initMethods(): void;
-}
-export {};

package/dist/templates/Tariswap.js

@@ -1,36 +0,0 @@
-import { TemplateFactory } from "./TemplateFactory";
-export class TariswapTemplate extends TemplateFactory {
-    templateAddress;
-    newPool;
-    mint;
-    mintWithSymbol;
-    totalSupply;
-    payFee;
-    payFeeConfidential;
-    withdraw;
-    addLiquidity;
-    removeLiquidity;
-    deposit;
-    swap;
-    constructor(templateAddress) {
-        super(templateAddress);
-        this.templateAddress = templateAddress;
-        this._initFunctions();
-        this._initMethods();
-    }
-    _initFunctions() {
-        this.newPool = this._defineFunction("new");
-        this.mint = this._defineFunction("mint");
-        this.mintWithSymbol = this._defineFunction("mint_with_symbol");
-    }
-    _initMethods() {
-        this.totalSupply = this._defineMethod("total_supply");
-        this.payFee = this._defineMethod("pay_fee");
-        this.payFeeConfidential = this._defineMethod("pay_fee_confidential");
-        this.withdraw = this._defineMethod("withdraw");
-        this.addLiquidity = this._defineMethod("add_liquidity");
-        this.removeLiquidity = this._defineMethod("remove_liquidity");
-        this.deposit = this._defineMethod("deposit");
-        this.swap = this._defineMethod("swap");
-    }
-}

package/dist/templates/TemplateFactory.d.ts

@@ -1,9 +0,0 @@
-import { TariFunctionDefinition, TariMethodDefinition } from "../builders/types";
-export declare abstract class TemplateFactory {
-    templateAddress: string;
-    constructor(templateAddress: string);
-    _defineFunction<T extends TariFunctionDefinition>(name: T["functionName"]): T;
-    _defineMethod<T extends TariMethodDefinition>(name: T["methodName"]): T;
-    protected abstract _initFunctions(): void;
-    protected abstract _initMethods(): void;
-}

package/dist/templates/TemplateFactory.js

@@ -1,18 +0,0 @@
-export class TemplateFactory {
-    templateAddress;
-    constructor(templateAddress) {
-        this.templateAddress = templateAddress;
-    }
-    _defineFunction(name) {
-        return {
-            templateAddress: this.templateAddress,
-            functionName: name,
-        };
-    }
-    _defineMethod(name) {
-        return {
-            componentAddress: this.templateAddress,
-            methodName: name,
-        };
-    }
-}

package/dist/templates/TestFaucet.d.ts

@@ -1,49 +0,0 @@
-import { Amount, ConfidentialWithdrawProof, TariFunctionDefinition, TariMethodDefinition } from "../builders/types";
-import { TemplateFactory } from "./TemplateFactory";
-interface MintFunction extends TariFunctionDefinition {
-    functionName: "mint";
-    args?: [string];
-}
-interface MintWithSymbolFunction extends TariFunctionDefinition {
-    functionName: "mint_with_symbol";
-    args?: [amount: string, symbol: string];
-}
-interface PayFeeMethod extends TariMethodDefinition {
-    methodName: "pay_fee";
-    args?: [Amount];
-}
-interface PayFeeConfidentialMethod extends TariMethodDefinition {
-    methodName: "pay_fee_confidential";
-    args?: [ConfidentialWithdrawProof];
-}
-interface TakeFreeCoinsMethod extends TariMethodDefinition {
-    methodName: "take_free_coins";
-    args?: [];
-}
-interface TakeFreeCoinsConfidentialMethod extends TariMethodDefinition {
-    methodName: "take_free_coins_confidential";
-    args?: [ConfidentialWithdrawProof];
-}
-interface BurnCoinsMethod extends TariMethodDefinition {
-    methodName: "burn_coins";
-    args?: [BigInt];
-}
-interface TotalSupplyMethod extends TariMethodDefinition {
-    methodName: "total_supply";
-    args?: [];
-}
-export declare class TestFaucet extends TemplateFactory {
-    templateAddress: string;
-    mint: MintFunction;
-    mintWithSymbol: MintWithSymbolFunction;
-    takeFreeCoins: TakeFreeCoinsMethod;
-    takeFreeCoinsConfidential: TakeFreeCoinsConfidentialMethod;
-    burnCoins: BurnCoinsMethod;
-    totalSupply: TotalSupplyMethod;
-    payFee: PayFeeMethod;
-    payFeeConfidential: PayFeeConfidentialMethod;
-    constructor(templateAddress: string);
-    protected _initFunctions(): void;
-    protected _initMethods(): void;
-}
-export {};

package/dist/templates/TestFaucet.js

@@ -1,31 +0,0 @@
-import { TemplateFactory } from "./TemplateFactory";
-export class TestFaucet extends TemplateFactory {
-    templateAddress;
-    mint;
-    mintWithSymbol;
-    takeFreeCoins;
-    takeFreeCoinsConfidential;
-    burnCoins;
-    totalSupply;
-    payFee;
-    payFeeConfidential;
-    constructor(templateAddress) {
-        super(templateAddress);
-        this.templateAddress = templateAddress;
-        this._initFunctions();
-        this._initMethods();
-    }
-    _initFunctions() {
-        this.mint = this._defineFunction("mint");
-        this.mintWithSymbol = this._defineFunction("mint_with_symbol");
-    }
-    _initMethods() {
-        this.takeFreeCoins = this._defineMethod("take_free_coins");
-        this.takeFreeCoinsConfidential =
-            this._defineMethod("take_free_coins_confidential");
-        this.burnCoins = this._defineMethod("burn_coins");
-        this.totalSupply = this._defineMethod("total_supply");
-        this.payFee = this._defineMethod("pay_fee");
-        this.payFeeConfidential = this._defineMethod("pay_fee_confidential");
-    }
-}

package/dist/templates/index.js

@@ -1,5 +0,0 @@
-export { TemplateFactory } from "./TemplateFactory";
-export { AccountTemplate } from "./Account";
-export { TariswapTemplate } from "./Tariswap";
-export { PoolTemplate } from "./Pool";
-export { TestFaucet } from "./TestFaucet";

package/dist/utils.d.ts

@@ -1,2 +0,0 @@
-export declare function toHexString(byteArray: any): string;
-export declare function fromHexString(hexString: string): number[];