@azguardwallet/types 0.4.1 → 0.5.0

package/dist/action.d.ts

@@ -1,6 +1,6 @@
 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;
 /** A request to add a capsule to PXE */

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 | AztecSimulateTxOperation | AztecSimulateUtilityOperation | AztecProfileTxOperation | AztecSendTxOperation | AztecGetContractClassMetadataOperation | AztecGetContractMetadataOperation | AztecRegisterContractOperation | AztecRegisterContractClassOperation | AztecProveTxOperation | AztecGetNodeInfoOperation | AztecGetPXEInfoOperation | AztecGetCurrentBaseFeesOperation | AztecUpdateContractOperation | AztecRegisterSenderOperation | AztecGetSendersOperation | AztecRemoveSenderOperation | AztecGetTxReceiptOperation | AztecGetPrivateEventsOperation | AztecGetPublicEventsOperation | AztecGetCompleteAddressOperation | AztecGetAddressOperation | AztecGetChainIdOperation | AztecGetVersionOperation | AztecCreateTxExecutionRequestOperation | 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<AztecSimulateTxResult> | Result<AztecSimulateUtilityResult> | Result<AztecProfileTxResult> | Result<AztecSendTxResult> | Result<AztecGetContractClassMetadataResult> | Result<AztecGetContractMetadataResult> | Result<AztecRegisterContractResult> | Result<AztecRegisterContractClassResult> | Result<AztecProveTxResult> | Result<AztecGetNodeInfoResult> | Result<AztecGetPXEInfoResult> | Result<AztecGetCurrentBaseFeesResult> | Result<AztecUpdateContractResult> | Result<AztecRegisterSenderResult> | Result<AztecGetSendersResult> | Result<AztecRemoveSenderResult> | Result<AztecGetTxReceiptResult> | Result<AztecGetPrivateEventsResult> | Result<AztecGetPublicEventsResult> | Result<AztecGetCompleteAddressResult> | Result<AztecGetAddressResult> | Result<AztecGetChainIdResult> | Result<AztecGetVersionResult> | Result<AztecCreateTxExecutionRequestResult> | Result<AztecCreateAuthWitResult>;
 /** A request to get complete address of the specified account */
 export type GetCompleteAddressOperation = {
     /** Operation kind */
@@ -137,3 +137,345 @@ export type SimulateViewsResult = {
     /** List of results, decoded with function return types ABI (AbiDecoded[]) */
     decoded: unknown[];
 };
+/** Aztec.js Wallet request */
+export type AztecSimulateTxOperation = {
+    /** Operation kind */
+    kind: "aztec_simulateTx";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** An authenticated tx request ready for simulation (TxExecutionRequest) */
+    txRequest: unknown;
+    /** Whether to simulate the public part of the transaction */
+    simulatePublic: boolean;
+    /** (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state */
+    skipTxValidation?: boolean;
+    /** (Optional) If false, fees are enforced */
+    skipFeeEnforcement?: boolean;
+    /** (Optional) State overrides for the simulation, such as msgSender, contract instances and artifacts (SimulationOverrides) */
+    overrides?: unknown;
+    /** (Optional) The accounts whose notes we can access in this call. Currently optional and will default to all (AztecAddress[]) */
+    scopes?: 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";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** 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[];
+    /** (Optional) The msg sender to set for the call (AztecAddress) */
+    from?: unknown;
+    /** (Optional) The accounts whose notes we can access in this call. Currently optional and will default to all (AztecAddress[]) */
+    scopes?: 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";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** An authenticated tx request ready for simulation (TxExecutionRequest) */
+    txRequest: unknown;
+    /** Profile mode */
+    profileMode: "gates" | "execution-steps" | "full";
+    /** (Optional) The message sender to use for the simulation */
+    skipProofGeneration?: boolean;
+    /** (Optional) If false, this function throws if the transaction is unable to be included in a block at the current state (AztecAddress) */
+    msgSender?: 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";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** The transaction as created via `proveTx` (Tx) */
+    tx: unknown;
+};
+/** A result of the "aztec_sendTx" operation (TxHash) */
+export type AztecSendTxResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetContractClassMetadataOperation = {
+    /** Operation kind */
+    kind: "aztec_getContractClassMetadata";
+    /** Chain to execute PXE 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 PXE 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 AztecRegisterContractOperation = {
+    /** Operation kind */
+    kind: "aztec_registerContract";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** A contract instance to register, with an optional artifact which can be omitted if the contract class has already been registered */
+    contract: {
+        /** Contract instance (ContractInstanceWithAddress) */
+        instance: unknown;
+        /** Contract artifact (ContractArtifact) */
+        artifact?: unknown;
+    };
+};
+/** A result of the "aztec_registerContract" operation */
+export type AztecRegisterContractResult = void;
+/** Aztec.js Wallet request */
+export type AztecRegisterContractClassOperation = {
+    /** Operation kind */
+    kind: "aztec_registerContractClass";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** The build artifact for the contract class (ContractArtifact) */
+    artifact: unknown;
+};
+/** A result of the "aztec_registerContractClass" operation */
+export type AztecRegisterContractClassResult = void;
+/** Aztec.js Wallet request */
+export type AztecProveTxOperation = {
+    /** Operation kind */
+    kind: "aztec_proveTx";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** An authenticated tx request ready for simulation (TxExecutionRequest) */
+    txRequest: unknown;
+    /** (Optional) The result of the private execution of the transaction. The txRequest will be executed if not provided (PrivateExecutionResult) */
+    privateExecutionResult?: unknown;
+};
+/** A result of the "aztec_proveTx" operation (TxProvingResult) */
+export type AztecProveTxResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetNodeInfoOperation = {
+    /** Operation kind */
+    kind: "aztec_getNodeInfo";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+};
+/** A result of the "aztec_getNodeInfo" operation (NodeInfo) */
+export type AztecGetNodeInfoResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetPXEInfoOperation = {
+    /** Operation kind */
+    kind: "aztec_getPXEInfo";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+};
+/** A result of the "aztec_getPXEInfo" operation (PXEInfo) */
+export type AztecGetPXEInfoResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetCurrentBaseFeesOperation = {
+    /** Operation kind */
+    kind: "aztec_getCurrentBaseFees";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+};
+/** A result of the "aztec_getCurrentBaseFees" operation (GasFees) */
+export type AztecGetCurrentBaseFeesResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecUpdateContractOperation = {
+    /** Operation kind */
+    kind: "aztec_updateContract";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** The address of the contract to update (AztecAddress) */
+    contractAddress: unknown;
+    /** The updated artifact for the contract (ContractArtifact) */
+    artifact: unknown;
+};
+/** A result of the "aztec_updateContract" operation */
+export type AztecUpdateContractResult = void;
+/** Aztec.js Wallet request */
+export type AztecRegisterSenderOperation = {
+    /** Operation kind */
+    kind: "aztec_registerSender";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** Address of the user to add to the address book (AztecAddress) */
+    address: unknown;
+};
+/** A result of the "aztec_registerSender" operation (AztecAddress) */
+export type AztecRegisterSenderResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetSendersOperation = {
+    /** Operation kind */
+    kind: "aztec_getSenders";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+};
+/** A result of the "aztec_getSenders" operation (AztecAddress[]) */
+export type AztecGetSendersResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecRemoveSenderOperation = {
+    /** Operation kind */
+    kind: "aztec_removeSender";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** Address of the user to remove from the address book (AztecAddress) */
+    address: unknown;
+};
+/** A result of the "aztec_removeSender" operation */
+export type AztecRemoveSenderResult = void;
+/** Aztec.js Wallet request */
+export type AztecGetTxReceiptOperation = {
+    /** Operation kind */
+    kind: "aztec_getTxReceipt";
+    /** Chain to execute PXE 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 AztecGetPrivateEventsOperation = {
+    /** Operation kind */
+    kind: "aztec_getPrivateEvents";
+    /** Chain to execute PXE 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 AztecGetPublicEventsOperation = {
+    /** Operation kind */
+    kind: "aztec_getPublicEvents";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+    /** 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 */
+    limit: number;
+};
+/** A result of the "aztec_getPublicEvents" operation (T[]) */
+export type AztecGetPublicEventsResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetCompleteAddressOperation = {
+    /** Operation kind */
+    kind: "aztec_getCompleteAddress";
+    /** Address of the account */
+    account: CaipAccount;
+};
+/** A result of the "aztec_getCompleteAddress" operation (CompleteAddress) */
+export type AztecGetCompleteAddressResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetAddressOperation = {
+    /** Operation kind */
+    kind: "aztec_getAddress";
+    /** Address of the account ¯\_(ツ)_/¯ */
+    account: CaipAccount;
+};
+/** A result of the "aztec_getAddress" operation (AztecAddress) */
+export type AztecGetAddressResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetChainIdOperation = {
+    /** Operation kind */
+    kind: "aztec_getChainId";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+};
+/** A result of the "aztec_getChainId" operation (Fr) */
+export type AztecGetChainIdResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecGetVersionOperation = {
+    /** Operation kind */
+    kind: "aztec_getVersion";
+    /** Chain to execute PXE request for */
+    chain: CaipChain;
+};
+/** A result of the "aztec_getVersion" operation (Fr) */
+export type AztecGetVersionResult = unknown;
+/** Aztec.js Wallet request */
+export type AztecCreateTxExecutionRequestOperation = {
+    /** Operation kind */
+    kind: "aztec_createTxExecutionRequest";
+    /** Address of the account to create tx request for */
+    account: CaipAccount;
+    /** Execution payload (ExecutionPayload) */
+    exec: unknown;
+    /** Fee options */
+    fee: FeeOptionsDto;
+    /** Execution options (TxExecutionOptions) */
+    options: unknown;
+};
+/** Transferrable version of FeeOptions */
+export type FeeOptionsDto = {
+    /** Fee payment method */
+    paymentMethod: FeePaymentMethodDto;
+    /** Gas settings (GasSettings) */
+    gasSettings: unknown;
+};
+/** Transferrable version of FeePaymentMethod */
+export type FeePaymentMethodDto = {
+    /** Address of the assset contract (AztecAddress) */
+    asset?: unknown;
+    /** Execution payload (ExecutionPayload) */
+    executionPayload: unknown;
+    /** Address of the fee payer (AztecAddress) */
+    feePayer: unknown;
+};
+/** A result of the "aztec_createTxExecutionRequest" operation (TxExecutionRequest) */
+export type AztecCreateTxExecutionRequestResult = 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) */
+    messageHashOrIntent: unknown | IntentInnerHashDto | IntentActionDto;
+};
+/** Transferrable version of IntentInnerHash */
+export type IntentInnerHashDto = {
+    /** Address of the authwit consumer (AztecAddress) */
+    consumer: unknown;
+    /** Intent hash (Fr) */
+    innerHash: unknown;
+};
+/** Transferrable version of IntentAction */
+export type IntentActionDto = {
+    /** Address of the caller (AztecAddress) */
+    caller: unknown;
+    /** Function call (FunctionCall) */
+    action: 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.5.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"
     }
-}
+}