Last updated on October 23, 2023
5 min read
How to use GetBlock configuration files
How to make HTTP requests with curl using JSON config file
Using GetBlock’s JSON configuration file with curl is particularly helpful when you need to access various node endpoints without hardcoding API keys in the code:
- Download the
getblock.config.json
file from your GetBlock account; - Make sure you have jq installed. jq is a versatile command-line tool that enables extracting values from JSON files;
- Navigate to your workspace or directory where you have imported the
getblock.config.json
file and open a terminal; - Now, you can make a GET request to a selected node endpoint using the curl command:
curl -X GET https://go.getblock.io/"$(jq -r '.shared.btc.mainnet.rest[0]' getblock.config.json)"/rest/chaininfo.json
How to use GetBlock’s JavaScript config with Web3.js
In this brief guide, we'll walk you through the process of connecting to Ethereum nodes as well as other EVM-compatible networks using web3.js and GetBlock’s JS configuration file. This approach abstracts the details of the API endpoint, providing a heightened level of security.
- Make sure the web3.js library is added to your project. In order to do that, use one of the following methods:
- Npm:
npm install web3
- Yarn:
yarn add web3
- Pure js link:
dist/web3.min.js
- Install
getblock.config.js
file found in your GetBlock account. Add this file to your project directory; - Import the getblock module to a .js file that configures a new Web3 instance:
const { getblock } = require('./getblock.config.js');
- Connect to an Ethereum node and start sending API calls using web3.js over HTTP or WebSocket in the format below:
const { getblock } = require('./getblock.config.js');
var Web3 = require('web3');
// Create the JSON-RPC provider
var web3Rpc = new Web3(new Web3.providers.HttpProvider(
getblock.shared.eth.mainnet.rpc[0].go()
));
// Create the WebSocket provider
var web3Ws = new Web3.providers.WebsocketProvider(
`wss://go.getblock.io/${getblock.shared.eth.mainnet.ws[0].token()}`
));
Use go() method to access an entire endpoint or token() to fetch the token.
How to use the JS config with Hardhat
GetBlock’s configuration file provides a more organized and flexible approach to interacting with Ethereum nodes and EVM-compatible networks without exposing sensitive API keys or credentials in the code. Set up GetBlock’s JS config file in Hardhat following the steps below:
- Ensure you have Hardhat installed as a dependency in your Node.js project or run the following command to do so:
npm install --save-dev hardhat
- Navigate to your GetBlock account and install the
getblock.config.js
file. Copy and paste it into your working directory; - Open the
hardhat.config.js
file from your project directory and import the getblock module:
const { getblock } = require('./getblock.config.js');
- To set up GetBlock as a provider, modify the Hardhat configuration file with the credentials as shown below. Use go() method to access an entire endpoint or token() to fetch the token only.
const { getblock } = require('./getblock.config.js');
module.exports = {
defaultNetwork: "sepolia",
networks: {
hardhat: {
},
sepolia: {
url: getblock.shared.eth.sepolia.rpc[0].go() // https://go.getblock.io/<ACCESS-TOKEN>/
},
goerli: {
url: `https://go.getblock.io/${getblock.shared.eth.goerli.rpc[0].token()}` // <ACCESS-TOKEN>
},
},
solidity: {
version: "0.8.19",
settings: {
optimizer: {
enabled: true,
runs: 200
}
}
},
paths: {
sources: "./contracts",
tests: "./test",
cache: "./cache",
artifacts: "./artifacts"
},
mocha: {
timeout: 40000
}
}
Previous
{ "overview": "Overview", "guides": "Guides", "get-started": "Get Started", "rpc-service": "Nodes Methods", "getblock-explorer": "Explorer API", "getblock-tracker": "Tracker API", "nodes-endpoints": "Nodes Endpoints" }
Next
{ "overview": "Overview", "guides": "Guides", "get-started": "Get Started", "rpc-service": "Nodes Methods", "getblock-explorer": "Explorer API", "getblock-tracker": "Tracker API", "nodes-endpoints": "Nodes Endpoints" }