@towns-protocol/web3 0.0.191

package/LICENSE.txt

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 River Association
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,3 @@
+# web3
+
+Dapps for our Space and Registry contracts

package/dist/ContractHelpers.d.ts

@@ -0,0 +1,18 @@
+import { BigNumber, BigNumberish, ethers } from 'ethers';
+import { BasicRoleInfo, Permission, Address } from './ContractTypes';
+import { BaseChainConfig } from './IStaticContractsInfo';
+import { ISpaceDapp } from './ISpaceDapp';
+import { IArchitectBase as ISpaceArchitectBaseV3, IMembershipBase as IMembershipBaseV3 } from './v3';
+export declare function mintMockNFT(provider: ethers.providers.Provider, config: BaseChainConfig, fromWallet: ethers.Wallet, toAddress: string): Promise<ethers.ContractTransaction>;
+export declare function balanceOfMockNFT(config: BaseChainConfig, provider: ethers.providers.Provider, address: Address): Promise<BigNumber>;
+export declare function getTestGatingNftAddress(_chainId: number): Promise<Address>;
+export declare function getFilteredRolesFromSpace(spaceDapp: ISpaceDapp, spaceNetworkId: string): Promise<BasicRoleInfo[]>;
+export declare function isRoleIdInArray(roleIds: BigNumber[] | readonly bigint[], roleId: BigNumberish | bigint): boolean;
+type CreateMembershipStructArgs = {
+    name: string;
+    permissions: Permission[];
+    requirements: ISpaceArchitectBaseV3.MembershipRequirementsStruct;
+} & Omit<IMembershipBaseV3.MembershipStruct, 'symbol' | 'price' | 'maxSupply' | 'duration' | 'currency' | 'feeRecipient' | 'freeAllocation' | 'pricingModule'>;
+export declare function createMembershipStruct(args: CreateMembershipStructArgs): ISpaceArchitectBaseV3.MembershipStruct;
+export {};
+//# sourceMappingURL=ContractHelpers.d.ts.map

package/dist/ContractHelpers.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContractHelpers.d.ts","sourceRoot":"","sources":["../src/ContractHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,YAAY,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAExD,OAAO,EAAE,aAAa,EAAE,UAAU,EAAE,OAAO,EAAE,MAAM,iBAAiB,CAAA;AACpE,OAAO,EAAE,eAAe,EAAE,MAAM,wBAAwB,CAAA;AACxD,OAAO,EAAE,UAAU,EAAE,MAAM,cAAc,CAAA;AACzC,OAAO,EACH,cAAc,IAAI,qBAAqB,EAEvC,eAAe,IAAI,iBAAiB,EACvC,MAAM,MAAM,CAAA;AAIb,wBAAgB,WAAW,CACvB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,MAAM,EAAE,eAAe,EACvB,UAAU,EAAE,MAAM,CAAC,MAAM,EACzB,SAAS,EAAE,MAAM,GAClB,OAAO,CAAC,MAAM,CAAC,mBAAmB,CAAC,CAOrC;AAED,wBAAgB,gBAAgB,CAC5B,MAAM,EAAE,eAAe,EACvB,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,QAAQ,EACnC,OAAO,EAAE,OAAO,sBAQnB;AAED,wBAAsB,uBAAuB,CAAC,QAAQ,EAAE,MAAM,GAAG,OAAO,CAAC,OAAO,CAAC,CAEhF;AAED,wBAAsB,yBAAyB,CAC3C,SAAS,EAAE,UAAU,EACrB,cAAc,EAAE,MAAM,GACvB,OAAO,CAAC,aAAa,EAAE,CAAC,CAW1B;AAED,wBAAgB,eAAe,CAC3B,OAAO,EAAE,SAAS,EAAE,GAAG,SAAS,MAAM,EAAE,EACxC,MAAM,EAAE,YAAY,GAAG,MAAM,GAC9B,OAAO,CAOT;AAYD,KAAK,0BAA0B,GAAG;IAC9B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,UAAU,EAAE,CAAA;IACzB,YAAY,EAAE,qBAAqB,CAAC,4BAA4B,CAAA;CACnE,GAAG,IAAI,CACJ,iBAAiB,CAAC,gBAAgB,EAChC,QAAQ,GACR,OAAO,GACP,WAAW,GACX,UAAU,GACV,UAAU,GACV,cAAc,GACd,gBAAgB,GAChB,eAAe,CACpB,CAAA;AAuBD,wBAAgB,sBAAsB,CAAC,IAAI,EAAE,0BAA0B,0CAOtE"}

package/dist/ContractHelpers.js

@@ -0,0 +1,75 @@
+import { ethers } from 'ethers';
+import { MockERC721AShim as MockERC721AShimV3, } from './v3';
+import { getTestGatingNFTContractAddress } from './TestGatingNFT';
+export function mintMockNFT(provider, config, fromWallet, toAddress) {
+    if (!config.addresses.utils.mockNFT) {
+        throw new Error('No mock ERC721 address provided');
+    }
+    const mockNFTAddress = config.addresses.utils.mockNFT;
+    const mockNFT = new MockERC721AShimV3(mockNFTAddress, provider);
+    return mockNFT.write(fromWallet).mintTo(toAddress);
+}
+export function balanceOfMockNFT(config, provider, address) {
+    if (!config.addresses.utils.mockNFT) {
+        throw new Error('No mock ERC721 address provided');
+    }
+    const mockNFTAddress = config.addresses.utils.mockNFT;
+    const mockNFT = new MockERC721AShimV3(mockNFTAddress, provider);
+    return mockNFT.read.balanceOf(address);
+}
+export async function getTestGatingNftAddress(_chainId) {
+    return await getTestGatingNFTContractAddress();
+}
+export async function getFilteredRolesFromSpace(spaceDapp, spaceNetworkId) {
+    const spaceRoles = await spaceDapp.getRoles(spaceNetworkId);
+    const filteredRoles = [];
+    // Filter out space roles which won't work when creating a channel
+    for (const r of spaceRoles) {
+        // Filter out roles which have no permissions & the Owner role
+        if (r.name !== 'Owner') {
+            filteredRoles.push(r);
+        }
+    }
+    return filteredRoles;
+}
+export function isRoleIdInArray(roleIds, roleId) {
+    for (const r of roleIds) {
+        if (r.eq(roleId)) {
+            return true;
+        }
+    }
+    return false;
+}
+/**
+ * TODO: these are only used in tests, should move them to different file?
+ */
+function isMembershipStructV3(returnValue) {
+    return typeof returnValue.settings.price === 'number';
+}
+function _createMembershipStruct({ name, permissions, requirements, }) {
+    return {
+        settings: {
+            name,
+            symbol: 'MEMBER',
+            price: 0,
+            maxSupply: 1000,
+            duration: 0,
+            currency: ethers.constants.AddressZero,
+            feeRecipient: ethers.constants.AddressZero,
+            freeAllocation: 0,
+            pricingModule: ethers.constants.AddressZero,
+        },
+        permissions,
+        requirements,
+    };
+}
+export function createMembershipStruct(args) {
+    const result = _createMembershipStruct(args);
+    if (isMembershipStructV3(result)) {
+        return result;
+    }
+    else {
+        throw new Error("createMembershipStruct: version is not 'v3'");
+    }
+}
+//# sourceMappingURL=ContractHelpers.js.map

package/dist/ContractHelpers.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContractHelpers.js","sourceRoot":"","sources":["../src/ContractHelpers.ts"],"names":[],"mappings":"AAAA,OAAO,EAA2B,MAAM,EAAE,MAAM,QAAQ,CAAA;AAKxD,OAAO,EAEH,eAAe,IAAI,iBAAiB,GAEvC,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,+BAA+B,EAAE,MAAM,iBAAiB,CAAA;AAEjE,MAAM,UAAU,WAAW,CACvB,QAAmC,EACnC,MAAuB,EACvB,UAAyB,EACzB,SAAiB;IAEjB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;IACtD,CAAC;IACD,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAA;IACrD,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IAC/D,OAAO,OAAO,CAAC,KAAK,CAAC,UAAU,CAAC,CAAC,MAAM,CAAC,SAAS,CAAC,CAAA;AACtD,CAAC;AAED,MAAM,UAAU,gBAAgB,CAC5B,MAAuB,EACvB,QAAmC,EACnC,OAAgB;IAEhB,IAAI,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,EAAE,CAAC;QAClC,MAAM,IAAI,KAAK,CAAC,iCAAiC,CAAC,CAAA;IACtD,CAAC;IACD,MAAM,cAAc,GAAG,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,OAAO,CAAA;IACrD,MAAM,OAAO,GAAG,IAAI,iBAAiB,CAAC,cAAc,EAAE,QAAQ,CAAC,CAAA;IAC/D,OAAO,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAA;AAC1C,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,uBAAuB,CAAC,QAAgB;IAC1D,OAAO,MAAM,+BAA+B,EAAE,CAAA;AAClD,CAAC;AAED,MAAM,CAAC,KAAK,UAAU,yBAAyB,CAC3C,SAAqB,EACrB,cAAsB;IAEtB,MAAM,UAAU,GAAG,MAAM,SAAS,CAAC,QAAQ,CAAC,cAAc,CAAC,CAAA;IAC3D,MAAM,aAAa,GAAoB,EAAE,CAAA;IACzC,kEAAkE;IAClE,KAAK,MAAM,CAAC,IAAI,UAAU,EAAE,CAAC;QACzB,8DAA8D;QAC9D,IAAI,CAAC,CAAC,IAAI,KAAK,OAAO,EAAE,CAAC;YACrB,aAAa,CAAC,IAAI,CAAC,CAAC,CAAC,CAAA;QACzB,CAAC;IACL,CAAC;IACD,OAAO,aAAa,CAAA;AACxB,CAAC;AAED,MAAM,UAAU,eAAe,CAC3B,OAAwC,EACxC,MAA6B;IAE7B,KAAK,MAAM,CAAC,IAAI,OAAsB,EAAE,CAAC;QACrC,IAAI,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,CAAC;YACf,OAAO,IAAI,CAAA;QACf,CAAC;IACL,CAAC;IACD,OAAO,KAAK,CAAA;AAChB,CAAC;AAED;;GAEG;AAEH,SAAS,oBAAoB,CACzB,WAAmD;IAEnD,OAAO,OAAO,WAAW,CAAC,QAAQ,CAAC,KAAK,KAAK,QAAQ,CAAA;AACzD,CAAC;AAiBD,SAAS,uBAAuB,CAAC,EAC7B,IAAI,EACJ,WAAW,EACX,YAAY,GACa;IACzB,OAAO;QACH,QAAQ,EAAE;YACN,IAAI;YACJ,MAAM,EAAE,QAAQ;YAChB,KAAK,EAAE,CAAC;YACR,SAAS,EAAE,IAAI;YACf,QAAQ,EAAE,CAAC;YACX,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,WAAW;YACtC,YAAY,EAAE,MAAM,CAAC,SAAS,CAAC,WAAW;YAC1C,cAAc,EAAE,CAAC;YACjB,aAAa,EAAE,MAAM,CAAC,SAAS,CAAC,WAAW;SAC9C;QACD,WAAW;QACX,YAAY;KACf,CAAA;AACL,CAAC;AAED,MAAM,UAAU,sBAAsB,CAAC,IAAgC;IACnE,MAAM,MAAM,GAAG,uBAAuB,CAAC,IAAI,CAAC,CAAA;IAC5C,IAAI,oBAAoB,CAAC,MAAM,CAAC,EAAE,CAAC;QAC/B,OAAO,MAAM,CAAA;IACjB,CAAC;SAAM,CAAC;QACJ,MAAM,IAAI,KAAK,CAAC,6CAA6C,CAAC,CAAA;IAClE,CAAC;AACL,CAAC"}

package/dist/ContractTypes.d.ts

@@ -0,0 +1,143 @@
+import { UserEntitlementShim as UserEntitlementShimV3 } from './v3/UserEntitlementShim';
+import { IMembershipBase as IMembershipBaseV3, IArchitectBase as ISpaceArchitectBaseV3 } from './v3/ICreateSpaceShim';
+import { ILegacyArchitectBase } from './v3/ILegacySpaceArchitectShim';
+import { IRolesBase as IRolesBaseV3 } from './v3/IRolesShim';
+import { RuleEntitlementShim } from './v3/RuleEntitlementShim';
+import { IRuleEntitlementBase, IRuleEntitlementV2Base } from './v3';
+import { IPricingModulesBase } from './v3/IPricingShim';
+import { RuleEntitlementV2Shim } from './v3/RuleEntitlementV2Shim';
+import { CreateSpaceParams, CreateLegacySpaceParams, UpdateChannelParams, UpdateChannelAccessParams } from './ISpaceDapp';
+export declare const Permission: {
+    /** No permission required. */
+    readonly Undefined: "Undefined";
+    /** Read event permission. */
+    readonly Read: "Read";
+    /** Write event permission. */
+    readonly Write: "Write";
+    /** Invite user permission. */
+    readonly Invite: "Invite";
+    /** Join space permission. */
+    readonly JoinSpace: "JoinSpace";
+    /** Redact events permission. */
+    readonly Redact: "Redact";
+    /** Modify or ban user permission. */
+    readonly ModifyBanning: "ModifyBanning";
+    /** Pin/unpin events permission. */
+    readonly PinMessage: "PinMessage";
+    /** Add or remove channels permission. */
+    readonly AddRemoveChannels: "AddRemoveChannels";
+    /** Modify space settings permission. */
+    readonly ModifySpaceSettings: "ModifySpaceSettings";
+    /** React to a message permission. */
+    readonly React: "React";
+};
+export type Permission = (typeof Permission)[keyof typeof Permission];
+export type EntitlementShim = UserEntitlementShimV3 | RuleEntitlementShim | RuleEntitlementV2Shim;
+export type EntitlementStruct = IRolesBaseV3.CreateEntitlementStruct;
+type UserEntitlementShim = UserEntitlementShimV3;
+type MembershipInfoStruct = IMembershipBaseV3.MembershipStruct;
+type TotalSupplyOutputStruct = {
+    totalSupply: number;
+};
+export type MembershipStruct = ISpaceArchitectBaseV3.MembershipStruct;
+export type LegacyMembershipStruct = ILegacyArchitectBase.MembershipStruct;
+export type MembershipRequirementsStruct = ISpaceArchitectBaseV3.MembershipRequirementsStruct;
+export type LegacyMembershipRequirementsStruct = ILegacyArchitectBase.MembershipRequirementsStruct;
+export type SpaceInfoStruct = ISpaceArchitectBaseV3.SpaceInfoStruct;
+export type LegacySpaceInfoStruct = ILegacyArchitectBase.SpaceInfoStruct;
+export type PricingModuleStruct = IPricingModulesBase.PricingModuleStruct;
+/**
+ * Supported entitlement modules
+ */
+export declare enum EntitlementModuleType {
+    UserEntitlement = "UserEntitlement",
+    RuleEntitlement = "RuleEntitlement",
+    RuleEntitlementV2 = "RuleEntitlementV2"
+}
+export declare function isLegacyMembershipType(object: MembershipStruct | LegacyMembershipStruct): object is LegacyMembershipStruct;
+export declare function isCreateLegacySpaceParams(object: CreateSpaceParams | CreateLegacySpaceParams): object is CreateLegacySpaceParams;
+export declare function isRuleDataV1(ruleData: IRuleEntitlementBase.RuleDataStruct | IRuleEntitlementV2Base.RuleDataV2Struct): ruleData is IRuleEntitlementBase.RuleDataStruct;
+/**
+ * Role details from multiple contract sources
+ */
+interface RuleDataV1 {
+    kind: 'v1';
+    rules: IRuleEntitlementBase.RuleDataStruct;
+}
+interface RuleDataV2 {
+    kind: 'v2';
+    rules: IRuleEntitlementV2Base.RuleDataV2Struct;
+}
+export type VersionedRuleData = RuleDataV1 | RuleDataV2;
+export interface RoleDetails {
+    id: number;
+    name: string;
+    permissions: Permission[];
+    users: string[];
+    ruleData: VersionedRuleData;
+    channels: ChannelMetadata[];
+}
+/**
+ * Basic channel metadata from the space contract.
+ */
+export interface ChannelMetadata {
+    name: string;
+    description?: string;
+    channelNetworkId: string;
+    disabled: boolean;
+}
+/**
+ * Channel details from multiple contract sources
+ */
+export interface ChannelDetails {
+    /** The River `spaceId` which this channel belongs. */
+    spaceNetworkId: string;
+    /** The River `channelId` of the channel. */
+    channelNetworkId: string;
+    /** The name of the channel. */
+    name: string;
+    /** Whether the channel is disabled. */
+    disabled: boolean;
+    /** The roles defined for the channel {@link RoleEntitlements}. */
+    roles: RoleEntitlements[];
+    /** The description of the channel. */
+    description?: string;
+}
+/** Role details for a channel from multiple contract sources */
+export interface RoleEntitlements {
+    /** The id of the role. */
+    roleId: number;
+    /** The name of the role. */
+    name: string;
+    /** The permissions that this role has. @see {@link Permission} */
+    permissions: Permission[];
+    /** The userIds that are in this role. */
+    users: string[];
+    /** @internal The River struct that represents the rule data of the role {@link VersionedRuleData}. */
+    ruleData: VersionedRuleData;
+}
+export interface EntitlementDetails {
+    users: string[];
+    ruleData: VersionedRuleData;
+}
+export interface BasicRoleInfo {
+    roleId: number;
+    name: string;
+}
+export interface EntitlementModule {
+    moduleType: EntitlementModuleType;
+}
+export declare function isPermission(permission: string): permission is Permission;
+export declare function isUserEntitlement(entitlement: EntitlementModule): entitlement is UserEntitlementShim;
+export declare function isRuleEntitlement(entitlement: EntitlementModule): entitlement is RuleEntitlementShim;
+export declare function isRuleEntitlementV2(entitlement: EntitlementModule): entitlement is RuleEntitlementV2Shim;
+export declare const isUpdateChannelStatusParams: (params: UpdateChannelParams) => params is UpdateChannelAccessParams;
+export declare function isStringArray(args: any): args is string[];
+export type MembershipInfo = Pick<MembershipInfoStruct, 'maxSupply' | 'currency' | 'feeRecipient' | 'price' | 'duration' | 'pricingModule'> & TotalSupplyInfo & {
+    prepaidSupply: number;
+    remainingFreeSupply: number;
+};
+export type TotalSupplyInfo = Pick<TotalSupplyOutputStruct, 'totalSupply'>;
+export type Address = `0x${string}`;
+export {};
+//# sourceMappingURL=ContractTypes.d.ts.map

package/dist/ContractTypes.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContractTypes.d.ts","sourceRoot":"","sources":["../src/ContractTypes.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,mBAAmB,IAAI,qBAAqB,EAAE,MAAM,0BAA0B,CAAA;AACvF,OAAO,EACH,eAAe,IAAI,iBAAiB,EACpC,cAAc,IAAI,qBAAqB,EAC1C,MAAM,uBAAuB,CAAA;AAC9B,OAAO,EAAE,oBAAoB,EAAE,MAAM,gCAAgC,CAAA;AACrE,OAAO,EAAE,UAAU,IAAI,YAAY,EAAE,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EAAE,mBAAmB,EAAE,MAAM,0BAA0B,CAAA;AAC9D,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,MAAM,CAAA;AACnE,OAAO,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAA;AAEvD,OAAO,EAAE,qBAAqB,EAAE,MAAM,4BAA4B,CAAA;AAGlE,OAAO,EACH,iBAAiB,EACjB,uBAAuB,EACvB,mBAAmB,EACnB,yBAAyB,EAC5B,MAAM,cAAc,CAAA;AAErB,eAAO,MAAM,UAAU;IACnB,8BAA8B;;IAE9B,6BAA6B;;IAE7B,8BAA8B;;IAE9B,8BAA8B;;IAE9B,6BAA6B;;IAE7B,gCAAgC;;IAEhC,qCAAqC;;IAErC,mCAAmC;;IAEnC,yCAAyC;;IAEzC,wCAAwC;;IAExC,qCAAqC;;CAE/B,CAAA;AAEV,MAAM,MAAM,UAAU,GAAG,CAAC,OAAO,UAAU,CAAC,CAAC,MAAM,OAAO,UAAU,CAAC,CAAA;AAErE,MAAM,MAAM,eAAe,GAAG,qBAAqB,GAAG,mBAAmB,GAAG,qBAAqB,CAAA;AAEjG,MAAM,MAAM,iBAAiB,GAAG,YAAY,CAAC,uBAAuB,CAAA;AAEpE,KAAK,mBAAmB,GAAG,qBAAqB,CAAA;AAEhD,KAAK,oBAAoB,GAAG,iBAAiB,CAAC,gBAAgB,CAAA;AAE9D,KAAK,uBAAuB,GAAG;IAAE,WAAW,EAAE,MAAM,CAAA;CAAE,CAAA;AAEtD,MAAM,MAAM,gBAAgB,GAAG,qBAAqB,CAAC,gBAAgB,CAAA;AAErE,MAAM,MAAM,sBAAsB,GAAG,oBAAoB,CAAC,gBAAgB,CAAA;AAE1E,MAAM,MAAM,4BAA4B,GAAG,qBAAqB,CAAC,4BAA4B,CAAA;AAE7F,MAAM,MAAM,kCAAkC,GAAG,oBAAoB,CAAC,4BAA4B,CAAA;AAElG,MAAM,MAAM,eAAe,GAAG,qBAAqB,CAAC,eAAe,CAAA;AAEnE,MAAM,MAAM,qBAAqB,GAAG,oBAAoB,CAAC,eAAe,CAAA;AAExE,MAAM,MAAM,mBAAmB,GAAG,mBAAmB,CAAC,mBAAmB,CAAA;AAEzE;;GAEG;AACH,oBAAY,qBAAqB;IAC7B,eAAe,oBAAoB;IACnC,eAAe,oBAAoB;IACnC,iBAAiB,sBAAsB;CAC1C;AAED,wBAAgB,sBAAsB,CAClC,MAAM,EAAE,gBAAgB,GAAG,sBAAsB,GAClD,MAAM,IAAI,sBAAsB,CAElC;AAED,wBAAgB,yBAAyB,CACrC,MAAM,EAAE,iBAAiB,GAAG,uBAAuB,GACpD,MAAM,IAAI,uBAAuB,CAEnC;AAED,wBAAgB,YAAY,CACxB,QAAQ,EAAE,oBAAoB,CAAC,cAAc,GAAG,sBAAsB,CAAC,gBAAgB,GACxF,QAAQ,IAAI,oBAAoB,CAAC,cAAc,CAEjD;AAED;;GAEG;AAEH,UAAU,UAAU;IAChB,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,oBAAoB,CAAC,cAAc,CAAA;CAC7C;AACD,UAAU,UAAU;IAChB,IAAI,EAAE,IAAI,CAAA;IACV,KAAK,EAAE,sBAAsB,CAAC,gBAAgB,CAAA;CACjD;AAED,MAAM,MAAM,iBAAiB,GAAG,UAAU,GAAG,UAAU,CAAA;AAEvD,MAAM,WAAW,WAAW;IACxB,EAAE,EAAE,MAAM,CAAA;IACV,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,EAAE,UAAU,EAAE,CAAA;IACzB,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,QAAQ,EAAE,iBAAiB,CAAA;IAC3B,QAAQ,EAAE,eAAe,EAAE,CAAA;CAC9B;AAED;;GAEG;AACH,MAAM,WAAW,eAAe;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,gBAAgB,EAAE,MAAM,CAAA;IACxB,QAAQ,EAAE,OAAO,CAAA;CACpB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC3B,sDAAsD;IACtD,cAAc,EAAE,MAAM,CAAA;IACtB,4CAA4C;IAC5C,gBAAgB,EAAE,MAAM,CAAA;IACxB,+BAA+B;IAC/B,IAAI,EAAE,MAAM,CAAA;IACZ,uCAAuC;IACvC,QAAQ,EAAE,OAAO,CAAA;IACjB,kEAAkE;IAClE,KAAK,EAAE,gBAAgB,EAAE,CAAA;IACzB,sCAAsC;IACtC,WAAW,CAAC,EAAE,MAAM,CAAA;CACvB;AAED,gEAAgE;AAChE,MAAM,WAAW,gBAAgB;IAC7B,0BAA0B;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,4BAA4B;IAC5B,IAAI,EAAE,MAAM,CAAA;IACZ,kEAAkE;IAClE,WAAW,EAAE,UAAU,EAAE,CAAA;IACzB,yCAAyC;IACzC,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,sGAAsG;IACtG,QAAQ,EAAE,iBAAiB,CAAA;CAC9B;AAKD,MAAM,WAAW,kBAAkB;IAC/B,KAAK,EAAE,MAAM,EAAE,CAAA;IACf,QAAQ,EAAE,iBAAiB,CAAA;CAC9B;AAED,MAAM,WAAW,aAAa;IAC1B,MAAM,EAAE,MAAM,CAAA;IACd,IAAI,EAAE,MAAM,CAAA;CACf;AAED,MAAM,WAAW,iBAAiB;IAC9B,UAAU,EAAE,qBAAqB,CAAA;CACpC;AAED,wBAAgB,YAAY,CAAC,UAAU,EAAE,MAAM,GAAG,UAAU,IAAI,UAAU,CAEzE;AAED,wBAAgB,iBAAiB,CAC7B,WAAW,EAAE,iBAAiB,GAC/B,WAAW,IAAI,mBAAmB,CAEpC;AAED,wBAAgB,iBAAiB,CAC7B,WAAW,EAAE,iBAAiB,GAC/B,WAAW,IAAI,mBAAmB,CAEpC;AAED,wBAAgB,mBAAmB,CAC/B,WAAW,EAAE,iBAAiB,GAC/B,WAAW,IAAI,qBAAqB,CAEtC;AAED,eAAO,MAAM,2BAA2B,GACpC,QAAQ,mBAAmB,KAC5B,MAAM,IAAI,yBAKZ,CAAA;AAED,wBAAgB,aAAa,CAEzB,IAAI,EAAE,GAAG,GACV,IAAI,IAAI,MAAM,EAAE,CAElB;AAED,MAAM,MAAM,cAAc,GAAG,IAAI,CAC7B,oBAAoB,EACpB,WAAW,GAAG,UAAU,GAAG,cAAc,GAAG,OAAO,GAAG,UAAU,GAAG,eAAe,CACrF,GACG,eAAe,GAAG;IACd,aAAa,EAAE,MAAM,CAAA;IACrB,mBAAmB,EAAE,MAAM,CAAA;CAC9B,CAAA;AAEL,MAAM,MAAM,eAAe,GAAG,IAAI,CAAC,uBAAuB,EAAE,aAAa,CAAC,CAAA;AAE1E,MAAM,MAAM,OAAO,GAAG,KAAK,MAAM,EAAE,CAAA"}

package/dist/ContractTypes.js

@@ -0,0 +1,65 @@
+import { NoopRuleData } from './entitlement';
+export const Permission = {
+    /** No permission required. */
+    Undefined: 'Undefined',
+    /** Read event permission. */
+    Read: 'Read',
+    /** Write event permission. */
+    Write: 'Write',
+    /** Invite user permission. */
+    Invite: 'Invite',
+    /** Join space permission. */
+    JoinSpace: 'JoinSpace',
+    /** Redact events permission. */
+    Redact: 'Redact',
+    /** Modify or ban user permission. */
+    ModifyBanning: 'ModifyBanning',
+    /** Pin/unpin events permission. */
+    PinMessage: 'PinMessage',
+    /** Add or remove channels permission. */
+    AddRemoveChannels: 'AddRemoveChannels',
+    /** Modify space settings permission. */
+    ModifySpaceSettings: 'ModifySpaceSettings',
+    /** React to a message permission. */
+    React: 'React',
+};
+/**
+ * Supported entitlement modules
+ */
+export var EntitlementModuleType;
+(function (EntitlementModuleType) {
+    EntitlementModuleType["UserEntitlement"] = "UserEntitlement";
+    EntitlementModuleType["RuleEntitlement"] = "RuleEntitlement";
+    EntitlementModuleType["RuleEntitlementV2"] = "RuleEntitlementV2";
+})(EntitlementModuleType || (EntitlementModuleType = {}));
+export function isLegacyMembershipType(object) {
+    return typeof object.requirements.ruleData === typeof NoopRuleData;
+}
+export function isCreateLegacySpaceParams(object) {
+    return typeof object.membership.requirements.ruleData === typeof NoopRuleData;
+}
+export function isRuleDataV1(ruleData) {
+    return ruleData.checkOperations.length === 0 || 'threshold' in ruleData.checkOperations[0];
+}
+export function isPermission(permission) {
+    return Object.values(Permission).includes(permission);
+}
+export function isUserEntitlement(entitlement) {
+    return entitlement.moduleType === EntitlementModuleType.UserEntitlement;
+}
+export function isRuleEntitlement(entitlement) {
+    return entitlement.moduleType === EntitlementModuleType.RuleEntitlement;
+}
+export function isRuleEntitlementV2(entitlement) {
+    return entitlement.moduleType === EntitlementModuleType.RuleEntitlementV2;
+}
+export const isUpdateChannelStatusParams = (params) => {
+    return ('disabled' in params &&
+        !('roleIds' in params || 'channelName' in params || 'channelDescription' in params));
+};
+export function isStringArray(
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+args) {
+    return Array.isArray(args) && args.length > 0 && args.every((arg) => typeof arg === 'string');
+}
+//# sourceMappingURL=ContractTypes.js.map

package/dist/ContractTypes.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ContractTypes.js","sourceRoot":"","sources":["../src/ContractTypes.ts"],"names":[],"mappings":"AAYA,OAAO,EAAE,YAAY,EAAE,MAAM,eAAe,CAAA;AAS5C,MAAM,CAAC,MAAM,UAAU,GAAG;IACtB,8BAA8B;IAC9B,SAAS,EAAE,WAAW;IACtB,6BAA6B;IAC7B,IAAI,EAAE,MAAM;IACZ,8BAA8B;IAC9B,KAAK,EAAE,OAAO;IACd,8BAA8B;IAC9B,MAAM,EAAE,QAAQ;IAChB,6BAA6B;IAC7B,SAAS,EAAE,WAAW;IACtB,gCAAgC;IAChC,MAAM,EAAE,QAAQ;IAChB,qCAAqC;IACrC,aAAa,EAAE,eAAe;IAC9B,mCAAmC;IACnC,UAAU,EAAE,YAAY;IACxB,yCAAyC;IACzC,iBAAiB,EAAE,mBAAmB;IACtC,wCAAwC;IACxC,mBAAmB,EAAE,qBAAqB;IAC1C,qCAAqC;IACrC,KAAK,EAAE,OAAO;CACR,CAAA;AA4BV;;GAEG;AACH,MAAM,CAAN,IAAY,qBAIX;AAJD,WAAY,qBAAqB;IAC7B,4DAAmC,CAAA;IACnC,4DAAmC,CAAA;IACnC,gEAAuC,CAAA;AAC3C,CAAC,EAJW,qBAAqB,KAArB,qBAAqB,QAIhC;AAED,MAAM,UAAU,sBAAsB,CAClC,MAAiD;IAEjD,OAAO,OAAO,MAAM,CAAC,YAAY,CAAC,QAAQ,KAAK,OAAO,YAAY,CAAA;AACtE,CAAC;AAED,MAAM,UAAU,yBAAyB,CACrC,MAAmD;IAEnD,OAAO,OAAO,MAAM,CAAC,UAAU,CAAC,YAAY,CAAC,QAAQ,KAAK,OAAO,YAAY,CAAA;AACjF,CAAC;AAED,MAAM,UAAU,YAAY,CACxB,QAAuF;IAEvF,OAAO,QAAQ,CAAC,eAAe,CAAC,MAAM,KAAK,CAAC,IAAI,WAAW,IAAI,QAAQ,CAAC,eAAe,CAAC,CAAC,CAAC,CAAA;AAC9F,CAAC;AAqFD,MAAM,UAAU,YAAY,CAAC,UAAkB;IAC3C,OAAO,MAAM,CAAC,MAAM,CAAC,UAAU,CAAC,CAAC,QAAQ,CAAC,UAAwB,CAAC,CAAA;AACvE,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC7B,WAA8B;IAE9B,OAAO,WAAW,CAAC,UAAU,KAAK,qBAAqB,CAAC,eAAe,CAAA;AAC3E,CAAC;AAED,MAAM,UAAU,iBAAiB,CAC7B,WAA8B;IAE9B,OAAO,WAAW,CAAC,UAAU,KAAK,qBAAqB,CAAC,eAAe,CAAA;AAC3E,CAAC;AAED,MAAM,UAAU,mBAAmB,CAC/B,WAA8B;IAE9B,OAAO,WAAW,CAAC,UAAU,KAAK,qBAAqB,CAAC,iBAAiB,CAAA;AAC7E,CAAC;AAED,MAAM,CAAC,MAAM,2BAA2B,GAAG,CACvC,MAA2B,EACQ,EAAE;IACrC,OAAO,CACH,UAAU,IAAI,MAAM;QACpB,CAAC,CAAC,SAAS,IAAI,MAAM,IAAI,aAAa,IAAI,MAAM,IAAI,oBAAoB,IAAI,MAAM,CAAC,CACtF,CAAA;AACL,CAAC,CAAA;AAED,MAAM,UAAU,aAAa;AACzB,8DAA8D;AAC9D,IAAS;IAET,OAAO,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,OAAO,GAAG,KAAK,QAAQ,CAAC,CAAA;AACjG,CAAC"}

package/dist/ConvertersEntitlements.d.ts

@@ -0,0 +1,10 @@
+import { Address, EntitlementStruct } from './ContractTypes';
+import { IRuleEntitlementBase, IRuleEntitlementV2Base } from './v3';
+export declare function encodeUsers(users: string[] | Address[]): string;
+export declare function decodeUsers(encodedData: string): string[];
+export declare function createUserEntitlementStruct(moduleAddress: string, users: string[]): EntitlementStruct;
+export declare function createRuleEntitlementStruct(moduleAddress: Address, ruleData: IRuleEntitlementBase.RuleDataStruct): EntitlementStruct;
+export declare function createRuleEntitlementV2Struct(moduleAddress: Address, ruleData: IRuleEntitlementV2Base.RuleDataV2Struct): EntitlementStruct;
+export declare function convertRuleDataV1ToV2(ruleData: IRuleEntitlementBase.RuleDataStruct): IRuleEntitlementV2Base.RuleDataV2Struct;
+export declare function convertRuleDataV2ToV1(ruleData: IRuleEntitlementV2Base.RuleDataV2Struct): IRuleEntitlementBase.RuleDataStruct;
+//# sourceMappingURL=ConvertersEntitlements.d.ts.map

package/dist/ConvertersEntitlements.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConvertersEntitlements.d.ts","sourceRoot":"","sources":["../src/ConvertersEntitlements.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,OAAO,EAAE,iBAAiB,EAAE,MAAM,iBAAiB,CAAA;AAC5D,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,MAAM,CAAA;AAYnE,wBAAgB,WAAW,CAAC,KAAK,EAAE,MAAM,EAAE,GAAG,OAAO,EAAE,UAItD;AAED,wBAAgB,WAAW,CAAC,WAAW,EAAE,MAAM,GAAG,MAAM,EAAE,CASzD;AAED,wBAAgB,2BAA2B,CACvC,aAAa,EAAE,MAAM,EACrB,KAAK,EAAE,MAAM,EAAE,GAChB,iBAAiB,CAMnB;AAED,wBAAgB,2BAA2B,CACvC,aAAa,EAAE,OAAO,EACtB,QAAQ,EAAE,oBAAoB,CAAC,cAAc,GAC9C,iBAAiB,CAMnB;AAED,wBAAgB,6BAA6B,CACzC,aAAa,EAAE,OAAO,EACtB,QAAQ,EAAE,sBAAsB,CAAC,gBAAgB,GAClD,iBAAiB,CAMnB;AAED,wBAAgB,qBAAqB,CACjC,QAAQ,EAAE,oBAAoB,CAAC,cAAc,GAC9C,sBAAsB,CAAC,gBAAgB,CA+CzC;AAED,wBAAgB,qBAAqB,CACjC,QAAQ,EAAE,sBAAsB,CAAC,gBAAgB,GAClD,oBAAoB,CAAC,cAAc,CA+CrC"}

package/dist/ConvertersEntitlements.js

@@ -0,0 +1,120 @@
+import { ethers } from 'ethers';
+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,
+    };
+}
+//# sourceMappingURL=ConvertersEntitlements.js.map

package/dist/ConvertersEntitlements.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConvertersEntitlements.js","sourceRoot":"","sources":["../src/ConvertersEntitlements.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAI/B,OAAO,EACH,kBAAkB,EAClB,cAAc,EACd,gBAAgB,EAChB,qBAAqB,EACrB,qBAAqB,GACxB,MAAM,eAAe,CAAA;AAGtB,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"}

package/dist/ConvertersRoles.d.ts

@@ -0,0 +1,8 @@
+import { Permission, EntitlementStruct, MembershipStruct, LegacyMembershipStruct } from './ContractTypes';
+import { Space as SpaceV3 } from './v3/Space';
+import { IRuleEntitlementBase, IRuleEntitlementV2Base } from './v3';
+export declare function createLegacyEntitlementStruct<Space extends SpaceV3>(spaceIn: Space, users: string[], ruleData: IRuleEntitlementBase.RuleDataStruct): Promise<EntitlementStruct[]>;
+export declare function createEntitlementStruct<Space extends SpaceV3>(spaceIn: Space, users: string[], ruleData: IRuleEntitlementV2Base.RuleDataV2Struct): Promise<EntitlementStruct[]>;
+export declare function toPermissions(permissions: readonly string[]): Permission[];
+export declare function downgradeMembershipStruct(membership: MembershipStruct): LegacyMembershipStruct;
+//# sourceMappingURL=ConvertersRoles.d.ts.map

package/dist/ConvertersRoles.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConvertersRoles.d.ts","sourceRoot":"","sources":["../src/ConvertersRoles.ts"],"names":[],"mappings":"AAAA,OAAO,EAEH,UAAU,EACV,iBAAiB,EAEjB,gBAAgB,EAChB,sBAAsB,EACzB,MAAM,iBAAiB,CAAA;AAUxB,OAAO,EAAE,KAAK,IAAI,OAAO,EAAE,MAAM,YAAY,CAAA;AAC7C,OAAO,EAAE,oBAAoB,EAAE,sBAAsB,EAAE,MAAM,MAAM,CAAA;AAEnE,wBAAsB,6BAA6B,CAAC,KAAK,SAAS,OAAO,EACrE,OAAO,EAAE,KAAK,EACd,KAAK,EAAE,MAAM,EAAE,EACf,QAAQ,EAAE,oBAAoB,CAAC,cAAc,GAC9C,OAAO,CAAC,iBAAiB,EAAE,CAAC,CA2C9B;AAED,wBAAsB,uBAAuB,CAAC,KAAK,SAAS,OAAO,EAC/D,OAAO,EAAE,KAAK,EACd,KAAK,EAAE,MAAM,EAAE,EACf,QAAQ,EAAE,sBAAsB,CAAC,gBAAgB,GAClD,OAAO,CAAC,iBAAiB,EAAE,CAAC,CA2C9B;AAED,wBAAgB,aAAa,CAAC,WAAW,EAAE,SAAS,MAAM,EAAE,GAAG,UAAU,EAAE,CAK1E;AAED,wBAAgB,yBAAyB,CAAC,UAAU,EAAE,gBAAgB,GAAG,sBAAsB,CAa9F"}

package/dist/ConvertersRoles.js

@@ -0,0 +1,94 @@
+import { EntitlementModuleType, } from './ContractTypes';
+import { createRuleEntitlementStruct, createRuleEntitlementV2Struct, createUserEntitlementStruct, convertRuleDataV2ToV1, } from './ConvertersEntitlements';
+import { decodeRuleDataV2 } from './entitlement';
+export async function createLegacyEntitlementStruct(spaceIn, users, ruleData) {
+    const space = spaceIn;
+    // figure out the addresses for each entitlement module
+    const entitlementModules = await space.Entitlements.read.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.read.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;
+}
+export function toPermissions(permissions) {
+    return permissions.map((p) => {
+        const perm = p;
+        return perm;
+    });
+}
+export function downgradeMembershipStruct(membership) {
+    return {
+        requirements: {
+            ruleData: convertRuleDataV2ToV1(decodeRuleDataV2(membership.requirements.ruleData)),
+            everyone: membership.requirements.everyone,
+            users: membership.requirements.users,
+            syncEntitlements: membership.requirements.syncEntitlements,
+        },
+        permissions: membership.permissions,
+        settings: membership.settings,
+    };
+}
+//# sourceMappingURL=ConvertersRoles.js.map

package/dist/ConvertersRoles.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"ConvertersRoles.js","sourceRoot":"","sources":["../src/ConvertersRoles.ts"],"names":[],"mappings":"AAAA,OAAO,EACH,qBAAqB,GAMxB,MAAM,iBAAiB,CAAA;AACxB,OAAO,EACH,2BAA2B,EAC3B,6BAA6B,EAC7B,2BAA2B,EAC3B,qBAAqB,GACxB,MAAM,0BAA0B,CAAA;AACjC,OAAO,EAAE,gBAAgB,EAAE,MAAM,eAAe,CAAA;AAMhD,MAAM,CAAC,KAAK,UAAU,6BAA6B,CAC/C,OAAc,EACd,KAAe,EACf,QAA6C;IAE7C,MAAM,KAAK,GAAG,OAAkB,CAAA;IAChC,uDAAuD;IACvD,MAAM,kBAAkB,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,EAAE,CAAA;IAC1E,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,OAAkB,CAAA;IAChC,uDAAuD;IACvD,MAAM,kBAAkB,GAAG,MAAM,KAAK,CAAC,YAAY,CAAC,IAAI,CAAC,eAAe,EAAE,CAAA;IAC1E,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;AAED,MAAM,UAAU,aAAa,CAAC,WAA8B;IACxD,OAAO,WAAW,CAAC,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE;QACzB,MAAM,IAAI,GAAG,CAAe,CAAA;QAC5B,OAAO,IAAI,CAAA;IACf,CAAC,CAAC,CAAA;AACN,CAAC;AAED,MAAM,UAAU,yBAAyB,CAAC,UAA4B;IAClE,OAAO;QACH,YAAY,EAAE;YACV,QAAQ,EAAE,qBAAqB,CAC3B,gBAAgB,CAAC,UAAU,CAAC,YAAY,CAAC,QAAe,CAAC,CAC5D;YACD,QAAQ,EAAE,UAAU,CAAC,YAAY,CAAC,QAAQ;YAC1C,KAAK,EAAE,UAAU,CAAC,YAAY,CAAC,KAAK;YACpC,gBAAgB,EAAE,UAAU,CAAC,YAAY,CAAC,gBAAgB;SAC7D;QACD,WAAW,EAAE,UAAU,CAAC,WAAW;QACnC,QAAQ,EAAE,UAAU,CAAC,QAAQ;KAChC,CAAA;AACL,CAAC"}

package/dist/DelegateRegistry.d.ts

@@ -0,0 +1,3 @@
+import { ethers } from 'ethers';
+export declare function computeDelegatorsForProvider(provider: ethers.providers.BaseProvider, wallets: string[]): Promise<string[]>;
+//# sourceMappingURL=DelegateRegistry.d.ts.map

package/dist/DelegateRegistry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"DelegateRegistry.d.ts","sourceRoot":"","sources":["../src/DelegateRegistry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,EAAS,MAAM,QAAQ,CAAA;AAqEtC,wBAAsB,4BAA4B,CAC9C,QAAQ,EAAE,MAAM,CAAC,SAAS,CAAC,YAAY,EACvC,OAAO,EAAE,MAAM,EAAE,GAClB,OAAO,CAAC,MAAM,EAAE,CAAC,CAwBnB"}