https://github.com/chainstacklabs/chainstack-covalent-sdk
A JavaScript SDK designed to streamline the process of developing using the integration of Chainstack with Covalent APIs, enhancing the ease of use and efficiency
https://github.com/chainstacklabs/chainstack-covalent-sdk
chainstack covalent-api javascript sdk
Last synced: 10 months ago
JSON representation
A JavaScript SDK designed to streamline the process of developing using the integration of Chainstack with Covalent APIs, enhancing the ease of use and efficiency
- Host: GitHub
- URL: https://github.com/chainstacklabs/chainstack-covalent-sdk
- Owner: chainstacklabs
- License: apache-2.0
- Created: 2023-05-25T17:56:17.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-16T11:34:47.000Z (almost 2 years ago)
- Last Synced: 2025-03-27T06:12:16.771Z (10 months ago)
- Topics: chainstack, covalent-api, javascript, sdk
- Language: JavaScript
- Homepage: https://docs.chainstack.com/docs/work-with-chainstack-marketplace
- Size: 62.5 KB
- Stars: 12
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Chainstack is the leading suite of services connecting developers with Web3 infrastructure
• Homepage •
Supported protocols •
Chainstack blog •
Chainstack docs •
Blockchain API reference •
• Start for free •
# Chainstack Covalent API JavaScript SDK
A JavaScript SDK designed to streamline the process of developing using the integration of Chainstack with Covalent APIs, enhancing the ease of use and efficiency.
## Quickstart
* Install the [Chainstack-Covalent integration](https://docs.chainstack.com/docs/work-with-chainstack-marketplace#install-an-app) from your Chainstack console.
* Get a [Chainstack API key](https://docs.chainstack.com/reference/platform-api-getting-started#create-api-key).
* In your project's directory, install the Chainstack SDK:
```sh
npm i chainstack-covalent-sdk
```
* In a new file, import the Chainstack SDK and use your Chainstack API key in the constructor:
```js
const {ChainstackApi} = require("chainstack-covalent-sdk")
const CHAINSTACK_API_KEY = 'YOUR_CHAINSTACK_API_KEY'
const chainstack = new ChainstackApi(CHAINSTACK_API_KEY);
```
* (Optional but recommended) — The Chainstack-Covalent SDK comes with the `dotenv` package included, so you can use a `.env` file to import the Chainstack API key:
- Create a `.env` file with your Chainstack API key:
```env
CHAINSTACK_API_KEY="YOUR_CHAINSTACK_API_KEY"
```
- Import it in your project:
```js
const {ChainstackApi} = require("chainstack-covalent-sdk")
const CHAINSTACK_API_KEY = process.env.CHAINSTACK_API_KEY
const chainstack = new ChainstackApi(CHAINSTACK_API_KEY);
```
## Usage
The Chainstack-Covalent SDK has many endpoints to get all sorts of data, from smart contract deployments to NFT data. Each endpoint takes an object as a parameter to configure the call to the Covalent API.
### Fetch token balances
This endpoint fetches all the token balances from the specified address on the selected chain:
```js
const {ChainstackApi} = require("chainstack-covalent-sdk")
const CHAINSTACK_API_KEY = process.env.CHAINSTACK_API_KEY
const chainstack = new ChainstackApi(CHAINSTACK_API_KEY);
// Config parameters
const parameters = {
chainName: 'eth-mainnet',
walletAddress: '0xae2Fc483527B8EF99EB5D9B44875F005ba1FaE13',
currency: 'USD',
nft: true,
noNftFetch: false,
noSpam: true,
};
chainstack.fetchTokenBalances(parameters)
.then(data => console.log(data))
.catch(error => console.error(error));
```
#### Explain the parameter object
The parameters object allows for fine tuning of your request, here is the explanation about the configuration parameters for `fetchTokenBalances`:
1. **chainName** (string, required): This parameter represents the name of the blockchain network you're interested in. For example, 'eth-mainnet' for the Ethereum mainnet. Find a complete list on the [Covalent docs](https://www.covalenthq.com/docs/networks/).
```javascript
const chainName = 'eth-mainnet';
```
2. **walletAddress** (string, required): This is the address of the wallet for which you want to fetch token balances. If you pass in an Ethereum Name Service (ENS) address or a RSK Name Service (RNS) address, it will be automatically resolved to the corresponding wallet address.
```javascript
const walletAddress = '0xae2Fc483527B8EF99EB5D9B44875F005ba1FaE13';
```
3. **quote-currency** (string, optional): This is the currency in which you want the balances to be quoted, such as 'USD' for United States Dollars. If not provided, the balances may be returned in the native currency of the blockchain network.
```javascript
const quoteCurrency = 'USD';
```
4. **nft** (boolean, optional): If set to `true`, Non-Fungible Tokens (NFTs) will be included in the response along with fungible tokens. If `false` or not provided, NFTs will not be included.
```javascript
const nft = true;
```
5. **no-nft-fetch** (boolean, optional): If set to `true`, the response will only include NFTs that have been cached. This can make the response faster, as it avoids having to fetch data about NFTs from the blockchain. If `false` or not provided, all NFTs will be included, regardless of whether they are cached.
```javascript
const noNftFetch = false;
```
6. **no-spam** (boolean, optional): If set to `true`, any tokens that are suspected to be spam will be excluded from the response. This currently supports 'eth-mainnet' and 'matic-mainnet'. If `false` or not provided, all tokens, including potential spam, will be included.
```javascript
const noSpam = true;
```
Remember, this function returns a promise. Handle this promise appropriately in your code, either by using `.then()` and `.catch()` methods, or by using the `await` keyword inside an async function with a try-catch block.
## Work in progress
This tool and its documentation is work in progress, we will be adding a complete list of endpoints available soon.