@account-kit/smart-contracts 4.0.0-alpha.0 → 4.0.0-alpha.10

package/dist/types/src/msca/plugins/multisig/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/multisig/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,YAAY,EAAE,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,oBAAoB,EAAE,MAAM,mCAAmC,CAAC;AACzE,OAAO,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AACrD,OAAO,EAAE,yBAAyB,EAAE,MAAM,wCAAwC,CAAC;AACnF,mBAAmB,gBAAgB,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,kCAAkC,GACnC,MAAM,aAAa,CAAC;AACrB,mBAAmB,YAAY,CAAC;AAChC,OAAO,EAAE,KAAK,UAAU,EAAE,MAAM,YAAY,CAAC;AAC7C,OAAO,EACL,iBAAiB,EACjB,gBAAgB,EAChB,aAAa,EACb,wBAAwB,GACzB,MAAM,kBAAkB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/multisig/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,gBAAgB,CAAC;AACpC,OAAO,EAAE,qBAAqB,EAAE,MAAM,gBAAgB,CAAC;AACvD,OAAO,EAAE,2BAA2B,EAAE,MAAM,iBAAiB,CAAC;AAC9D,OAAO,EACL,cAAc,EACd,iBAAiB,EACjB,kCAAkC,EAClC,KAAK,2BAA2B,GACjC,MAAM,aAAa,CAAC;AACrB,mBAAmB,YAAY,CAAC"}

package/dist/types/src/msca/plugins/multisig/middleware.d.ts

@@ -1,16 +1,16 @@
 import { type ClientMiddlewareFn } from "@aa-sdk/core";
-import { type MultisigUserOperationContext } from "./index.js";
+import { type MultisigUserOperationContext } from "./types.js";
 /**
  * A signer middleware to be used with Multisig Account Clients.
  * This middleware handles correctly aggregating signatures passed through
  * as context when sending UserOperations, proposing UserOperations, or adding signatures to a UserOperation.
  *
- * @param struct the user operation struct to be signed
- * @param param the parameters to be passed to the middleware
- * @param param.account the account to be used for signing
- * @param param.client the smart account client that will be used for RPC requests
- * @param param.context the context object containing the signatures to be aggregated {@link MultisigUserOperationContext}
- * @returns a Promise containing a UserOperation with an aggregated signature in the `signature` field
+ * @param {Deferrable<UserOperationStruct<TEntryPointVersion>>} struct the user operation struct to be signed
+ * @param {ClientMiddlewareArgs<TAccount, C, TContext, TEntryPointVersion>} args the parameters to be passed to the middleware
+ * @param {UserOperationOverrides<TEntryPointVersion>} args.account the account to be used for signing
+ * @param {MiddlewareClient} args.client the smart account client that will be used for RPC requests
+ * @param {MultisigUserOperationContext} args.context the context object containing the signatures to be aggregated MultisigUserOperationContext
+ * @returns {Promise<Deferrable<UserOperationStruct<TEntryPointVersion>>>} a Promise containing a UserOperation with an aggregated signature in the `signature` field
  */
 export declare const multisigSignatureMiddleware: ClientMiddlewareFn<MultisigUserOperationContext>;
 //# sourceMappingURL=middleware.d.ts.map

package/dist/types/src/msca/plugins/multisig/middleware.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/multisig/middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,kBAAkB,EAGxB,MAAM,cAAc,CAAC;AAOtB,OAAO,EAIL,KAAK,4BAA4B,EAClC,MAAM,YAAY,CAAC;AAEpB;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,2BAA2B,EAAE,kBAAkB,CAC1D,4BAA4B,CAmG7B,CAAC"}
+{"version":3,"file":"middleware.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/multisig/middleware.ts"],"names":[],"mappings":"AAAA,OAAO,EAOL,KAAK,kBAAkB,EAGxB,MAAM,cAAc,CAAC;AAOtB,OAAO,EAAE,KAAK,4BAA4B,EAAE,MAAM,YAAY,CAAC;AAO/D;;;;;;;;;;;GAWG;AACH,eAAO,MAAM,2BAA2B,EAAE,kBAAkB,CAC1D,4BAA4B,CAmG7B,CAAC"}

package/dist/types/src/msca/plugins/multisig/utils/combineSignatures.d.ts

@@ -1,10 +1,36 @@
 import { type Hex } from "viem";
 import type { Signature } from "../types.js";
-export declare const combineSignatures: ({ signatures, upperLimitMaxFeePerGas, upperLimitMaxPriorityFeePerGas, upperLimitPvg, usingMaxValues, }: {
+export type CombineSignaturesParams = {
     upperLimitPvg: Hex;
     upperLimitMaxFeePerGas: Hex;
     upperLimitMaxPriorityFeePerGas: Hex;
     signatures: Signature[];
     usingMaxValues: boolean;
-}) => `0x${string}`;
+};
+/**
+ * Combines multiple signatures with provided upper limit values for gas fees and returns the concatenated result.
+ *
+ * @example
+ * ```ts
+ * import { combineSignatures } from "@account-kit/smart-contracts";
+ *
+ * const combinedSignature = combineSignatures({
+ *  // this is the upper limit pre-verification gas
+ *  upperLimitPvg: "0x01",
+ *  upperLimitMaxFeePerGas: "0x02",
+ *  upperLimitMaxPriorityFeePerGas: "0x03",
+ *  signatures: [{
+ *    signerType: "EOA",
+ *    userOpSigType: "UPPERLIMIT",
+ *    signer: `0x...`,
+ *    signature: `0x...`,
+ *  }]
+ *  usingMaxValues: false,
+ * });
+ * ```
+ *
+ * @param {CombineSignaturesParams} params The function parameters
+ * @returns {Hex} The concatenated result of padding and formatting the provided values and signatures
+ */
+export declare function combineSignatures({ signatures, upperLimitMaxFeePerGas, upperLimitMaxPriorityFeePerGas, upperLimitPvg, usingMaxValues, }: CombineSignaturesParams): Hex;
 //# sourceMappingURL=combineSignatures.d.ts.map

package/dist/types/src/msca/plugins/multisig/utils/combineSignatures.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"combineSignatures.d.ts","sourceRoot":"","sources":["../../../../../../../src/msca/plugins/multisig/utils/combineSignatures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAe,MAAM,MAAM,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAG7C,eAAO,MAAM,iBAAiB;mBAOb,GAAG;4BACM,GAAG;oCACK,GAAG;gBACvB,SAAS,EAAE;oBACP,OAAO;mBAQxB,CAAC"}
+{"version":3,"file":"combineSignatures.d.ts","sourceRoot":"","sources":["../../../../../../../src/msca/plugins/multisig/utils/combineSignatures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,GAAG,EAAe,MAAM,MAAM,CAAC;AAC7C,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAG7C,MAAM,MAAM,uBAAuB,GAAG;IACpC,aAAa,EAAE,GAAG,CAAC;IACnB,sBAAsB,EAAE,GAAG,CAAC;IAC5B,8BAA8B,EAAE,GAAG,CAAC;IACpC,UAAU,EAAE,SAAS,EAAE,CAAC;IACxB,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AACH,wBAAgB,iBAAiB,CAAC,EAChC,UAAU,EACV,sBAAsB,EACtB,8BAA8B,EAC9B,aAAa,EACb,cAAc,GACf,EAAE,uBAAuB,GAAG,GAAG,CAO/B"}

package/dist/types/src/msca/plugins/multisig/utils/formatSignatures.d.ts

@@ -5,9 +5,9 @@ import type { Signature } from "../types";
  * by signer address. The EOA SIGS contain the 65 signautre data for EOA signers and 65 bytes containing SIGNER | OFFSET | V for contract signers.
  * The OFFSET is used to fetch the signature data from the CONTRACT_SIG_DATAS.
  *
- * @param signatures the array of {@link Signature} objects to combine into the correct aggregated signature format excluding the upper limits
- * @param usingMaxValues a boolean indicating wether or not the UserOperation is using the UPPER_LIMIT for the gas and fee values
- * @returns the Hex representation of the signature
+ * @param {Signature[]} signatures the array of Signature objects to combine into the correct aggregated signature format excluding the upper limits
+ * @param {boolean} usingMaxValues a boolean indicating wether or not the UserOperation is using the UPPER_LIMIT for the gas and fee values
+ * @returns {Hex} the Hex representation of the signature
  */
 export declare const formatSignatures: (signatures: Signature[], usingMaxValues?: boolean) => `0x${string}`;
 //# sourceMappingURL=formatSignatures.d.ts.map

package/dist/types/src/msca/plugins/multisig/utils/getSignerType.d.ts

@@ -1,11 +1,30 @@
-import type { SmartContractAccount, SmartAccountSigner } from "@aa-sdk/core";
-import { type Transport, type Chain, type Client, type PublicRpcSchema, type PublicActions, type Hex } from "viem";
+import type { SmartAccountSigner, SmartContractAccount } from "@aa-sdk/core";
+import { type Chain, type Client, type Hex, type PublicActions, type PublicRpcSchema, type Transport } from "viem";
 import type { SignerType } from "../types";
 type GetSignerTypeParams<TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends SmartContractAccount | undefined = SmartContractAccount | undefined, TClient extends Client<TTransport, TChain, TAccount, PublicRpcSchema, PublicActions> = Client<TTransport, TChain, TAccount, PublicRpcSchema, PublicActions>> = {
     signer: SmartAccountSigner<any>;
     signature: Hex;
     client: TClient;
 };
+/**
+ * Determines the type of signer (Externally Owned Account (EOA) or CONTRACT) based on the provided client, signature, and signer.
+ *
+ * @example
+ * ```ts
+ * import { getSignerType } from "@account-kit/smart-contracts";
+ * import { LocalAccountSigner } from "@aa-sdk/core";
+ * import { createPublicClient, generatePrivateKey } from "viem";
+ *
+ * const signer = LocalAccountSigner.privateKeyToAccountSigner(generatePrivateKey());
+ * const client = createPublicClient(...);
+ * const signature = signer.signMessage("Hello World");
+ *
+ * const signerType = await getSignerType({ client, signature, signer }); // EOA
+ * ```
+ *
+ * @param {GetSignerTypeParams<TTransport, TChain>} params the parameters including the client, signature, and signer
+ * @returns {Promise<SignerType>} A promise that resolves to the signer type, which is either "EOA" or "CONTRACT"
+ */
 export declare const getSignerType: <TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined>({ client, signature, signer, }: GetSignerTypeParams<TTransport, TChain, SmartContractAccount | undefined, Client<TTransport, TChain, SmartContractAccount | undefined, PublicRpcSchema, PublicActions>>) => Promise<SignerType>;
 export {};
 //# sourceMappingURL=getSignerType.d.ts.map

package/dist/types/src/msca/plugins/multisig/utils/getSignerType.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"getSignerType.d.ts","sourceRoot":"","sources":["../../../../../../../src/msca/plugins/multisig/utils/getSignerType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,oBAAoB,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EACL,KAAK,SAAS,EACd,KAAK,KAAK,EACV,KAAK,MAAM,EACX,KAAK,eAAe,EACpB,KAAK,aAAa,EAClB,KAAK,GAAG,EAET,MAAM,MAAM,CAAC;AACd,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,KAAK,mBAAmB,CACtB,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,EACb,OAAO,SAAS,MAAM,CACpB,UAAU,EACV,MAAM,EACN,QAAQ,EACR,eAAe,EACf,aAAa,CACd,GAAG,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,aAAa,CAAC,IACtE;IACF,MAAM,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAChC,SAAS,EAAE,GAAG,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF,eAAO,MAAM,aAAa,+SAOmB,QAAQ,UAAU,CAO9D,CAAC"}
+{"version":3,"file":"getSignerType.d.ts","sourceRoot":"","sources":["../../../../../../../src/msca/plugins/multisig/utils/getSignerType.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,kBAAkB,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAC7E,OAAO,EACL,KAAK,KAAK,EACV,KAAK,MAAM,EACX,KAAK,GAAG,EACR,KAAK,aAAa,EAClB,KAAK,eAAe,EAEpB,KAAK,SAAS,EACf,MAAM,MAAM,CAAC;AACd,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,UAAU,CAAC;AAE3C,KAAK,mBAAmB,CACtB,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,EACb,OAAO,SAAS,MAAM,CACpB,UAAU,EACV,MAAM,EACN,QAAQ,EACR,eAAe,EACf,aAAa,CACd,GAAG,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,EAAE,eAAe,EAAE,aAAa,CAAC,IACtE;IACF,MAAM,EAAE,kBAAkB,CAAC,GAAG,CAAC,CAAC;IAChC,SAAS,EAAE,GAAG,CAAC;IACf,MAAM,EAAE,OAAO,CAAC;CACjB,CAAC;AAEF;;;;;;;;;;;;;;;;;;GAkBG;AACH,eAAO,MAAM,aAAa,+SAOmB,QAAQ,UAAU,CAO9D,CAAC"}

package/dist/types/src/msca/plugins/multisig/utils/index.d.ts

@@ -1,5 +1,9 @@
+export type * from "./combineSignatures.js";
 export { combineSignatures } from "./combineSignatures.js";
+export type * from "./formatSignatures.js";
 export { formatSignatures } from "./formatSignatures.js";
+export type * from "./getSignerType.js";
 export { getSignerType } from "./getSignerType.js";
+export type * from "./splitAggregatedSignature.js";
 export { splitAggregatedSignature } from "./splitAggregatedSignature.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/msca/plugins/multisig/utils/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/msca/plugins/multisig/utils/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../../src/msca/plugins/multisig/utils/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,wBAAwB,CAAC;AAC5C,OAAO,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC3D,mBAAmB,uBAAuB,CAAC;AAC3C,OAAO,EAAE,gBAAgB,EAAE,MAAM,uBAAuB,CAAC;AACzD,mBAAmB,oBAAoB,CAAC;AACxC,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,mBAAmB,+BAA+B,CAAC;AACnD,OAAO,EAAE,wBAAwB,EAAE,MAAM,+BAA+B,CAAC"}

package/dist/types/src/msca/plugins/multisig/utils/splitAggregatedSignature.d.ts

@@ -7,20 +7,21 @@ export type SplitAggregateSignatureParams<TAccount extends SmartContractAccount
     account: SmartContractAccount;
     request: UserOperationRequest<TEntryPointVersion>;
 };
-/**
- * Takes an aggregated signature and threshold and splits it into its components
- *
- * @param args - the arguments for the split
- * @param args.aggregateSignature - the aggregated signature to split
- * @param args.threshold - the threshold for the signature
- * @param args.account - the account which the signature is valid for
- * @param args.request - the user operation request that the signature is for
- * @returns the signature split into its upper limits and current signatures
- */
-export declare const splitAggregatedSignature: <TAccount extends SmartContractAccount | undefined = SmartContractAccount | undefined>(args: SplitAggregateSignatureParams<TAccount, GetEntryPointFromAccount<TAccount, SmartContractAccount<string, keyof import("@aa-sdk/core").EntryPointRegistryBase<unknown>>>>) => Promise<{
+export type SplitAggregateSignatureResult = {
     upperLimitPvg: Hex;
     upperLimitMaxFeePerGas: Hex;
     upperLimitMaxPriorityFeePerGas: Hex;
     signatures: Signature[];
-}>;
+};
+/**
+ * Takes an aggregated signature and threshold and splits it into its components
+ *
+ * @param {SplitAggregateSignatureParams<TAccount>} args - the arguments for the split
+ * @param {Hex} args.aggregateSignature - the aggregated signature to split
+ * @param {number} args.threshold - the threshold for the signature
+ * @param {SmartContractAccount} args.account - the account which the signature is valid for
+ * @param {UserOperationRequest<TEntryPointVersion>} args.request - the user operation request that the signature is for
+ * @returns {Promise<SplitAggregateSignatureResult>} the signature split into its upper limits and current signatures
+ */
+export declare const splitAggregatedSignature: <TAccount extends SmartContractAccount | undefined = SmartContractAccount | undefined>(args: SplitAggregateSignatureParams<TAccount, GetEntryPointFromAccount<TAccount, SmartContractAccount<string, keyof import("@aa-sdk/core").EntryPointRegistryBase<unknown>>>>) => Promise<SplitAggregateSignatureResult>;
 //# sourceMappingURL=splitAggregatedSignature.d.ts.map

package/dist/types/src/msca/plugins/multisig/utils/splitAggregatedSignature.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"splitAggregatedSignature.d.ts","sourceRoot":"","sources":["../../../../../../../src/msca/plugins/multisig/utils/splitAggregatedSignature.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EAC1B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAwC,KAAK,GAAG,EAAE,MAAM,MAAM,CAAC;AAEtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,6BAA6B,CACvC,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,EACb,kBAAkB,SAAS,wBAAwB,CAAC,QAAQ,CAAC,GAAG,wBAAwB,CAAC,QAAQ,CAAC,IAChG;IACF,mBAAmB,EAAE,GAAG,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,oBAAoB,CAAC;IAC9B,OAAO,EAAE,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;CACnD,CAAC;AACF;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB;mBAOpB,GAAG;4BACM,GAAG;oCACK,GAAG;gBACvB,SAAS,EAAE;EA4FxB,CAAC"}
+{"version":3,"file":"splitAggregatedSignature.d.ts","sourceRoot":"","sources":["../../../../../../../src/msca/plugins/multisig/utils/splitAggregatedSignature.ts"],"names":[],"mappings":"AAAA,OAAO,EAEL,KAAK,wBAAwB,EAC7B,KAAK,oBAAoB,EACzB,KAAK,oBAAoB,EAC1B,MAAM,cAAc,CAAC;AACtB,OAAO,EAAwC,KAAK,GAAG,EAAE,MAAM,MAAM,CAAC;AAEtE,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,aAAa,CAAC;AAE7C,MAAM,MAAM,6BAA6B,CACvC,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,EACb,kBAAkB,SAAS,wBAAwB,CAAC,QAAQ,CAAC,GAAG,wBAAwB,CAAC,QAAQ,CAAC,IAChG;IACF,mBAAmB,EAAE,GAAG,CAAC;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,OAAO,EAAE,oBAAoB,CAAC;IAC9B,OAAO,EAAE,oBAAoB,CAAC,kBAAkB,CAAC,CAAC;CACnD,CAAC;AAEF,MAAM,MAAM,6BAA6B,GAAG;IAC1C,aAAa,EAAE,GAAG,CAAC;IACnB,sBAAsB,EAAE,GAAG,CAAC;IAC5B,8BAA8B,EAAE,GAAG,CAAC;IACpC,UAAU,EAAE,SAAS,EAAE,CAAC;CACzB,CAAC;AAEF;;;;;;;;;GASG;AACH,eAAO,MAAM,wBAAwB,2QAMlC,QAAQ,6BAA6B,CA2FvC,CAAC"}

package/dist/types/src/msca/plugins/session-key/extension.d.ts

@@ -27,5 +27,18 @@ export type SessionKeyPluginActions<TAccount extends SmartContractAccount | unde
 } & (IsUndefined<TAccount> extends false ? {
     getAccountSessionKeys: (args?: GetPluginAddressParameter & GetAccountParameter<TAccount>) => Promise<ReadonlyArray<Address>>;
 } : {});
+/**
+ * Creates actions for managing session keys in a smart contract associated with a client, including adding, removing, rotating, and updating session key permissions.
+ *
+ * @example
+ * ```ts
+ * import { createModularAccountAlchemyClient, sessionKeyPluginActions } from "@account-kit/smart-contracts";
+ *
+ * const client = createModularAccountAlchemyClient(...).extend(sessionKeyPluginActions);
+ * ```
+ *
+ * @param {Client<TTransport, TChain, TAccount>} client The client instance to use for managing session keys
+ * @returns {SessionKeyPluginActions<TAccount>} An object containing methods for session key management and interaction with the smart contract
+ */
 export declare const sessionKeyPluginActions: <TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends SmartContractAccount | undefined = SmartContractAccount | undefined>(client: Client<TTransport, TChain, TAccount>) => SessionKeyPluginActions<TAccount>;
 //# sourceMappingURL=extension.d.ts.map

package/dist/types/src/msca/plugins/session-key/extension.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"extension.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/extension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,+BAA+B,EAChC,MAAM,cAAc,CAAC;AACtB,OAAO,EAGL,KAAK,mBAAmB,EACxB,KAAK,WAAW,EAChB,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EAE1B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAGL,KAAK,uBAAuB,IAAI,wBAAwB,EACzD,MAAM,aAAa,CAAC;AAGrB,MAAM,MAAM,uBAAuB,CACjC,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,EACb,kBAAkB,SAAS,wBAAwB,CAAC,QAAQ,CAAC,GAAG,wBAAwB,CAAC,QAAQ,CAAC,IAChG,IAAI,CACN,wBAAwB,CAAC,QAAQ,CAAC,EAChC,kBAAkB,GAClB,eAAe,GACf,kBAAkB,GAClB,sBAAsB,CACzB,GAAG;IACF,mBAAmB,EAAE,CACnB,IAAI,EAAE;QAAE,GAAG,EAAE,OAAO,CAAA;KAAE,GAAG,yBAAyB,GAChD,mBAAmB,CAAC,QAAQ,CAAC,KAC5B,OAAO,CAAC,OAAO,CAAC,CAAC;IAEtB,qBAAqB,EAAE,CACrB,IAAI,EAAE,yBAAyB,GAAG,mBAAmB,CAAC,QAAQ,CAAC,KAC5D,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAErC,gBAAgB,EAAE,CAChB,IAAI,EAAE;QAAE,GAAG,EAAE,OAAO,CAAA;KAAE,GAAG,yBAAyB,GAChD,mBAAmB,CAAC,QAAQ,CAAC,GAC7B,+BAA+B,CAAC,kBAAkB,CAAC,KAClD,OAAO,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAE1D,aAAa,EAAE,CACb,IAAI,EAAE;QACJ,GAAG,EAAE,OAAO,CAAC;QACb,WAAW,EAAE,GAAG,EAAE,CAAC;QACnB,GAAG,EAAE,GAAG,CAAC;KACV,GAAG,yBAAyB,GAC3B,mBAAmB,CAAC,QAAQ,CAAC,GAC7B,+BAA+B,CAAC,kBAAkB,CAAC,KAClD,OAAO,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAE1D,gBAAgB,EAAE,CAChB,IAAI,EAAE;QACJ,MAAM,EAAE,OAAO,CAAC;QAChB,MAAM,EAAE,OAAO,CAAC;KACjB,GAAG,yBAAyB,GAC3B,mBAAmB,CAAC,QAAQ,CAAC,GAC7B,+BAA+B,CAAC,kBAAkB,CAAC,KAClD,OAAO,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAE1D,2BAA2B,EAAE,CAC3B,IAAI,EAAE;QACJ,GAAG,EAAE,OAAO,CAAC;QACb,WAAW,EAAE,GAAG,EAAE,CAAC;KACpB,GAAG,yBAAyB,GAC3B,mBAAmB,CAAC,QAAQ,CAAC,GAC7B,+BAA+B,CAAC,kBAAkB,CAAC,KAClD,OAAO,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC;CAC3D,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,KAAK,GAClC;IACE,qBAAqB,EAAE,CACrB,IAAI,CAAC,EAAE,yBAAyB,GAAG,mBAAmB,CAAC,QAAQ,CAAC,KAC7D,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;CACtC,GACD,EAAE,CAAC,CAAC;AAEV,eAAO,MAAM,uBAAuB,EAAE,CACpC,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,EAEb,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,KACzC,uBAAuB,CAAC,QAAQ,CAyMpC,CAAC"}
+{"version":3,"file":"extension.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/extension.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,wBAAwB,EACxB,+BAA+B,EAChC,MAAM,cAAc,CAAC;AACtB,OAAO,EAGL,KAAK,mBAAmB,EACxB,KAAK,WAAW,EAChB,KAAK,uBAAuB,EAC5B,KAAK,oBAAoB,EAE1B,MAAM,cAAc,CAAC;AACtB,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,GAAG,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AACnE,OAAO,KAAK,EAAE,yBAAyB,EAAE,MAAM,aAAa,CAAC;AAC7D,OAAO,EAGL,KAAK,uBAAuB,IAAI,wBAAwB,EACzD,MAAM,aAAa,CAAC;AAGrB,MAAM,MAAM,uBAAuB,CACjC,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,EACb,kBAAkB,SAAS,wBAAwB,CAAC,QAAQ,CAAC,GAAG,wBAAwB,CAAC,QAAQ,CAAC,IAChG,IAAI,CACN,wBAAwB,CAAC,QAAQ,CAAC,EAChC,kBAAkB,GAClB,eAAe,GACf,kBAAkB,GAClB,sBAAsB,CACzB,GAAG;IACF,mBAAmB,EAAE,CACnB,IAAI,EAAE;QAAE,GAAG,EAAE,OAAO,CAAA;KAAE,GAAG,yBAAyB,GAChD,mBAAmB,CAAC,QAAQ,CAAC,KAC5B,OAAO,CAAC,OAAO,CAAC,CAAC;IAEtB,qBAAqB,EAAE,CACrB,IAAI,EAAE,yBAAyB,GAAG,mBAAmB,CAAC,QAAQ,CAAC,KAC5D,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;IAErC,gBAAgB,EAAE,CAChB,IAAI,EAAE;QAAE,GAAG,EAAE,OAAO,CAAA;KAAE,GAAG,yBAAyB,GAChD,mBAAmB,CAAC,QAAQ,CAAC,GAC7B,+BAA+B,CAAC,kBAAkB,CAAC,KAClD,OAAO,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAE1D,aAAa,EAAE,CACb,IAAI,EAAE;QACJ,GAAG,EAAE,OAAO,CAAC;QACb,WAAW,EAAE,GAAG,EAAE,CAAC;QACnB,GAAG,EAAE,GAAG,CAAC;KACV,GAAG,yBAAyB,GAC3B,mBAAmB,CAAC,QAAQ,CAAC,GAC7B,+BAA+B,CAAC,kBAAkB,CAAC,KAClD,OAAO,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAE1D,gBAAgB,EAAE,CAChB,IAAI,EAAE;QACJ,MAAM,EAAE,OAAO,CAAC;QAChB,MAAM,EAAE,OAAO,CAAC;KACjB,GAAG,yBAAyB,GAC3B,mBAAmB,CAAC,QAAQ,CAAC,GAC7B,+BAA+B,CAAC,kBAAkB,CAAC,KAClD,OAAO,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC;IAE1D,2BAA2B,EAAE,CAC3B,IAAI,EAAE;QACJ,GAAG,EAAE,OAAO,CAAC;QACb,WAAW,EAAE,GAAG,EAAE,CAAC;KACpB,GAAG,yBAAyB,GAC3B,mBAAmB,CAAC,QAAQ,CAAC,GAC7B,+BAA+B,CAAC,kBAAkB,CAAC,KAClD,OAAO,CAAC,uBAAuB,CAAC,kBAAkB,CAAC,CAAC,CAAC;CAC3D,GAAG,CAAC,WAAW,CAAC,QAAQ,CAAC,SAAS,KAAK,GAClC;IACE,qBAAqB,EAAE,CACrB,IAAI,CAAC,EAAE,yBAAyB,GAAG,mBAAmB,CAAC,QAAQ,CAAC,KAC7D,OAAO,CAAC,aAAa,CAAC,OAAO,CAAC,CAAC,CAAC;CACtC,GACD,EAAE,CAAC,CAAC;AAEV;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,uBAAuB,EAAE,CACpC,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,EAEb,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,KACzC,uBAAuB,CAAC,QAAQ,CAyMpC,CAAC"}

package/dist/types/src/msca/plugins/session-key/index.d.ts

@@ -1,4 +1,4 @@
 export type * from "./extension.js";
 export { sessionKeyPluginActions } from "./extension.js";
-export { SessionKeyPlugin } from "./plugin.js";
+export { SessionKeyPlugin, SessionKeyPluginAbi, SessionKeyPluginExecutionFunctionAbi, type InstallSessionKeyPluginParams, } from "./plugin.js";
 //# sourceMappingURL=index.d.ts.map

package/dist/types/src/msca/plugins/session-key/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,gBAAgB,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AACzD,OAAO,EAAE,gBAAgB,EAAE,MAAM,aAAa,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/index.ts"],"names":[],"mappings":"AAAA,mBAAmB,gBAAgB,CAAC;AACpC,OAAO,EAAE,uBAAuB,EAAE,MAAM,gBAAgB,CAAC;AAEzD,OAAO,EACL,gBAAgB,EAChB,mBAAmB,EACnB,oCAAoC,EACpC,KAAK,6BAA6B,GACnC,MAAM,aAAa,CAAC"}

package/dist/types/src/msca/plugins/session-key/permissions.d.ts

@@ -31,6 +31,9 @@ export type GasSpendLimit = {
     spendLimit: bigint;
     refreshInterval?: number;
 };
+/**
+ * A builder for creating the hex-encoded data for updating session key permissions.
+ */
 export declare class SessionKeyPermissionsBuilder {
     private _contractAccessControlType;
     private _contractAddressAccessEntrys;
@@ -40,14 +43,160 @@ export declare class SessionKeyPermissionsBuilder {
     private _erc20TokenSpendLimits;
     private _gasSpendLimit?;
     private _requiredPaymaster?;
+    /**
+     * Sets the access control type for the contract and returns the current instance for method chaining.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
+     *
+     * const builder = new SessionKeyPermissionsBuilder();
+     * builder.setContractAccessControlType(SessionKeyAccessListType.ALLOWLIST);
+     * ```
+     *
+     * @param {SessionKeyAccessListType} aclType The access control type for the session key
+     * @returns {SessionKeyPermissionsBuilder} The current instance for method chaining
+     */
     setContractAccessControlType(aclType: SessionKeyAccessListType): this;
+    /**
+     * Adds a contract access entry to the internal list of contract address access entries.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
+     *
+     * const builder = new SessionKeyPermissionsBuilder();
+     * builder.addContractAddressAccessEntry({
+     *  contractAddress: "0x1234",
+     *  isOnList: true,
+     *  checkSelectors: true,
+     * });
+     * ```
+     *
+     * @param {ContractAccessEntry} entry the contract access entry to be added
+     * @returns {SessionKeyPermissionsBuilder} the instance of the current class for chaining
+     */
     addContractAddressAccessEntry(entry: ContractAccessEntry): this;
+    /**
+     * Adds a contract method entry to the `_contractMethodAccessEntrys` array.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
+     *
+     * const builder = new SessionKeyPermissionsBuilder();
+     * builder.addContractAddressAccessEntry({
+     *  contractAddress: "0x1234",
+     *  methodSelector: "0x45678",
+     *  isOnList: true,
+     * });
+     * ```
+     *
+     * @param {ContractMethodEntry} entry The contract method entry to be added
+     * @returns {SessionKeyPermissionsBuilder} The instance of the class for method chaining
+     */
     addContractFunctionAccessEntry(entry: ContractMethodEntry): this;
+    /**
+     * Sets the time range for an object and returns the object itself for chaining.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
+     *
+     * const builder = new SessionKeyPermissionsBuilder();
+     * builder.setTimeRange({
+     *  validFrom: Date.now(),
+     *  validUntil: Date.now() + (15 * 60 * 1000),
+     * });
+     * ```
+     *
+     * @param {TimeRange} timeRange The time range to be set
+     * @returns {SessionKeyPermissionsBuilder} The current object for method chaining
+     */
     setTimeRange(timeRange: TimeRange): this;
+    /**
+     * Sets the native token spend limit and returns the instance for chaining.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
+     *
+     * const builder = new SessionKeyPermissionsBuilder();
+     * builder.setNativeTokenSpendLimit({
+     *  spendLimit: 1000000000000000000n,
+     *  refreshInterval: 3600,
+     * });
+     * ```
+     *
+     * @param {NativeTokenLimit} limit The limit to set for native token spending
+     * @returns {SessionKeyPermissionsBuilder} The instance for chaining
+     */
     setNativeTokenSpendLimit(limit: NativeTokenLimit): this;
+    /**
+     * Adds an ERC20 token spend limit to the list of limits and returns the updated object.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
+     *
+     * const builder = new SessionKeyPermissionsBuilder();
+     * builder.addErc20TokenSpendLimit({
+     *  tokenAddress: "0x1234",
+     *  spendLimit: 1000000000000000000n,
+     *  refreshInterval: 3600,
+     * });
+     * ```
+     *
+     * @param {Erc20TokenLimit} limit The ERC20 token spend limit to be added
+     * @returns {object} The updated object with the new ERC20 token spend limit
+     */
     addErc20TokenSpendLimit(limit: Erc20TokenLimit): this;
-    setGasSpendLimit(limit: GasSpendLimit): this;
+    /**
+     * Sets the gas spend limit and returns the current instance for method chaining.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
+     *
+     * const builder = new SessionKeyPermissionsBuilder();
+     * builder.setGasSpendLimit({
+     *  spendLimit: 1000000000000000000n,
+     *  refreshInterval: 3600,
+     * });
+     * ```
+     *
+     * @param {GasSpendLimit} limit - The gas spend limit to be set
+     * @returns {SessionKeyPermissionsBuilder} The current instance for chaining
+     */ setGasSpendLimit(limit: GasSpendLimit): this;
+    /**
+     * Sets the required paymaster address.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
+     *
+     * const builder = new SessionKeyPermissionsBuilder();
+     * builder.setRequiredPaymaster("0x1234");
+     * ```
+     *
+     * @param {Address} paymaster the address of the paymaster to be set
+     * @returns {SessionKeyPermissionsBuilder} the current instance for method chaining
+     */
     setRequiredPaymaster(paymaster: Address): this;
+    /**
+     * Encodes various function calls into an array of hexadecimal strings based on the provided permissions and limits.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeyPermissionsBuilder } from "@account-kit/smart-contracts";
+     *
+     * const builder = new SessionKeyPermissionsBuilder();
+     * builder.setRequiredPaymaster("0x1234");
+     * const encoded = builder.encode();
+     * ```
+     *
+     * @returns {Hex[]} An array of encoded hexadecimal strings representing the function calls for setting access control, permissions, and limits.
+     */
     encode(): Hex[];
     private encodeIfDefined;
 }

package/dist/types/src/msca/plugins/session-key/permissions.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,KAAK,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,MAAM,CAAC;AAGlE,oBAAY,wBAAwB;IAClC,SAAS,IAAI;IACb,QAAQ,IAAI;IACZ,gBAAgB,IAAI;CACrB;AAED,MAAM,MAAM,mBAAmB,GAAG;IAEhC,eAAe,EAAE,OAAO,CAAC;IAEzB,QAAQ,EAAE,OAAO,CAAC;IAElB,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAEhC,eAAe,EAAE,OAAO,CAAC;IAEzB,cAAc,EAAE,GAAG,CAAC;IAEpB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,MAAM,CAAC;IAGnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IAGnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAGF,MAAM,MAAM,aAAa,GAAG;IAI1B,UAAU,EAAE,MAAM,CAAC;IAGnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,qBAAa,4BAA4B;IACvC,OAAO,CAAC,0BAA0B,CACG;IACrC,OAAO,CAAC,4BAA4B,CAA6B;IACjE,OAAO,CAAC,2BAA2B,CAA6B;IAChE,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,sBAAsB,CAAC,CAAmB;IAClD,OAAO,CAAC,sBAAsB,CAAyB;IACvD,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,OAAO,CAAC,kBAAkB,CAAC,CAAU;IAE9B,4BAA4B,CAAC,OAAO,EAAE,wBAAwB;IAK9D,6BAA6B,CAAC,KAAK,EAAE,mBAAmB;IAKxD,8BAA8B,CAAC,KAAK,EAAE,mBAAmB;IAKzD,YAAY,CAAC,SAAS,EAAE,SAAS;IAKjC,wBAAwB,CAAC,KAAK,EAAE,gBAAgB;IAKhD,uBAAuB,CAAC,KAAK,EAAE,eAAe;IAK9C,gBAAgB,CAAC,KAAK,EAAE,aAAa;IAKrC,oBAAoB,CAAC,SAAS,EAAE,OAAO;IAKvC,MAAM,IAAI,GAAG,EAAE;IA0EtB,OAAO,CAAC,eAAe;CAKxB"}
+{"version":3,"file":"permissions.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAsB,KAAK,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,MAAM,CAAC;AAGlE,oBAAY,wBAAwB;IAClC,SAAS,IAAI;IACb,QAAQ,IAAI;IACZ,gBAAgB,IAAI;CACrB;AAED,MAAM,MAAM,mBAAmB,GAAG;IAEhC,eAAe,EAAE,OAAO,CAAC;IAEzB,QAAQ,EAAE,OAAO,CAAC;IAElB,cAAc,EAAE,OAAO,CAAC;CACzB,CAAC;AAEF,MAAM,MAAM,mBAAmB,GAAG;IAEhC,eAAe,EAAE,OAAO,CAAC;IAEzB,cAAc,EAAE,GAAG,CAAC;IAEpB,QAAQ,EAAE,OAAO,CAAC;CACnB,CAAC;AAEF,MAAM,MAAM,SAAS,GAAG;IACtB,SAAS,EAAE,MAAM,CAAC;IAClB,UAAU,EAAE,MAAM,CAAC;CACpB,CAAC;AAEF,MAAM,MAAM,gBAAgB,GAAG;IAC7B,UAAU,EAAE,MAAM,CAAC;IAGnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF,MAAM,MAAM,eAAe,GAAG;IAC5B,YAAY,EAAE,OAAO,CAAC;IACtB,UAAU,EAAE,MAAM,CAAC;IAGnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAGF,MAAM,MAAM,aAAa,GAAG;IAI1B,UAAU,EAAE,MAAM,CAAC;IAGnB,eAAe,CAAC,EAAE,MAAM,CAAC;CAC1B,CAAC;AAEF;;GAEG;AACH,qBAAa,4BAA4B;IACvC,OAAO,CAAC,0BAA0B,CACG;IACrC,OAAO,CAAC,4BAA4B,CAA6B;IACjE,OAAO,CAAC,2BAA2B,CAA6B;IAChE,OAAO,CAAC,UAAU,CAAC,CAAY;IAC/B,OAAO,CAAC,sBAAsB,CAAC,CAAmB;IAClD,OAAO,CAAC,sBAAsB,CAAyB;IACvD,OAAO,CAAC,cAAc,CAAC,CAAgB;IACvC,OAAO,CAAC,kBAAkB,CAAC,CAAU;IAErC;;;;;;;;;;;;;OAaG;IACI,4BAA4B,CAAC,OAAO,EAAE,wBAAwB;IAKrE;;;;;;;;;;;;;;;;;OAiBG;IACI,6BAA6B,CAAC,KAAK,EAAE,mBAAmB;IAK/D;;;;;;;;;;;;;;;;;OAiBG;IACI,8BAA8B,CAAC,KAAK,EAAE,mBAAmB;IAKhE;;;;;;;;;;;;;;;;OAgBG;IACI,YAAY,CAAC,SAAS,EAAE,SAAS;IAKxC;;;;;;;;;;;;;;;;OAgBG;IACI,wBAAwB,CAAC,KAAK,EAAE,gBAAgB;IAKvD;;;;;;;;;;;;;;;;;OAiBG;IACI,uBAAuB,CAAC,KAAK,EAAE,eAAe;IAKrD;;;;;;;;;;;;;;;;OAgBG,CAAQ,gBAAgB,CAAC,KAAK,EAAE,aAAa;IAKhD;;;;;;;;;;;;;OAaG;IACI,oBAAoB,CAAC,SAAS,EAAE,OAAO;IAK9C;;;;;;;;;;;;;OAaG;IACI,MAAM,IAAI,GAAG,EAAE;IA0EtB,OAAO,CAAC,eAAe;CAKxB"}

package/dist/types/src/msca/plugins/session-key/signer.d.ts

@@ -12,20 +12,82 @@ export declare const SessionKeySignerSchema: z.ZodObject<{
     storageKey?: string | undefined;
 }>;
 export type SessionKeySignerConfig = z.input<typeof SessionKeySignerSchema>;
+export declare const SESSION_KEY_SIGNER_TYPE_PFX = "alchemy:session-key";
 /**
  * A simple session key signer that uses localStorage or sessionStorage to store
  * a private key. If the key is not found, it will generate a new one and store
  * it in the storage.
  */
-export declare const SESSION_KEY_SIGNER_TYPE_PFX = "alchemy:session-key";
 export declare class SessionKeySigner implements SmartAccountSigner<LocalAccountSigner<PrivateKeyAccount>> {
     signerType: string;
     inner: LocalAccountSigner<PrivateKeyAccount>;
     private storageType;
     private storageKey;
+    /**
+     * Initializes a new instance of a session key signer with the provided configuration. This will set the `signerType`, `storageKey`, and `storageType`. It will also manage the session key, either fetching it from storage or generating a new one if it doesn't exist.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeySigner } from "@account-kit/smart-contracts";
+     *
+     * const signer = new SessionKeySigner();
+     * ```
+     *
+     * @param {SessionKeySignerConfig} config_ the configuration for initializing the session key signer
+     */
     constructor(config_?: SessionKeySignerConfig);
+    /**
+     * An async function that retrieves the address using the inner object's `getAddress` method.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeySigner } from "@account-kit/smart-contracts";
+     *
+     * const signer = new SessionKeySigner();
+     * const sessionKeyAddress = await signer.getAddress();
+     * ```
+     *
+     * @returns {Promise<string>} A promise that resolves to the address as a string
+     */
     getAddress: () => Promise<`0x${string}`>;
+    /**
+     * Signs a message using the inner signer.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeySigner } from "@account-kit/smart-contracts";
+     *
+     * const signer = new SessionKeySigner();
+     * const sessionKeyAddress = await signer.signMessage("hello");
+     * ```
+     *
+     * @param {SignableMessage} msg The message to sign
+     * @returns {Promise<Hex>} A promise that resolves to the signed message
+     */
     signMessage: (msg: SignableMessage) => Promise<`0x${string}`>;
+    /**
+     * Signs the provided typed data using the inner signer.
+     *
+     * @example
+     * ```ts
+     * import { SessionKeySigner } from "@account-kit/smart-contracts";
+     *
+     * const signer = new SessionKeySigner();
+     * console.log(await signer.signTypedData({
+     *  types: {
+     *    "Message": [{ name: "content", type: "string" }]
+     *  },
+     *  primaryType: "Message",
+     *  message: { content: "Hello" },
+     * }));
+     * ```
+     *
+     * @template TTypedData - The typed data type, which extends `TypedData` or a record of unknown keys to unknown values.
+     * @template TPrimaryType - The primary type of the typed data.
+     *
+     * @param {TypedDataDefinition<TTypedData, TPrimaryType>} params The parameters containing the typed data definition and primary type.
+     * @returns {Promise<string>} A promise that resolves to the signed typed data as a string.
+     */
     signTypedData: <const TTypedData extends {
         [x: string]: readonly import("viem").TypedDataParameter[];
         [x: `string[${string}]`]: undefined;
@@ -237,7 +299,15 @@ export declare class SessionKeySigner implements SmartAccountSigner<LocalAccount
     /**
      * Generates a new private key and stores it in the storage.
      *
-     * @returns The public address of the new key.
+     * @example
+     * ```ts
+     * import { SessionKeySigner } from "@account-kit/smart-contracts";
+     *
+     * const signer = new SessionKeySigner();
+     * const newSessionKey = signer.generateNewKey();
+     * ```
+     *
+     * @returns {Address} The public address of the new key.
      */
     generateNewKey: () => `0x${string}`;
 }

package/dist/types/src/msca/plugins/session-key/signer.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,KAAK,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,EAEV,iBAAiB,EACjB,eAAe,EAEf,mBAAmB,EACpB,MAAM,MAAM,CAAC;AAEd,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,sBAAsB;;;;;;;;;EAMjC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAE5E;;;;GAIG;AAEH,eAAO,MAAM,2BAA2B,wBAAwB,CAAC;AACjE,qBAAa,gBACX,YAAW,kBAAkB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;IAEpE,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;IAC7C,OAAO,CAAC,WAAW,CAAgD;IACnE,OAAO,CAAC,UAAU,CAAS;gBAEf,OAAO,GAAE,sBAA2B;IA2BhD,UAAU,EAAE,MAAM,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAEtC;IAEF,WAAW,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAI3D;IAEF,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8HAOX;IAEF;;;;OAIG;IACH,cAAc,sBASZ;CACH"}
+{"version":3,"file":"signer.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/signer.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,KAAK,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAC3E,OAAO,KAAK,EAEV,iBAAiB,EACjB,eAAe,EAEf,mBAAmB,EACpB,MAAM,MAAM,CAAC;AAEd,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAC;AAExB,eAAO,MAAM,sBAAsB;;;;;;;;;EAMjC,CAAC;AAEH,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,sBAAsB,CAAC,CAAC;AAC5E,eAAO,MAAM,2BAA2B,wBAAwB,CAAC;AAEjE;;;;GAIG;AACH,qBAAa,gBACX,YAAW,kBAAkB,CAAC,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;IAEpE,UAAU,EAAE,MAAM,CAAC;IACnB,KAAK,EAAE,kBAAkB,CAAC,iBAAiB,CAAC,CAAC;IAC7C,OAAO,CAAC,WAAW,CAAgD;IACnE,OAAO,CAAC,UAAU,CAAS;IAE3B;;;;;;;;;;;OAWG;gBACS,OAAO,GAAE,sBAA2B;IA2BhD;;;;;;;;;;;;OAYG;IACH,UAAU,EAAE,MAAM,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAEtC;IAEF;;;;;;;;;;;;;OAaG;IACH,WAAW,EAAE,CAAC,GAAG,EAAE,eAAe,KAAK,OAAO,CAAC,KAAK,MAAM,EAAE,CAAC,CAI3D;IAEF;;;;;;;;;;;;;;;;;;;;;;OAsBG;IACH,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;8HAOX;IAEF;;;;;;;;;;;;OAYG;IACH,cAAc,sBASZ;CACH"}

package/dist/types/src/msca/plugins/session-key/utils.d.ts

@@ -1,10 +1,30 @@
 import type { GetAccountParameter, SmartContractAccount } from "@aa-sdk/core";
 import type { Address, Chain, Client, Transport } from "viem";
-export declare const buildSessionKeysToRemoveStruct: <TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends SmartContractAccount | undefined = SmartContractAccount | undefined>(client: Client<TTransport, TChain, TAccount>, args: {
+type BuildSessionKeysToRemoveStructParams<TAccount extends SmartContractAccount | undefined = SmartContractAccount | undefined> = {
     keys: ReadonlyArray<Address>;
     pluginAddress?: Address;
-} & GetAccountParameter<TAccount>) => Promise<{
+} & GetAccountParameter<TAccount>;
+/**
+ * Finds predecessors for each provided key and returns them in the struct `ISessionKeyPlugin.SessionKeyToRemove[]`.
+ *
+ * @example
+ * ```ts
+ * import { buildSessionKeysToRemoveStruct } from "@account-kit/smart-contracts";
+ *
+ * const client = createSmartAccountClient(...);
+ *
+ * const keysToRemove = await buildSessionKeysToRemoveStruct(client, {
+ *  keys: ["0x...", "0x..."],
+ * });
+ * ```
+ *
+ * @param {Client<TTransport, TChain, TAccount>} client The client instance used to interact with the smart account
+ * @param {BuildSessionKeysToRemoveStructParams<TAccount>} args Arguments to configure the session key removal process
+ * @returns {Promise<{ sessionKey: Address; predecessor: Address }[]>} A promise that resolves to an array of objects each containing a session key and its predecessor
+ */
+export declare function buildSessionKeysToRemoveStruct<TTransport extends Transport = Transport, TChain extends Chain | undefined = Chain | undefined, TAccount extends SmartContractAccount | undefined = SmartContractAccount | undefined>(client: Client<TTransport, TChain, TAccount>, args: BuildSessionKeysToRemoveStructParams): Promise<{
     sessionKey: Address;
     predecessor: Address;
 }[]>;
+export {};
 //# sourceMappingURL=utils.d.ts.map

package/dist/types/src/msca/plugins/session-key/utils.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAE9E,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAK9D,eAAO,MAAM,8BAA8B,EAAE,CAC3C,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,EAEb,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAC5C,IAAI,EAAE;IACJ,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,GAAG,mBAAmB,CAAC,QAAQ,CAAC,KAC9B,OAAO,CAAC;IAAE,UAAU,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,OAAO,CAAA;CAAE,EAAE,CAoB3D,CAAC"}
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/utils.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,mBAAmB,EAAE,oBAAoB,EAAE,MAAM,cAAc,CAAC;AAE9E,OAAO,KAAK,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,EAAE,SAAS,EAAE,MAAM,MAAM,CAAC;AAG9D,KAAK,oCAAoC,CACvC,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,IACX;IACF,IAAI,EAAE,aAAa,CAAC,OAAO,CAAC,CAAC;IAC7B,aAAa,CAAC,EAAE,OAAO,CAAC;CACzB,GAAG,mBAAmB,CAAC,QAAQ,CAAC,CAAC;AAElC;;;;;;;;;;;;;;;;;GAiBG;AACH,wBAAsB,8BAA8B,CAClD,UAAU,SAAS,SAAS,GAAG,SAAS,EACxC,MAAM,SAAS,KAAK,GAAG,SAAS,GAAG,KAAK,GAAG,SAAS,EACpD,QAAQ,SAAS,oBAAoB,GAAG,SAAS,GAC7C,oBAAoB,GACpB,SAAS,EAEb,MAAM,EAAE,MAAM,CAAC,UAAU,EAAE,MAAM,EAAE,QAAQ,CAAC,EAC5C,IAAI,EAAE,oCAAoC,GACzC,OAAO,CAAC;IAAE,UAAU,EAAE,OAAO,CAAC;IAAC,WAAW,EAAE,OAAO,CAAA;CAAE,EAAE,CAAC,CAmB1D"}