@towns-labs/web3 2.0.1

package/dist/space/entitlements/ConvertersEntitlements.js

@@ -0,0 +1,193 @@
+import { ethers } from 'ethers';
+import { EntitlementModuleType } from '../../types/ContractTypes';
+import { CheckOperationType, encodeRuleData, encodeRuleDataV2, encodeThresholdParams, decodeThresholdParams, } from './entitlement';
+const UserAddressesEncoding = 'address[]';
+export function encodeUsers(users) {
+    const abiCoder = ethers.utils.defaultAbiCoder;
+    const encodedData = abiCoder.encode([UserAddressesEncoding], [users]);
+    return encodedData;
+}
+export function decodeUsers(encodedData) {
+    const abiCoder = ethers.utils.defaultAbiCoder;
+    const decodedData = abiCoder.decode([UserAddressesEncoding], encodedData);
+    let u = [];
+    if (decodedData.length) {
+        // decoded value is in element 0 of the array
+        u = decodedData[0];
+    }
+    return u;
+}
+export function createUserEntitlementStruct(moduleAddress, users) {
+    const data = encodeUsers(users);
+    return {
+        module: moduleAddress,
+        data,
+    };
+}
+export function createRuleEntitlementStruct(moduleAddress, ruleData) {
+    const encoded = encodeRuleData(ruleData);
+    return {
+        module: moduleAddress,
+        data: encoded,
+    };
+}
+export function createRuleEntitlementV2Struct(moduleAddress, ruleData) {
+    const encoded = encodeRuleDataV2(ruleData);
+    return {
+        module: moduleAddress,
+        data: encoded,
+    };
+}
+export function convertRuleDataV1ToV2(ruleData) {
+    const operations = ruleData.operations.map((op) => {
+        return { ...op };
+    });
+    const logicalOperations = ruleData.logicalOperations.map((op) => {
+        return { ...op };
+    });
+    const checkOperations = ruleData.checkOperations.map((op) => {
+        switch (op.opType) {
+            case CheckOperationType.MOCK:
+            case CheckOperationType.ERC20:
+            case CheckOperationType.ERC721:
+            case CheckOperationType.ETH_BALANCE: {
+                const threshold = ethers.BigNumber.from(op.threshold).toBigInt();
+                return {
+                    opType: op.opType,
+                    chainId: op.chainId,
+                    contractAddress: op.contractAddress,
+                    params: encodeThresholdParams({ threshold }),
+                };
+            }
+            case CheckOperationType.ERC1155:
+                throw new Error('ERC1155 not supported for V1 Rule Data');
+            case CheckOperationType.ISENTITLED:
+                return {
+                    opType: op.opType,
+                    chainId: op.chainId,
+                    contractAddress: op.contractAddress,
+                    params: `0x`,
+                };
+            default:
+                throw new Error('Unsupported Check Operation Type');
+        }
+    });
+    return {
+        operations,
+        logicalOperations,
+        checkOperations,
+    };
+}
+export function convertRuleDataV2ToV1(ruleData) {
+    const operations = ruleData.operations.map((op) => {
+        return { ...op };
+    });
+    const logicalOperations = ruleData.logicalOperations.map((op) => {
+        return { ...op };
+    });
+    const checkOperations = ruleData.checkOperations.map((op) => {
+        switch (op.opType) {
+            case CheckOperationType.MOCK:
+            case CheckOperationType.ERC20:
+            case CheckOperationType.ERC721:
+            case CheckOperationType.ETH_BALANCE: {
+                const { threshold } = decodeThresholdParams(op.params);
+                return {
+                    opType: op.opType,
+                    chainId: op.chainId,
+                    contractAddress: op.contractAddress,
+                    threshold,
+                };
+            }
+            case CheckOperationType.ERC1155:
+                throw new Error('ERC1155 not supported for V1 Rule Data');
+            case CheckOperationType.ISENTITLED:
+                return {
+                    opType: op.opType,
+                    chainId: op.chainId,
+                    contractAddress: op.contractAddress,
+                    threshold: 0n,
+                };
+            default:
+                throw new Error('Unsupported Check Operation Type');
+        }
+    });
+    return {
+        operations,
+        logicalOperations,
+        checkOperations,
+    };
+}
+export async function createLegacyEntitlementStruct(spaceIn, users, ruleData) {
+    const space = spaceIn;
+    // figure out the addresses for each entitlement module
+    const entitlementModules = await space.Entitlements.getEntitlements();
+    let userEntitlementAddress;
+    let ruleEntitlementAddress;
+    for (const module of entitlementModules) {
+        switch (module.moduleType) {
+            case EntitlementModuleType.UserEntitlement:
+                userEntitlementAddress = module.moduleAddress;
+                break;
+            case EntitlementModuleType.RuleEntitlement:
+                ruleEntitlementAddress = module.moduleAddress;
+                break;
+        }
+    }
+    if (!userEntitlementAddress) {
+        throw new Error('User entitlement module address not found.');
+    }
+    if (!ruleEntitlementAddress) {
+        throw new Error('Rule entitlement module address not found.');
+    }
+    // create the entitlements array
+    const entitlements = [];
+    // create the user entitlement
+    if (users.length) {
+        const userEntitlement = createUserEntitlementStruct(userEntitlementAddress, users);
+        entitlements.push(userEntitlement);
+    }
+    if (ruleData.operations.length > 0) {
+        const ruleEntitlement = createRuleEntitlementStruct(ruleEntitlementAddress, ruleData);
+        entitlements.push(ruleEntitlement);
+    }
+    // return the converted entitlements
+    return entitlements;
+}
+export async function createEntitlementStruct(spaceIn, users, ruleData) {
+    const space = spaceIn;
+    // figure out the addresses for each entitlement module
+    const entitlementModules = await space.Entitlements.getEntitlements();
+    let userEntitlementAddress;
+    let ruleEntitlementAddress;
+    for (const module of entitlementModules) {
+        switch (module.moduleType) {
+            case EntitlementModuleType.UserEntitlement:
+                userEntitlementAddress = module.moduleAddress;
+                break;
+            case EntitlementModuleType.RuleEntitlementV2:
+                ruleEntitlementAddress = module.moduleAddress;
+                break;
+        }
+    }
+    if (!userEntitlementAddress) {
+        throw new Error('User entitlement module address not found.');
+    }
+    if (!ruleEntitlementAddress) {
+        throw new Error('Rule entitlement V2 module address not found.');
+    }
+    // create the entitlements array
+    const entitlements = [];
+    // create the user entitlement
+    if (users.length) {
+        const userEntitlement = createUserEntitlementStruct(userEntitlementAddress, users);
+        entitlements.push(userEntitlement);
+    }
+    if (ruleData.operations.length > 0) {
+        const ruleEntitlement = createRuleEntitlementV2Struct(ruleEntitlementAddress, ruleData);
+        entitlements.push(ruleEntitlement);
+    }
+    // return the converted entitlements
+    return entitlements;
+}
+//# sourceMappingURL=ConvertersEntitlements.js.map

package/dist/space/entitlements/ConvertersEntitlements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConvertersEntitlements.js","sourceRoot":"","sources":["../../../src/space/entitlements/ConvertersEntitlements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAE/B,OAAO,EAAW,qBAAqB,EAAqB,MAAM,2BAA2B,CAAA;AAG7F,OAAO,EACH,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,GACxB,MAAM,eAAe,CAAA;AAItB,MAAM,qBAAqB,GAAG,WAAW,CAAA;AAEzC,MAAM,UAAU,WAAW,CAAC,KAA2B;IACnD,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,CAAA;IAC7C,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,CAAA;IACrE,OAAO,WAAW,CAAA;AACtB,CAAC;AAED,MAAM,UAAU,WAAW,CAAC,WAAmB;IAC3C,MAAM,QAAQ,GAAG,MAAM,CAAC,KAAK,CAAC,eAAe,CAAA;IAC7C,MAAM,WAAW,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,qBAAqB,CAAC,EAAE,WAAW,CAAe,CAAA;IACvF,IAAI,CAAC,GAAa,EAAE,CAAA;IACpB,IAAI,WAAW,CAAC,MAAM,EAAE,CAAC;QACrB,6CAA6C;QAC7C,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAA;IACtB,CAAC;IACD,OAAO,CAAC,CAAA;AACZ,CAAC;AAED,MAAM,UAAU,2BAA2B,CACvC,aAAqB,EACrB,KAAe;IAEf,MAAM,IAAI,GAAG,WAAW,CAAC,KAAK,CAAC,CAAA;IAC/B,OAAO;QACH,MAAM,EAAE,aAAa;QACrB,IAAI;KACP,CAAA;AACL,CAAC;AAED,MAAM,UAAU,2BAA2B,CACvC,aAAsB,EACtB,QAA6C;IAE7C,MAAM,OAAO,GAAG,cAAc,CAAC,QAAQ,CAAC,CAAA;IACxC,OAAO;QACH,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,OAAO;KAChB,CAAA;AACL,CAAC;AAED,MAAM,UAAU,6BAA6B,CACzC,aAAsB,EACtB,QAAiD;IAEjD,MAAM,OAAO,GAAG,gBAAgB,CAAC,QAAQ,CAAC,CAAA;IAC1C,OAAO;QACH,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,OAAO;KAChB,CAAA;AACL,CAAC;AAED,MAAM,UAAU,qBAAqB,CACjC,QAA6C;IAE7C,MAAM,UAAU,GAA2C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAC9E,CAAC,EAAE,EAA0C,EAAE;QAC3C,OAAO,EAAE,GAAG,EAAE,EAAE,CAAA;IACpB,CAAC,CACJ,CAAA;IACD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC,GAAG,CACpD,CAAC,EAAE,EAAiD,EAAE;QAClD,OAAO,EAAE,GAAG,EAAE,EAAE,CAAA;IACpB,CAAC,CACJ,CAAA;IACD,MAAM,eAAe,GAAG,QAAQ,CAAC,eAAe,CAAC,GAAG,CAChD,CAAC,EAAE,EAAiD,EAAE;QAClD,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAChB,KAAK,kBAAkB,CAAC,IAAI,CAAC;YAC7B,KAAK,kBAAkB,CAAC,KAAK,CAAC;YAC9B,KAAK,kBAAkB,CAAC,MAAM,CAAC;YAC/B,KAAK,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC;gBAClC,MAAM,SAAS,GAAG,MAAM,CAAC,SAAS,CAAC,IAAI,CAAC,EAAE,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAA;gBAChE,OAAO;oBACH,MAAM,EAAE,EAAE,CAAC,MAAM;oBACjB,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,eAAe,EAAE,EAAE,CAAC,eAAe;oBACnC,MAAM,EAAE,qBAAqB,CAAC,EAAE,SAAS,EAAE,CAAC;iBAC/C,CAAA;YACL,CAAC;YACD,KAAK,kBAAkB,CAAC,OAAO;gBAC3B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;YAE7D,KAAK,kBAAkB,CAAC,UAAU;gBAC9B,OAAO;oBACH,MAAM,EAAE,EAAE,CAAC,MAAM;oBACjB,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,eAAe,EAAE,EAAE,CAAC,eAAe;oBACnC,MAAM,EAAE,IAAI;iBACf,CAAA;YAEL;gBACI,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QAC3D,CAAC;IACL,CAAC,CACJ,CAAA;IACD,OAAO;QACH,UAAU;QACV,iBAAiB;QACjB,eAAe;KACyB,CAAA;AAChD,CAAC;AAED,MAAM,UAAU,qBAAqB,CACjC,QAAiD;IAEjD,MAAM,UAAU,GAA2C,QAAQ,CAAC,UAAU,CAAC,GAAG,CAC9E,CAAC,EAAE,EAA0C,EAAE;QAC3C,OAAO,EAAE,GAAG,EAAE,EAAE,CAAA;IACpB,CAAC,CACJ,CAAA;IACD,MAAM,iBAAiB,GAAG,QAAQ,CAAC,iBAAiB,CAAC,GAAG,CACpD,CAAC,EAAE,EAAiD,EAAE;QAClD,OAAO,EAAE,GAAG,EAAE,EAAE,CAAA;IACpB,CAAC,CACJ,CAAA;IACD,MAAM,eAAe,GAAG,QAAQ,CAAC,eAAe,CAAC,GAAG,CAChD,CAAC,EAAE,EAA6C,EAAE;QAC9C,QAAQ,EAAE,CAAC,MAAM,EAAE,CAAC;YAChB,KAAK,kBAAkB,CAAC,IAAI,CAAC;YAC7B,KAAK,kBAAkB,CAAC,KAAK,CAAC;YAC9B,KAAK,kBAAkB,CAAC,MAAM,CAAC;YAC/B,KAAK,kBAAkB,CAAC,WAAW,CAAC,CAAC,CAAC;gBAClC,MAAM,EAAE,SAAS,EAAE,GAAG,qBAAqB,CAAC,EAAE,CAAC,MAAa,CAAC,CAAA;gBAC7D,OAAO;oBACH,MAAM,EAAE,EAAE,CAAC,MAAM;oBACjB,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,eAAe,EAAE,EAAE,CAAC,eAAe;oBACnC,SAAS;iBACZ,CAAA;YACL,CAAC;YACD,KAAK,kBAAkB,CAAC,OAAO;gBAC3B,MAAM,IAAI,KAAK,CAAC,wCAAwC,CAAC,CAAA;YAE7D,KAAK,kBAAkB,CAAC,UAAU;gBAC9B,OAAO;oBACH,MAAM,EAAE,EAAE,CAAC,MAAM;oBACjB,OAAO,EAAE,EAAE,CAAC,OAAO;oBACnB,eAAe,EAAE,EAAE,CAAC,eAAe;oBACnC,SAAS,EAAE,EAAE;iBAChB,CAAA;YAEL;gBACI,MAAM,IAAI,KAAK,CAAC,kCAAkC,CAAC,CAAA;QAC3D,CAAC;IACL,CAAC,CACJ,CAAA;IACD,OAAO;QACH,UAAU;QACV,iBAAiB;QACjB,eAAe;KACqB,CAAA;AAC5C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAC/C,OAAc,EACd,KAAe,EACf,QAA6C;IAE7C,MAAM,KAAK,GAAG,OAAO,CAAA;IACrB,uDAAuD;IACvD,MAAM,kBAAkB,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,CAAA;IACrE,IAAI,sBAAsB,CAAA;IAC1B,IAAI,sBAAsB,CAAA;IAC1B,KAAK,MAAM,MAAM,IAAI,kBAAkB,EAAE,CAAC;QACtC,QAAQ,MAAM,CAAC,UAAmC,EAAE,CAAC;YACjD,KAAK,qBAAqB,CAAC,eAAe;gBACtC,sBAAsB,GAAG,MAAM,CAAC,aAAa,CAAA;gBAC7C,MAAK;YACT,KAAK,qBAAqB,CAAC,eAAe;gBACtC,sBAAsB,GAAG,MAAM,CAAC,aAAa,CAAA;gBAC7C,MAAK;QACb,CAAC;IACL,CAAC;IACD,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;IACjE,CAAC;IACD,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;IACjE,CAAC;IAED,gCAAgC;IAChC,MAAM,YAAY,GAAwB,EAAE,CAAA;IAC5C,8BAA8B;IAC9B,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACf,MAAM,eAAe,GAAsB,2BAA2B,CAClE,sBAAsB,EACtB,KAAK,CACR,CAAA;QACD,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IACtC,CAAC;IAED,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,eAAe,GAAsB,2BAA2B,CAClE,sBAAsC,EACtC,QAAQ,CACX,CAAA;QACD,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IACtC,CAAC;IACD,oCAAoC;IACpC,OAAO,YAAY,CAAA;AACvB,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CACzC,OAAc,EACd,KAAe,EACf,QAAiD;IAEjD,MAAM,KAAK,GAAG,OAAO,CAAA;IACrB,uDAAuD;IACvD,MAAM,kBAAkB,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,CAAA;IACrE,IAAI,sBAAsB,CAAA;IAC1B,IAAI,sBAAsB,CAAA;IAC1B,KAAK,MAAM,MAAM,IAAI,kBAAkB,EAAE,CAAC;QACtC,QAAQ,MAAM,CAAC,UAAmC,EAAE,CAAC;YACjD,KAAK,qBAAqB,CAAC,eAAe;gBACtC,sBAAsB,GAAG,MAAM,CAAC,aAAa,CAAA;gBAC7C,MAAK;YACT,KAAK,qBAAqB,CAAC,iBAAiB;gBACxC,sBAAsB,GAAG,MAAM,CAAC,aAAa,CAAA;gBAC7C,MAAK;QACb,CAAC;IACL,CAAC;IACD,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,4CAA4C,CAAC,CAAA;IACjE,CAAC;IACD,IAAI,CAAC,sBAAsB,EAAE,CAAC;QAC1B,MAAM,IAAI,KAAK,CAAC,+CAA+C,CAAC,CAAA;IACpE,CAAC;IAED,gCAAgC;IAChC,MAAM,YAAY,GAAwB,EAAE,CAAA;IAC5C,8BAA8B;IAC9B,IAAI,KAAK,CAAC,MAAM,EAAE,CAAC;QACf,MAAM,eAAe,GAAsB,2BAA2B,CAClE,sBAAsB,EACtB,KAAK,CACR,CAAA;QACD,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IACtC,CAAC;IAED,IAAI,QAAQ,CAAC,UAAU,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACjC,MAAM,eAAe,GAAsB,6BAA6B,CACpE,sBAAiC,EACjC,QAAQ,CACX,CAAA;QACD,YAAY,CAAC,IAAI,CAAC,eAAe,CAAC,CAAA;IACtC,CAAC;IACD,oCAAoC;IACpC,OAAO,YAAY,CAAA;AACvB,CAAC"}

package/dist/space/entitlements/RuleBuilder.d.ts

@@ -0,0 +1,83 @@
+import { type Address, type Hex } from 'viem';
+import { CheckOperationType, type Operation, LogicalOperationType, OperationType } from './entitlement';
+export interface RuleCheckErc20Params {
+    chainId: bigint;
+    contractAddress: Address;
+    threshold: bigint;
+}
+export interface RuleCheckErc721Params {
+    chainId: bigint;
+    contractAddress: Address;
+    threshold: bigint;
+}
+export interface RuleCheckErc1155Params {
+    chainId: bigint;
+    contractAddress: Address;
+    threshold: bigint;
+    tokenId: bigint;
+}
+export interface RuleCheckEthBalanceParams {
+    threshold: bigint;
+}
+export interface RuleCheckIsEntitledParams {
+    chainId: bigint;
+    contractAddress: Address;
+    params?: Hex;
+}
+/** Convert a rule tree to encoded Hex data for smart contracts. */
+export declare const createRule: (operation: Operation) => Hex;
+/** Convert a rule tree to ethers typing IRuleEntitlementBase.RuleDataV2Struct */
+export declare const createRuleStruct: (operation: Operation) => import("@towns-labs/generated/dev/typings/IRuleEntitlement.sol/IRuleEntitlementV2").IRuleEntitlementBase.RuleDataV2Struct;
+export declare const Rules: {
+    and: (left: Operation, right: Operation) => {
+        opType: OperationType.LOGICAL;
+        logicalType: LogicalOperationType.AND;
+        leftOperation: Operation;
+        rightOperation: Operation;
+    };
+    or: (left: Operation, right: Operation) => {
+        opType: OperationType.LOGICAL;
+        logicalType: LogicalOperationType.OR;
+        leftOperation: Operation;
+        rightOperation: Operation;
+    };
+    checkErc1155: (params: RuleCheckErc1155Params) => {
+        opType: OperationType.CHECK;
+        checkType: CheckOperationType.ERC1155;
+        chainId: bigint;
+        contractAddress: `0x${string}`;
+        params: `0x${string}`;
+    };
+    checkErc20: (params: RuleCheckErc20Params) => {
+        opType: OperationType.CHECK;
+        checkType: CheckOperationType.ERC20;
+        chainId: bigint;
+        contractAddress: `0x${string}`;
+        params: `0x${string}`;
+    };
+    checkErc721: (params: RuleCheckErc721Params) => {
+        opType: OperationType.CHECK;
+        checkType: CheckOperationType.ERC721;
+        chainId: bigint;
+        contractAddress: `0x${string}`;
+        params: `0x${string}`;
+    };
+    checkEthBalance: (params: RuleCheckEthBalanceParams) => {
+        opType: OperationType.CHECK;
+        checkType: CheckOperationType.ETH_BALANCE;
+        chainId: bigint;
+        contractAddress: "0x0000000000000000000000000000000000000000";
+        params: `0x${string}`;
+    };
+    checkIsEntitled: (params: RuleCheckIsEntitledParams) => {
+        opType: OperationType.CHECK;
+        checkType: CheckOperationType.ISENTITLED;
+        chainId: bigint;
+        contractAddress: `0x${string}`;
+        params: `0x${string}`;
+    };
+    every: (ops_0: Operation, ops_1: Operation, ...ops: Operation[]) => Operation;
+    some: (ops_0: Operation, ops_1: Operation, ...ops: Operation[]) => Operation;
+    noop: import("./entitlement").NoOperation;
+};
+//# sourceMappingURL=RuleBuilder.d.ts.map

package/dist/space/entitlements/RuleBuilder.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"RuleBuilder.d.ts","sourceRoot":"","sources":["../../../src/space/entitlements/RuleBuilder.ts"],"names":[],"mappings":"AACA,OAAO,EAAe,KAAK,OAAO,EAAE,KAAK,GAAG,EAAE,MAAM,MAAM,CAAA;AAC1D,OAAO,EACH,kBAAkB,EAElB,KAAK,SAAS,EAEd,oBAAoB,EAEpB,aAAa,EAIhB,MAAM,eAAe,CAAA;AAEtB,MAAM,WAAW,oBAAoB;IACjC,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,OAAO,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,qBAAqB;IAClC,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,OAAO,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,sBAAsB;IACnC,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,OAAO,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;CAClB;AAGD,MAAM,WAAW,yBAAyB;IACtC,SAAS,EAAE,MAAM,CAAA;CACpB;AAED,MAAM,WAAW,yBAAyB;IACtC,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,OAAO,CAAA;IACxB,MAAM,CAAC,EAAE,GAAG,CAAA;CACf;AA8ED,mEAAmE;AACnE,eAAO,MAAM,UAAU,GAAI,WAAW,SAAS,KAAG,GAGjD,CAAA;AAED,iFAAiF;AACjF,eAAO,MAAM,gBAAgB,GAAI,WAAW,SAAS,8HAKpD,CAAA;AAED,eAAO,MAAM,KAAK;gBAvCC,SAAS,SAAS,SAAS;;;;;;eAS5B,SAAS,SAAS,SAAS;;;;;;2BAvCf,sBAAsB;;;;;;;yBApBxB,oBAAoB;;;;;;;0BAUnB,qBAAqB;;;;;;;8BAoBjB,yBAAyB;;;;;;;8BAUzB,yBAAyB;;;;;;;;;;CA4DzD,CAAA"}

package/dist/space/entitlements/RuleBuilder.js

@@ -0,0 +1,86 @@
+// Fancy wrapper on top of ./entitlement.ts to enable building rule trees in a friendlier way.
+import { zeroAddress } from 'viem';
+import { CheckOperationType, encodeThresholdParams, encodeERC1155Params, LogicalOperationType, NoopRuleData, OperationType, treeToRuleData, encodeRuleDataV2, NoopOperation, } from './entitlement';
+/** Check ERC20 token balance */
+const checkErc20 = (params) => ({
+    opType: OperationType.CHECK,
+    checkType: CheckOperationType.ERC20,
+    chainId: params.chainId,
+    contractAddress: params.contractAddress,
+    params: encodeThresholdParams({ threshold: params.threshold }),
+});
+/** Check ERC721 NFT balance */
+const checkErc721 = (params) => ({
+    opType: OperationType.CHECK,
+    checkType: CheckOperationType.ERC721,
+    chainId: params.chainId,
+    contractAddress: params.contractAddress,
+    params: encodeThresholdParams({ threshold: params.threshold }),
+});
+/** Check ERC1155 multi-token balance */
+const checkErc1155 = (params) => ({
+    opType: OperationType.CHECK,
+    checkType: CheckOperationType.ERC1155,
+    chainId: params.chainId,
+    contractAddress: params.contractAddress,
+    params: encodeERC1155Params({ threshold: params.threshold, tokenId: params.tokenId }),
+});
+/** Check native ETH balance across all ether chains */
+const checkEthBalance = (params) => ({
+    opType: OperationType.CHECK,
+    checkType: CheckOperationType.ETH_BALANCE,
+    chainId: 0n,
+    contractAddress: zeroAddress,
+    params: encodeThresholdParams({ threshold: params.threshold }),
+});
+/** Check cross-chain entitlement */
+const checkIsEntitled = (params) => ({
+    opType: OperationType.CHECK,
+    checkType: CheckOperationType.ISENTITLED,
+    chainId: params.chainId,
+    contractAddress: params.contractAddress,
+    params: params.params ?? '0x',
+});
+/** Combine two rules with AND (both must pass) */
+const and = (left, right) => ({
+    opType: OperationType.LOGICAL,
+    logicalType: LogicalOperationType.AND,
+    leftOperation: left,
+    rightOperation: right,
+});
+/** Combine two rules with OR (either must pass) */
+const or = (left, right) => ({
+    opType: OperationType.LOGICAL,
+    logicalType: LogicalOperationType.OR,
+    leftOperation: left,
+    rightOperation: right,
+});
+/** Check if ALL rules pass (variadic `and`) */
+const every = (...ops) => ops.slice(2).reduce((acc, op) => and(acc, op), and(ops[0], ops[1]));
+/** Check if ANY rule passes (variadic `or`) */
+const some = (...ops) => ops.slice(2).reduce((acc, op) => or(acc, op), or(ops[0], ops[1]));
+/** Convert a rule tree to encoded Hex data for smart contracts. */
+export const createRule = (operation) => {
+    const ruleData = treeToRuleData(operation);
+    return encodeRuleDataV2(ruleData);
+};
+/** Convert a rule tree to ethers typing IRuleEntitlementBase.RuleDataV2Struct */
+export const createRuleStruct = (operation) => {
+    if (operation.opType === OperationType.NONE) {
+        return NoopRuleData;
+    }
+    return treeToRuleData(operation);
+};
+export const Rules = {
+    and,
+    or,
+    checkErc1155,
+    checkErc20,
+    checkErc721,
+    checkEthBalance,
+    checkIsEntitled,
+    every,
+    some,
+    noop: NoopOperation,
+};
+//# sourceMappingURL=RuleBuilder.js.map

package/dist/space/entitlements/RuleBuilder.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"RuleBuilder.js","sourceRoot":"","sources":["../../../src/space/entitlements/RuleBuilder.ts"],"names":[],"mappings":"AAAA,8FAA8F;AAC9F,OAAO,EAAE,WAAW,EAA0B,MAAM,MAAM,CAAA;AAC1D,OAAO,EACH,kBAAkB,EAClB,qBAAqB,EAErB,mBAAmB,EACnB,oBAAoB,EACpB,YAAY,EACZ,aAAa,EACb,cAAc,EACd,gBAAgB,EAChB,aAAa,GAChB,MAAM,eAAe,CAAA;AAgCtB,gCAAgC;AAChC,MAAM,UAAU,GAAG,CAAC,MAA4B,EAAE,EAAE,CAChD,CAAC;IACG,MAAM,EAAE,aAAa,CAAC,KAAK;IAC3B,SAAS,EAAE,kBAAkB,CAAC,KAAK;IACnC,OAAO,EAAE,MAAM,CAAC,OAAO;IACvB,eAAe,EAAE,MAAM,CAAC,eAAe;IACvC,MAAM,EAAE,qBAAqB,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;CACjE,CAAqB,CAAA;AAE1B,+BAA+B;AAC/B,MAAM,WAAW,GAAG,CAAC,MAA6B,EAAE,EAAE,CAClD,CAAC;IACG,MAAM,EAAE,aAAa,CAAC,KAAK;IAC3B,SAAS,EAAE,kBAAkB,CAAC,MAAM;IACpC,OAAO,EAAE,MAAM,CAAC,OAAO;IACvB,eAAe,EAAE,MAAM,CAAC,eAAe;IACvC,MAAM,EAAE,qBAAqB,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;CACjE,CAAqB,CAAA;AAE1B,wCAAwC;AACxC,MAAM,YAAY,GAAG,CAAC,MAA8B,EAAE,EAAE,CACpD,CAAC;IACG,MAAM,EAAE,aAAa,CAAC,KAAK;IAC3B,SAAS,EAAE,kBAAkB,CAAC,OAAO;IACrC,OAAO,EAAE,MAAM,CAAC,OAAO;IACvB,eAAe,EAAE,MAAM,CAAC,eAAe;IACvC,MAAM,EAAE,mBAAmB,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,OAAO,EAAE,MAAM,CAAC,OAAO,EAAE,CAAC;CACxF,CAAqB,CAAA;AAE1B,uDAAuD;AACvD,MAAM,eAAe,GAAG,CAAC,MAAiC,EAAE,EAAE,CAC1D,CAAC;IACG,MAAM,EAAE,aAAa,CAAC,KAAK;IAC3B,SAAS,EAAE,kBAAkB,CAAC,WAAW;IACzC,OAAO,EAAE,EAAE;IACX,eAAe,EAAE,WAAW;IAC5B,MAAM,EAAE,qBAAqB,CAAC,EAAE,SAAS,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;CACjE,CAAqB,CAAA;AAE1B,oCAAoC;AACpC,MAAM,eAAe,GAAG,CAAC,MAAiC,EAAE,EAAE,CAC1D,CAAC;IACG,MAAM,EAAE,aAAa,CAAC,KAAK;IAC3B,SAAS,EAAE,kBAAkB,CAAC,UAAU;IACxC,OAAO,EAAE,MAAM,CAAC,OAAO;IACvB,eAAe,EAAE,MAAM,CAAC,eAAe;IACvC,MAAM,EAAE,MAAM,CAAC,MAAM,IAAI,IAAI;CAChC,CAAqB,CAAA;AAE1B,kDAAkD;AAClD,MAAM,GAAG,GAAG,CAAC,IAAe,EAAE,KAAgB,EAAE,EAAE,CAC9C,CAAC;IACG,MAAM,EAAE,aAAa,CAAC,OAAO;IAC7B,WAAW,EAAE,oBAAoB,CAAC,GAAG;IACrC,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,KAAK;CACxB,CAAqB,CAAA;AAE1B,mDAAmD;AACnD,MAAM,EAAE,GAAG,CAAC,IAAe,EAAE,KAAgB,EAAE,EAAE,CAC7C,CAAC;IACG,MAAM,EAAE,aAAa,CAAC,OAAO;IAC7B,WAAW,EAAE,oBAAoB,CAAC,EAAE;IACpC,aAAa,EAAE,IAAI;IACnB,cAAc,EAAE,KAAK;CACxB,CAAqB,CAAA;AAE1B,+CAA+C;AAC/C,MAAM,KAAK,GAAG,CAAC,GAAG,GAA2C,EAAE,EAAE,CAC7D,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAY,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAElF,+CAA+C;AAC/C,MAAM,IAAI,GAAG,CAAC,GAAG,GAA2C,EAAE,EAAE,CAC5D,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,MAAM,CAAY,CAAC,GAAG,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,GAAG,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAA;AAEhF,mEAAmE;AACnE,MAAM,CAAC,MAAM,UAAU,GAAG,CAAC,SAAoB,EAAO,EAAE;IACpD,MAAM,QAAQ,GAAG,cAAc,CAAC,SAAS,CAAC,CAAA;IAC1C,OAAO,gBAAgB,CAAC,QAAQ,CAAC,CAAA;AACrC,CAAC,CAAA;AAED,iFAAiF;AACjF,MAAM,CAAC,MAAM,gBAAgB,GAAG,CAAC,SAAoB,EAAE,EAAE;IACrD,IAAI,SAAS,CAAC,MAAM,KAAK,aAAa,CAAC,IAAI,EAAE,CAAC;QAC1C,OAAO,YAAY,CAAA;IACvB,CAAC;IACD,OAAO,cAAc,CAAC,SAAS,CAAC,CAAA;AACpC,CAAC,CAAA;AAED,MAAM,CAAC,MAAM,KAAK,GAAG;IACjB,GAAG;IACH,EAAE;IACF,YAAY;IACZ,UAAU;IACV,WAAW;IACX,eAAe;IACf,eAAe;IACf,KAAK;IACL,IAAI;IACJ,IAAI,EAAE,aAAa;CACtB,CAAA"}