@tari-project/tarijs 0.5.0 → 0.5.2

package/packages/tari_universe/src/signer.ts

@@ -1,29 +1,24 @@
 import {
   SubmitTransactionResponse,
-  Account,
+  AccountData,
   Substate,
   TemplateDefinition,
   VaultBalances,
   ListSubstatesResponse,
   SubmitTransactionRequest,
-  TariSigner,
-  TransactionResult,
-} from "@tari-project/tari-signer";
-import {
-  SignerRequest,
-  SignerMethodNames,
-  SignerReturnType,
-  TariUniverseSignerParameters,
-  WindowSize,
+  ListSubstatesRequest,
+  GetTransactionResultResponse,
   ListAccountNftFromBalancesRequest,
-} from "./types";
+} from "@tari-project/tarijs-types";
+import { SignerRequest, SignerMethodNames, SignerReturnType, TariUniverseSignerParameters, WindowSize } from "./types";
 import {
   AccountsGetBalancesResponse,
+  ConfidentialViewVaultBalanceRequest,
   ListAccountNftRequest,
   ListAccountNftResponse,
-  SubstateType,
 } from "@tari-project/wallet_jrpc_client";
 import { sendSignerCall } from "./utils";
+import { TariSigner } from "@tari-project/tari-signer";
 
 export class TariUniverseSigner implements TariSigner {
   public signerName = "TariUniverse";
@@ -56,27 +51,27 @@ export class TariUniverseSigner implements TariSigner {
     return this.sendRequest<"getPublicKey">({ methodName: "getPublicKey", args: [] });
   }
 
-  public async listSubstates(
-    filter_by_template: string | null,
-    filter_by_type: SubstateType | null,
-    limit: number | null,
-    offset: number | null,
-  ): Promise<ListSubstatesResponse> {
+  public async listSubstates({
+    filter_by_template,
+    filter_by_type,
+    limit,
+    offset,
+  }: ListSubstatesRequest): Promise<ListSubstatesResponse> {
     return this.sendRequest<"listSubstates">({
       methodName: "listSubstates",
-      args: [filter_by_template, filter_by_type, limit, offset],
+      args: [{ filter_by_template, filter_by_type, limit, offset }],
     });
   }
 
-  public getConfidentialVaultBalances(
-    viewKeyId: number,
-    vaultId: string,
-    min: number | null,
-    max: number | null,
-  ): Promise<VaultBalances> {
+  public getConfidentialVaultBalances({
+    vault_id,
+    maximum_expected_value,
+    minimum_expected_value,
+    view_key_id,
+  }: ConfidentialViewVaultBalanceRequest): Promise<VaultBalances> {
     return this.sendRequest({
       methodName: "getConfidentialVaultBalances",
-      args: [viewKeyId, vaultId, min, max],
+      args: [{ view_key_id, vault_id, minimum_expected_value, maximum_expected_value }],
     });
   }
 
@@ -88,7 +83,7 @@ export class TariUniverseSigner implements TariSigner {
     return this.sendRequest({ methodName: "requestParentSize", args: [] });
   }
 
-  public async getAccount(): Promise<Account> {
+  public async getAccount(): Promise<AccountData> {
     return this.sendRequest({ methodName: "getAccount", args: [] });
   }
 
@@ -113,7 +108,7 @@ export class TariUniverseSigner implements TariSigner {
     });
   }
 
-  public async getTransactionResult(transactionId: string): Promise<TransactionResult> {
+  public async getTransactionResult(transactionId: string): Promise<GetTransactionResultResponse> {
     return this.sendRequest({
       methodName: "getTransactionResult",
       args: [transactionId],

package/packages/tari_universe/src/types.ts

@@ -1,6 +1,5 @@
 import { TariPermissions } from "@tari-project/tari-permissions";
 import { TariUniverseSigner } from "./signer";
-import { BalanceEntry } from "@tari-project/typescript-bindings";
 
 export type TariUniverseSignerParameters = {
   permissions: TariPermissions;
@@ -32,7 +31,3 @@ export type SignerResponse<T extends SignerMethodNames> = {
   result: SignerReturnType<T>;
   resultError?: string;
 };
-
-export interface ListAccountNftFromBalancesRequest {
-  balances: Array<BalanceEntry>;
-}

package/packages/tarijs/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tarijs",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/tarijs/src/index.ts

@@ -2,18 +2,6 @@ import { TariSigner } from "@tari-project/tari-signer";
 import { TariProvider } from "@tari-project/tari-provider";
 import * as utils from "./utils";
 import { Network } from "./network";
-import {
-  Account,
-  TransactionStatus,
-  TransactionResult,
-  SubmitTransactionResponse,
-  SubmitTransactionRequest,
-  VaultBalances,
-  VaultData,
-  TemplateDefinition,
-  SubstateRequirement,
-  Substate,
-} from "@tari-project/tari-signer";
 import { MetamaskTariSigner } from "@tari-project/metamask-signer";
 import { MetaMaskInpageProvider } from "@metamask/providers";
 import { WalletDaemonTariSigner, WalletDaemonParameters, TariPermissions } from "@tari-project/wallet-daemon-signer";
@@ -38,6 +26,16 @@ import {
   convertU256ToHexString,
   createNftAddressFromResource,
   createNftAddressFromToken,
+  TransactionStatus,
+  GetTransactionResultResponse,
+  AccountData,
+  SubmitTransactionResponse,
+  SubmitTransactionRequest,
+  VaultBalances,
+  VaultData,
+  TemplateDefinition,
+  SubstateRequirement,
+  Substate,
 } from "@tari-project/tarijs-types";
 
 export * from "@tari-project/tarijs-types";
@@ -46,9 +44,9 @@ export {
   Network,
   TariSigner,
   TariProvider,
-  Account,
+  AccountData,
   TransactionStatus,
-  TransactionResult,
+  GetTransactionResultResponse,
   SubmitTransactionResponse,
   SubmitTransactionRequest,
   VaultBalances,

package/packages/tarijs_types/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/tarijs-types",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/tarijs_types/src/ConfidentialOutput.ts

@@ -1,4 +1,4 @@
-import type { ElgamalVerifiableBalance } from "./ElgamalVerifiableBalance";
+import { ElgamalVerifiableBalance } from "@tari-project/typescript-bindings";
 
 export interface ConfidentialOutput {
   commitment: string;

package/packages/tarijs_types/src/ConfidentialWithdrawProof.ts

@@ -1,4 +1,4 @@
-import type { ConfidentialOutputStatement } from "./ConfidentialOutputStatement";
+import { ConfidentialOutputStatement } from "@tari-project/typescript-bindings";
 
 export interface ConfidentialWithdrawProof {
   inputs: Array<Uint8Array>;

package/packages/tarijs_types/src/GetTransactionResultResponse.ts

@@ -0,0 +1,8 @@
+import { FinalizeResult } from "@tari-project/typescript-bindings";
+import { TransactionStatus } from "./TransactionStatus";
+
+export type GetTransactionResultResponse = {
+  transaction_id: string;
+  status: TransactionStatus;
+  result: FinalizeResult | null;
+};

package/packages/tarijs_types/src/Instruction.ts

@@ -1,9 +1,8 @@
-import { ComponentAddress, LogLevel } from "@tari-project/typescript-bindings";
-import { Arg } from "./Arg";
+import { ComponentAddress, LogLevel, PublishedTemplateAddress } from "@tari-project/typescript-bindings";
+import { TransactionArg } from "./TransactionArg";
 import { ConfidentialClaim } from "./ConfidentialClaim";
 import { Amount } from "./Amount";
 import { ConfidentialOutput } from "./ConfidentialOutput";
-import { TemplateAddress } from "./TemplateAddress";
 
 export type Instruction =
   | CreateAccount
@@ -17,8 +16,12 @@ export type Instruction =
   | CreateFreeTestCoins;
 
 export type CreateAccount = { CreateAccount: { owner_public_key: string; workspace_bucket: string | null } };
-export type CallFunction = { CallFunction: { template_address: TemplateAddress; function: string; args: Array<Arg> } };
-export type CallMethod = { CallMethod: { component_address: ComponentAddress; method: string; args: Array<Arg> } };
+export type CallFunction = {
+  CallFunction: { template_address: PublishedTemplateAddress; function: string; args: Array<TransactionArg> };
+};
+export type CallMethod = {
+  CallMethod: { component_address: ComponentAddress; method: string; args: Array<TransactionArg> };
+};
 export type PutLastInstructionOutputOnWorkspace = { PutLastInstructionOutputOnWorkspace: { key: number[] } };
 export type EmitLog = { EmitLog: { level: LogLevel; message: string } };
 export type ClaimBurn = { ClaimBurn: { claim: ConfidentialClaim } };

package/packages/tarijs_types/src/ListAccountNftFromBalancesRequest.ts

@@ -0,0 +1,5 @@
+import { BalanceEntry } from "@tari-project/typescript-bindings";
+
+export interface ListAccountNftFromBalancesRequest {
+  balances: Array<BalanceEntry>;
+}

package/packages/tarijs_types/src/Transaction.ts

@@ -1,8 +1,8 @@
 import { Instruction } from "./Instruction";
 import { SubstateRequirement } from "./SubstateRequirement";
-import { Epoch } from "./Epoch";
 import { VersionedSubstateId } from "./VersionedSubstateId";
 import { TransactionSignature } from "./TransactionSignature";
+import { Epoch } from "@tari-project/typescript-bindings";
 
 export interface Transaction {
   id: string;

package/packages/tarijs_types/src/TransactionArg.ts

@@ -0,0 +1,2 @@
+// this type differs from ts-bindings to allow any argument to be passed in the transaction
+export type TransactionArg = any;

package/packages/tarijs_types/src/TransactionResult.ts

@@ -1,3 +1,4 @@
+import { TransactionStatus } from "./TransactionStatus";
 import { FinalizeResult } from "./FinalizeResult";
 
 export type SubmitTransactionResponse = {
@@ -9,16 +10,6 @@ export interface SubmitTxResult {
   result: TransactionResult;
 }
 
-export enum TransactionStatus {
-  New,
-  DryRun,
-  Pending,
-  Accepted,
-  Rejected,
-  InvalidTransaction,
-  OnlyFeeAccepted,
-}
-
 export type TransactionResult = {
   transaction_id: string;
   status: TransactionStatus;

package/packages/tarijs_types/src/TransactionStatus.ts

@@ -0,0 +1,9 @@
+export enum TransactionStatus {
+  New,
+  DryRun,
+  Pending,
+  Accepted,
+  Rejected,
+  InvalidTransaction,
+  OnlyFeeAccepted,
+}

package/packages/tarijs_types/src/UnsignedTransaction.ts

@@ -1,9 +1,8 @@
+import { Epoch } from "@tari-project/typescript-bindings";
 import { Instruction } from "./Instruction";
-import { Epoch } from "./Epoch";
 import { SubstateRequirement } from "./SubstateRequirement";
 import { VersionedSubstateId } from "./VersionedSubstateId";
 
-//TODO refactor type (https://github.com/tari-project/tari.js/issues/29)
 // differs from bindings implementation because of 'Instruction'
 export interface UnsignedTransaction {
   feeInstructions: Instruction[];

package/packages/tarijs_types/src/helpers/index.ts

@@ -1,5 +1,15 @@
 import { NonFungibleId, NonFungibleToken, ResourceAddress } from "@tari-project/typescript-bindings";
-import { TransactionStatus } from "../TransactionResult";
+import { TransactionStatus } from "../TransactionStatus";
+export {
+  substateIdToString,
+  stringToSubstateId,
+  shortenSubstateId,
+  shortenString,
+  rejectReasonToString,
+  getSubstateDiffFromTransactionResult,
+  getRejectReasonFromTransactionResult,
+  jrpcPermissionToString,
+} from "@tari-project/typescript-bindings";
 
 export function convertStringToTransactionStatus(status: string): TransactionStatus {
   switch (status) {
@@ -49,12 +59,9 @@ export function convertHexStringToU256Array(hexString: string): number[] {
 
 export function createNftAddressFromResource(address: ResourceAddress, tokenId: NonFungibleId): string {
   let nftAddress = "nft_";
-
   const resourceAddress = address.replace(/^resource_/, "");
   nftAddress += resourceAddress;
-
   nftAddress += "_uuid_";
-
   const nftIdHexString = convertU256ToHexString(tokenId);
   nftAddress += nftIdHexString;
 

package/packages/tarijs_types/src/index.ts

@@ -1,13 +1,9 @@
-export { TemplateAddress } from "./TemplateAddress";
+export { ComponentAddress, ResourceAddress, PublishedTemplateAddress, Epoch } from "@tari-project/typescript-bindings";
 export { Amount } from "./Amount";
-export { Arg } from "./Arg";
-export { ComponentAddress } from "./ComponentAddress";
+export { TransactionArg } from "./TransactionArg";
 export { ConfidentialClaim } from "./ConfidentialClaim";
 export { ConfidentialOutput } from "./ConfidentialOutput";
-export { ConfidentialOutputStatement } from "./ConfidentialOutputStatement";
-export { ConfidentialStatement } from "./ConfidentialStatement";
 export { ConfidentialWithdrawProof } from "./ConfidentialWithdrawProof";
-export { Epoch } from "./Epoch";
 export {
   FinalizeResult,
   FinalizeResultStatus,
@@ -15,22 +11,44 @@ export {
   TxResultAcceptFeeRejectRest,
   TxResultReject,
 } from "./FinalizeResult";
-export { ResourceAddress } from "./ResourceAddress";
+export { GetTransactionResultResponse } from "./GetTransactionResultResponse";
 export { Instruction } from "./Instruction";
 export { Transaction } from "./Transaction";
 export { SubstateDiff, DownSubstates, UpSubstates } from "./SubstateDiff";
 export { SubstateRequirement } from "./SubstateRequirement";
-export { TransactionId } from "./TransactionId";
-export { TransactionResult, TransactionStatus, SubmitTxResult, SubmitTransactionResponse } from "./TransactionResult";
+export { TransactionResult, SubmitTxResult, SubmitTransactionResponse } from "./TransactionResult";
 export { TransactionSignature } from "./TransactionSignature";
+export { TransactionStatus } from "./TransactionStatus";
 export { UnsignedTransaction } from "./UnsignedTransaction";
 export { VersionedSubstateId } from "./VersionedSubstateId";
-export { ViewableBalanceProof } from "./ViewableBalanceProof";
 export { WorkspaceArg } from "./Workspace";
+export { ListAccountNftFromBalancesRequest } from "./ListAccountNftFromBalancesRequest";
+export {
+  AccountData,
+  ListSubstatesRequest,
+  ListSubstatesResponse,
+  SubmitTransactionRequest,
+  Substate,
+  SubstateMetadata,
+  ReqSubstate,
+  TemplateDefinition,
+  VaultBalances,
+  VaultData,
+  GetSubstateRequest,
+} from "./signer";
+
 export {
   convertHexStringToU256Array,
   convertStringToTransactionStatus,
   convertU256ToHexString,
   createNftAddressFromResource,
   createNftAddressFromToken,
+  getRejectReasonFromTransactionResult,
+  getSubstateDiffFromTransactionResult,
+  jrpcPermissionToString,
+  rejectReasonToString,
+  shortenString,
+  shortenSubstateId,
+  stringToSubstateId,
+  substateIdToString,
 } from "./helpers";

package/packages/{tari_provider/src/types.ts → tarijs_types/src/signer.ts}

@@ -1,4 +1,4 @@
-import { FinalizeResult, SubstateType } from "@tari-project/typescript-bindings";
+import { SubstateType, TemplateDef } from "@tari-project/typescript-bindings";
 
 export type SubstateMetadata = {
   substate_id: string;
@@ -7,28 +7,27 @@ export type SubstateMetadata = {
   template_address: string | null;
 };
 
-export type SubstateRequirement = {
+export type ReqSubstate = {
   substate_id: string;
   version?: number | null;
 };
 
-export type TransactionResult = {
-  transaction_id: string;
-  status: TransactionStatus;
-  result: FinalizeResult | null;
+export type SubmitTransactionRequest = {
+  network: number;
+  account_id: number;
+  instructions: object[];
+  fee_instructions: object[];
+  inputs: object[];
+  input_refs: object[];
+  required_substates: ReqSubstate[];
+  is_dry_run: boolean;
+  min_epoch: number | null;
+  max_epoch: number | null;
+  is_seal_signer_authorized: boolean;
+  detect_inputs_use_unversioned: boolean;
 };
 
-export enum TransactionStatus {
-  New,
-  DryRun,
-  Pending,
-  Accepted,
-  Rejected,
-  InvalidTransaction,
-  OnlyFeeAccepted,
-}
-
-export interface Account {
+export interface AccountData {
   account_id: number;
   address: string;
   public_key: string;
@@ -47,28 +46,18 @@ export interface VaultBalances {
   balances: Map<string, number | null>;
 }
 
-export interface TemplateDefinition {
-  // TODO: Define this type
-  [key: string]: any;
-}
+export type TemplateDefinition = TemplateDef;
 
-export type SubmitTransactionRequest = {
-  network: number;
-  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;
-  is_seal_signer_authorized: boolean;
-  detect_inputs_use_unversioned: boolean;
-};
+export interface Substate {
+  value: any;
+  address: {
+    substate_id: string;
+    version: number;
+  };
+}
 
-export type SubmitTransactionResponse = {
-  transaction_id: string;
+export type ListSubstatesResponse = {
+  substates: Array<SubstateMetadata>;
 };
 
 export type ListSubstatesRequest = {
@@ -78,19 +67,7 @@ export type ListSubstatesRequest = {
   offset: number | null;
 };
 
-export type ListSubstatesResponse = {
-  substates: Array<SubstateMetadata>;
-};
-
 export type GetSubstateRequest = {
   substate_address: string;
   version: number | null;
 };
-
-export interface Substate {
-  value: any;
-  address: {
-    substate_id: string;
-    version: number;
-  };
-}

package/packages/wallet_daemon/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/wallet-daemon-signer",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "",
   "type": "module",
   "publishConfig": {

package/packages/wallet_daemon/src/signer.ts

@@ -1,29 +1,30 @@
 import { TariPermissions } from "@tari-project/tari-permissions";
 import { TariConnection } from "./webrtc";
-import {
-  SubmitTransactionRequest,
-  TransactionResult,
-  SubmitTransactionResponse,
-  VaultBalances,
-  TemplateDefinition,
-  Substate,
-  ListSubstatesResponse,
-  TariSigner,
-} from "@tari-project/tari-signer";
-import { Account } from "@tari-project/tari-signer";
+import { TariSigner } from "@tari-project/tari-signer";
 import {
   WalletDaemonClient,
   substateIdToString,
   Instruction,
-  SubstateType,
   SubstatesListRequest,
   KeyBranch,
   SubstateId,
   ListAccountNftRequest,
   ListAccountNftResponse,
+  ConfidentialViewVaultBalanceRequest,
 } from "@tari-project/wallet_jrpc_client";
 import { WebRtcRpcTransport } from "./webrtc_transport";
-import { convertStringToTransactionStatus } from "@tari-project/tarijs-types";
+import {
+  AccountData,
+  convertStringToTransactionStatus,
+  GetTransactionResultResponse,
+  SubmitTransactionRequest,
+  SubmitTransactionResponse,
+  VaultBalances,
+  TemplateDefinition,
+  Substate,
+  ListSubstatesResponse,
+  ListSubstatesRequest,
+} from "@tari-project/tarijs-types";
 
 export const WalletDaemonNotConnected = "WALLET_DAEMON_NOT_CONNECTED";
 export const Unsupported = "UNSUPPORTED";
@@ -114,7 +115,7 @@ export class WalletDaemonTariSigner implements TariSigner {
     return this.getWebRtcTransport()?.isConnected() || true;
   }
 
-  public async createFreeTestCoins(): Promise<Account> {
+  public async createFreeTestCoins(): Promise<AccountData> {
     const res = await this.client.createFreeTestCoins({
       account: { Name: "template_web" },
       amount: 1000000,
@@ -129,7 +130,7 @@ export class WalletDaemonTariSigner implements TariSigner {
     };
   }
 
-  public async getAccount(): Promise<Account> {
+  public async getAccount(): Promise<AccountData> {
     const { account, public_key } = (await this.client.accountsGetDefault({})) as any;
     const address = typeof account.address === "object" ? account.address.Component : account.address;
     const { balances } = await this.client.accountsGetBalances({
@@ -197,7 +198,7 @@ export class WalletDaemonTariSigner implements TariSigner {
     return { transaction_id: res.transaction_id };
   }
 
-  public async getTransactionResult(transactionId: string): Promise<TransactionResult> {
+  public async getTransactionResult(transactionId: string): Promise<GetTransactionResultResponse> {
     const res = await this.client.getTransactionResult({ transaction_id: transactionId });
 
     return {
@@ -217,27 +218,27 @@ export class WalletDaemonTariSigner implements TariSigner {
     return resp.template_definition as TemplateDefinition;
   }
 
-  public async getConfidentialVaultBalances(
-    viewKeyId: number,
-    vaultId: string,
-    min: number | null = null,
-    max: number | null = null,
-  ): Promise<VaultBalances> {
+  public async getConfidentialVaultBalances({
+    vault_id,
+    view_key_id,
+    maximum_expected_value = null,
+    minimum_expected_value = null,
+  }: ConfidentialViewVaultBalanceRequest): Promise<VaultBalances> {
     const res = await this.client.viewVaultBalance({
-      view_key_id: viewKeyId,
-      vault_id: vaultId,
-      minimum_expected_value: min,
-      maximum_expected_value: max,
+      view_key_id,
+      vault_id,
+      minimum_expected_value,
+      maximum_expected_value,
     });
     return { balances: res.balances as unknown as Map<string, number | null> };
   }
 
-  public async listSubstates(
-    filter_by_template: string | null,
-    filter_by_type: SubstateType | null,
-    limit: number | null,
-    offset: number | null,
-  ): Promise<ListSubstatesResponse> {
+  public async listSubstates({
+    filter_by_template,
+    filter_by_type,
+    limit,
+    offset,
+  }: ListSubstatesRequest): Promise<ListSubstatesResponse> {
     const resp = await this.client.substatesList({
       filter_by_template,
       filter_by_type,

package/packages/walletconnect/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tari-project/wallet-connect-signer",
-  "version": "0.5.0",
+  "version": "0.5.2",
   "description": "",
   "type": "module",
   "publishConfig": {