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

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

@@ -0,0 +1,53 @@
+import { type Address, type Hex } from "viem";
+export declare enum SessionKeyAccessListType {
+    ALLOWLIST = 0,
+    DENYLIST = 1,
+    ALLOW_ALL_ACCESS = 2
+}
+export type ContractAccessEntry = {
+    contractAddress: Address;
+    isOnList: boolean;
+    checkSelectors: boolean;
+};
+export type ContractMethodEntry = {
+    contractAddress: Address;
+    methodSelector: Hex;
+    isOnList: boolean;
+};
+export type TimeRange = {
+    validFrom: number;
+    validUntil: number;
+};
+export type NativeTokenLimit = {
+    spendLimit: bigint;
+    refreshInterval?: number;
+};
+export type Erc20TokenLimit = {
+    tokenAddress: Address;
+    spendLimit: bigint;
+    refreshInterval?: number;
+};
+export type GasSpendLimit = {
+    spendLimit: bigint;
+    refreshInterval?: number;
+};
+export declare class SessionKeyPermissionsBuilder {
+    private _contractAccessControlType;
+    private _contractAddressAccessEntrys;
+    private _contractMethodAccessEntrys;
+    private _timeRange?;
+    private _nativeTokenSpendLimit?;
+    private _erc20TokenSpendLimits;
+    private _gasSpendLimit?;
+    private _requiredPaymaster?;
+    setContractAccessControlType(aclType: SessionKeyAccessListType): this;
+    addContractAddressAccessEntry(entry: ContractAccessEntry): this;
+    addContractFunctionAccessEntry(entry: ContractMethodEntry): this;
+    setTimeRange(timeRange: TimeRange): this;
+    setNativeTokenSpendLimit(limit: NativeTokenLimit): this;
+    addErc20TokenSpendLimit(limit: Erc20TokenLimit): this;
+    setGasSpendLimit(limit: GasSpendLimit): this;
+    setRequiredPaymaster(paymaster: Address): this;
+    encode(): Hex[];
+    private encodeIfDefined;
+}

package/dist/esm/src/msca/plugins/session-key/permissions.js

@@ -0,0 +1,149 @@
+import { encodeFunctionData } from "viem";
+import { SessionKeyPermissionsUpdatesAbi } from "./SessionKeyPermissionsUpdatesAbi.js";
+export var SessionKeyAccessListType;
+(function (SessionKeyAccessListType) {
+    SessionKeyAccessListType[SessionKeyAccessListType["ALLOWLIST"] = 0] = "ALLOWLIST";
+    SessionKeyAccessListType[SessionKeyAccessListType["DENYLIST"] = 1] = "DENYLIST";
+    SessionKeyAccessListType[SessionKeyAccessListType["ALLOW_ALL_ACCESS"] = 2] = "ALLOW_ALL_ACCESS";
+})(SessionKeyAccessListType || (SessionKeyAccessListType = {}));
+export class SessionKeyPermissionsBuilder {
+    constructor() {
+        Object.defineProperty(this, "_contractAccessControlType", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: SessionKeyAccessListType.ALLOWLIST
+        });
+        Object.defineProperty(this, "_contractAddressAccessEntrys", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: []
+        });
+        Object.defineProperty(this, "_contractMethodAccessEntrys", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: []
+        });
+        Object.defineProperty(this, "_timeRange", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_nativeTokenSpendLimit", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_erc20TokenSpendLimits", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: []
+        });
+        Object.defineProperty(this, "_gasSpendLimit", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        Object.defineProperty(this, "_requiredPaymaster", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+    }
+    setContractAccessControlType(aclType) {
+        this._contractAccessControlType = aclType;
+        return this;
+    }
+    addContractAddressAccessEntry(entry) {
+        this._contractAddressAccessEntrys.push(entry);
+        return this;
+    }
+    addContractFunctionAccessEntry(entry) {
+        this._contractMethodAccessEntrys.push(entry);
+        return this;
+    }
+    setTimeRange(timeRange) {
+        this._timeRange = timeRange;
+        return this;
+    }
+    setNativeTokenSpendLimit(limit) {
+        this._nativeTokenSpendLimit = limit;
+        return this;
+    }
+    addErc20TokenSpendLimit(limit) {
+        this._erc20TokenSpendLimits.push(limit);
+        return this;
+    }
+    setGasSpendLimit(limit) {
+        this._gasSpendLimit = limit;
+        return this;
+    }
+    setRequiredPaymaster(paymaster) {
+        this._requiredPaymaster = paymaster;
+        return this;
+    }
+    encode() {
+        return [
+            encodeFunctionData({
+                abi: SessionKeyPermissionsUpdatesAbi,
+                functionName: "setAccessListType",
+                args: [this._contractAccessControlType],
+            }),
+            ...this._contractAddressAccessEntrys.map((entry) => encodeFunctionData({
+                abi: SessionKeyPermissionsUpdatesAbi,
+                functionName: "updateAccessListAddressEntry",
+                args: [entry.contractAddress, entry.isOnList, entry.checkSelectors],
+            })),
+            ...this._contractMethodAccessEntrys.map((entry) => encodeFunctionData({
+                abi: SessionKeyPermissionsUpdatesAbi,
+                functionName: "updateAccessListFunctionEntry",
+                args: [entry.contractAddress, entry.methodSelector, entry.isOnList],
+            })),
+            this.encodeIfDefined((timeRange) => encodeFunctionData({
+                abi: SessionKeyPermissionsUpdatesAbi,
+                functionName: "updateTimeRange",
+                args: [timeRange.validFrom, timeRange.validUntil],
+            }), this._timeRange),
+            this.encodeIfDefined((nativeSpendLimit) => encodeFunctionData({
+                abi: SessionKeyPermissionsUpdatesAbi,
+                functionName: "setNativeTokenSpendLimit",
+                args: [
+                    nativeSpendLimit.spendLimit,
+                    nativeSpendLimit.refreshInterval ?? 0,
+                ],
+            }), this._nativeTokenSpendLimit),
+            ...this._erc20TokenSpendLimits.map((erc20SpendLimit) => encodeFunctionData({
+                abi: SessionKeyPermissionsUpdatesAbi,
+                functionName: "setERC20SpendLimit",
+                args: [
+                    erc20SpendLimit.tokenAddress,
+                    erc20SpendLimit.spendLimit,
+                    erc20SpendLimit.refreshInterval ?? 0,
+                ],
+            })),
+            this.encodeIfDefined((spendLimit) => encodeFunctionData({
+                abi: SessionKeyPermissionsUpdatesAbi,
+                functionName: "setGasSpendLimit",
+                args: [spendLimit.spendLimit, spendLimit.refreshInterval ?? 0],
+            }), this._gasSpendLimit),
+            this.encodeIfDefined((paymaster) => encodeFunctionData({
+                abi: SessionKeyPermissionsUpdatesAbi,
+                functionName: "setRequiredPaymaster",
+                args: [paymaster],
+            }), this._requiredPaymaster),
+        ].filter((x) => x !== "0x");
+    }
+    encodeIfDefined(encode, param) {
+        if (!param)
+            return "0x";
+        return encode(param);
+    }
+}
+//# sourceMappingURL=permissions.js.map

package/dist/esm/src/msca/plugins/session-key/permissions.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"permissions.js","sourceRoot":"","sources":["../../../../../../src/msca/plugins/session-key/permissions.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAA0B,MAAM,MAAM,CAAC;AAClE,OAAO,EAAE,+BAA+B,EAAE,MAAM,sCAAsC,CAAC;AAEvF,MAAM,CAAN,IAAY,wBAIX;AAJD,WAAY,wBAAwB;IAClC,iFAAa,CAAA;IACb,+EAAY,CAAA;IACZ,+FAAoB,CAAA;AACtB,CAAC,EAJW,wBAAwB,KAAxB,wBAAwB,QAInC;AAmDD,MAAM,OAAO,4BAA4B;IAAzC;QACU;;;;mBACN,wBAAwB,CAAC,SAAS;WAAC;QAC7B;;;;mBAAsD,EAAE;WAAC;QACzD;;;;mBAAqD,EAAE;WAAC;QACxD;;;;;WAAuB;QACvB;;;;;WAA0C;QAC1C;;;;mBAA4C,EAAE;WAAC;QAC/C;;;;;WAA+B;QAC/B;;;;;WAA6B;IAyHvC,CAAC;IAvHQ,4BAA4B,CAAC,OAAiC;QACnE,IAAI,CAAC,0BAA0B,GAAG,OAAO,CAAC;QAC1C,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,6BAA6B,CAAC,KAA0B;QAC7D,IAAI,CAAC,4BAA4B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC9C,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,8BAA8B,CAAC,KAA0B;QAC9D,IAAI,CAAC,2BAA2B,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QAC7C,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,YAAY,CAAC,SAAoB;QACtC,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,wBAAwB,CAAC,KAAuB;QACrD,IAAI,CAAC,sBAAsB,GAAG,KAAK,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,uBAAuB,CAAC,KAAsB;QACnD,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACxC,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,gBAAgB,CAAC,KAAoB;QAC1C,IAAI,CAAC,cAAc,GAAG,KAAK,CAAC;QAC5B,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,oBAAoB,CAAC,SAAkB;QAC5C,IAAI,CAAC,kBAAkB,GAAG,SAAS,CAAC;QACpC,OAAO,IAAI,CAAC;IACd,CAAC;IAEM,MAAM;QACX,OAAO;YACL,kBAAkB,CAAC;gBACjB,GAAG,EAAE,+BAA+B;gBACpC,YAAY,EAAE,mBAAmB;gBACjC,IAAI,EAAE,CAAC,IAAI,CAAC,0BAA0B,CAAC;aACxC,CAAC;YACF,GAAG,IAAI,CAAC,4BAA4B,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CACjD,kBAAkB,CAAC;gBACjB,GAAG,EAAE,+BAA+B;gBACpC,YAAY,EAAE,8BAA8B;gBAC5C,IAAI,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,cAAc,CAAC;aACpE,CAAC,CACH;YACD,GAAG,IAAI,CAAC,2BAA2B,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAChD,kBAAkB,CAAC;gBACjB,GAAG,EAAE,+BAA+B;gBACpC,YAAY,EAAE,+BAA+B;gBAC7C,IAAI,EAAE,CAAC,KAAK,CAAC,eAAe,EAAE,KAAK,CAAC,cAAc,EAAE,KAAK,CAAC,QAAQ,CAAC;aACpE,CAAC,CACH;YACD,IAAI,CAAC,eAAe,CAClB,CAAC,SAAS,EAAE,EAAE,CACZ,kBAAkB,CAAC;gBACjB,GAAG,EAAE,+BAA+B;gBACpC,YAAY,EAAE,iBAAiB;gBAC/B,IAAI,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,SAAS,CAAC,UAAU,CAAC;aAClD,CAAC,EACJ,IAAI,CAAC,UAAU,CAChB;YACD,IAAI,CAAC,eAAe,CAClB,CAAC,gBAAgB,EAAE,EAAE,CACnB,kBAAkB,CAAC;gBACjB,GAAG,EAAE,+BAA+B;gBACpC,YAAY,EAAE,0BAA0B;gBACxC,IAAI,EAAE;oBACJ,gBAAgB,CAAC,UAAU;oBAC3B,gBAAgB,CAAC,eAAe,IAAI,CAAC;iBACtC;aACF,CAAC,EACJ,IAAI,CAAC,sBAAsB,CAC5B;YACD,GAAG,IAAI,CAAC,sBAAsB,CAAC,GAAG,CAAC,CAAC,eAAe,EAAE,EAAE,CACrD,kBAAkB,CAAC;gBACjB,GAAG,EAAE,+BAA+B;gBACpC,YAAY,EAAE,oBAAoB;gBAClC,IAAI,EAAE;oBACJ,eAAe,CAAC,YAAY;oBAC5B,eAAe,CAAC,UAAU;oBAC1B,eAAe,CAAC,eAAe,IAAI,CAAC;iBACrC;aACF,CAAC,CACH;YACD,IAAI,CAAC,eAAe,CAClB,CAAC,UAAU,EAAE,EAAE,CACb,kBAAkB,CAAC;gBACjB,GAAG,EAAE,+BAA+B;gBACpC,YAAY,EAAE,kBAAkB;gBAChC,IAAI,EAAE,CAAC,UAAU,CAAC,UAAU,EAAE,UAAU,CAAC,eAAe,IAAI,CAAC,CAAC;aAC/D,CAAC,EACJ,IAAI,CAAC,cAAc,CACpB;YACD,IAAI,CAAC,eAAe,CAClB,CAAC,SAAS,EAAE,EAAE,CACZ,kBAAkB,CAAC;gBACjB,GAAG,EAAE,+BAA+B;gBACpC,YAAY,EAAE,sBAAsB;gBACpC,IAAI,EAAE,CAAC,SAAS,CAAC;aAClB,CAAC,EACJ,IAAI,CAAC,kBAAkB,CACxB;SACF,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,KAAK,IAAI,CAAC,CAAC;IAC9B,CAAC;IAEO,eAAe,CAAI,MAAyB,EAAE,KAAS;QAC7D,IAAI,CAAC,KAAK;YAAE,OAAO,IAAI,CAAC;QAExB,OAAO,MAAM,CAAC,KAAK,CAAC,CAAC;IACvB,CAAC;CACF","sourcesContent":["import { encodeFunctionData, type Address, type Hex } from \"viem\";\nimport { SessionKeyPermissionsUpdatesAbi } from \"./SessionKeyPermissionsUpdatesAbi.js\";\n\nexport enum SessionKeyAccessListType {\n  ALLOWLIST = 0,\n  DENYLIST = 1,\n  ALLOW_ALL_ACCESS = 2,\n}\n\nexport type ContractAccessEntry = {\n  // The contract address to add or remove.\n  contractAddress: Address;\n  // Whether the contract address should be on the list.\n  isOnList: boolean;\n  // Whether to check selectors for the contract address.\n  checkSelectors: boolean;\n};\n\nexport type ContractMethodEntry = {\n  // The contract address to add or remove.\n  contractAddress: Address;\n  // The function selector to add or remove.\n  methodSelector: Hex;\n  // Whether the function selector should be on the list.\n  isOnList: boolean;\n};\n\nexport type TimeRange = {\n  validFrom: number;\n  validUntil: number;\n};\n\nexport type NativeTokenLimit = {\n  spendLimit: bigint;\n  // The time interval over which the spend limit is enforced. If unset, there is no time\n  /// interval by which the limit is refreshed.\n  refreshInterval?: number;\n};\n\nexport type Erc20TokenLimit = {\n  tokenAddress: Address;\n  spendLimit: bigint;\n  // The time interval over which the spend limit is enforced. If unset, there is no time\n  /// interval by which the limit is refreshed.\n  refreshInterval?: number;\n};\n\n// uint256 spendLimit, uint48 refreshInterval\nexport type GasSpendLimit = {\n  // The amount, in wei, of native tokens that a session key can spend on gas.\n  // Note that this is not the same as the gas limit for a user operation, which is measured in units of gas.\n  // This tracks gas units * gas price.\n  spendLimit: bigint;\n  // The time interval over which the spend limit is enforced. If unset, there is no time\n  /// interval by which the limit is refreshed.\n  refreshInterval?: number;\n};\n\nexport class SessionKeyPermissionsBuilder {\n  private _contractAccessControlType: SessionKeyAccessListType =\n    SessionKeyAccessListType.ALLOWLIST;\n  private _contractAddressAccessEntrys: ContractAccessEntry[] = [];\n  private _contractMethodAccessEntrys: ContractMethodEntry[] = [];\n  private _timeRange?: TimeRange;\n  private _nativeTokenSpendLimit?: NativeTokenLimit;\n  private _erc20TokenSpendLimits: Erc20TokenLimit[] = [];\n  private _gasSpendLimit?: GasSpendLimit;\n  private _requiredPaymaster?: Address;\n\n  public setContractAccessControlType(aclType: SessionKeyAccessListType) {\n    this._contractAccessControlType = aclType;\n    return this;\n  }\n\n  public addContractAddressAccessEntry(entry: ContractAccessEntry) {\n    this._contractAddressAccessEntrys.push(entry);\n    return this;\n  }\n\n  public addContractFunctionAccessEntry(entry: ContractMethodEntry) {\n    this._contractMethodAccessEntrys.push(entry);\n    return this;\n  }\n\n  public setTimeRange(timeRange: TimeRange) {\n    this._timeRange = timeRange;\n    return this;\n  }\n\n  public setNativeTokenSpendLimit(limit: NativeTokenLimit) {\n    this._nativeTokenSpendLimit = limit;\n    return this;\n  }\n\n  public addErc20TokenSpendLimit(limit: Erc20TokenLimit) {\n    this._erc20TokenSpendLimits.push(limit);\n    return this;\n  }\n\n  public setGasSpendLimit(limit: GasSpendLimit) {\n    this._gasSpendLimit = limit;\n    return this;\n  }\n\n  public setRequiredPaymaster(paymaster: Address) {\n    this._requiredPaymaster = paymaster;\n    return this;\n  }\n\n  public encode(): Hex[] {\n    return [\n      encodeFunctionData({\n        abi: SessionKeyPermissionsUpdatesAbi,\n        functionName: \"setAccessListType\",\n        args: [this._contractAccessControlType],\n      }),\n      ...this._contractAddressAccessEntrys.map((entry) =>\n        encodeFunctionData({\n          abi: SessionKeyPermissionsUpdatesAbi,\n          functionName: \"updateAccessListAddressEntry\",\n          args: [entry.contractAddress, entry.isOnList, entry.checkSelectors],\n        })\n      ),\n      ...this._contractMethodAccessEntrys.map((entry) =>\n        encodeFunctionData({\n          abi: SessionKeyPermissionsUpdatesAbi,\n          functionName: \"updateAccessListFunctionEntry\",\n          args: [entry.contractAddress, entry.methodSelector, entry.isOnList],\n        })\n      ),\n      this.encodeIfDefined(\n        (timeRange) =>\n          encodeFunctionData({\n            abi: SessionKeyPermissionsUpdatesAbi,\n            functionName: \"updateTimeRange\",\n            args: [timeRange.validFrom, timeRange.validUntil],\n          }),\n        this._timeRange\n      ),\n      this.encodeIfDefined(\n        (nativeSpendLimit) =>\n          encodeFunctionData({\n            abi: SessionKeyPermissionsUpdatesAbi,\n            functionName: \"setNativeTokenSpendLimit\",\n            args: [\n              nativeSpendLimit.spendLimit,\n              nativeSpendLimit.refreshInterval ?? 0,\n            ],\n          }),\n        this._nativeTokenSpendLimit\n      ),\n      ...this._erc20TokenSpendLimits.map((erc20SpendLimit) =>\n        encodeFunctionData({\n          abi: SessionKeyPermissionsUpdatesAbi,\n          functionName: \"setERC20SpendLimit\",\n          args: [\n            erc20SpendLimit.tokenAddress,\n            erc20SpendLimit.spendLimit,\n            erc20SpendLimit.refreshInterval ?? 0,\n          ],\n        })\n      ),\n      this.encodeIfDefined(\n        (spendLimit) =>\n          encodeFunctionData({\n            abi: SessionKeyPermissionsUpdatesAbi,\n            functionName: \"setGasSpendLimit\",\n            args: [spendLimit.spendLimit, spendLimit.refreshInterval ?? 0],\n          }),\n        this._gasSpendLimit\n      ),\n      this.encodeIfDefined(\n        (paymaster) =>\n          encodeFunctionData({\n            abi: SessionKeyPermissionsUpdatesAbi,\n            functionName: \"setRequiredPaymaster\",\n            args: [paymaster],\n          }),\n        this._requiredPaymaster\n      ),\n    ].filter((x) => x !== \"0x\");\n  }\n\n  private encodeIfDefined<T>(encode: (param: T) => Hex, param?: T): Hex {\n    if (!param) return \"0x\";\n\n    return encode(param);\n  }\n}\n"]}