@towns-labs/web3 2.0.1

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

@@ -0,0 +1,353 @@
+import { IRuleEntitlement, IRuleEntitlementBase } from '@towns-labs/generated/dev/typings/IRuleEntitlement.sol/IRuleEntitlement';
+import { BaseContractShim } from '../../BaseContractShim';
+import { BigNumberish, ethers } from 'ethers';
+import { EntitlementModuleType, EntitlementModule } from '../../types/ContractTypes';
+import { IRuleEntitlement__factory } from '@towns-labs/generated/dev/typings/factories/IRuleEntitlement.sol/IRuleEntitlement__factory';
+declare const abi: readonly [{
+    readonly type: "function";
+    readonly name: "description";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "encodeRuleData";
+    readonly inputs: readonly [{
+        readonly name: "data";
+        readonly type: "tuple";
+        readonly internalType: "struct IRuleEntitlementBase.RuleData";
+        readonly components: readonly [{
+            readonly name: "operations";
+            readonly type: "tuple[]";
+            readonly internalType: "struct IRuleEntitlementBase.Operation[]";
+            readonly components: readonly [{
+                readonly name: "opType";
+                readonly type: "uint8";
+                readonly internalType: "enum IRuleEntitlementBase.CombinedOperationType";
+            }, {
+                readonly name: "index";
+                readonly type: "uint8";
+                readonly internalType: "uint8";
+            }];
+        }, {
+            readonly name: "checkOperations";
+            readonly type: "tuple[]";
+            readonly internalType: "struct IRuleEntitlementBase.CheckOperation[]";
+            readonly components: readonly [{
+                readonly name: "opType";
+                readonly type: "uint8";
+                readonly internalType: "enum IRuleEntitlementBase.CheckOperationType";
+            }, {
+                readonly name: "chainId";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "contractAddress";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "threshold";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }];
+        }, {
+            readonly name: "logicalOperations";
+            readonly type: "tuple[]";
+            readonly internalType: "struct IRuleEntitlementBase.LogicalOperation[]";
+            readonly components: readonly [{
+                readonly name: "logOpType";
+                readonly type: "uint8";
+                readonly internalType: "enum IRuleEntitlementBase.LogicalOperationType";
+            }, {
+                readonly name: "leftOperationIndex";
+                readonly type: "uint8";
+                readonly internalType: "uint8";
+            }, {
+                readonly name: "rightOperationIndex";
+                readonly type: "uint8";
+                readonly internalType: "uint8";
+            }];
+        }];
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly stateMutability: "pure";
+}, {
+    readonly type: "function";
+    readonly name: "getEntitlementDataByRoleId";
+    readonly inputs: readonly [{
+        readonly name: "roleId";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "getRuleData";
+    readonly inputs: readonly [{
+        readonly name: "roleId";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "data";
+        readonly type: "tuple";
+        readonly internalType: "struct IRuleEntitlementBase.RuleData";
+        readonly components: readonly [{
+            readonly name: "operations";
+            readonly type: "tuple[]";
+            readonly internalType: "struct IRuleEntitlementBase.Operation[]";
+            readonly components: readonly [{
+                readonly name: "opType";
+                readonly type: "uint8";
+                readonly internalType: "enum IRuleEntitlementBase.CombinedOperationType";
+            }, {
+                readonly name: "index";
+                readonly type: "uint8";
+                readonly internalType: "uint8";
+            }];
+        }, {
+            readonly name: "checkOperations";
+            readonly type: "tuple[]";
+            readonly internalType: "struct IRuleEntitlementBase.CheckOperation[]";
+            readonly components: readonly [{
+                readonly name: "opType";
+                readonly type: "uint8";
+                readonly internalType: "enum IRuleEntitlementBase.CheckOperationType";
+            }, {
+                readonly name: "chainId";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }, {
+                readonly name: "contractAddress";
+                readonly type: "address";
+                readonly internalType: "address";
+            }, {
+                readonly name: "threshold";
+                readonly type: "uint256";
+                readonly internalType: "uint256";
+            }];
+        }, {
+            readonly name: "logicalOperations";
+            readonly type: "tuple[]";
+            readonly internalType: "struct IRuleEntitlementBase.LogicalOperation[]";
+            readonly components: readonly [{
+                readonly name: "logOpType";
+                readonly type: "uint8";
+                readonly internalType: "enum IRuleEntitlementBase.LogicalOperationType";
+            }, {
+                readonly name: "leftOperationIndex";
+                readonly type: "uint8";
+                readonly internalType: "uint8";
+            }, {
+                readonly name: "rightOperationIndex";
+                readonly type: "uint8";
+                readonly internalType: "uint8";
+            }];
+        }];
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "initialize";
+    readonly inputs: readonly [{
+        readonly name: "space";
+        readonly type: "address";
+        readonly internalType: "address";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "isCrosschain";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "isEntitled";
+    readonly inputs: readonly [{
+        readonly name: "channelId";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }, {
+        readonly name: "user";
+        readonly type: "address[]";
+        readonly internalType: "address[]";
+    }, {
+        readonly name: "permission";
+        readonly type: "bytes32";
+        readonly internalType: "bytes32";
+    }];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "bool";
+        readonly internalType: "bool";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "moduleType";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "name";
+    readonly inputs: readonly [];
+    readonly outputs: readonly [{
+        readonly name: "";
+        readonly type: "string";
+        readonly internalType: "string";
+    }];
+    readonly stateMutability: "view";
+}, {
+    readonly type: "function";
+    readonly name: "removeEntitlement";
+    readonly inputs: readonly [{
+        readonly name: "roleId";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "function";
+    readonly name: "setEntitlement";
+    readonly inputs: readonly [{
+        readonly name: "roleId";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }, {
+        readonly name: "entitlementData";
+        readonly type: "bytes";
+        readonly internalType: "bytes";
+    }];
+    readonly outputs: readonly [];
+    readonly stateMutability: "nonpayable";
+}, {
+    readonly type: "error";
+    readonly name: "CheckOperationsLimitReaced";
+    readonly inputs: readonly [{
+        readonly name: "limit";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "Entitlement__InvalidValue";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "Entitlement__NotAllowed";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "Entitlement__NotMember";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "Entitlement__ValueAlreadyExists";
+    readonly inputs: readonly [];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidCheckOperationIndex";
+    readonly inputs: readonly [{
+        readonly name: "operationIndex";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }, {
+        readonly name: "checkOperationsLength";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidLeftOperationIndex";
+    readonly inputs: readonly [{
+        readonly name: "leftOperationIndex";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }, {
+        readonly name: "currentOperationIndex";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidLogicalOperationIndex";
+    readonly inputs: readonly [{
+        readonly name: "operationIndex";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }, {
+        readonly name: "logicalOperationsLength";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidOperationType";
+    readonly inputs: readonly [{
+        readonly name: "opType";
+        readonly type: "uint8";
+        readonly internalType: "enum IRuleEntitlementBase.CombinedOperationType";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "InvalidRightOperationIndex";
+    readonly inputs: readonly [{
+        readonly name: "rightOperationIndex";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }, {
+        readonly name: "currentOperationIndex";
+        readonly type: "uint8";
+        readonly internalType: "uint8";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "LogicalOperationLimitReached";
+    readonly inputs: readonly [{
+        readonly name: "limit";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+}, {
+    readonly type: "error";
+    readonly name: "OperationsLimitReached";
+    readonly inputs: readonly [{
+        readonly name: "limit";
+        readonly type: "uint256";
+        readonly internalType: "uint256";
+    }];
+}], connect: typeof IRuleEntitlement__factory.connect;
+export { abi as IRuleEntitlementAbi };
+export type { IRuleEntitlementBase, IRuleEntitlement };
+export declare class RuleEntitlementShim extends BaseContractShim<typeof connect> implements EntitlementModule {
+    constructor(address: string, provider: ethers.providers.Provider);
+    get moduleType(): EntitlementModuleType;
+    getRoleEntitlement(roleId: BigNumberish): Promise<IRuleEntitlementBase.RuleDataStruct | null>;
+    decodeGetRuleData(entitlementData: string): IRuleEntitlementBase.RuleDataStruct | undefined;
+}
+//# sourceMappingURL=RuleEntitlementShim.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RuleEntitlementShim.d.ts","sourceRoot":"","sources":["../../../src/space/entitlements/RuleEntitlementShim.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,gBAAgB,EAChB,oBAAoB,EACvB,MAAM,yEAAyE,CAAA;AAChF,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AACzD,OAAO,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC7C,OAAO,EAAE,qBAAqB,EAAE,iBAAiB,EAAE,MAAM,2BAA2B,CAAA;AAEpF,OAAO,EAAE,yBAAyB,EAAE,MAAM,4FAA4F,CAAA;AAGtI,QAAA,MAAQ,GAAG;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;IAAE,OAAO,0CAA8B,CAAA;AAClD,OAAO,EAAE,GAAG,IAAI,mBAAmB,EAAE,CAAA;AACrC,YAAY,EAAE,oBAAoB,EAAE,gBAAgB,EAAE,CAAA;AAEtD,qBAAa,mBACT,SAAQ,gBAAgB,CAAC,OAAO,OAAO,CACvC,YAAW,iBAAiB;gBAEhB,OAAO,EAAE,MAAM,EAAE,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ;IAIhE,IAAW,UAAU,IAAI,qBAAqB,CAE7C;IAEY,kBAAkB,CAC3B,MAAM,EAAE,YAAY,GACrB,OAAO,CAAC,oBAAoB,CAAC,cAAc,GAAG,IAAI,CAAC;IAW/C,iBAAiB,CACpB,eAAe,EAAE,MAAM,GACxB,oBAAoB,CAAC,cAAc,GAAG,SAAS;CAiBrD"}

package/dist/space/entitlements/RuleEntitlementShim.js

@@ -0,0 +1,40 @@
+import { BaseContractShim } from '../../BaseContractShim';
+import { EntitlementModuleType } from '../../types/ContractTypes';
+import { dlogger } from '@towns-labs/utils';
+import { IRuleEntitlement__factory } from '@towns-labs/generated/dev/typings/factories/IRuleEntitlement.sol/IRuleEntitlement__factory';
+const logger = dlogger('csb:SpaceDapp:debug');
+const { abi, connect } = IRuleEntitlement__factory;
+export { abi as IRuleEntitlementAbi };
+export class RuleEntitlementShim extends BaseContractShim {
+    constructor(address, provider) {
+        super(address, provider, connect, abi);
+    }
+    get moduleType() {
+        return EntitlementModuleType.RuleEntitlement;
+    }
+    async getRoleEntitlement(roleId) {
+        if (roleId === 0) {
+            return {
+                operations: [],
+                checkOperations: [],
+                logicalOperations: [],
+            };
+        }
+        return this.read.getRuleData(roleId);
+    }
+    decodeGetRuleData(entitlementData) {
+        try {
+            const decoded = this.decodeFunctionResult('getRuleData', entitlementData);
+            if (decoded.length === 0) {
+                logger.error('RuleEntitlementShim No rule data', decoded);
+                return undefined;
+            }
+            return decoded?.length > 0 ? decoded[0] : undefined;
+        }
+        catch (error) {
+            logger.error('RuleEntitlementShim Error decoding RuleDataStruct', error);
+        }
+        return;
+    }
+}
+//# sourceMappingURL=RuleEntitlementShim.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"RuleEntitlementShim.js","sourceRoot":"","sources":["../../../src/space/entitlements/RuleEntitlementShim.ts"],"names":[],"mappings":"AAIA,OAAO,EAAE,gBAAgB,EAAE,MAAM,wBAAwB,CAAA;AAEzD,OAAO,EAAE,qBAAqB,EAAqB,MAAM,2BAA2B,CAAA;AACpF,OAAO,EAAE,OAAO,EAAE,MAAM,mBAAmB,CAAA;AAC3C,OAAO,EAAE,yBAAyB,EAAE,MAAM,4FAA4F,CAAA;AACtI,MAAM,MAAM,GAAG,OAAO,CAAC,qBAAqB,CAAC,CAAA;AAE7C,MAAM,EAAE,GAAG,EAAE,OAAO,EAAE,GAAG,yBAAyB,CAAA;AAClD,OAAO,EAAE,GAAG,IAAI,mBAAmB,EAAE,CAAA;AAGrC,MAAM,OAAO,mBACT,SAAQ,gBAAgC;IAGxC,YAAY,OAAe,EAAE,QAAmC;QAC5D,KAAK,CAAC,OAAO,EAAE,QAAQ,EAAE,OAAO,EAAE,GAAG,CAAC,CAAA;IAC1C,CAAC;IAED,IAAW,UAAU;QACjB,OAAO,qBAAqB,CAAC,eAAe,CAAA;IAChD,CAAC;IAEM,KAAK,CAAC,kBAAkB,CAC3B,MAAoB;QAEpB,IAAI,MAAM,KAAK,CAAC,EAAE,CAAC;YACf,OAAO;gBACH,UAAU,EAAE,EAAE;gBACd,eAAe,EAAE,EAAE;gBACnB,iBAAiB,EAAE,EAAE;aACxB,CAAA;QACL,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,WAAW,CAAC,MAAM,CAAC,CAAA;IACxC,CAAC;IAEM,iBAAiB,CACpB,eAAuB;QAEvB,IAAI,CAAC;YACD,MAAM,OAAO,GAAG,IAAI,CAAC,oBAAoB,CACrC,aAAa,EACb,eAAe,CACkC,CAAA;YAErD,IAAI,OAAO,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;gBACvB,MAAM,CAAC,KAAK,CAAC,kCAAkC,EAAE,OAAO,CAAC,CAAA;gBACzD,OAAO,SAAS,CAAA;YACpB,CAAC;YACD,OAAO,OAAO,EAAE,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,SAAS,CAAA;QACvD,CAAC;QAAC,OAAO,KAAK,EAAE,CAAC;YACb,MAAM,CAAC,KAAK,CAAC,mDAAmD,EAAE,KAAK,CAAC,CAAA;QAC5E,CAAC;QACD,OAAM;IACV,CAAC;CACJ"}