@fxhash/config 0.0.8 → 0.0.10

package/README.md

@@ -1,6 +1,14 @@
-# fxhash-config
+# @fxhash/config
 
-`@fxhash/config` contains all variables used within all modules of fx(package)
+This contains all variables used within all modules of fx(package)
+
+## Installation
+
+```
+pnpm add @fxhash/config
+```
+
+## Usage
 
 For you application you usually want to use the config like this:
 
@@ -9,5 +17,14 @@ import { config } from "@fxhash/config"
 ```
 
 This singleton will expose variables for testnet/mainnet based on the `FXHASH_ENV` .env variable.
+
 - Set `FXHASH_ENV=dev` to expose the config for testnet/dev environments
 - Set `FXHASH_ENV=prd` or `FXHASH_ENV=production` to expose the config for mainnet/production environments
+
+> Note: If the `@fxhash/config` package is used on the client side you also have to set the `NEXT_PUBLIC_FXHASH_ENV` or `REACT_APP_FXHASH_ENV` environment variable.
+
+### Local development
+
+Additional to the testnet and mainnet specific configuration there is the 3rd option for `local` development. This option is designed to be used within the fxhash monorepository. You can use it by setting the `FXHASH_ENV=local` environment variable. Since all services are dockerised there is an additional `localDocker` configuration. This configuration is automatically used when the `@fxhash/config` package is used inside a docker container and the `FXHASH_ENV` is set to `local`. The `localDocker` configuration basically just replaces all "localhost" urls with "host.docker.internal".
+
+- Set `FXHASH_ENV=local` to expose the config for local development within the fxhash monorepository

package/dist/api/base.d.ts

@@ -0,0 +1,11 @@
+export interface IBaseApis {
+	rpcs: string[];
+	reservoir: string;
+	safe: string;
+	whitelist: string;
+	alchemy: {
+		rpc: string
+	};
+}
+export declare const baseTestnetApis: IBaseApis;
+export declare const baseMainnetApis: IBaseApis;

package/dist/api/eth.d.ts

@@ -1,7 +1,11 @@
-interface IEthApis {
-    rpcs: string[];
-    reservoir: string;
+export interface IEthApis {
+	rpcs: string[];
+	reservoir: string;
+	safe: string;
+	whitelist: string;
+	alchemy: {
+		rpc: string
+	};
 }
-declare const ethTestnetApis: IEthApis;
-
-export { IEthApis, ethTestnetApis };
+export declare const ethTestnetApis: IEthApis;
+export declare const ethMainnetApis: IEthApis;

package/dist/api/fxhash.d.ts

@@ -1,32 +1,9 @@
-interface IFxhashApis {
-    website: string;
-    main: string;
-    file: string;
-    fsEmulator: string;
-    extract: string;
-    media: string;
-    ipfsGateway: string;
-    ipfsGatewaySafe: string;
-    onchfsProxy: string;
-    authority: {
-        api: string;
-    };
-    capture: {
-        lambdas: {
-            small: string;
-            medium: string;
-            large: string;
-        };
-    };
-    dashboard: {
-        backend: string;
-        aggregator: string;
-    };
-    events: {
-        liveBackend: string;
-    };
-}
-declare const fxhashDevApis: IFxhashApis;
-declare const fxhashPrdApis: IFxhashApis;
-
-export { IFxhashApis, fxhashDevApis, fxhashPrdApis };
+import { IFxhashApis, TEnv } from "../types.js";
+export declare const fxhashDevApis: IFxhashApis;
+export declare const fxhashLocalApis: IFxhashApis;
+export declare const fxhashLocalDockerApis: IFxhashApis;
+export declare const fxhashPrdApis: IFxhashApis;
+/**
+* Given some env, returns the associated APIs config.
+*/
+export declare function fxApisByEnv(env: TEnv): IFxhashApis;

package/dist/api/tezos.d.ts

@@ -1,9 +1,8 @@
-interface ITezosApis {
-    tzktWebsite: string;
-    tzkt: string;
-    rpcs: string[];
+export interface ITezosApis {
+	tzktWebsite: string;
+	tzkt: string;
+	tzktPro: string;
+	rpcs: string[];
 }
-declare const tezosTestnetApis: ITezosApis;
-declare const tezosMainnetApis: ITezosApis;
-
-export { ITezosApis, tezosMainnetApis, tezosTestnetApis };
+export declare const tezosTestnetApis: ITezosApis;
+export declare const tezosMainnetApis: ITezosApis;

package/dist/config/algolia.d.ts

@@ -0,0 +1,11 @@
+export type AlgoliaConfig = {
+	appId: string
+	enabled: boolean
+	indexGenerativeTokens: string
+	indexOffers: string
+	indexUsers: string
+	indexArticles: string
+	indexAccounts: string
+};
+export declare const algoliaConfigDev: AlgoliaConfig;
+export declare const algoliaConfigProd: AlgoliaConfig;

package/dist/config/gpu.d.ts

@@ -0,0 +1,11 @@
+declare const GPU_VERSIONS: readonly ["v111", "v132"];
+type GPUVersion = (typeof GPU_VERSIONS)[number];
+interface GPURenderingVersionConfig {
+	date: string;
+	version: string;
+	batchArn: string;
+}
+export type GPURenderingConfig = Record<GPUVersion, GPURenderingVersionConfig>;
+export declare const gpuRenderingConfigDev: GPURenderingConfig;
+export declare const gpuRenderingConfigProd: GPURenderingConfig;
+export {};

package/dist/config/metadata.d.ts

@@ -0,0 +1,15 @@
+import { type Result } from "@fxhash/utils";
+import { type AppMetadataError } from "../errors/metadata.js";
+import { IAppMetadata, TEnv } from "../types.js";
+/**
+* Get application metadata by merging some cross-env metadata with an
+* environment-specific URL (application front-end).
+*/
+export declare function fxAppEnvMetadata(env: TEnv): IAppMetadata;
+/**
+* Test whether some value is a valid {@link IAppMetadata} interface. If not,
+* the issue causing it to be invalid is returned as a failure.
+* @param value Any value which should be tested for being valid App Metadata
+* @returns A Result with void success or failure with the issue
+*/
+export declare function isAppMetadataValid(value: any): Result<void, AppMetadataError>;

package/dist/config.d.ts

@@ -1,68 +1,14 @@
-import { IEthApis } from './api/eth.js';
-import { ITezosApis } from './api/tezos.js';
-import { IFxhashApis } from './api/fxhash.js';
-import { ITezosContracts } from './contracts/tezos.js';
-import { IEthContracts } from './contracts/eth.js';
-
-interface IFxhashNetworkConfig {
-    network: string;
-}
-interface IFxhashEnvConfig {
-    envName: string;
-    gtMinPrice: string;
-    ETH_WALLET_CONNECT_ID: string;
-    ETH_CHAIN_ID: string;
-}
-type TBlockchain = "tez" | "eth";
-type TBlockchainNetwork = "testnet" | "mainnet";
-type TEnv = "dev" | "prd";
-type TBlockchainContacts = {
-    [B in TBlockchain]: {
-        tez: ITezosContracts;
-        eth: IEthContracts | null;
-    }[B];
-};
-type TBlockchainApis = {
-    [B in TBlockchain]: {
-        tez: ITezosApis;
-        eth: IEthApis | null;
-    }[B];
-};
-type TNetworkBlockchainConfig = {
-    [B in TBlockchain]: {
-        tez: IFxhashNetworkConfig;
-        eth: IFxhashNetworkConfig;
-    }[B];
-};
-type IFxhashConfig = {
-    networks: {
-        [N in TBlockchainNetwork]: {
-            [B in TBlockchain]: {
-                contracts: TBlockchainContacts[B];
-                config: TNetworkBlockchainConfig[B];
-                apis: TBlockchainApis[B];
-            };
-        };
-    };
-    envs: {
-        [K in TEnv]: {
-            apis: IFxhashApis;
-            config: IFxhashEnvConfig;
-        };
-    };
-};
-type IFxhashConfigSingleEnv = {
-    [B in TBlockchain]: {
-        contracts: TBlockchainContacts[B];
-        config: TNetworkBlockchainConfig[B];
-        apis: TBlockchainApis[B];
-    };
-} & {
-    apis: IFxhashApis;
-    config: IFxhashEnvConfig;
-};
+import { type IFxhashConfig, type IFxhashConfigSingleEnv, type TBlockchainNetwork, type TEnv } from "./types.js";
+/**
+* --------------------------------------------------------
+*/
 declare const fxhashConfig: IFxhashConfig;
-declare const devConfig: IFxhashConfigSingleEnv;
-declare const prdConfig: IFxhashConfigSingleEnv;
-
-export { IFxhashConfig, IFxhashConfigSingleEnv, IFxhashEnvConfig, IFxhashNetworkConfig, TBlockchain, TBlockchainNetwork, TEnv, devConfig, fxhashConfig, prdConfig };
+export declare function getBlockchainNetworkForEnv(env: TEnv): TBlockchainNetwork;
+export declare function getConfigForEnv(env: TEnv): IFxhashConfigSingleEnv;
+export declare const localConfig: IFxhashConfigSingleEnv;
+export declare const localDockerConfig: IFxhashConfigSingleEnv;
+export declare const devConfig: IFxhashConfigSingleEnv;
+export declare const prdConfig: IFxhashConfigSingleEnv;
+declare let config: IFxhashConfigSingleEnv;
+declare function setConfig(userConfig: Partial<IFxhashConfigSingleEnv>): IFxhashConfigSingleEnv;
+export { fxhashConfig, config, setConfig };

package/dist/constants.d.ts

@@ -0,0 +1,2 @@
+export declare const AUTH_JWT_PK_DEV = "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEA1hF8JwAxIiFWzbXIgeOK\nBzf6SZlT3S1YampzVgy4pw1G0aKwHnyvC+HrRfkEOCGxX24DqbEpZby2LjKF9bfa\nOLrERrNSNrDLXbf3ipKQrnEBu2UdT2pE5UF/SwJUTdGczb78EId0yIjuZ26qZcQg\nPr1ji6FgdOOdEwdphl4x1dlQzgMgjhRcPwf9NsBx3R6l/ut2o38Qa8azxM7XBg8F\nUlsKGy4/jY2OIEKCravCoXmpeX9pxploED/DoJJI9FZXVB7/91iIb6MI0Ycby+xo\nGL/cF+ZYSVRoFexji4vpycJfltW5YJ8jHSveZWa6LXqM6LY7zRFmlxb3SF4tsDTT\nPQIDAQAB\n-----END PUBLIC KEY-----";
+export declare const AUTH_JWT_PK_PRD = "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAtwl1CRvpN7MZeGGDTy8x\n+W3EkZfBzZqEp3vahCaqBdMkMhy7oB1pUU7pjb34tg9epnKdKo0cZn+Bw1LkSKWh\nZ1DSbgCdNR47qKb4xN8mZ5VvEw/64+nUXbCOikX+rMqSE2tNeNU3KOYr8VQYt9dv\n/J0xFwsr0aa4m23dmJ/oPLA8eR8lZk++fEZsbezKH3i9zz73I0UAivijM0S9lYeB\nNkT5zOaAJARzl69hEMQAv9qUkokwPSHlcG+LakhTGYAyMe3w/KHXVRkWjuCUgUJf\n90oveckX4dhMbHbz9ba1p3hpmwdmlRzljIIE2GQYawA8eNLsOb/z6V8HGMbCL/N9\nJwIDAQAB\n-----END PUBLIC KEY-----";

package/dist/contracts/base.d.ts

@@ -0,0 +1,30 @@
+export interface IBaseContracts {
+	multicall3: `0x${string}`;
+	seaport_zone: `0x${string}`;
+	issuer_factory_v1: `0x${string}`;
+	fixed_price_minter_v1: `0x${string}`;
+	dutch_auction_minter_v1: `0x${string}`;
+	mint_ticket_factory_v1: `0x${string}`;
+	ticket_redeemer_v1: `0x${string}`;
+	ipfs_renderer_v1: `0x${string}`;
+	onchfs_renderer_v1: `0x${string}`;
+	randomizer_v1: `0x${string}`;
+	role_registry_v1: `0x${string}`;
+	contract_registry_v1: `0x${string}`;
+	gen_art_token_impl_v1: `0x${string}`;
+	mint_ticket_impl_v1: `0x${string}`;
+	onchfs_file_system: `0x${string}`;
+	onchfs_content_store: `0x${string}`;
+	seaport: `0x${string}`;
+	fxhashTeamSafeAddress: `0x${string}`;
+	signerSafe: `0x${string}`;
+	moderationSafe: `0x${string}`;
+	farcaster_frame_fixed_price_minter_v1: `0x${string}`;
+	fx_token: `0x${string}`;
+	fx_airdrop: `0x${string}`;
+	fx_tez_airdrop: `0x${string}`;
+	fx_token_launchpad: `0x${string}`;
+	fx_project_factory: `0x${string}`;
+}
+export declare const baseTestnetContracts: IBaseContracts;
+export declare const baseMainnetContracts: IBaseContracts;

package/dist/contracts/eth.d.ts

@@ -1,14 +1,31 @@
-interface IEthContracts {
-    project_factory: string;
-    splits_factory: string;
-    splits_main: string;
-    scripty_storage: string;
-    scripty_builder: string;
-    seaport_zone: string;
-    fixed_price_minter_v1: string;
-    dutch_auction_v1: string;
-    mint_ticket_factory_v1: string;
+export interface IEthContracts {
+	multicall3: `0x${string}`;
+	seaport_zone: `0x${string}`;
+	issuer_factory_v1: `0x${string}`;
+	fixed_price_minter_v1: `0x${string}`;
+	dutch_auction_minter_v1: `0x${string}`;
+	mint_ticket_factory_v1: `0x${string}`;
+	ticket_redeemer_v1: `0x${string}`;
+	ipfs_renderer_v1: `0x${string}`;
+	onchfs_renderer_v1: `0x${string}`;
+	randomizer_v1: `0x${string}`;
+	role_registry_v1: `0x${string}`;
+	contract_registry_v1: `0x${string}`;
+	gen_art_token_impl_v1: `0x${string}`;
+	mint_ticket_impl_v1: `0x${string}`;
+	onchfs_file_system: `0x${string}`;
+	onchfs_content_store: `0x${string}`;
+	seaport: `0x${string}`;
+	fxhashTeamSafeAddress: `0x${string}`;
+	signerSafe: `0x${string}`;
+	moderationSafe: `0x${string}`;
+	farcaster_frame_fixed_price_minter_v1: `0x${string}`;
+	fx_token: `0x${string}`;
 }
-declare const ethTestnetContracts: IEthContracts;
-
-export { IEthContracts, ethTestnetContracts };
+export declare const ethTestnetContracts: IEthContracts;
+/**
+* TODO
+* -----------------------------------------------------------------------------
+* Put the actual addresses.
+*/
+export declare const ethMainnetContracts: IEthContracts;

package/dist/contracts/tezos.d.ts

@@ -1,41 +1,41 @@
-interface ITezosContracts {
-    allowed_mint: string;
-    allowed_mint_issuer: string;
-    allowed_mint_issuer_v3: string;
-    allowed_mint_v3: string;
-    articles: string;
-    collaboration_factory: string;
-    consumable_database: string;
-    cycles: string;
-    gentk_v1: string;
-    gentk_v1_data: string;
-    gentk_v2: string;
-    gentk_v3: string;
-    issuer_tickets: string;
-    issuer_v0: string;
-    issuer_v1: string;
-    issuer_v2: string;
-    issuer_v3: string;
-    marketplace_v1: string;
-    marketplace_v2: string;
-    marketplace_v3: string;
-    moderation_articles: string;
-    moderation_team: string;
-    moderation_token: string;
-    moderation_token_v3: string;
-    moderation_user: string;
-    pricing_dutch_auction: string;
-    pricing_dutch_auction_v3: string;
-    pricing_fixed: string;
-    pricing_fixed_v3: string;
-    randomizer: string;
-    token_moderation: string;
-    treasury: string;
-    user_moderation: string;
-    user_register: string;
-    onchfs_files: string;
+export interface ITezosContracts {
+	allowed_mint: string;
+	allowed_mint_issuer: string;
+	allowed_mint_issuer_v3: string;
+	allowed_mint_v3: string;
+	articles: string;
+	card_proxy: string;
+	collaboration_factory: string;
+	consumable_database: string;
+	cycles: string;
+	gentk_v1: string;
+	gentk_v1_data: string;
+	gentk_v2: string;
+	gentk_v3: string;
+	issuer_tickets: string;
+	issuer_v0: string;
+	issuer_v1: string;
+	issuer_v2: string;
+	issuer_v3: string;
+	marketplace_v1: string;
+	marketplace_v2: string;
+	marketplace_v3: string;
+	moderation_articles: string;
+	moderation_team: string;
+	moderation_token: string;
+	moderation_token_v3: string;
+	moderation_user: string;
+	pricing_dutch_auction: string;
+	pricing_dutch_auction_v3: string;
+	pricing_fixed: string;
+	pricing_fixed_v3: string;
+	randomizer: string;
+	randomizer_v2: string;
+	token_moderation: string;
+	treasury: string;
+	user_moderation: string;
+	user_register: string;
+	onchfs_files: string;
 }
-declare const tezosTestnetContracts: ITezosContracts;
-declare const tezosMainnetContracts: ITezosContracts;
-
-export { ITezosContracts, tezosMainnetContracts, tezosTestnetContracts };
+export declare const tezosTestnetContracts: ITezosContracts;
+export declare const tezosMainnetContracts: ITezosContracts;

package/dist/errors/metadata.d.ts

@@ -0,0 +1,14 @@
+import { type IRichErrorMessages, RichError, type RichErrorUnion } from "@fxhash/errors";
+export declare class AppMetadataInvalidTypeError extends RichError {
+	name: "AppMetadataInvalidTypeError";
+	messages: {
+		dev: string
+	};
+}
+export declare class AppMetadataMissingPropertiesError extends RichError {
+	name: "AppMetadataMissingPropertiesError";
+	constructor(messages: IRichErrorMessages);
+	constructor(properties: string[]);
+}
+export declare const AppMetadataErrors: (typeof AppMetadataInvalidTypeError | typeof AppMetadataMissingPropertiesError)[];
+export type AppMetadataError = RichErrorUnion<typeof AppMetadataErrors>;

package/dist/helpers.d.ts

@@ -0,0 +1,6 @@
+import { TEnv } from "./types.js";
+export declare function getDockerInternalUrl(url: string): string;
+export declare const isProd: boolean;
+export declare const isLocal: boolean;
+export declare const isDockerLocal: boolean;
+export declare function getEnv(): TEnv;

package/dist/index.d.ts

@@ -1,12 +1,14 @@
-export { IEthApis, ethTestnetApis } from './api/eth.js';
-export { ITezosApis, tezosMainnetApis, tezosTestnetApis } from './api/tezos.js';
-export { IFxhashApis, fxhashDevApis, fxhashPrdApis } from './api/fxhash.js';
-export { ITezosContracts, tezosMainnetContracts, tezosTestnetContracts } from './contracts/tezos.js';
-export { IEthContracts, ethTestnetContracts } from './contracts/eth.js';
-import { fxhashConfig, IFxhashConfigSingleEnv } from './config.js';
-export { IFxhashConfig, IFxhashEnvConfig, IFxhashNetworkConfig, TBlockchain, TBlockchainNetwork, TEnv, devConfig, prdConfig } from './config.js';
-
-declare let config: IFxhashConfigSingleEnv;
-declare function setConfig(userConfig: Partial<IFxhashConfigSingleEnv>): IFxhashConfigSingleEnv;
-
-export { config, fxhashConfig as default, fxhashConfig, setConfig };
+import { type IEthApis, ethTestnetApis } from "./api/eth.js";
+import { type ITezosApis, tezosTestnetApis, tezosMainnetApis } from "./api/tezos.js";
+import { fxhashDevApis, fxhashPrdApis } from "./api/fxhash.js";
+import { type ITezosContracts, tezosMainnetContracts, tezosTestnetContracts } from "./contracts/tezos.js";
+import { type IEthContracts, ethTestnetContracts } from "./contracts/eth.js";
+import { type GPURenderingConfig } from "./config/gpu.js";
+import { fxhashConfig, prdConfig, devConfig, localConfig, config, setConfig } from "./config.js";
+import { type IFxhashEnvConfig, type IFxhashNetworkConfig, type TBlockchain, type TBlockchainNetwork, type TEnv, type IFxhashConfig } from "./types.js";
+export { ethTestnetApis, tezosTestnetApis, tezosMainnetApis, fxhashDevApis, fxhashPrdApis, tezosTestnetContracts, tezosMainnetContracts, ethTestnetContracts, fxhashConfig, devConfig, prdConfig, localConfig, config, setConfig, type IEthApis, type ITezosApis, type ITezosContracts, type IEthContracts, type IFxhashEnvConfig, type IFxhashNetworkConfig, type TBlockchain, type TBlockchainNetwork, type TEnv, type IFxhashConfig, type GPURenderingConfig };
+export * from "./types.js";
+export * from "./helpers.js";
+export * from "./utils/index.js";
+export { isAppMetadataValid } from "./config/metadata.js";
+export default fxhashConfig;