@azguardwallet/types 0.4.1 → 0.6.0

package/dist/action.d.ts

@@ -1,8 +1,8 @@
 import { AuthwitContent } from "./authwit-content";
 /** Action kind */
-export type ActionKind = "add_capsule" | "add_private_authwit" | "add_public_authwit" | "call" | "encoded_call";
+export type ActionKind = Action["kind"];
 /** A request to perform some action */
-export type Action = AddCapsuleAction | AddPrivateAuthwitAction | AddPublicAuthwitAction | CallAction | EncodedCallAction;
+export type Action = AddCapsuleAction | AddExtraArgsAction | AddPrivateAuthwitAction | AddPublicAuthwitAction | CallAction | EncodedCallAction;
 /** A request to add a capsule to PXE */
 export type AddCapsuleAction = {
     /** Action kind */
@@ -14,6 +14,13 @@ export type AddCapsuleAction = {
     /** Capsule to be added (Fr[]) */
     capsule: string[];
 };
+/** A request to add extra args to be available during execution */
+export type AddExtraArgsAction = {
+    /** Action kind */
+    kind: "add_extra_args";
+    /** Args (Fr[]) */
+    args: string[];
+};
 /** A request to add an authwit for the message hash computed from the given content to PXE */
 export type AddPrivateAuthwitAction = {
     /** Action kind */
@@ -43,6 +50,8 @@ export type CallAction = {
     method: string;
     /** Arguments (unencoded) */
     args: any[];
+    /** Whether or not the caller's address should be hidden from the called contract */
+    hideSender?: boolean;
 };
 /** A request to call a contract with encoded args (matches FunctionCall from aztec.js) */
 export type EncodedCallAction = {
@@ -56,6 +65,8 @@ export type EncodedCallAction = {
     selector: string;
     /** Type of the function (FunctionType) */
     type?: string;
+    /** Whether or not the caller's address should be hidden from the called contract */
+    hideMsgSender?: boolean;
     /** Whether this call can makes modifications to state or not */
     isStatic?: boolean;
     /** Encoded arguments (Fr[]) */

package/dist/authwit-content.d.ts

@@ -1,38 +1,19 @@
+import { CallAction, EncodedCallAction } from "./action";
 /** Content to add authwitness for. */
 export type AuthwitContent = CallAuthwitContent | EncodedCallAuthwitContent | IntentAuthwitContent | MessageHashAuthwitContent;
 /** Contract call to be authorized */
-export type CallAuthwitContent = {
+export type CallAuthwitContent = Omit<CallAction, "kind"> & {
     /** Authwit content kind */
-    kind: "call";
+    readonly kind: "call";
     /** Address of the caller (AztecAddress) */
-    caller: string;
-    /** Address of the contract (AztecAddress) */
-    contract: string;
-    /** Name of the function */
-    method: string;
-    /** Arguments (unencoded) */
-    args: any[];
+    readonly caller: string;
 };
 /** Encoded contract call to be authorized */
-export type EncodedCallAuthwitContent = {
+export type EncodedCallAuthwitContent = Omit<EncodedCallAction, "kind"> & {
     /** Authwit content kind */
     kind: "encoded_call";
     /** Address of the caller (AztecAddress) */
     caller: string;
-    /** Name of the function */
-    name?: string;
-    /** Address of the contract (AztecAddress) */
-    to: string;
-    /** Selector of the function (FunctionSelector) */
-    selector: string;
-    /** Type of the function (FunctionType) */
-    type?: string;
-    /** Whether this call can makes modifications to state or not */
-    isStatic?: boolean;
-    /** Encoded arguments (Fr[]) */
-    args: string[];
-    /** Return types for decoding (AbiType[]) */
-    returnTypes?: unknown[];
 };
 /** Arbitrary intent to be authorized */
 export type IntentAuthwitContent = {

package/dist/dapp-session.d.ts

@@ -8,7 +8,7 @@ export type CaipAccount = `${CaipChain}:${string}`;
 /** DApp metadata */
 export type DappMetadata = {
     /** Name */
-    name: string;
+    name?: string;
     /** Short description */
     description?: string;
     /** Logo URI */

package/dist/operation.d.ts

@@ -2,11 +2,11 @@ import { Action, CallAction, EncodedCallAction } from "./action";
 import { Result } from "./result";
 import { CaipAccount, CaipChain } from "./dapp-session";
 /** Operation kind */
-export type OperationKind = "add_note" | "get_complete_address" | "register_contract" | "register_sender" | "register_token" | "send_transaction" | "simulate_transaction" | "simulate_utility" | "simulate_views";
+export type OperationKind = Operation["kind"];
 /** A request to perform some operation */
-export type Operation = GetCompleteAddressOperation | RegisterContractOperation | RegisterSenderOperation | RegisterTokenOperation | SendTransactionOperation | SimulateTransactionOperation | SimulateUtilityOperation | SimulateViewsOperation;
+export type Operation = GetCompleteAddressOperation | RegisterContractOperation | RegisterSenderOperation | RegisterTokenOperation | SendTransactionOperation | SimulateTransactionOperation | SimulateUtilityOperation | SimulateViewsOperation | AztecGetContractClassMetadataOperation | AztecGetContractMetadataOperation | AztecGetPrivateEventsOperation | AztecGetChainInfoOperation | AztecGetTxReceiptOperation | AztecRegisterSenderOperation | AztecGetAddressBookOperation | AztecRegisterContractOperation | AztecSimulateTxOperation | AztecSimulateUtilityOperation | AztecProfileTxOperation | AztecSendTxOperation | AztecCreateAuthWitOperation;
 /** Operation result */
-export type OperationResult = Result<GetCompleteAddressResult> | Result<RegisterContractResult> | Result<RegisterSenderResult> | Result<RegisterTokenResult> | Result<SendTransactionResult> | Result<SimulateTransactionResult> | Result<SimulateUtilityResult> | Result<SimulateViewsResult>;
+export type OperationResult = Result<GetCompleteAddressResult> | Result<RegisterContractResult> | Result<RegisterSenderResult> | Result<RegisterTokenResult> | Result<SendTransactionResult> | Result<SimulateTransactionResult> | Result<SimulateUtilityResult> | Result<SimulateViewsResult> | Result<AztecGetContractClassMetadataResult> | Result<AztecGetContractMetadataResult> | Result<AztecGetPrivateEventsResult> | Result<AztecGetChainInfoResult> | Result<AztecGetTxReceiptResult> | Result<AztecRegisterSenderResult> | Result<AztecGetAddressBookResult> | Result<AztecRegisterContractResult> | Result<AztecSimulateTxResult> | Result<AztecSimulateUtilityResult> | Result<AztecProfileTxResult> | Result<AztecSendTxResult> | Result<AztecCreateAuthWitResult>;
 /** A request to get complete address of the specified account */
 export type GetCompleteAddressOperation = {
     /** Operation kind */
@@ -59,6 +59,24 @@ export type RegisterTokenOperation = {
 };
 /** A result of the "register_token" operation */
 export type RegisterTokenResult = Result<void>;
+/** Fees and gas options */
+export type FeeOptions = {
+    /** Tells if fee payment payload (either fee juice with claim or fpc) is included */
+    readonly embeddedFeePayment?: "fjwc" | "fpc";
+    /** Suggest gas limits to be used at the first step of estimation */
+    readonly gasLimits?: GasLimits;
+    /** Suggest teardown gas limits to be used at the first step of estimation */
+    readonly teardownGasLimits?: GasLimits;
+    /** Multiplier for the simulated gas */
+    readonly gasPadding?: number;
+};
+/** Gas limits */
+export type GasLimits = {
+    /** DA gas */
+    readonly daGas: number;
+    /** L2 gas */
+    readonly l2Gas: number;
+};
 /** A request to send the transaction */
 export type SendTransactionOperation = {
     /** Operation kind */
@@ -66,15 +84,12 @@ export type SendTransactionOperation = {
     /** Address of the account to send transaction from */
     account: CaipAccount;
     /**
-     * Batch of calls to be passed to the account contract for the "execution" phase
+     * Batch of calls to be passed to the account contract
      * and additional actions, that may be needed for its execution
      * */
     actions: Action[];
-    /**
-     * Batch of calls to be passed to the account contract for the "setup" phase
-     * and additional actions, that may be needed for its execution
-     * */
-    setup?: Action[];
+    /** Fees and gas options */
+    fee?: FeeOptions;
 };
 /** A result of the "send_transaction" operation (TxHash) */
 export type SendTransactionResult = string;
@@ -85,15 +100,12 @@ export type SimulateTransactionOperation = {
     /** Address of the account to send transaction from */
     account: CaipAccount;
     /**
-     * Batch of calls to be passed to the account contract for the "execution" phase
+     * Batch of calls to be passed to the account contract
      * and additional actions, that may be needed for its execution
      * */
     actions: Action[];
-    /**
-     * Batch of calls to be passed to the account contract for the "setup" phase
-     * and additional actions, that may be needed for its execution
-     * */
-    setup?: Action[];
+    /** Fees and gas options */
+    fee?: FeeOptions;
     /** Whether to also simulate enqueued public calls or not */
     simulatePublic?: boolean;
 };
@@ -137,3 +149,170 @@ export type SimulateViewsResult = {
     /** List of results, decoded with function return types ABI (AbiDecoded[]) */
     decoded: unknown[];
 };
+/** Aztec.js Wallet request */
+export type AztecGetContractClassMetadataOperation = {
+    /** Operation kind */
+    kind: "aztec_getContractClassMetadata";
+    /** Chain to execute request for */
+    chain: CaipChain;
+    /** Identifier of the class (Fr) */
+    id: unknown;
+    /** Whether or not to also return contract artifact */
+    includeArtifact?: boolean;
+};
+/** A result of the "aztec_getContractClassMetadata" operation (ContractClassMetadata) */
+export type AztecGetContractClassMetadataResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetContractMetadataOperation = {
+    /** Operation kind */
+    kind: "aztec_getContractMetadata";
+    /** Chain to execute request for */
+    chain: CaipChain;
+    /** The address that the contract instance resides at (AztecAddress) */
+    address: unknown;
+};
+/** A result of the "aztec_getContractMetadata" operation (ContractMetadata) */
+export type AztecGetContractMetadataResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetPrivateEventsOperation = {
+    /** Operation kind */
+    kind: "aztec_getPrivateEvents";
+    /** Chain to execute request for */
+    chain: CaipChain;
+    /** The address of the contract to get events from (AztecAddress) */
+    contractAddress: unknown;
+    /** Metadata of the event. This should be the class generated from the contract. e.g. Contract.events.Event (EventMetadataDefinition) */
+    eventMetadata: unknown;
+    /** The block number to search from */
+    from: number;
+    /** The amount of blocks to search */
+    numBlocks: number;
+    /** The addresses that decrypted the logs (AztecAddress[]) */
+    recipients: unknown[];
+};
+/** A result of the "aztec_getPrivateEvents" operation (T[]) */
+export type AztecGetPrivateEventsResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetChainInfoOperation = {
+    /** Operation kind */
+    kind: "aztec_getChainInfo";
+    /** Chain to execute request for */
+    chain: CaipChain;
+};
+/** A result of the "aztec_getChainInfo" operation (ChainInfo) */
+export type AztecGetChainInfoResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetTxReceiptOperation = {
+    /** Operation kind */
+    kind: "aztec_getTxReceipt";
+    /** Chain to execute request for */
+    chain: CaipChain;
+    /** The transaction hash (TxHash) */
+    txHash: unknown;
+};
+/** A result of the "aztec_getTxReceipt" operation (TxReceipt) */
+export type AztecGetTxReceiptResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecRegisterSenderOperation = {
+    /** Operation kind */
+    kind: "aztec_registerSender";
+    /** Chain to execute request for */
+    chain: CaipChain;
+    /** Address of the user to add to the address book (AztecAddress) */
+    address: unknown;
+    /** Optional alias for the sender's address */
+    alias?: string;
+};
+/** A result of the "aztec_registerSender" operation (AztecAddress) */
+export type AztecRegisterSenderResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetAddressBookOperation = {
+    /** Operation kind */
+    kind: "aztec_getAddressBook";
+    /** Chain to execute request for */
+    chain: CaipChain;
+};
+/** A result of the "aztec_getAddressBook" operation (Aliased<AztecAddress>[]) */
+export type AztecGetAddressBookResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecRegisterContractOperation = {
+    /** Operation kind */
+    kind: "aztec_registerContract";
+    /** Chain to execute request for */
+    chain: CaipChain;
+    /** Contract instance (AztecAddress | ContractInstanceWithAddress | ContractInstantiationData | ContractInstanceAndArtifact) */
+    instanceData: unknown;
+    /** Contract artifact (ContractArtifact) */
+    artifact?: unknown;
+    /** Secret key (Fr) */
+    secretKey?: unknown;
+};
+/** A result of the "aztec_registerContract" operation (ContractInstanceWithAddress) */
+export type AztecRegisterContractResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecSimulateTxOperation = {
+    /** Operation kind */
+    kind: "aztec_simulateTx";
+    /** Address of the account to simulate transaction from */
+    account: CaipAccount;
+    /** Payload (ExecutionPayload) */
+    exec: unknown;
+    /** Options (SimulateOptions) */
+    opts: unknown;
+};
+/** A result of the "aztec_simulateTx" operation (TxSimulationResult) */
+export type AztecSimulateTxResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecSimulateUtilityOperation = {
+    /** Operation kind */
+    kind: "aztec_simulateUtility";
+    /** Address of the account to simulate utility function from */
+    account: CaipAccount;
+    /** The name of the utility contract function to be called */
+    functionName: string;
+    /** The arguments to be provided to the function */
+    args: any[];
+    /** The address of the contract to be called (AztecAddress) */
+    to: unknown;
+    /** (Optional) The authentication witnesses required for the function call (AuthWitness[]) */
+    authwits?: unknown[];
+};
+/** A result of the "aztec_simulateUtility" operation (UtilitySimulationResult) */
+export type AztecSimulateUtilityResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecProfileTxOperation = {
+    /** Operation kind */
+    kind: "aztec_profileTx";
+    /** Address of the account to profile tx from */
+    account: CaipAccount;
+    /** Payload (ExecutionPayload) */
+    exec: unknown;
+    /** Options (ProfileOptions) */
+    opts: unknown;
+};
+/** A result of the "aztec_profileTx" operation (TxProfileResult) */
+export type AztecProfileTxResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecSendTxOperation = {
+    /** Operation kind */
+    kind: "aztec_sendTx";
+    /** Address of the account to send tx from */
+    account: CaipAccount;
+    /** Payload (ExecutionPayload) */
+    exec: unknown;
+    /** Options (SendOptions) */
+    opts: unknown;
+};
+/** A result of the "aztec_sendTx" operation (TxHash) */
+export type AztecSendTxResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecCreateAuthWitOperation = {
+    /** Operation kind */
+    kind: "aztec_createAuthWit";
+    /** Address of the account to create authwit for */
+    account: CaipAccount;
+    /** Intent or message hash (Fr | Buffer<ArrayBuffer> | IntentInnerHash | CallIntent) */
+    messageHashOrIntent: unknown;
+};
+/** A result of the "aztec_createAuthWit" operation (AuthWitness) */
+export type AztecCreateAuthWitResult = unknown;

package/dist/result.d.ts

@@ -1,7 +1,7 @@
 /** Result object */
-export type Result<T> = OkResult<T> | FailedResult | SkippedResult;
+export type Result<T = unknown> = OkResult<T> | FailedResult | SkippedResult;
 /** Successful result, containing returned value */
-export type OkResult<T> = {
+export type OkResult<T = unknown> = {
     /** Result status */
     status: "ok";
     /** Returned value */

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@azguardwallet/types",
-    "version": "0.4.1",
+    "version": "0.6.0",
     "description": "Typings for Azguard Wallet inpage RPC client",
     "author": "Azguard Wallet",
     "homepage": "https://github.com/AzguardWallet/azguard-wallet-types",
@@ -16,4 +16,4 @@
     "scripts": {
         "build": "rm -rf dist && tsc"
     }
-}
+}