Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Feature/lit 3593 js sdk add a map of network names to rpc url #527

Merged
merged 10 commits into from
Jul 11, 2024
Merged

Feature/lit 3593 js sdk add a map of network names to rpc url #527

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
10 commits
Select commit Hold shift + click to select a range
e1c9a13
feat: use map of network to RPC, general worker, relayer urls
Ansonhkg Jul 11, 2024
f669cf3
chore: prettier
Ansonhkg Jul 11, 2024
29a6ee9
fix: use map values
Ansonhkg Jul 11, 2024
d1d6f32
fix: use map values instead of keys
Ansonhkg Jul 11, 2024
f615185
fix: doc on LIT_RPC
Ansonhkg Jul 11, 2024
30691ec
fix: let to const
Ansonhkg Jul 11, 2024
9cf33e8
fix: rename `CHAIN_INFO` to `METAMASK_CHAIN_INFO`
Ansonhkg Jul 11, 2024
ea614f6
fix: https://github.com/LIT-Protocol/js-sdk/pull/527#discussion_r1673…
Ansonhkg Jul 11, 2024
bc91353
fix: jsDoc and chain info
Ansonhkg Jul 11, 2024
12569dd
fix: check the correct variable, not the concatenated string
Ansonhkg Jul 11, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
191 changes: 181 additions & 10 deletions packages/constants/src/lib/constants/constants.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -477,21 +477,25 @@ export const LIT_CHAINS: LITChain<LITEVMChain> = {
type: null,
vmType: 'EVM',
},

/**
* @deprecated Will be removed in version 7.x. - Use `chronicleVesuviusTestnet` instead.
*/
datilDevnet: {
contractAddress: null,
chainId: 2311,
name: 'Vesuvius - Lit Protocol Devnet',
name: 'Chronicle Vesuvius - Lit Protocol Testnet',
symbol: 'tstLit',
decimals: 18,
rpcUrls: ['https://vesuvius-rpc.litprotocol.com/'],
blockExplorerUrls: ['https://vesuvius-explorer.litprotocol.com/'],
type: null,
vmType: 'EVM',
},
datilTestnet: {
chronicleVesuviusTestnet: {
contractAddress: null,
chainId: 2311,
name: 'Vesuvius - Lit Protocol Testnet',
name: 'Chronicle Vesuvius - Lit Protocol Testnet',
symbol: 'tstLit',
decimals: 18,
rpcUrls: ['https://vesuvius-rpc.litprotocol.com/'],
Expand Down Expand Up @@ -625,27 +629,175 @@ export const LIT_CHAINS: LITChain<LITEVMChain> = {
export const LIT_CHAIN_RPC_URL = LIT_CHAINS['chronicleTestnet'].rpcUrls[0];

/**
* Enum representing the available LIT RPC endpoints.
* Object containing information to submit to Metamask
*/
export const metamaskChainInfo = {
/**
* Information about the "chronicle" chain.
*/
chronicle: {
chainId: LIT_CHAINS['chronicleTestnet'].chainId,
chainName: LIT_CHAINS['chronicleTestnet'].name,
nativeCurrency: {
name: LIT_CHAINS['chronicleTestnet'].symbol,
symbol: LIT_CHAINS['chronicleTestnet'].symbol,
decimals: LIT_CHAINS['chronicleTestnet'].decimals,
},
rpcUrls: LIT_CHAINS['chronicleTestnet'].rpcUrls,
blockExplorerUrls: LIT_CHAINS['chronicleTestnet'].blockExplorerUrls,
iconUrls: ['future'],
},
/**
* Information about the "chronicleVesuvius" chain.
*/
chronicleVesuvius: {
chainId: LIT_CHAINS['chronicleVesuviusTestnet'].chainId,
chainName: LIT_CHAINS['chronicleVesuviusTestnet'].name,
nativeCurrency: {
name: LIT_CHAINS['chronicleVesuviusTestnet'].symbol,
symbol: LIT_CHAINS['chronicleVesuviusTestnet'].symbol,
decimals: LIT_CHAINS['chronicleVesuviusTestnet'].decimals,
},
rpcUrls: LIT_CHAINS['chronicleVesuviusTestnet'].rpcUrls,
blockExplorerUrls: LIT_CHAINS['chronicleVesuviusTestnet'].blockExplorerUrls,
iconUrls: ['future'],
},
};

/**
* Constants representing the available LIT RPC endpoints.
*/
export enum LIT_RPC {
export const LIT_RPC = {
/**
* Local Anvil RPC endpoint.
*/
LOCAL_ANVIL = 'http://127.0.0.1:8545',
LOCAL_ANVIL: 'http://127.0.0.1:8545',

/**
* Chronicle RPC endpoint - Used for Cayenne, Manzano, Habanero
*/
CHRONICLE = 'https://chain-rpc.litprotocol.com/http',
CHRONICLE: 'https://chain-rpc.litprotocol.com/http',

/**
* Chronicle Vesuvius RPC endpoint - used for >= Datil-dev, Datil-test
* @deprecated Will be removed in version 7.x. - Use CHRONICLE_VESUVIUS instead
*/
VESUVIUS: 'https://vesuvius-rpc.litprotocol.com',

/**
* Vesuvius RPC endpoint - used for >= Datil-dev, Datil-test
* Chronicle Vesuvius RPC endpoint - used for >= Datil-dev, Datil-test
*/
VESUVIUS = 'https://vesuvius-rpc.litprotocol.com',
}
CHRONICLE_VESUVIUS: 'https://vesuvius-rpc.litprotocol.com',
} as const;

export const LIT_EVM_CHAINS = LIT_CHAINS;

/**
* Represents the Lit Network constants.
*/
export const LIT_NETWORK = {
Cayenne: 'cayenne',
Manzano: 'manzano',
Habanero: 'habanero',
DatilDev: 'datil-dev',
DatilTest: 'datil-test',
Custom: 'custom',
Localhost: 'localhost',
} as const;

/**
* The type representing the keys of the LIT_NETWORK object.
*
*/
export type LIT_NETWORK_TYPES = keyof typeof LIT_NETWORK;

/**
* The type representing the values of the LIT_NETWORK object.
*/
export type LIT_NETWORK_VALUES = (typeof LIT_NETWORK)[keyof typeof LIT_NETWORK];

/**
* RPC URL by Network
*
* A mapping of network names to their corresponding RPC URLs.
*/
export const RPC_URL_BY_NETWORK: { [key in LIT_NETWORK_VALUES]: string } = {
cayenne: LIT_RPC.CHRONICLE,
manzano: LIT_RPC.CHRONICLE,
habanero: LIT_RPC.CHRONICLE,
'datil-dev': LIT_RPC.CHRONICLE_VESUVIUS,
'datil-test': LIT_RPC.CHRONICLE_VESUVIUS,
custom: LIT_RPC.LOCAL_ANVIL,
localhost: LIT_RPC.LOCAL_ANVIL,
};

/**
* Mapping of network names to their corresponding relayer URLs.
*/
export const RELAYER_URL_BY_NETWORK: { [key in LIT_NETWORK_VALUES]: string } = {
cayenne: 'https://relayer-server-staging-cayenne.getlit.dev',
manzano: 'https://manzano-relayer.getlit.dev',
habanero: 'https://habanero-relayer.getlit.dev',
'datil-dev': 'https://datil-dev-relayer.getlit.dev',
'datil-test': 'https://datil-test-relayer.getlit.dev',
custom: 'http://localhost:3000',
localhost: 'http://localhost:3000',
};

/**
* URL mappings for general worker URLs by network.
*/
export const GENERAL_WORKER_URL_BY_NETWORK: {
[key in LIT_NETWORK_VALUES]: string;
} = {
cayenne: 'https://apis.getlit.dev/cayenne/contracts',
manzano: 'https://apis.getlit.dev/manzano/contracts',
habanero: 'https://apis.getlit.dev/habanero/contracts',
'datil-dev': 'https://apis.getlit.dev/datil-dev/contracts',
'datil-test': 'https://apis.getlit.dev/datil-test/contracts',

// just use cayenne abis for custom and localhost
custom: 'https://apis.getlit.dev/cayenne/contracts',
localhost: 'https://apis.getlit.dev/cayenne/contracts',
};

/**
* URL constants for the staging worker by network.
*
* @remarks
* This constant maps each network to its corresponding staging worker URL.
*/
export const GENERAL_STAGING_WORKER_URL_BY_NETWORK: {
[key in LIT_NETWORK_VALUES]: string;
} = {
cayenne: 'https://staging.apis.getlit.dev/cayenne/contracts',
manzano: 'https://staging.apis.getlit.dev/manzano/contracts',
habanero: 'https://staging.apis.getlit.dev/habanero/contracts',
'datil-dev': 'https://staging.apis.getlit.dev/datil-dev/contracts',
'datil-test': 'https://staging.apis.getlit.dev/datil-test/contracts',

// just use cayenne abis for custom and localhost
custom: 'https://apis.getlit.dev/cayenne/contracts',
localhost: 'https://apis.getlit.dev/cayenne/contracts',
};

/**
* Mapping of network values to corresponding chain info.
*/
export const CHAIN_INFO_BY_NETWORK: Record<
LIT_NETWORK_VALUES,
| typeof metamaskChainInfo.chronicle
| typeof metamaskChainInfo.chronicleVesuvius
> = {
cayenne: metamaskChainInfo.chronicle,
manzano: metamaskChainInfo.chronicle,
habanero: metamaskChainInfo.chronicle,
'datil-dev': metamaskChainInfo.chronicleVesuvius,
'datil-test': metamaskChainInfo.chronicleVesuvius,
custom: metamaskChainInfo.chronicleVesuvius,
localhost: metamaskChainInfo.chronicleVesuvius,
};

/**
* Solana Chains supported by the LIT protocol. Use the chain name as a key in this object.
* @constant
Expand Down Expand Up @@ -839,11 +991,30 @@ export const TELEM_API_URL = 'https://lit-general-worker.getlit.dev';
// ========== RLI Delegation ==========
export const SIWE_DELEGATION_URI = 'lit:capability:delegation';

/**
* @deprecated Will be removed in version 7.x. - Use RELAYER_URL_BY_NETWORK.Cayenne instead
*/
export const RELAY_URL_CAYENNE =
'https://relayer-server-staging-cayenne.getlit.dev';

/**
* @deprecated Will be removed in version 7.x. - Use RELAYER_URL_BY_NETWORK.Habanero instead
*/
export const RELAY_URL_HABANERO = 'https://habanero-relayer.getlit.dev';

/**
* @deprecated Will be removed in version 7.x. - Use RELAYER_URL_BY_NETWORK.Manzano instead
*/
export const RELAY_URL_MANZANO = 'https://manzano-relayer.getlit.dev';

/**
* @deprecated Will be removed in version 7.x. - Use RELAYER_URL_BY_NETWORK.DatilDev instead
*/
export const RELAY_URL_DATIL_DEV = 'https://datil-dev-relayer.getlit.dev';

/**
* @deprecated Will be removed in version 7.x. - Use RELAYER_URL_BY_NETWORK.DatilTest instead
*/
export const RELAY_URL_DATIL_TEST = 'https://datil-test-relayer.getlit.dev';

// ========== Lit Actions ==========
Expand Down
Loading
Loading