chainlist-rpcs 0.2.10 → 0.3.0

package/README.md

@@ -1,6 +1,6 @@
 # Unofficial chainlist RPC npm module
 
-Installation: `npm install -S chainlist-rpcs`
+Installation: `npm install -S chainlist-rpcs`. See [npm package](https://www.npmjs.com/package/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.
 
@@ -14,7 +14,7 @@ The module exports constants that are objects you can access. The `rpcs` and `ch
 import { rpcs, chains_by_id, chains_by_name } from 'chainlist-rpcs'
 
 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( rpcs[1] ) // [ { url: String, tracking: String, trackingDetails: String } ].
 console.log( chains_by_name["ethereum"] ) // Output: 1
 ```
 

package/app.js

@@ -1,5 +1,5 @@
-// Export the constants verbatim
-export { default as rpcs } from './constants/extraRpcs'
+// Export the constants
+export { default as rpcs } from './modules/rpcs'
 export { default as chains_by_id } from './constants/chainIds'
 
 // Export the helper functions

package/modules/rpcs.js

@@ -0,0 +1,19 @@
+import rpcs from '../constants/extraRpcs'
+
+// The llama format is { [Number]: { rpcs: [] } }, we can simplify that
+const simple_rpc_list = Object.keys( rpcs ).reduce( ( acc, chainId ) => {
+    acc[chainId] = rpcs[chainId].rpcs || []
+    return acc
+},{} )
+
+// The llama format for an RPC is sometimes and object and sometimes a string, let's normalize that
+Object.keys( simple_rpc_list ).forEach( chainId => {
+    simple_rpc_list[chainId] = simple_rpc_list[chainId].map( rpc => {
+        if( typeof rpc === 'string' ) {
+            return { url: rpc }
+        }
+        return rpc
+    } )
+} )
+
+export default simple_rpc_list

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "chainlist-rpcs",
-  "version": "0.2.10",
+  "version": "0.3.0",
   "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,7 @@
 import { describe, it, expect } from 'vitest'
 
-import { get_rpcs_for_chains, get_rpcs_for_chain } from '../modules/filter'
+import { get_rpcs_for_chains, get_rpcs_for_chain, chains_by_name } from '../app'
+import { chains_by_id } from '../app'
 
 describe( 'get_rpcs_for_chain', () => {
 
@@ -101,4 +102,22 @@ describe( 'get_rpcs_for_chains', () => {
 
     } )
 
+} )
+
+describe( 'Chain constant should have coherent values', () => {
+
+    it( 'Should have some expected chain ids', () => {
+        const expected_chain_ids = [ 1, 42161 ]
+        for( const chain_id of expected_chain_ids ) {
+            expect( chains_by_id[chain_id] ).toBeDefined()
+        }
+    } )
+
+    it( 'Should have some expected chain names', () => {
+        const expected_chain_names = [ 'ethereum', 'arbitrum' ]
+        for( const chain_name of expected_chain_names ) {
+            expect( chains_by_name[chain_name] ).toBeDefined()
+        }
+    } )
+
 } )