@avalabs/core-covalent-sdk 2.8.0-alpha.197

package/LICENSE

@@ -0,0 +1,9 @@
+Copyright (C) 2021, Ava Labs, Inc. All rights reserved.
+
+Subject to the limited license below (**”License””), you may not, and you may not permit anyone else to, copy, reproduce, aggregate, republish, download, post, distribute, license, sublicense, reverse engineer, modify, or create derivative works based on this software (collectively, **“Software”**). 
+
+You are hereby granted a limited, non-exclusive, non-sublicensable and non-transferable license to download and use the Software as-is solely (i) for use in connection with the Avalanche Public Blockchain platform, having a NetworkID of 1 (Mainnet) or 5 (Fuji), and associated blockchains, comprised exclusively of the Avalanche X-Chain, C-Chain, P-Chain and any subnets linked to the P-Chain (**“Avalanche Authorized Platform”**) or (ii) for non-production, testing or research purposes without any commercial application within the Avalanche ecosystem (**“Non-Commercial Use”**); provided that, in each case, you may not use or allow use of the Software (a) in connection with any forks of the Avalanche Authorized Platform, (b) in any manner not operationally connected to the Avalanche Authorized Platform other than for Non-Commercial Use, or (c) to the extent the number of monthly active users or the number of total installs of any software that uses the Software across all versions thereof exceeds 10,000 at any time. You may not modify or alter the Software in any way.
+
+You hereby acknowledge and agree to the terms set forth at www.avalabs.org/important-notice.
+
+**TO THE MAXIMUM EXTENT PERMITTED BY LAW, THE SOFTWARE IS PROVIDED ON AN “AS IS” BASIS, AND AVA LABS EXPRESSLY DISCLAIMS AND EXCLUDES ALL REPRESENTATIONS, WARRANTIES AND OTHER TERMS AND CONDITIONS, WHETHER EXPRESS OR IMPLIED, INCLUDING WITHOUT LIMITATION BY OPERATION OF LAW OR BY CUSTOM, STATUTE OR OTHERWISE, AND INCLUDING, BUT NOT LIMITED TO, ANY IMPLIED WARRANTY, TERM, OR CONDITION OF NON-INFRINGEMENT, MERCHANTABILITY, TITLE, OR FITNESS FOR PARTICULAR PURPOSE. YOU USE THE SOFTWARE AT YOUR OWN RISK. AVA LABS EXPRESSLY DISCLAIMS ALL LIABILITY (INCLUDING FOR ALL DIRECT, CONSEQUENTIAL OR OTHER DAMAGES OR LOSSES) RELATED TO ANY USE OF THE SOFTWARE.**

package/README.md

@@ -0,0 +1,11 @@
+# `covalent-sdk`
+
+> TODO: description
+
+## Usage
+
+```
+const covalentSdk = require('covalent-sdk');
+
+// TODO: DEMONSTRATE API
+```

package/dist/index.d.ts

@@ -0,0 +1,170 @@
+import { HttpOptions } from '@avalabs/core-utils-sdk';
+
+interface GetAddressBalancesV2Response {
+    data: {
+        address: string;
+        updated_at: string;
+        next_update_at: string;
+        quote_currency: string;
+        chain_id: number;
+        items: GetAddressBalanceV2Item[];
+        pagination: null | PaginationResponse;
+    };
+    error: boolean;
+    error_message: null | string;
+    error_code: null | string;
+}
+interface PaginationQuery {
+    pageSize: number;
+    pageNumber: number;
+}
+interface PaginationResponse {
+    has_more: boolean;
+    page_number: number;
+    page_size: number;
+    total_count: null | number;
+}
+interface GetAddressBalanceV2Item {
+    contract_decimals: number;
+    contract_name: string;
+    contract_ticker_symbol: string;
+    contract_address: string;
+    supports_erc: null | string[];
+    logo_url: string;
+    last_transferred_at: null | string;
+    type: 'cryptocurrency' | 'dust' | 'nft';
+    balance: string;
+    balance_24h: null | string;
+    quote_rate: number;
+    quote_rate_24h: null | number;
+    quote: number;
+    quote_24h: null | number;
+    nft_data: null | NFTData[];
+}
+interface NFTAttribute {
+    trait_type: string;
+    value: string;
+}
+interface NFTData {
+    token_id: string;
+    token_balance: null | string;
+    token_url: null | string;
+    supports_erc: string[];
+    token_price_wei: null;
+    token_quote_rate_eth: null;
+    original_owner: string;
+    external_data: {
+        name: string;
+        description: string;
+        image: string;
+        image_256: string;
+        image_512: string;
+        image_1024: string;
+        animation_url: string | null;
+        external_url: string | null;
+        attributes: NFTAttribute[];
+        owner: string | null;
+    };
+    owner: string;
+    owner_address: null;
+    burned: null;
+}
+interface GetTxsForAddressResponse {
+    data: {
+        address: string;
+        updated_at: string;
+        next_update_at: string;
+        quote_currency: string;
+        chain_id: number;
+        items: AddressTxsItem[];
+        pagination: null | PaginationResponse;
+    };
+    error: boolean;
+    error_message: null | string;
+    error_code: null | string;
+}
+interface AddressTxsItem {
+    block_signed_at: string;
+    block_height: number;
+    tx_hash: string;
+    tx_offset: number;
+    successful: boolean;
+    from_address: string;
+    from_address_label: null | string;
+    to_address: string;
+    to_address_label: null | string;
+    value: string;
+    value_quote: number;
+    gas_offered: number;
+    gas_spent: number;
+    gas_price: number;
+    gas_quote: number;
+    gas_quote_rate: number;
+    logEvents?: TxsLogEvent[];
+}
+interface TxsLogEvent {
+    block_signed_at: string;
+    block_height: number;
+    tx_offset: number;
+    log_offset: number;
+    tx_hash: string;
+    raw_log_topics: string[];
+    sender_contract_decimals: number;
+    sender_name: null | string;
+    sender_contract_ticker_symbol: null | string;
+    sender_address: string;
+    sender_address_label: null | string;
+    sender_logo_url: null | string;
+    raw_log_data: string;
+    decoded: any;
+}
+
+declare class Covalent {
+    private chainID;
+    private apiKey;
+    private httpClient;
+    constructor(chainID: number, apiKey?: string);
+    /**
+     * Set the API key used by this instance.
+     * @param key
+     */
+    setApiKey(key: string | undefined): void;
+    /**
+     * Connect to a different chain.
+     * @param chainID
+     */
+    setChainID(chainID: number): void;
+    /**
+     * Return current token balances along with their spot prices. This endpoint supports a variety of
+     * token standards like ERC20, ERC721 and ERC1155. As a special case, network native tokens like ETH
+     * on Ethereum are also returned even though it's not a token contract.
+     * @param address The address to check the balance of.
+     * @param nft True if you want NFT data returned.
+     * @param currency The currency to get price data on.
+     * @param pagination
+     */
+    getAddressBalancesV2(address: string, nft?: boolean, currency?: string, pagination?: PaginationQuery, httpOptions?: {
+        params?: Record<string, string>;
+        customOptions?: HttpOptions;
+    }): Promise<GetAddressBalancesV2Response>;
+    /**
+     * Return all transactions along with their decoded log events. This endpoint does a
+     * deep-crawl of the blockchain to retrieve all kinds of transactions that references the address
+     * including indexed topics within the event logs.
+     * @param address Address to get history of.
+     * @param currency
+     * @param ascending Order by ascending.
+     * @param logs Set to `true` if you want event logs.
+     * @param pagination
+     */
+    getTransactionsForAddress(address: string, currency?: string, ascending?: boolean, logs?: boolean, pagination?: PaginationQuery, httpOptions?: {
+        params?: Record<string, string>;
+        customOptions?: HttpOptions;
+    }): Promise<GetTxsForAddressResponse>;
+}
+
+declare const BASE_URL = "https://api.covalenthq.com";
+
+declare function createApiUrl(chainID: number, version?: number): string;
+
+export { AddressTxsItem, BASE_URL, Covalent, GetAddressBalanceV2Item, GetAddressBalancesV2Response, GetTxsForAddressResponse, NFTAttribute, NFTData, PaginationQuery, PaginationResponse, TxsLogEvent, createApiUrl };

package/dist/index.js

@@ -0,0 +1 @@
+"use strict";var t=require("@avalabs/core-utils-sdk");const e="https://api.covalenthq.com";function a(t,a=1){return`${e}/v${a}/${t}`}exports.BASE_URL=e,exports.Covalent=class{chainID;apiKey;httpClient;constructor(e,s){this.chainID=e,this.apiKey=s,this.httpClient=new t.HttpClient(a(e))}setApiKey(t){this.apiKey=t}setChainID(e){this.chainID=e,this.httpClient=new t.HttpClient(a(e))}async getAddressBalancesV2(t,e=!1,a="USD",s,n){const i=new URLSearchParams({...n?.params,nft:e.toString(),"quote-currency":a});this.apiKey&&i.append("key",this.apiKey),s&&i.append("page-size",s.pageSize.toString()),s&&i.append("page-number",s.pageNumber.toString());const r=`/address/${t}/balances_v2/`;return await this.httpClient.get(r,Object.fromEntries(i),n?.customOptions)}async getTransactionsForAddress(t,e="USD",a=!1,s=!1,n,i){const r=new URLSearchParams({...i?.params,"block-signed-at-asc":a?"true":"false","quote-currency":e,"no-logs":s?"false":"true"});this.apiKey&&r.append("key",this.apiKey),n&&r.append("page-size",n.pageSize.toString()),n&&r.append("page-number",n.pageNumber.toString());const p=`/address/${t}/transactions_v2/`;return await this.httpClient.get(p,Object.fromEntries(r),i?.customOptions)}},exports.createApiUrl=a;

package/esm/Covalent.d.ts

@@ -0,0 +1,48 @@
+import { HttpOptions } from '@avalabs/core-utils-sdk';
+import { PaginationQuery, GetAddressBalancesV2Response, GetTxsForAddressResponse } from './models.js';
+
+declare class Covalent {
+    private chainID;
+    private apiKey;
+    private httpClient;
+    constructor(chainID: number, apiKey?: string);
+    /**
+     * Set the API key used by this instance.
+     * @param key
+     */
+    setApiKey(key: string | undefined): void;
+    /**
+     * Connect to a different chain.
+     * @param chainID
+     */
+    setChainID(chainID: number): void;
+    /**
+     * Return current token balances along with their spot prices. This endpoint supports a variety of
+     * token standards like ERC20, ERC721 and ERC1155. As a special case, network native tokens like ETH
+     * on Ethereum are also returned even though it's not a token contract.
+     * @param address The address to check the balance of.
+     * @param nft True if you want NFT data returned.
+     * @param currency The currency to get price data on.
+     * @param pagination
+     */
+    getAddressBalancesV2(address: string, nft?: boolean, currency?: string, pagination?: PaginationQuery, httpOptions?: {
+        params?: Record<string, string>;
+        customOptions?: HttpOptions;
+    }): Promise<GetAddressBalancesV2Response>;
+    /**
+     * Return all transactions along with their decoded log events. This endpoint does a
+     * deep-crawl of the blockchain to retrieve all kinds of transactions that references the address
+     * including indexed topics within the event logs.
+     * @param address Address to get history of.
+     * @param currency
+     * @param ascending Order by ascending.
+     * @param logs Set to `true` if you want event logs.
+     * @param pagination
+     */
+    getTransactionsForAddress(address: string, currency?: string, ascending?: boolean, logs?: boolean, pagination?: PaginationQuery, httpOptions?: {
+        params?: Record<string, string>;
+        customOptions?: HttpOptions;
+    }): Promise<GetTxsForAddressResponse>;
+}
+
+export { Covalent };

package/esm/Covalent.js

@@ -0,0 +1 @@
+import{HttpClient as t}from"@avalabs/core-utils-sdk";import{createApiUrl as e}from"./createApiUrl.js";class a{chainID;apiKey;httpClient;constructor(a,s){this.chainID=a,this.apiKey=s,this.httpClient=new t(e(a))}setApiKey(t){this.apiKey=t}setChainID(a){this.chainID=a,this.httpClient=new t(e(a))}async getAddressBalancesV2(t,e=!1,a="USD",s,i){const n=new URLSearchParams({...i?.params,nft:e.toString(),"quote-currency":a});this.apiKey&&n.append("key",this.apiKey),s&&n.append("page-size",s.pageSize.toString()),s&&n.append("page-number",s.pageNumber.toString());const r=`/address/${t}/balances_v2/`;return await this.httpClient.get(r,Object.fromEntries(n),i?.customOptions)}async getTransactionsForAddress(t,e="USD",a=!1,s=!1,i,n){const r=new URLSearchParams({...n?.params,"block-signed-at-asc":a?"true":"false","quote-currency":e,"no-logs":s?"false":"true"});this.apiKey&&r.append("key",this.apiKey),i&&r.append("page-size",i.pageSize.toString()),i&&r.append("page-number",i.pageNumber.toString());const p=`/address/${t}/transactions_v2/`;return await this.httpClient.get(p,Object.fromEntries(r),n?.customOptions)}}export{a as Covalent};

package/esm/constants.d.ts

@@ -0,0 +1,3 @@
+declare const BASE_URL = "https://api.covalenthq.com";
+
+export { BASE_URL };

package/esm/constants.js

@@ -0,0 +1 @@
+const t="https://api.covalenthq.com";export{t as BASE_URL};

package/esm/createApiUrl.d.ts

@@ -0,0 +1,3 @@
+declare function createApiUrl(chainID: number, version?: number): string;
+
+export { createApiUrl };

package/esm/createApiUrl.js

@@ -0,0 +1 @@
+import{BASE_URL as t}from"./constants.js";function n(n,o=1){return`${t}/v${o}/${n}`}export{n as createApiUrl};

package/esm/index.d.ts

@@ -0,0 +1,4 @@
+export { Covalent } from './Covalent.js';
+export { BASE_URL } from './constants.js';
+export { createApiUrl } from './createApiUrl.js';
+export { AddressTxsItem, GetAddressBalanceV2Item, GetAddressBalancesV2Response, GetTxsForAddressResponse, NFTAttribute, NFTData, PaginationQuery, PaginationResponse, TxsLogEvent } from './models.js';

package/esm/index.js

@@ -0,0 +1 @@
+export{Covalent}from"./Covalent.js";export{BASE_URL}from"./constants.js";export{createApiUrl}from"./createApiUrl.js";

package/esm/models.d.ts

@@ -0,0 +1,120 @@
+interface GetAddressBalancesV2Response {
+    data: {
+        address: string;
+        updated_at: string;
+        next_update_at: string;
+        quote_currency: string;
+        chain_id: number;
+        items: GetAddressBalanceV2Item[];
+        pagination: null | PaginationResponse;
+    };
+    error: boolean;
+    error_message: null | string;
+    error_code: null | string;
+}
+interface PaginationQuery {
+    pageSize: number;
+    pageNumber: number;
+}
+interface PaginationResponse {
+    has_more: boolean;
+    page_number: number;
+    page_size: number;
+    total_count: null | number;
+}
+interface GetAddressBalanceV2Item {
+    contract_decimals: number;
+    contract_name: string;
+    contract_ticker_symbol: string;
+    contract_address: string;
+    supports_erc: null | string[];
+    logo_url: string;
+    last_transferred_at: null | string;
+    type: 'cryptocurrency' | 'dust' | 'nft';
+    balance: string;
+    balance_24h: null | string;
+    quote_rate: number;
+    quote_rate_24h: null | number;
+    quote: number;
+    quote_24h: null | number;
+    nft_data: null | NFTData[];
+}
+interface NFTAttribute {
+    trait_type: string;
+    value: string;
+}
+interface NFTData {
+    token_id: string;
+    token_balance: null | string;
+    token_url: null | string;
+    supports_erc: string[];
+    token_price_wei: null;
+    token_quote_rate_eth: null;
+    original_owner: string;
+    external_data: {
+        name: string;
+        description: string;
+        image: string;
+        image_256: string;
+        image_512: string;
+        image_1024: string;
+        animation_url: string | null;
+        external_url: string | null;
+        attributes: NFTAttribute[];
+        owner: string | null;
+    };
+    owner: string;
+    owner_address: null;
+    burned: null;
+}
+interface GetTxsForAddressResponse {
+    data: {
+        address: string;
+        updated_at: string;
+        next_update_at: string;
+        quote_currency: string;
+        chain_id: number;
+        items: AddressTxsItem[];
+        pagination: null | PaginationResponse;
+    };
+    error: boolean;
+    error_message: null | string;
+    error_code: null | string;
+}
+interface AddressTxsItem {
+    block_signed_at: string;
+    block_height: number;
+    tx_hash: string;
+    tx_offset: number;
+    successful: boolean;
+    from_address: string;
+    from_address_label: null | string;
+    to_address: string;
+    to_address_label: null | string;
+    value: string;
+    value_quote: number;
+    gas_offered: number;
+    gas_spent: number;
+    gas_price: number;
+    gas_quote: number;
+    gas_quote_rate: number;
+    logEvents?: TxsLogEvent[];
+}
+interface TxsLogEvent {
+    block_signed_at: string;
+    block_height: number;
+    tx_offset: number;
+    log_offset: number;
+    tx_hash: string;
+    raw_log_topics: string[];
+    sender_contract_decimals: number;
+    sender_name: null | string;
+    sender_contract_ticker_symbol: null | string;
+    sender_address: string;
+    sender_address_label: null | string;
+    sender_logo_url: null | string;
+    raw_log_data: string;
+    decoded: any;
+}
+
+export { AddressTxsItem, GetAddressBalanceV2Item, GetAddressBalancesV2Response, GetTxsForAddressResponse, NFTAttribute, NFTData, PaginationQuery, PaginationResponse, TxsLogEvent };

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@avalabs/core-covalent-sdk",
+  "version": "2.8.0-alpha.197",
+  "license": "Limited Ecosystem License",
+  "private": false,
+  "main": "dist/index.js",
+  "module": "esm/index.js",
+  "typings": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "esm"
+  ],
+  "sideEffects": false,
+  "publishConfig": {
+    "access": "restricted"
+  },
+  "description": "Typescript SDK for the Covalent API.",
+  "author": "Emre Kanatli",
+  "homepage": "https://github.com/ava-labs/avalanche-sdks#readme",
+  "scripts": {
+    "start": "rollup -c --watch",
+    "build": "rollup -c",
+    "lint": "eslint --fix -c ./.eslintrc.js \"src/**/*.ts*\""
+  },
+  "dependencies": {
+    "@avalabs/core-utils-sdk": "2.8.0-alpha.197"
+  }
+}