chainlist-rpcs 0.0.1

package/.babelrc

@@ -0,0 +1,5 @@
+{
+    "presets": [
+        "@babel/preset-react"
+    ]
+}

package/.eslintrc.cjs

@@ -0,0 +1,8 @@
+// const { eslint_config } = require( './index.cjs' )
+const { eslint_config } = require( 'airier' )
+
+// Export the default eslint config
+module.exports = {
+    ...eslint_config,
+    settings: { "react": { "version": "16" }  },
+}

package/.husky/pre-commit

@@ -0,0 +1,21 @@
+#!/usr/bin/env sh
+. "$(dirname -- "$0")/_/husky.sh"
+
+echo "\n🤖 [ precommit hook ] linting before committing..."
+
+
+# If errors, make it clear they cannot commit
+if ! lint_outcome=$( npm run lint ); then
+    echo "🚨 [ precommit hook ] lint encountered blocking issues, fix them before committing\n"
+    echo "$lint_outcome"
+    exit 1
+fi
+
+# If warnings, suggest they fix them
+if echo $lint_outcome | grep -q "warning"; then
+    echo "⚠️ [ precommit hook ] lint encountered warnings, consider fixing them before pushing\n"
+    echo "$lint_outcome"
+    exit 0
+fi
+
+echo "✅ [ precommit hook ] lint encountered no blocking issues\n"

package/.npmrc.bak

@@ -0,0 +1 @@
+//registry.npmjs.org/:_authToken=${NPM_ACCESS_TOKEN}

package/.vscode/settings.json

@@ -0,0 +1,27 @@
+{
+	"i18n-ally.localesPaths": [
+		"public/locales"
+	],
+	"i18n-ally.keystyle": "nested",
+	"eslint.validate": [
+		"javascript",
+		"javascriptreact",
+		"typescript",
+		"typescriptreact"
+	],
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": "explicit"
+	},
+	"editor.renderWhitespace": "all",
+	"editor.formatOnSave": true,
+	"eslint.format.enable": true,
+	"eslint.run": "onType",
+	"explorer.fileNesting.enabled": true,
+	"explorer.fileNesting.patterns": {
+		"vite.config.js": "*.js,.babelrc,.nvmrc,index.html,.gitignore",
+		".env": ".env*,.*.json",
+		"firebase.json": "fire*,.fire*",
+		"package.json": "package-lock.json, yarn.lock, pnpm-lock.yaml,.eslint*,config.*,.npm*,.nvm*,.ncu*",
+		"README.md": "*.md,LICENSE",
+	}
+}

package/README.md

@@ -0,0 +1,82 @@
+# Unofficial chainlist RPC npm module
+
+Installation: `npm install -S `
+
+NOTE: This module is unofficial and not maintained by Chainlist. If you want to add RPC urls, please refer to the [DefiLlama/chainlist](https://github.com/DefiLlama/chainlist) repository.
+
+NOTE 2: Keep in mind these RPCs are public and may have rate limits and imperfedt uptimel Use them at your own risk.
+
+## Usage of constants
+
+The module exports constants that are objects you can access. The `rpcs` and `chains_by_id` constants which equal the chainlist sources [in this folder of their repository](https://github.com/DefiLlama/chainlist/tree/main/constants). The `chains_by_name` constant is an object that maps chain names to their id.
+
+```js
+import { rpcs, chains_by_id, chains_by_name } from 'chainlist-rpc'
+
+console.log( chains[1] ) // Output: "ethereum"
+console.log( rpcs[1] ) // { rpcs: [ { url: String, tracking: String, trackingDetauls: String } ] }
+console.log( chains_by_name["ethereum"] ) // Output: 1
+```
+
+## Usage of helper functions
+
+This module makes available helpers that allow you to grab RPCs based on chain id or chain name.
+
+```js
+/**
+ * Retrieves the RPC urls for a specified blockchain.
+ *
+ * @param {Object} params - The parameters for retrieving RPCs.
+ * @param {number} [params.chain_id] - The ID of the blockchain.
+ * @param {string} [params.chain_name] - The name of the blockchain.
+ * @param {Array} [params.allowed_tracking=[]] - An array of tracking objects. Options: none, limited, yes.
+ * @returns {Array} The list of RPCs for the specified blockchain.
+ * @throws {Error} If both chain_id and chain_name are specified but do not match.
+ */
+export function get_rpcs_for_chain( { chain_id, chain_name, allowed_tracking=[] } )
+
+/**
+ * Retrieves the RPC urls for the specified chains.
+ *
+ * @param {Object} params - The parameters object.
+ * @param {Array<string>} [params.chain_ids=[]] - An array of chain IDs.
+ * @param {Array<string>} [params.chain_names=[]] - An array of chain names.
+ * @param {Array} [params.allowed_tracking=[]] - An array of tracking objects. Options: none, limited, yes.
+ * @returns {Array} An array of RPCs for the specified chains.
+ */
+export function get_rcpcs_for_chains( { chain_ids=[], chain_names=[], allowed_tracking=[] } )
+
+```
+
+Example usage:
+
+```js
+import { get_rcpcs_for_chain, get_rcpcs_for_chains } from 'chainlist-rpc'
+
+const single_chain_by_id = get_rcpcs_for_chain( { chain_id: 1 } ) // Output: [ { url: String, tracking: String, trackingDetauls: String } ]
+const single_chain_by_name = get_rcpcs_for_chain( { chain_name: "ethereum" } ) // Output: [ { url: String, tracking: String, trackingDetauls: String } ]
+
+const multiple_chains_by_id = get_rcpcs_for_chains( { chain_ids: [1, 42161] } ) // Output: { 1: [ { url: String, tracking: String, trackingDetauls: String } ], 42161: [ { url: String, tracking: String, trackingDetauls: String } ], ethereum: [ { url: String, tracking: String, trackingDetauls: String } ], arbitrum: [ { url: String, tracking: String, trackingDetauls: String } ] }
+
+const multiple_chains_by_name = get_rcpcs_for_chains( { chain_names: ["ethereum", "arbitrum"] } ) // Output: { 1: [ { url: String, tracking: String, trackingDetauls: String } ], 42161: [ { url: String, tracking: String, trackingDetauls: String } ], ethereum: [ { url: String, tracking: String, trackingDetauls: String } ], arbitrum: [ { url: String, tracking: String, trackingDetauls: String } ] }
+
+```
+
+## Example usage with viem
+
+```js
+import { get_rcpcs_for_chain, get_rcpcs_for_chains } from 'chainlist-rpc'
+import { arbitrum } from 'viem/chains'
+import { createPublicClient, fallback, http, formatEther } from 'viem'
+
+const your_private_rpc_endpoints = [ "https://your-private-rpc-endpoint.com", "https://your-private-rpc-endpoint-2.com" ]
+const chainlink_rpc_endpoints = get_rcpcs_for_chain( { chain_name: 'arbitrum' } )
+const rpc_endpoints = [ ...your_private_rpc_endpoints, ...chainlink_rpc_endpoints ]
+
+const public_client = createPublicClient( {
+    chain: arbitrum,
+    transport: fallback( rpc_endpoints.map( ( rpc ) => http( rpc ) ) )
+} )
+
+const gas_price_wei = await public_client.getGasPrice()
+```

package/app.js

@@ -0,0 +1,7 @@
+// Export the constants verbatim
+export { default as rpcs } from './constants/extraRpcs'
+export { default as chains_by_id } from './constants/chainIds'
+
+// Export the helper functions
+export { chains_by_name } from './modules/chains'
+export { get_rpcs_for_chain, get_rcpcs_for_chains } from './modules/filter'