Types

This page contains the code for all block3d types.

/** @devType The rules object from the config file */
type Rule = {
    type: string;
    title: string;
    addresses?: string[];
    minimumBal?: string;
    contracts?: Contract[];
    strict?: boolean;
};
/** @devType Used inside Rule type, this represents a smart contract */
type Contract = {
    address: string;
    chainId: number;
    minimumBal?: string;
};
/** @devType for the userData object that is returned by the `useBlock3r()` hook */
type UserData = {
    address?: string;
    simple?: {
        passing: Rule[];
        failing: Rule[];
    };
    token?: {
        passing: Rule[];
        failing: Rule[];
    };
    nft?: {
        passing: Rule[];
        failing: Rule[];
    };
};
/** @devType The type for the `block3dConfig` object inside the `block3d.config` file */
type Block3dConfig = {
    publicRoutes: string[];
    strict: boolean;
    rules: Rule[];
};

/** @dev Rainbow Kit custom connect button */
declare const Block3dConnectButton: () => React.JSX.Element;

interface Block3rProps {
    children: React.ReactNode;
    wagmiConfig: Config;
    block3dConfig: Block3dConfig;
}
/** @dev This wraps the entire app and is the only component the user has to interact with */
declare function Block3r({ children, wagmiConfig, block3dConfig, }: Block3rProps): React.JSX.Element;

interface Block3rContentProps {
    children: React.ReactNode;
    block3dConfig: Block3dConfig;
    wagmiConfig: Config;
}
/**
 * @dev This component handles displaying the <Block3d/> component vs the actual page depending on the `isBlock3d` boolean value
 */
declare function Block3rContent({ children, block3dConfig, wagmiConfig, }: Block3rContentProps): React.JSX.Element;

interface QRCodeModalProps {
    qrModalVisible: boolean;
    setQrModalVisible: (visible: boolean) => void;
    address: string;
}
/**
 * @dev A modal containing the user's address in the form of a QR code
 * @dev Not actually a modal at all currently... PRs are welcome
 */
declare function QRCodeModal({ qrModalVisible, setQrModalVisible, address, }: QRCodeModalProps): React.JSX.Element;

/**
 * @dev This is the core hook that determines whether a user can view a page or not
 * @returns isBlock3d - a boolean value that when true, means the user is blocked from viewing the page
 * @returns userData - an object containing the user's address and 3 sub objects for each rule type (simple, token, nft)
 * These sub-objects each contain two `Rule` arrays, one for passing and one for failing rules
 */
declare function useBlock3r(block3dConfig: Block3dConfig, wagmiConfig: Config): {
    isBlock3d: boolean;
    userData: UserData | undefined;
};

/**
 * @param address is the currently connected user address
 * @return `passing` is a Rule[] containing all simple rule checks the user passed
 * @return `failing` is a Rule[] containing all simple rule checks the user failed
 */
declare function checkSimpleRules(address: string, block3dConfig: Block3dConfig): Promise<{
    simplePassing: Rule[];
    simpleFailing: Rule[];
}>;

/**
 * @param address is the currently connected user address
 * @param block3dConfig is the block3d config object
 * @param wagmiConfig is the wagmi config object
 * @return `passing` is a Rule[] containing all token rule checks the user passed
 * @return `failing` is a Rule[] containing all token rule checks the user failed
 */
declare function checkTokenRules(address: string, block3dConfig: Block3dConfig, wagmiConfig: Config): Promise<{
    tokenPassing: Rule[];
    tokenFailing: Rule[];
}>;

/**
 * @param currentPath is the page the user is currently on
 * @return true if currentPath is listed in `publicRoutes` array in `block3d.config.ts`, false otherwise.
 */
declare function checkIsRoutePublic(currentPath: string, block3dConfig: Block3dConfig): Promise<boolean>;

/**
 * @param address is the currently connected user address
 * @param block3dConfig is the block3d config object
 * @param wagmiConfig is the wagmi config object
 * @return `passing` is a Rule[] containing all nft rule checks the user passed
 * @return `failing` is a Rule[] containing all nft rule checks the user failed
 */
declare function checkNftRules(address: string, block3dConfig: Block3dConfig, wagmiConfig: Config): Promise<{
    nftPassing: Rule[];
    nftFailing: Rule[];
}>;

/**@dev Contains all page restriction checks */
declare const checkBlock3d: (address: `0x${string}` | undefined, chain: number | undefined, currentPath: string, block3dConfig: Block3dConfig, config: Config) => Promise<{
    block3d: boolean;
    userData: undefined;
} | {
    block3d: boolean;
    userData: UserData;
}>;

interface RpcUrls {
    [chainId: number]: string;
}
/**
 * @dev This function views the wagmi config and retrieves any necessary provided RPC URLs, if none are provided we use the default values
 * @param rules is an array of valid rule types
 * @param wagmiConig is the current wagmi config object
 * @return `rpcUrls` is an KV object with chainIds mapped to RPC URLs
 */
declare function getRpcUrls(rules: Rule[], wagmiConfig: Config): Promise<RpcUrls>;

export { type Block3dConfig, Block3dConnectButton, Block3r, Block3rContent, QRCodeModal, type Rule, type UserData, checkBlock3d, checkIsRoutePublic, checkNftRules, checkSimpleRules, checkTokenRules, getRpcUrls, useBlock3r };