@towns-labs/web3 2.0.1

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

@@ -0,0 +1,147 @@
+import { IRuleEntitlementBase, IRuleEntitlementAbi } from './RuleEntitlementShim';
+import { IRuleEntitlementV2Base, IRuleEntitlementV2Abi } from './RuleEntitlementV2Shim';
+import { DecodeFunctionResultReturnType, Hex } from 'viem';
+import { ethers } from 'ethers';
+import { Address } from '../../types/ContractTypes';
+export type XchainConfig = {
+    supportedRpcUrls: {
+        [chainId: number]: string;
+    };
+    etherNativeNetworkIds: number[];
+    ethereumNetworkIds: number[];
+    skipFetchSetup?: boolean;
+};
+export type RuleData = DecodeFunctionResultReturnType<typeof IRuleEntitlementAbi, 'getRuleData'>;
+export type RuleDataV2 = DecodeFunctionResultReturnType<typeof IRuleEntitlementV2Abi, 'getRuleDataV2'>;
+export declare enum OperationType {
+    NONE = 0,
+    CHECK = 1,
+    LOGICAL = 2
+}
+export declare enum CheckOperationType {
+    NONE = 0,
+    MOCK = 1,
+    ERC20 = 2,
+    ERC721 = 3,
+    ERC1155 = 4,
+    ISENTITLED = 5,
+    ETH_BALANCE = 6
+}
+export declare enum LogicalOperationType {
+    NONE = 0,
+    AND = 1,
+    OR = 2
+}
+export type ContractOperation = {
+    opType: OperationType;
+    index: number;
+};
+export type ContractLogicalOperation = {
+    logOpType: LogicalOperationType;
+    leftOperationIndex: number;
+    rightOperationIndex: number;
+};
+export declare function isContractLogicalOperation(operation: ContractOperation): boolean;
+export type CheckOperation = {
+    opType: OperationType.CHECK;
+    checkType: CheckOperationType;
+    chainId: bigint;
+    contractAddress: Address;
+    threshold: bigint;
+};
+export type CheckOperationV2 = {
+    opType: OperationType.CHECK;
+    checkType: CheckOperationType;
+    chainId: bigint;
+    contractAddress: Address;
+    params: Hex;
+};
+export type OrOperation = {
+    opType: OperationType.LOGICAL;
+    logicalType: LogicalOperationType.OR;
+    leftOperation: Operation;
+    rightOperation: Operation;
+};
+export type AndOperation = {
+    opType: OperationType.LOGICAL;
+    logicalType: LogicalOperationType.AND;
+    leftOperation: Operation;
+    rightOperation: Operation;
+};
+export type NoOperation = {
+    opType: OperationType.NONE;
+    index: number;
+};
+export declare const NoopOperation: NoOperation;
+export declare const NoopRuleData: {
+    operations: never[];
+    checkOperations: never[];
+    logicalOperations: never[];
+};
+export declare const EncodedNoopRuleData: `0x${string}`;
+type EntitledWalletOrZeroAddress = string;
+export type LogicalOperation = OrOperation | AndOperation;
+export type SupportedLogicalOperationType = LogicalOperation['logicalType'];
+export type Operation = CheckOperationV2 | OrOperation | AndOperation | NoOperation;
+export declare function postOrderArrayToTree(operations: Operation[]): Operation;
+export type ThresholdParams = {
+    threshold: bigint;
+};
+export declare function encodeThresholdParams(params: ThresholdParams): Hex;
+export declare function decodeThresholdParams(params: Hex): Readonly<ThresholdParams>;
+export type ERC1155Params = {
+    threshold: bigint;
+    tokenId: bigint;
+};
+export declare function encodeERC1155Params(params: ERC1155Params): Hex;
+export declare function decodeERC1155Params(params: Hex): Readonly<ERC1155Params>;
+export declare function encodeRuleData(ruleData: IRuleEntitlementBase.RuleDataStruct): Hex;
+export declare function decodeRuleData(entitlementData: Hex): IRuleEntitlementBase.RuleDataStruct;
+export declare function encodeRuleDataV2(ruleData: IRuleEntitlementV2Base.RuleDataV2Struct): Hex;
+export declare function decodeRuleDataV2(entitlementData: Hex): IRuleEntitlementV2Base.RuleDataV2Struct;
+export declare function ruleDataToOperations(data: IRuleEntitlementV2Base.RuleDataV2Struct): Operation[];
+type DeepWriteable<T> = {
+    -readonly [P in keyof T]: DeepWriteable<T[P]>;
+};
+export declare function postOrderTraversal(operation: Operation, data: DeepWriteable<RuleDataV2>): void;
+export declare function treeToRuleData(root: Operation): IRuleEntitlementV2Base.RuleDataV2Struct;
+/**
+ *
+ * @param operations
+ * @param linkedWallets
+ * @param providers
+ * @returns An entitled wallet or the zero address, indicating no entitlement
+ */
+export declare function evaluateOperationsForEntitledWallet(operations: Operation[], linkedWallets: string[], xchainConfig: XchainConfig): Promise<string>;
+export declare function evaluateTree(controller: AbortController, linkedWallets: string[], xchainConfig: XchainConfig, entry?: Operation): Promise<EntitledWalletOrZeroAddress>;
+export declare function createExternalTokenStruct(addresses: Address[], options?: {
+    checkOptions?: Partial<Omit<DecodedCheckOperation, 'address'>>;
+    logicalOp?: SupportedLogicalOperationType;
+}): IRuleEntitlementV2Base.RuleDataV2Struct;
+export declare function createExternalNFTStruct(addresses: Address[], options?: {
+    checkOptions?: Partial<Omit<DecodedCheckOperation, 'address'>>;
+    logicalOp?: SupportedLogicalOperationType;
+}): IRuleEntitlementV2Base.RuleDataV2Struct;
+export declare class DecodedCheckOperationBuilder {
+    private decodedCheckOp;
+    setType(checkOpType: CheckOperationType): this;
+    setChainId(chainId: bigint): this;
+    setThreshold(threshold: bigint): this;
+    setAddress(address: Address): this;
+    setTokenId(tokenId: bigint): this;
+    setByteEncodedParams(params: Hex): this;
+    build(): DecodedCheckOperation;
+}
+export type DecodedCheckOperation = {
+    type: CheckOperationType;
+    chainId?: bigint;
+    address?: Address;
+    threshold?: bigint;
+    tokenId?: bigint;
+    byteEncodedParams?: Hex;
+};
+export declare function createOperationsTree(checkOp: DecodedCheckOperation[], logicalOp?: SupportedLogicalOperationType): IRuleEntitlementV2Base.RuleDataV2Struct;
+export declare function createDecodedCheckOperationFromTree(entitlementData: IRuleEntitlementV2Base.RuleDataV2Struct): DecodedCheckOperation[];
+export declare function findEthereumProviders(xchainConfig: XchainConfig): Promise<ethers.providers.StaticJsonRpcProvider[]>;
+export {};
+//# sourceMappingURL=entitlement.d.ts.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"entitlement.d.ts","sourceRoot":"","sources":["../../../src/space/entitlements/entitlement.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,uBAAuB,CAAA;AACjF,OAAO,EAAE,sBAAsB,EAAE,qBAAqB,EAAE,MAAM,yBAAyB,CAAA;AAGvF,OAAO,EAIH,8BAA8B,EAC9B,GAAG,EACN,MAAM,MAAM,CAAA;AAEb,OAAO,EAAE,MAAM,EAAE,MAAM,QAAQ,CAAA;AAC/B,OAAO,EAAE,OAAO,EAAE,MAAM,2BAA2B,CAAA;AAKnD,MAAM,MAAM,YAAY,GAAG;IACvB,gBAAgB,EAAE;QAAE,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAAA;KAAE,CAAA;IAG/C,qBAAqB,EAAE,MAAM,EAAE,CAAA;IAI/B,kBAAkB,EAAE,MAAM,EAAE,CAAA;IAI5B,cAAc,CAAC,EAAE,OAAO,CAAA;CAC3B,CAAA;AAID,MAAM,MAAM,QAAQ,GAAG,8BAA8B,CAAC,OAAO,mBAAmB,EAAE,aAAa,CAAC,CAAA;AAChG,MAAM,MAAM,UAAU,GAAG,8BAA8B,CACnD,OAAO,qBAAqB,EAC5B,eAAe,CAClB,CAAA;AAED,oBAAY,aAAa;IACrB,IAAI,IAAI;IACR,KAAK,IAAA;IACL,OAAO,IAAA;CACV;AAED,oBAAY,kBAAkB;IAC1B,IAAI,IAAI;IACR,IAAI,IAAA;IACJ,KAAK,IAAA;IACL,MAAM,IAAA;IACN,OAAO,IAAA;IACP,UAAU,IAAA;IACV,WAAW,IAAA;CACd;AAwBD,oBAAY,oBAAoB;IAC5B,IAAI,IAAI;IACR,GAAG,IAAA;IACH,EAAE,IAAA;CACL;AACD,MAAM,MAAM,iBAAiB,GAAG;IAC5B,MAAM,EAAE,aAAa,CAAA;IACrB,KAAK,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,MAAM,MAAM,wBAAwB,GAAG;IACnC,SAAS,EAAE,oBAAoB,CAAA;IAC/B,kBAAkB,EAAE,MAAM,CAAA;IAC1B,mBAAmB,EAAE,MAAM,CAAA;CAC9B,CAAA;AAED,wBAAgB,0BAA0B,CAAC,SAAS,EAAE,iBAAiB,WAEtE;AAED,MAAM,MAAM,cAAc,GAAG;IACzB,MAAM,EAAE,aAAa,CAAC,KAAK,CAAA;IAC3B,SAAS,EAAE,kBAAkB,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,OAAO,CAAA;IACxB,SAAS,EAAE,MAAM,CAAA;CACpB,CAAA;AACD,MAAM,MAAM,gBAAgB,GAAG;IAC3B,MAAM,EAAE,aAAa,CAAC,KAAK,CAAA;IAC3B,SAAS,EAAE,kBAAkB,CAAA;IAC7B,OAAO,EAAE,MAAM,CAAA;IACf,eAAe,EAAE,OAAO,CAAA;IACxB,MAAM,EAAE,GAAG,CAAA;CACd,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACtB,MAAM,EAAE,aAAa,CAAC,OAAO,CAAA;IAC7B,WAAW,EAAE,oBAAoB,CAAC,EAAE,CAAA;IACpC,aAAa,EAAE,SAAS,CAAA;IACxB,cAAc,EAAE,SAAS,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,YAAY,GAAG;IACvB,MAAM,EAAE,aAAa,CAAC,OAAO,CAAA;IAC7B,WAAW,EAAE,oBAAoB,CAAC,GAAG,CAAA;IACrC,aAAa,EAAE,SAAS,CAAA;IACxB,cAAc,EAAE,SAAS,CAAA;CAC5B,CAAA;AAED,MAAM,MAAM,WAAW,GAAG;IACtB,MAAM,EAAE,aAAa,CAAC,IAAI,CAAA;IAC1B,KAAK,EAAE,MAAM,CAAA;CAChB,CAAA;AAED,eAAO,MAAM,aAAa,EAAE,WAG3B,CAAA;AAED,eAAO,MAAM,YAAY;;;;CAIxB,CAAA;AAED,eAAO,MAAM,mBAAmB,eAAiC,CAAA;AAEjE,KAAK,2BAA2B,GAAG,MAAM,CAAA;AAEzC,MAAM,MAAM,gBAAgB,GAAG,WAAW,GAAG,YAAY,CAAA;AACzD,MAAM,MAAM,6BAA6B,GAAG,gBAAgB,CAAC,aAAa,CAAC,CAAA;AAE3E,MAAM,MAAM,SAAS,GAAG,gBAAgB,GAAG,WAAW,GAAG,YAAY,GAAG,WAAW,CAAA;AAkBnF,wBAAgB,oBAAoB,CAAC,UAAU,EAAE,SAAS,EAAE,GAAG,SAAS,CAoCvE;AAED,MAAM,MAAM,eAAe,GAAG;IAC1B,SAAS,EAAE,MAAM,CAAA;CACpB,CAAA;AAaD,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,eAAe,GAAG,GAAG,CAKlE;AAED,wBAAgB,qBAAqB,CAAC,MAAM,EAAE,GAAG,GAAG,QAAQ,CAAC,eAAe,CAAC,CAE5E;AAED,MAAM,MAAM,aAAa,GAAG;IACxB,SAAS,EAAE,MAAM,CAAA;IACjB,OAAO,EAAE,MAAM,CAAA;CAClB,CAAA;AAgBD,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,aAAa,GAAG,GAAG,CAQ9D;AAED,wBAAgB,mBAAmB,CAAC,MAAM,EAAE,GAAG,GAAG,QAAQ,CAAC,aAAa,CAAC,CAExE;AAED,wBAAgB,cAAc,CAAC,QAAQ,EAAE,oBAAoB,CAAC,cAAc,GAAG,GAAG,CAYjF;AAED,wBAAgB,cAAc,CAAC,eAAe,EAAE,GAAG,GAAG,oBAAoB,CAAC,cAAc,CAexF;AAED,wBAAgB,gBAAgB,CAAC,QAAQ,EAAE,sBAAsB,CAAC,gBAAgB,GAAG,GAAG,CAiBvF;AAED,wBAAgB,gBAAgB,CAAC,eAAe,EAAE,GAAG,GAAG,sBAAsB,CAAC,gBAAgB,CAwB9F;AAED,wBAAgB,oBAAoB,CAAC,IAAI,EAAE,sBAAsB,CAAC,gBAAgB,GAAG,SAAS,EAAE,CAiC/F;AAED,KAAK,aAAa,CAAC,CAAC,IAAI;IAAE,CAAC,UAAU,CAAC,IAAI,MAAM,CAAC,GAAG,aAAa,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;CAAE,CAAA;AAEzE,wBAAgB,kBAAkB,CAAC,SAAS,EAAE,SAAS,EAAE,IAAI,EAAE,aAAa,CAAC,UAAU,CAAC,QA8BvF;AAED,wBAAgB,cAAc,CAAC,IAAI,EAAE,SAAS,GAAG,sBAAsB,CAAC,gBAAgB,CASvF;AAwQD;;;;;;GAMG;AACH,wBAAsB,mCAAmC,CACrD,UAAU,EAAE,SAAS,EAAE,EACvB,aAAa,EAAE,MAAM,EAAE,EACvB,YAAY,EAAE,YAAY,mBAU7B;AAED,wBAAsB,YAAY,CAC9B,UAAU,EAAE,eAAe,EAC3B,aAAa,EAAE,MAAM,EAAE,EACvB,YAAY,EAAE,YAAY,EAC1B,KAAK,CAAC,EAAE,SAAS,GAClB,OAAO,CAAC,2BAA2B,CAAC,CAuBtC;AAID,wBAAgB,yBAAyB,CACrC,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,CAAC,EAAE;IACN,YAAY,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAC,CAAA;IAC9D,SAAS,CAAC,EAAE,6BAA6B,CAAA;CAC5C,2CAYJ;AAED,wBAAgB,uBAAuB,CACnC,SAAS,EAAE,OAAO,EAAE,EACpB,OAAO,CAAC,EAAE;IACN,YAAY,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC,qBAAqB,EAAE,SAAS,CAAC,CAAC,CAAA;IAC9D,SAAS,CAAC,EAAE,6BAA6B,CAAA;CAC5C,2CAaJ;AAED,qBAAa,4BAA4B;IACrC,OAAO,CAAC,cAAc,CAAqC;IAEpD,OAAO,CAAC,WAAW,EAAE,kBAAkB,GAAG,IAAI;IAK9C,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAKjC,YAAY,CAAC,SAAS,EAAE,MAAM,GAAG,IAAI;IAKrC,UAAU,CAAC,OAAO,EAAE,OAAO,GAAG,IAAI;IAKlC,UAAU,CAAC,OAAO,EAAE,MAAM,GAAG,IAAI;IAKjC,oBAAoB,CAAC,MAAM,EAAE,GAAG,GAAG,IAAI;IAKvC,KAAK,IAAI,qBAAqB;CAuFxC;AAED,MAAM,MAAM,qBAAqB,GAAG;IAChC,IAAI,EAAE,kBAAkB,CAAA;IACxB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,OAAO,CAAC,EAAE,OAAO,CAAA;IACjB,SAAS,CAAC,EAAE,MAAM,CAAA;IAClB,OAAO,CAAC,EAAE,MAAM,CAAA;IAChB,iBAAiB,CAAC,EAAE,GAAG,CAAA;CAC1B,CAAA;AAED,wBAAgB,oBAAoB,CAChC,OAAO,EAAE,qBAAqB,EAAE,EAChC,SAAS,GAAE,6BAAuD,GACnE,sBAAsB,CAAC,gBAAgB,CA2DzC;AAID,wBAAgB,mCAAmC,CAC/C,eAAe,EAAE,sBAAsB,CAAC,gBAAgB,GACzD,qBAAqB,EAAE,CAoCzB;AA4QD,wBAAsB,qBAAqB,CAAC,YAAY,EAAE,YAAY,qDAiBrE"}