viem 2.57.5 → 2.57.7

package/_types/tempo/actions/token.d.ts

@@ -19,6 +19,9 @@ import type { ExtractAbiItem, GetEventArgs } from '../../types/contract.js';
 import type { Log, Log as viem_Log } from '../../types/log.js';
 import type { Compute, OneOf, UnionOmit } from '../../types/utils.js';
 import * as Abis from '../Abis.js';
+import type * as Errors from '../errors.js';
+import { TempoExecutionError } from '../errors.js';
+import { type Resolvers } from '../internal/errors.js';
 import type { GetAccountParameter, ReadParameters, TokenParameter, TokenParameters, WriteParameters } from '../internal/types.js';
 import { type CallParameters } from '../internal/utils.js';
 import type { TransactionReceipt } from '../Transaction.js';
@@ -58,7 +61,7 @@ export declare namespace approve {
     } & TokenParameter;
     type Parameters<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = WriteParameters<chain, account> & Args;
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: approve.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -1037,7 +1040,7 @@ export declare namespace approveSync {
         /** Transaction receipt. */
         receipt: TransactionReceipt;
     }>;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Burns TIP20 tokens from a blocked address.
@@ -1076,7 +1079,7 @@ export declare namespace burnBlocked {
     } & TokenParameter;
     type Parameters<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = WriteParameters<chain, account> & Args;
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: burnBlocked.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -2055,7 +2058,7 @@ export declare namespace burnBlockedSync {
         /** Transaction receipt. */
         receipt: TransactionReceipt;
     }>;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Burns TIP20 tokens from the caller's balance.
@@ -2100,7 +2103,7 @@ export declare namespace burn {
     }>;
     type Parameters<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = WriteParameters<chain, account> & Args;
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: burn.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -3109,7 +3112,7 @@ export declare namespace burnSync {
         burner?: Address | undefined;
         receipt: TransactionReceipt;
     }>;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Changes the transfer policy ID for a TIP20 token.
@@ -3147,7 +3150,7 @@ export declare namespace changeTransferPolicy {
         token: TokenId.TokenIdOrAddress;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: changeTransferPolicy.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -4118,7 +4121,7 @@ export declare namespace changeTransferPolicySync {
     }> & {
         receipt: TransactionReceipt;
     }>;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Creates a new TIP20 token.
@@ -4172,7 +4175,7 @@ export declare namespace create {
         symbol: string;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: any): Promise<ReturnType<action>>;
     /**
@@ -4450,7 +4453,7 @@ export declare namespace createSync {
         /** Transaction receipt. */
         receipt: TransactionReceipt;
     }>;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Gets TIP20 token allowance.
@@ -4524,6 +4527,7 @@ export declare namespace getAllowance {
         data: import("../../index.js").Hex;
         to: Address;
     };
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Gets TIP20 token balance for an address.
@@ -4588,6 +4592,7 @@ export declare namespace getBalance {
         data: import("../../index.js").Hex;
         to: Address;
     };
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Gets TIP20 token metadata including name, symbol, logo URI, currency, decimals, and total supply.
@@ -4669,6 +4674,7 @@ export declare namespace getMetadata {
          */
         transferPolicyId?: bigint | undefined;
     }>;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Gets the total supply of a TIP20 token.
@@ -4727,6 +4733,7 @@ export declare namespace getTotalSupply {
         data: import("../../index.js").Hex;
         to: Address;
     };
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Gets the admin role for a specific role in a TIP20 token.
@@ -4790,6 +4797,7 @@ export declare namespace getRoleAdmin {
         data: import("../../index.js").Hex;
         to: Address;
     };
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Checks if an account has a specific role for a TIP20 token.
@@ -4859,6 +4867,7 @@ export declare namespace hasRole {
         data: import("../../index.js").Hex;
         to: Address;
     };
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Grants a role for a TIP20 token.
@@ -4902,7 +4911,7 @@ export declare namespace grantRoles {
         to: Address;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof sendTransaction | typeof sendTransactionSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: grantRoles.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -5879,7 +5888,7 @@ export declare namespace grantRolesSync {
             Required: true;
         }>[];
     };
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Mints TIP20 tokens to an address.
@@ -5920,7 +5929,7 @@ export declare namespace mint {
     } & TokenParameter;
     type Parameters<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = WriteParameters<chain, account> & Args;
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: mint.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -6913,7 +6922,7 @@ export declare namespace mintSync {
     }> & {
         receipt: TransactionReceipt;
     }>;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Pauses a TIP20 token.
@@ -6948,7 +6957,7 @@ export declare namespace pause {
         token: TokenId.TokenIdOrAddress;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: pause.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -7914,7 +7923,7 @@ export declare namespace pauseSync {
     }> & {
         receipt: TransactionReceipt;
     };
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Renounces a role for a TIP20 token.
@@ -7955,7 +7964,7 @@ export declare namespace renounceRoles {
         token: TokenId.TokenIdOrAddress;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof sendTransaction | typeof sendTransactionSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: renounceRoles.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -8927,7 +8936,7 @@ export declare namespace renounceRolesSync {
             Required: true;
         }>[];
     };
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Revokes a role for a TIP20 token.
@@ -8971,7 +8980,7 @@ export declare namespace revokeRoles {
         token: TokenId.TokenIdOrAddress;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof sendTransaction | typeof sendTransactionSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: revokeRoles.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -9948,7 +9957,7 @@ export declare namespace revokeRolesSync {
             Required: true;
         }>[];
     };
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Sets the supply cap for a TIP20 token.
@@ -9986,7 +9995,7 @@ export declare namespace setSupplyCap {
         token: TokenId.TokenIdOrAddress;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: setSupplyCap.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -10957,7 +10966,7 @@ export declare namespace setSupplyCapSync {
     }> & {
         receipt: TransactionReceipt;
     };
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Sets the admin role for a specific role in a TIP20 token.
@@ -10998,7 +11007,7 @@ export declare namespace setRoleAdmin {
         token: TokenId.TokenIdOrAddress;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: setRoleAdmin.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -11974,7 +11983,7 @@ export declare namespace setRoleAdminSync {
     }> & {
         receipt: TransactionReceipt;
     };
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Transfers TIP20 tokens to another address.
@@ -12016,7 +12025,7 @@ export declare namespace transfer {
     } & TokenParameter;
     type Parameters<chain extends Chain | undefined = Chain | undefined, account extends Account | undefined = Account | undefined> = WriteParameters<chain, account> & Args;
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: transfer.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -13048,7 +13057,7 @@ export declare namespace transferSync {
         /** Transaction receipt. */
         receipt: TransactionReceipt;
     }>;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Unpauses a TIP20 token.
@@ -13083,7 +13092,7 @@ export declare namespace unpause {
         token: TokenId.TokenIdOrAddress;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: unpause.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -14049,7 +14058,7 @@ export declare namespace unpauseSync {
     }> & {
         receipt: TransactionReceipt;
     };
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Updates the quote token for a TIP20 token.
@@ -14087,7 +14096,7 @@ export declare namespace prepareUpdateQuoteToken {
         token: TokenId.TokenIdOrAddress;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: prepareUpdateQuoteToken.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -15058,7 +15067,7 @@ export declare namespace prepareUpdateQuoteTokenSync {
     }> & {
         receipt: TransactionReceipt;
     }>;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Updates the quote token for a TIP20 token.
@@ -15093,7 +15102,7 @@ export declare namespace updateQuoteToken {
         token: TokenId.TokenIdOrAddress;
     };
     type ReturnValue = WriteContractReturnType;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
     /** @internal */
     function inner<action extends typeof writeContract | typeof writeContractSync, chain extends Chain | undefined, account extends Account | undefined>(action: action, client: Client<Transport, chain, account>, parameters: updateQuoteToken.Parameters<chain, account>): Promise<ReturnType<action>>;
     /**
@@ -16059,7 +16068,7 @@ export declare namespace updateQuoteTokenSync {
     }> & {
         receipt: TransactionReceipt;
     }>;
-    type ErrorType = BaseErrorType;
+    type ErrorType = Errors.ExecutionErrorType | BaseErrorType;
 }
 /**
  * Watches for TIP20 token approval events.
@@ -16385,4 +16394,163 @@ export declare namespace watchUpdateQuoteToken {
         token: TokenId.TokenIdOrAddress;
     };
 }
+/** Errors this module throws for decoded Tempo errors. Narrow with `error.name`. */
+export type ExecutionErrorType = TokenInsufficientAllowanceErrorType | TokenInsufficientBalanceErrorType | TokenPausedErrorType | TokenPolicyForbidsErrorType | TokenSupplyCapExceededErrorType | TokenUnauthorizedErrorType;
+/** `TokenInsufficientBalanceError` with a literal `name`, for narrowing. */
+export type TokenInsufficientBalanceErrorType = TokenInsufficientBalanceError & {
+    name: 'TokenInsufficientBalanceError';
+};
+/** Thrown when an account's TIP-20 balance is lower than the amount a call needs. */
+export declare class TokenInsufficientBalanceError extends TempoExecutionError<Errors.TempoExecutionError.Decoded<'InsufficientBalance'>> {
+    /** Balance available. */
+    available: bigint;
+    /** Token decimals, when known. */
+    decimals: number | undefined;
+    /** Amount required. */
+    required: bigint;
+    /** Token address. */
+    token: Address;
+    constructor(parameters: Errors.TempoExecutionError.Parameters & {
+        decimals?: number | undefined;
+    });
+}
+/** `TokenInsufficientAllowanceError` with a literal `name`, for narrowing. */
+export type TokenInsufficientAllowanceErrorType = TokenInsufficientAllowanceError & {
+    name: 'TokenInsufficientAllowanceError';
+};
+/** Thrown when a spender's TIP-20 allowance is lower than the amount it tries to transfer. */
+export declare class TokenInsufficientAllowanceError extends TempoExecutionError<Errors.TempoExecutionError.Decoded<'InsufficientAllowance'>> {
+    /** Current allowance, when known. */
+    allowance: bigint | undefined;
+    /** Amount the spender tried to transfer. */
+    amount: bigint | undefined;
+    /** Token decimals, when known. */
+    decimals: number | undefined;
+    /** Token owner. */
+    owner: Address;
+    /** Spender. */
+    spender: Address;
+    /** Token address. */
+    token: Address;
+    constructor(parameters: TokenInsufficientAllowanceError.Parameters);
+}
+export declare namespace TokenInsufficientAllowanceError {
+    /** Constructor parameters. */
+    type Parameters = Errors.TempoExecutionError.Parameters & {
+        /** Current allowance, when known. */
+        allowance?: bigint | undefined;
+        /** Amount the spender tried to transfer. */
+        amount?: bigint | undefined;
+        /** Token decimals, when known. */
+        decimals?: number | undefined;
+        /** Token owner. */
+        owner: Address;
+        /** Spender. */
+        spender: Address;
+        /** Token address. */
+        token: Address;
+    };
+}
+/** `TokenSupplyCapExceededError` with a literal `name`, for narrowing. */
+export type TokenSupplyCapExceededErrorType = TokenSupplyCapExceededError & {
+    name: 'TokenSupplyCapExceededError';
+};
+/** Thrown when minting would exceed a TIP-20 token's supply cap. */
+export declare class TokenSupplyCapExceededError extends TempoExecutionError<Errors.TempoExecutionError.Decoded<'SupplyCapExceeded'>> {
+    /** Amount to mint. */
+    amount: bigint | undefined;
+    /** Token decimals, when known. */
+    decimals: number | undefined;
+    /** Supply cap, when known. */
+    supplyCap: bigint | undefined;
+    /** Token address. */
+    token: Address;
+    /** Current total supply, when known. */
+    totalSupply: bigint | undefined;
+    constructor(parameters: TokenSupplyCapExceededError.Parameters);
+}
+export declare namespace TokenSupplyCapExceededError {
+    /** Constructor parameters. */
+    type Parameters = Errors.TempoExecutionError.Parameters & {
+        /** Amount to mint. */
+        amount?: bigint | undefined;
+        /** Token decimals, when known. */
+        decimals?: number | undefined;
+        /** Supply cap, when known. */
+        supplyCap?: bigint | undefined;
+        /** Token address. */
+        token: Address;
+        /** Current total supply, when known. */
+        totalSupply?: bigint | undefined;
+    };
+}
+/** `TokenPolicyForbidsError` with a literal `name`, for narrowing. */
+export type TokenPolicyForbidsErrorType = TokenPolicyForbidsError & {
+    name: 'TokenPolicyForbidsError';
+};
+/** Thrown when a TIP-20 token's transfer policy forbids the sender or recipient. */
+export declare class TokenPolicyForbidsError extends TempoExecutionError<Errors.TempoExecutionError.Decoded<'PolicyForbids'>> {
+    /** Sender, when known. */
+    from: Address | undefined;
+    /** Transfer policy ID, when known. */
+    policyId: bigint | undefined;
+    /** Whether the policy authorizes the recipient, when known. */
+    recipientAuthorized: boolean | undefined;
+    /** Whether the policy authorizes the sender, when known. */
+    senderAuthorized: boolean | undefined;
+    /** Recipient, when known. */
+    to: Address | undefined;
+    /** Token address. */
+    token: Address;
+    constructor(parameters: TokenPolicyForbidsError.Parameters);
+}
+export declare namespace TokenPolicyForbidsError {
+    /** Constructor parameters. */
+    type Parameters = Errors.TempoExecutionError.Parameters & {
+        /** Sender, when known. */
+        from?: Address | undefined;
+        /** Transfer policy ID, when known. */
+        policyId?: bigint | undefined;
+        /** Whether the policy authorizes the recipient, when known. */
+        recipientAuthorized?: boolean | undefined;
+        /** Whether the policy authorizes the sender, when known. */
+        senderAuthorized?: boolean | undefined;
+        /** Recipient, when known. */
+        to?: Address | undefined;
+        /** Token address. */
+        token: Address;
+    };
+}
+/** `TokenPausedError` with a literal `name`, for narrowing. */
+export type TokenPausedErrorType = TokenPausedError & {
+    name: 'TokenPausedError';
+};
+/** Thrown when calling a paused TIP-20 token. */
+export declare class TokenPausedError extends TempoExecutionError<Errors.TempoExecutionError.Decoded<'ContractPaused'>> {
+    /** Token address. */
+    token: Address;
+    constructor(parameters: Errors.TempoExecutionError.Parameters & {
+        token: Address;
+    });
+}
+/** `TokenUnauthorizedError` with a literal `name`, for narrowing. */
+export type TokenUnauthorizedErrorType = TokenUnauthorizedError & {
+    name: 'TokenUnauthorizedError';
+};
+/** Thrown when an account lacks the TIP-20 role a call requires. */
+export declare class TokenUnauthorizedError extends TempoExecutionError<Errors.TempoExecutionError.Decoded<'Unauthorized'>> {
+    /** Account that made the call. */
+    account: Address;
+    /** Role the call requires. */
+    role: TokenRole.TokenRole;
+    /** Token address. */
+    token: Address;
+    constructor(parameters: Errors.TempoExecutionError.Parameters & {
+        account: Address;
+        role: TokenRole.TokenRole;
+        token: Address;
+    });
+}
+/** @internal */
+export declare const errorResolvers: Resolvers;
 //# sourceMappingURL=token.d.ts.map