@abstract-foundation/agw-client

import { type Address, type Hash, type Hex } from 'viem'; export declare enum LimitType { Unlimited = 0, Lifetime = 1, Allowance = 2 } /** * Limit is the value tracked either for a lifetime or a period on-chain * @member limitType - Used to validate limit & period values (unlimited has no limit, lifetime has no period, allowance has both!) * @member limit - The limit is exceeded if the tracked value is greater than this over the provided period * @member period - The block.timestamp divisor for the limit to be enforced (eg: 60 for a minute, 86400 for a day, 604800 for a week, unset for lifetime) */ export interface Limit { limitType: LimitType; limit: bigint; period: bigint; } export declare const LimitUnlimited: { limitType: LimitType; limit: bigint; period: bigint; }; export declare const LimitZero: { limitType: LimitType; limit: bigint; period: bigint; }; /** * Common logic operators to used combine multiple constraints */ export declare enum ConstraintCondition { Unconstrained = 0, Equal = 1, Greater = 2, Less = 3, GreaterEqual = 4, LessEqual = 5, NotEqual = 6 } /** * Constraint allows performing logic checks on any binary word (bytes32) in the transaction. * This can let you set spend limits against functions on specific contracts * @member index - The location of the start of the data in the transaction. This is not the index of the constraint within the containing array! * @member condition - The kind of check to perform (None, =, >, <, >=, <=, !=) * @member refValue - The value to compare against (as bytes32) * @member limit - The limit to enforce on the parsed value (from index) */ export interface Constraint { index: bigint; condition: ConstraintCondition; refValue: Hash; limit: Limit; } /** * CallPolicy is a policy for a specific contract (address/function) call. * @member target - Only one policy per target per session (unique mapping) * @member selector - Solidity function selector (the selector directly), also unique mapping with target * @member maxValuePerUse - Will reject transaction if value is set above this amount (for transfer or call) * @member valueLimit - If not set, unlimited. If a number or a limit without a period, converts to a lifetime value. Also rejects transactions that have cumulative value greater than what's set here * @member constraints - Array of conditions with specific limits for performing range and logic checks (e.g. 5 > x >= 30) on the transaction data (not value!) */ export interface CallPolicy { target: Address; valueLimit: Limit; maxValuePerUse: bigint; selector: Hash; constraints: Constraint[]; } /** * Simplified CallPolicy for transactions with less than 4 bytes of data * @member target - Only one policy per target per session (unique mapping from CallPolicies) * @member maxValuePerUse - Will reject transaction if value is set above this amount * @member valueLimit - Validated from value */ export interface TransferPolicy { target: Address; maxValuePerUse: bigint; valueLimit: Limit; } /** * SessionConfig is a set of policies and metadata to validate a transaction * @member signer - The address that signs the transaction (session public key) * @member expiresAt - The block.timestamp at which the session is no longer valid * @member feeLimit - The maximum fee that can be paid for the transaction (maxFeePerGas * gasLimit) * @member callPolicies - Used to validate the transaction data, has complex calldata parsing logic * @member transferPolicies - Used to validate the transaction value when there's no additional data */ export interface SessionConfig { signer: Address; expiresAt: bigint; feeLimit: Limit; callPolicies: CallPolicy[]; transferPolicies: TransferPolicy[]; } export declare enum SessionStatus { NotInitialized = 0, Active = 1, Closed = 2, Expired = 3 } export interface SessionState { expiresAt: bigint; status: SessionStatus; feesRemaining: bigint; transferValue: { remaining: bigint; target: Address; selector: Hash; index: bigint; }[]; callValue: { remaining: bigint; target: Address; selector: Hash; index: bigint; }[]; callParams: { remaining: bigint; target: Address; selector: Hash; index: bigint; }[]; } export declare function getSessionSpec(): { readonly components: readonly [{ readonly internalType: "address"; readonly name: "signer"; readonly type: "address"; }, { readonly internalType: "uint256"; readonly name: "expiresAt"; readonly type: "uint256"; }, { readonly components: readonly [{ readonly internalType: "enum SessionLib.LimitType"; readonly name: "limitType"; readonly type: "uint8"; }, { readonly internalType: "uint256"; readonly name: "limit"; readonly type: "uint256"; }, { readonly internalType: "uint256"; readonly name: "period"; readonly type: "uint256"; }]; readonly internalType: "struct SessionLib.UsageLimit"; readonly name: "feeLimit"; readonly type: "tuple"; }, { readonly components: readonly [{ readonly internalType: "address"; readonly name: "target"; readonly type: "address"; }, { readonly internalType: "bytes4"; readonly name: "selector"; readonly type: "bytes4"; }, { readonly internalType: "uint256"; readonly name: "maxValuePerUse"; readonly type: "uint256"; }, { readonly components: readonly [{ readonly internalType: "enum SessionLib.LimitType"; readonly name: "limitType"; readonly type: "uint8"; }, { readonly internalType: "uint256"; readonly name: "limit"; readonly type: "uint256"; }, { readonly internalType: "uint256"; readonly name: "period"; readonly type: "uint256"; }]; readonly internalType: "struct SessionLib.UsageLimit"; readonly name: "valueLimit"; readonly type: "tuple"; }, { readonly components: readonly [{ readonly internalType: "enum SessionLib.Condition"; readonly name: "condition"; readonly type: "uint8"; }, { readonly internalType: "uint64"; readonly name: "index"; readonly type: "uint64"; }, { readonly internalType: "bytes32"; readonly name: "refValue"; readonly type: "bytes32"; }, { readonly components: readonly [{ readonly internalType: "enum SessionLib.LimitType"; readonly name: "limitType"; readonly type: "uint8"; }, { readonly internalType: "uint256"; readonly name: "limit"; readonly type: "uint256"; }, { readonly internalType: "uint256"; readonly name: "period"; readonly type: "uint256"; }]; readonly internalType: "struct SessionLib.UsageLimit"; readonly name: "limit"; readonly type: "tuple"; }]; readonly internalType: "struct SessionLib.Constraint[]"; readonly name: "constraints"; readonly type: "tuple[]"; }]; readonly internalType: "struct SessionLib.CallSpec[]"; readonly name: "callPolicies"; readonly type: "tuple[]"; }, { readonly components: readonly [{ readonly internalType: "address"; readonly name: "target"; readonly type: "address"; }, { readonly internalType: "uint256"; readonly name: "maxValuePerUse"; readonly type: "uint256"; }, { readonly components: readonly [{ readonly internalType: "enum SessionLib.LimitType"; readonly name: "limitType"; readonly type: "uint8"; }, { readonly internalType: "uint256"; readonly name: "limit"; readonly type: "uint256"; }, { readonly internalType: "uint256"; readonly name: "period"; readonly type: "uint256"; }]; readonly internalType: "struct SessionLib.UsageLimit"; readonly name: "valueLimit"; readonly type: "tuple"; }]; readonly internalType: "struct SessionLib.TransferSpec[]"; readonly name: "transferPolicies"; readonly type: "tuple[]"; }]; readonly internalType: "struct SessionLib.SessionSpec"; readonly name: "sessionSpec"; readonly type: "tuple"; }; export declare function encodeSession(sessionConfig: SessionConfig): Hex; export declare function encodeSessionWithPeriodIds(sessionConfig: SessionConfig, periods: bigint[]): Hex; export declare const getPeriodIdsForTransaction: (args: { sessionConfig: SessionConfig; target: Address; selector?: Hex; timestamp?: bigint; }) => bigint[]; export declare function getSessionHash(sessionConfig: SessionConfig): Hash; //# sourceMappingURL=sessions.d.ts.map