> For the complete documentation index, see [llms.txt](/llms.txt). # Types This page documents the TypeScript [enums](#enums) and [types](#types-1) used in Smart Accounts Kit APIs. ## Enums[​](#enums "Direct link to Enums") ### `CaveatType`[​](#caveattype "Direct link to caveattype") Enum representing the [caveat](/smart-accounts-kit/reference/delegation/caveats/) type. | Value | String | | ------------------------------------------- | ---------------------------------- | | CaveatType.AllowedCalldata | "allowedCalldata" | | CaveatType.AllowedMethods | "allowedMethods" | | CaveatType.AllowedTargets | "allowedTargets" | | CaveatType.ArgsEqualityCheck | "argsEqualityCheck" | | CaveatType.BlockNumber | "blockNumber" | | CaveatType.Deployed | "deployed" | | CaveatType.Erc1155BalanceChange | "erc1155BalanceChange" | | CaveatType.Erc20BalanceChange | "erc20BalanceChange" | | CaveatType.Erc20PeriodTransfer | "erc20PeriodTransfer" | | CaveatType.Erc20Streaming | "erc20Streaming" | | CaveatType.Erc20TransferAmount | "erc20TransferAmount" | | CaveatType.Erc721BalanceChange | "erc721BalanceChange" | | CaveatType.Erc721Transfer | "erc721Transfer" | | CaveatType.ExactCalldata | "exactCalldata" | | CaveatType.ExactCalldataBatch | "exactCalldataBatch" | | CaveatType.ExactExecution | "exactExecution" | | CaveatType.ExactExecutionBatch | "exactExecutionBatch" | | CaveatType.Id | "id" | | CaveatType.LimitedCalls | "limitedCalls" | | CaveatType.MultiTokenPeriod | "multiTokenPeriod" | | CaveatType.NativeBalanceChange | "nativeBalanceChange" | | CaveatType.NativeTokenPayment | "nativeTokenPayment" | | CaveatType.NativeTokenPeriodTransfer | "nativeTokenPeriodTransfer" | | CaveatType.NativeTokenStreaming | "nativeTokenStreaming" | | CaveatType.NativeTokenTransferAmount | "nativeTokenTransferAmount" | | CaveatType.Nonce | "nonce" | | CaveatType.OwnershipTransfer | "ownershipTransfer" | | CaveatType.Redeemer | "redeemer" | | CaveatType.SpecificActionERC20TransferBatch | "specificActionERC20TransferBatch" | | CaveatType.Timestamp | "timestamp" | | CaveatType.ValueLte | "valueLte" | ### `ExecutionMode`[​](#executionmode "Direct link to executionmode") Enum specifying how delegated executions are processed when [redeeming delegations](/smart-accounts-kit/reference/delegation/#redeemdelegations). | Value | Description | | --------------------------- | --------------------------------------------------------------- | | ExecutionMode.SingleDefault | Executes a single call and reverts on failure. | | ExecutionMode.SingleTry | Executes a single call and silently continues on failure. | | ExecutionMode.BatchDefault | Executes a batch of calls and reverts if any call fails. | | ExecutionMode.BatchTry | Executes a batch of calls and silently continues past failures. | ### `Implementation`[​](#implementation "Direct link to implementation") Enum representing the [MetaMask smart account](/smart-accounts-kit/concepts/smart-accounts/) implementation type. | Value | Description | | ---------------------------- | ----------------------------------------------------------------------------------------------------------------- | | Implementation.Hybrid | Supports both ECDSA and WebAuthn (passkey) signers. | | Implementation.MultiSig | Supports multiple ECDSA signers with threshold-based signing. | | Implementation.Stateless7702 | Uses [EIP-7702](https://eips.ethereum.org/EIPS/eip-7702) to upgrade an EOA to a smart account without deployment. | ### `ScopeType`[​](#scopetype "Direct link to scopetype") Enum representing [delegation scope types](/smart-accounts-kit/reference/delegation/delegation-scopes/). | Value | String | | ----------------------------------- | --------------------------- | | ScopeType.Erc20TransferAmount | "erc20TransferAmount" | | ScopeType.Erc20Streaming | "erc20Streaming" | | ScopeType.Erc20PeriodTransfer | "erc20PeriodTransfer" | | ScopeType.NativeTokenTransferAmount | "nativeTokenTransferAmount" | | ScopeType.NativeTokenStreaming | "nativeTokenStreaming" | | ScopeType.NativeTokenPeriodTransfer | "nativeTokenPeriodTransfer" | | ScopeType.Erc721Transfer | "erc721Transfer" | | ScopeType.OwnershipTransfer | "ownershipTransfer" | | ScopeType.FunctionCall | "functionCall" | ### `TransferWindow`[​](#transferwindow "Direct link to transferwindow") Enum representing predefined time intervals in seconds for transfer period durations. | Value | Seconds | | ------------------------ | -------- | | TransferWindow.Hourly | 3600 | | TransferWindow.Daily | 86400 | | TransferWindow.Weekly | 604800 | | TransferWindow.BiWeekly | 1209600 | | TransferWindow.Monthly | 2592000 | | TransferWindow.Quarterly | 7776000 | | TransferWindow.Yearly | 31536000 | ## Types[​](#types-1 "Direct link to Types") ### `AllowedCalldataBuilderConfig`[​](#allowedcalldatabuilderconfig "Direct link to allowedcalldatabuilderconfig") Defines an expected calldata segment for a single function signature. | Name | Type | Required | Description | | ---------- | ------ | -------- | ------------------------------------------------------------------------------------------------ | | startIndex | number | Yes | The byte offset in the calldata (including the 4-byte selector) where the expected value starts. | | value | Hex | Yes | The expected hex-encoded calldata at that offset. | ### `Caveat`[​](#caveat "Direct link to caveat") Represents a restriction or condition applied to a delegation. | Name | Type | Required | Description | | -------- | ---- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | enforcer | Hex | Yes | The contract address of the [caveat enforcer](/smart-accounts-kit/development/reference/glossary#caveat-enforcer)**Caveat enforcer** A smart contract that enforces delegation rules by validating caveat conditions during redemption hooks.. | | terms | Hex | Yes | The terms of the [caveat](/smart-accounts-kit/development/reference/glossary#caveat)**Caveat** A restriction attached to a delegation that limits how delegated authority can be used. encoded as hex data. | | args | Hex | Yes | Additional arguments required by the caveat enforcer, encoded as hex data. | ### `CaveatBuilderConfig`[​](#caveatbuilderconfig "Direct link to caveatbuilderconfig") Optional configuration for [createCaveatBuilder](/smart-accounts-kit/reference/delegation/#createcaveatbuilder). | Name | Type | Required | Description | | ----------------------------------- | ------- | -------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | allowInsecureUnrestrictedDelegation | boolean | No | Whether to allow unrestricted delegations with no [caveats](/smart-accounts-kit/development/reference/glossary#caveat)**Caveat** A restriction attached to a delegation that limits how delegated authority can be used.. The default is false. | ### `Delegation`[​](#delegation "Direct link to delegation") Represents a delegation that grants permissions from a [delegator](/smart-accounts-kit/development/reference/glossary#delegator-account)**Delegator account** The account that creates and signs a delegation to grant limited authority to another account. to a [delegate](/smart-accounts-kit/development/reference/glossary#delegate-account)**Delegate account** The account that receives delegated authority and can redeem a delegation under its constraints.. | Name | Type | Required | Description | | --------- | ------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | delegate | Hex | Yes | The address to which the delegation is being granted. | | delegator | Hex | Yes | The address that is granting the delegation. | | authority | Hex | Yes | The parent delegation hash, or ROOT_AUTHORITY for creating [root delegations](/smart-accounts-kit/development/reference/glossary#root-delegation)**Root delegation** The first delegation in a chain, where an account delegates its own authority directly.. | | caveats | [Caveat](#caveat)[] | Yes | An array of [caveats](/smart-accounts-kit/reference/delegation/caveats/) that constrain the delegation. | | salt | Hex | Yes | The salt for generating the delegation hash. This helps prevent hash collisions when creating identical delegations. | | signature | Hex | Yes | The signature to validate the delegation. | ### `ExactCalldataBuilderConfig`[​](#exactcalldatabuilderconfig "Direct link to exactcalldatabuilderconfig") Defines the exact calldata the [delegate](/smart-accounts-kit/development/reference/glossary#delegate-account)**Delegate account** The account that receives delegated authority and can redeem a delegation under its constraints. is allowed to call. | Name | Type | Required | Description | | -------- | ---- | -------- | --------------------------------------------------- | | calldata | Hex | Yes | The exact calldata the delegate is allowed to call. | ### `ExecutionStruct`[​](#executionstruct "Direct link to executionstruct") Represents a single execution to perform on behalf of a [delegator](/smart-accounts-kit/development/reference/glossary#delegator-account)**Delegator account** The account that creates and signs a delegation to grant limited authority to another account.. | Name | Type | Required | Description | | -------- | ------- | -------- | ------------------------------------------------------------------ | | target | Address | Yes | Address of the contract or recipient that the call is directed to. | | value | bigint | Yes | Value of native tokens to send along with the call in wei format. | | callData | Hex | Yes | Encoded function data to be executed on the target address. | ### `GetGrantedExecutionPermissionsResult`[​](#getgrantedexecutionpermissionsresult "Direct link to getgrantedexecutionpermissionsresult") The return type of [getGrantedExecutionPermissions](/smart-accounts-kit/reference/advanced-permissions/wallet-client/#getgrantedexecutionpermissions). An array of [PermissionResponse](#permissionresponse) objects. ### `GetSupportedExecutionPermissionsResult`[​](#getsupportedexecutionpermissionsresult "Direct link to getsupportedexecutionpermissionsresult") The return type of [getSupportedExecutionPermissions](/smart-accounts-kit/reference/advanced-permissions/wallet-client/#getsupportedexecutionpermissions). A `Record` keyed by permission type. ### `PartialSignature`[​](#partialsignature "Direct link to partialsignature") Represents a single [signer](/smart-accounts-kit/development/reference/glossary#signer)**Signer** An account that can sign transactions for a smart account.'s contribution to a multisig aggregated signature. | Name | Type | Required | Description | | --------- | ------------- | -------- | ----------------------------------------------------------------------------------- | | signer | Address | Yes | The address of the signer. | | signature | Hex | Yes | The signer's signature over the user operation. | | type | SignatureType | Yes | The signature type to represent signature algorithm. Only supported value is ECDSA. | ### `RedelegatePermissionContextReturnType`[​](#redelegatepermissioncontextreturntype "Direct link to redelegatepermissioncontextreturntype") Return type of [redelegatePermissionContext](/smart-accounts-kit/reference/erc7710/wallet-client/#redelegatepermissioncontext) and [redelegatePermissionContextOpen](/smart-accounts-kit/reference/erc7710/wallet-client/#redelegatepermissioncontextopen). | Name | Type | Description | | ----------------- | ------------------------- | --------------------------------------------------------------- | | delegation | [Delegation](#delegation) | The signed redelegation object. | | permissionContext | Hex | ABI-encoded delegation chain with the new delegation prepended. | ### `PermissionResponse`[​](#permissionresponse "Direct link to permissionresponse") Represents a granted [Advanced Permission](/smart-accounts-kit/development/reference/glossary#advanced-permissions)**Advanced Permissions** Fine-grained, wallet execution permissions that dapps can request from MetaMask extension users. Based on ERC-7715.. | Name | Type | Required | Description | | ----------------- | ---------------------------------------- | -------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | chainId | number | Yes | The chain ID for which the permission was granted. | | from | Address | Yes | The account address that granted the permission. | | to | Hex | Yes | The account address that received the permission. | | permission | PermissionTypes | Yes | The granted [permission](/smart-accounts-kit/reference/advanced-permissions/permissions/) details. | | rules | Record[] | No | The rules applied to the permission. For example, permission expiry. | | context | Hex | Yes | The permission context (encoded delegation list) used when redeeming the permission. | | dependencies | { factory: Address, factoryData: Hex }[] | Yes | Factory dependencies for account deployment. | | delegationManager | Address | Yes | The address of the [Delegation Manager](/smart-accounts-kit/development/reference/glossary#delegation-manager)**Delegation Manager** The ERC-7710 component that validates and redeems delegations, including signature checks and caveat enforcer hooks. contract for the permission. | ### `RequestExecutionPermissionsReturnType`[​](#requestexecutionpermissionsreturntype "Direct link to requestexecutionpermissionsreturntype") The return type of [requestExecutionPermissions](/smart-accounts-kit/reference/advanced-permissions/wallet-client/#requestexecutionpermissions). An array of [PermissionResponse](#permissionresponse) objects. ### `SmartAccountsEnvironment`[​](#smartaccountsenvironment "Direct link to smartaccountsenvironment") An object containing the contract addresses required to interact with the [Delegation Framework](/smart-accounts-kit/development/reference/glossary#delegation-framework)**Delegation Framework** A set of audited smart contracts that handle smart account creation, the delegation lifecycle, and caveat enforcement. on a specific chain. | Name | Type | Required | Description | | ----------------- | ------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | DelegationManager | Hex | Yes | The address of the [Delegation Manager](/smart-accounts-kit/development/reference/glossary#delegation-manager)**Delegation Manager** The ERC-7710 component that validates and redeems delegations, including signature checks and caveat enforcer hooks. contract. | | EntryPoint | Hex | Yes | The address of the ERC-4337 EntryPoint contract. | | SimpleFactory | Hex | Yes | The address of the factory contract for deploying [MetaMask Smart Accounts](/smart-accounts-kit/development/reference/glossary#metamask-smart-account)**MetaMask smart account** A smart contract account created using the Smart Accounts Kit that supports programmable behavior, flexible signing options, and ERC-7710 delegations.. | | implementations | Record | Yes | A map of MetaMask smart account implementation types to their deployed addresses. | | caveatEnforcers | Record | Yes | A map of caveat enforcer types to their deployed addresses. | ### `SupportedPermissionInfo`[​](#supportedpermissioninfo "Direct link to supportedpermissioninfo") Describes a supported [Advanced Permission](/smart-accounts-kit/development/reference/glossary#advanced-permissions)**Advanced Permissions** Fine-grained, wallet execution permissions that dapps can request from MetaMask extension users. Based on ERC-7715. type. Used in [GetSupportedExecutionPermissionsResult](#getsupportedexecutionpermissionsresult). | Name | Type | Required | Description | | --------- | -------- | -------- | ------------------------------------------------------------------------- | | chainIds | number[] | Yes | The chain IDs on which the permission type is supported. | | ruleTypes | string[] | Yes | The rule types supported for the permission type (for example, "expiry"). | ### `ValueLteBuilderConfig`[​](#valueltebuilderconfig "Direct link to valueltebuilderconfig") | Name | Type | Required | Description | | -------- | ------ | -------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | maxValue | bigint | Yes | The maximum native token amount the [delegate](/smart-accounts-kit/development/reference/glossary#delegate-account)**Delegate account** The account that receives delegated authority and can redeem a delegation under its constraints. can transfer per call. |