chainlist-rpcs 0.1.4 → 0.2.2

package/README.md

@@ -4,7 +4,7 @@ Installation: `npm install -S chainlist-rpcs`
 
 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.
+NOTE 2: Keep in mind these RPCs are public and may have rate limits and imperfect uptime. Use them at your own risk.
 
 ## Usage of constants
 
@@ -13,8 +13,8 @@ The module exports constants that are objects you can access. The `rpcs` and `ch
 ```js
 import { rpcs, chains_by_id, chains_by_name } from 'chainlist-rpcs'
 
-console.log( chains[1] ) // Output: "ethereum"
-console.log( rpcs[1] ) // { rpcs: [ { url: String, tracking: String, trackingDetauls: String } ] }
+console.log( chains[1] ) // Output: "ethereum". Note that this is by chain id and not by index. 1 here refers to chain id 1.
+console.log( rpcs[1] ) // { rpcs: [ { url: String, tracking: String, trackingDetails: String } ] }.
 console.log( chains_by_name["ethereum"] ) // Output: 1
 ```
 
@@ -44,33 +44,33 @@ export function get_rpcs_for_chain( { chain_id, chain_name, allowed_tracking=[]
  * @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=[] } )
+export function get_rpcs_for_chainss( { chain_ids=[], chain_names=[], allowed_tracking=[] } )
 
 ```
 
 Example usage:
 
 ```js
-import { get_rcpcs_for_chain, get_rcpcs_for_chains } from 'chainlist-rpcs'
+import { get_rpcs_for_chains, get_rpcs_for_chainss } from 'chainlist-rpcs'
 
-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 single_chain_by_id = get_rpcs_for_chains( { chain_id: 1 } ) // Output: [ { url: String, tracking: String, trackingDetails: String } ]
+const single_chain_by_name = get_rpcs_for_chains( { chain_name: "ethereum" } ) // Output: [ { url: String, tracking: String, trackingDetails: 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_id = get_rpcs_for_chainss( { chain_ids: [1, 42161] } ) // Output: { 1: [ { url: String, tracking: String, trackingDetails: String } ], 42161: [ { url: String, tracking: String, trackingDetails: String } ], ethereum: [ { url: String, tracking: String, trackingDetails: String } ], arbitrum: [ { url: String, tracking: String, trackingDetails: 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 } ] }
+const multiple_chains_by_name = get_rpcs_for_chainss( { chain_names: ["ethereum", "arbitrum"] } ) // Output: { 1: [ { url: String, tracking: String, trackingDetails: String } ], 42161: [ { url: String, tracking: String, trackingDetails: String } ], ethereum: [ { url: String, tracking: String, trackingDetails: String } ], arbitrum: [ { url: String, tracking: String, trackingDetails: String } ] }
 
 ```
 
 ## Example usage with viem
 
 ```js
-import { get_rcpcs_for_chain, get_rcpcs_for_chains } from 'chainlist-rpc'
+import { get_rpcs_for_chains, get_rpcs_for_chainss } 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 chainlink_rpc_endpoints = get_rpcs_for_chains( { chain_name: 'arbitrum' } )
 const rpc_endpoints = [ ...your_private_rpc_endpoints, ...chainlink_rpc_endpoints ]
 
 const public_client = createPublicClient( {

package/app.js

@@ -4,4 +4,4 @@ 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'
+export { get_rpcs_for_chain, get_rpcs_for_chains } from './modules/filter'

package/modules/filter.js

@@ -49,7 +49,7 @@ export function get_rpcs_for_chain( { chain_id, chain_name, allowed_tracking=[]
  * @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=[] } ) {
+export function get_rpcs_for_chains( { chain_ids=[], chain_names=[], allowed_tracking=[] } ) {
 
     // If chain names were specified, get the chain ids
     chain_ids = [

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chainlist-rpcs",
-  "version": "0.1.4",
+  "version": "0.2.2",
   "type": "module",
   "description": "Wrapper around the rpcs as published by DefiLlama/chainlist.",
   "main": "app.js",
@@ -29,4 +29,4 @@
     "husky": "^9.1.6",
     "vitest": "^2.1.5"
   }
-}
+}

package/tests/filter.test.js

@@ -1,6 +1,6 @@
 import { describe, it, expect } from 'vitest'
 
-import { get_rcpcs_for_chains, get_rpcs_for_chain } from '../modules/filter'
+import { get_rpcs_for_chains, get_rpcs_for_chain } from '../modules/filter'
 
 describe( 'get_rpcs_for_chain', () => {
 
@@ -81,12 +81,12 @@ describe( 'get_rpcs_for_chain', () => {
 
 } )
 
-describe( 'get_rcpcs_for_chains', () => {
+describe( 'get_rpcs_for_chains', () => {
 
     it( 'should return RPCs when called with valid chain_ids', () => {
 
         const chain_ids = [ 1, 42161 ]
-        const result = get_rcpcs_for_chains( { chain_ids } )
+        const result = get_rpcs_for_chains( { chain_ids } )
         expect( result[1].length ).to.be.greaterThan( 1 )
         expect( result[42161].length ).to.be.greaterThan( 1 )
 
@@ -95,7 +95,7 @@ describe( 'get_rcpcs_for_chains', () => {
     it( 'should return RPCs when called with valid chain_names', () => {
 
         const chain_names = [ 'ethereum', 'arbitrum' ]
-        const result = get_rcpcs_for_chains( { chain_names } )
+        const result = get_rpcs_for_chains( { chain_names } )
         expect( result[ 'ethereum' ].length ).to.be.greaterThan( 1 )
         expect( result[ 'arbitrum' ].length ).to.be.greaterThan( 1 )