类型脚本的 GoldRush SDK

脚本 SDK 类型 黄金冲 块链数据 API. 钱包令牌 余额、交易历史、NFT持有量、历史价格、象征性批准和跨链 跨活动 60+连锁店,主网和测试网,从一个 键入客户端.

npm install @covalenthq/client-sdk

使用方式 NodeJS v18 或以上,以取得最佳结果.

需要 GoldRush API 键 。 您可以在 GoldRush的网站

使用 SDK

1. 安装依赖关系

   npm install @covalenthq/client-sdk
   

2. 使用 GoldRushClient

   import { GoldRushClient, Chains } from "@covalenthq/client-sdk";
   
   const client = new GoldRushClient("<YOUR_API_KEY>");
   
   const ApiServices = async () => {
       try {
           const balanceResp =
               await client.BalanceService.getTokenBalancesForWalletAddress(
                   "eth-mainnet",
                   "0xfc43f5f9dd45258b3aff31bdbe6561d97e8b71de"
               );
   
           if (balanceResp.error) {
               throw balanceResp;
           }
   
           console.log(balanceResp.data);
       } catch (error) {
           console.error(error);
       }
   };
   

The `GoldRushClient` can be configured with a second object argument, `settings`, and a third argument for `streamingConfig`. The settings offered are
1. **debug**: A boolean that enables server logs of the API calls, enhanced with the request URL, response time and code, and other settings. It is set as `false` by default.
2. **threadCount**: A number that sets the number of concurrent requests allowed. It is set as `2` by default.
3. **enableRetry**: A boolean that enables retrying the API endpoint in case of a `429 - rate limit` error. It is set as `true` by default.
4. **maxRetries**: A number that sets the number of retries to be made in case of `429 - rate limit` error. To be in effect, it requires `enableRetry` to be enabled. It is set as `2` by default.
5. **retryDelay**: A number that sets the delay in `ms` for retrying the API endpoint in case of `429 - rate limit` error. To be in effect, it requires `enableRetry` to be enabled. It is set as `1500` by default.
6. **source**: A string that defines the `source` of the request for better analytics. Predefined values include `"Ponder"`, `"GoldRush"`, and `"Viem"`, but any custom string is accepted.

The `streamingConfig` is optional and configures the real-time streaming service. The available options are:
1. **shouldRetry**: A function that determines whether to retry connection based on retry count. Defaults to retry up to 5 times.
2. **maxReconnectAttempts**: Maximum number of reconnection attempts. Defaults to `5`.
3. **onConnecting**: Callback function triggered when connecting to the streaming service.
4. **onOpened**: Callback function triggered when connection is successfully established.
5. **onClosed**: Callback function triggered when connection is closed.
6. **onError**: Callback function triggered when an error occurs.

特征

1. 名称决议

GoldRush SDK 本地解析以下钱包地址

1. ENS域(例如:. demo.eth(中文(简体) )
2. 伦斯·汉德勒斯(英语:Lens handles)(例如:. demo.lens(中文(简体) )
3. 不可阻挡域(如:. demo.x(中文(简体) )
4. RNS域名( 如. demo.ron(中文(简体) )

2. 查询参数

所有API 调用参数都可以通过 typed objects 作为查询参数.

举例来说,以下设定 quoteCurrency 查询参数到 CAD 参数 nft 改为 true 为钱包地址获取包括NFT在内的所有符号余额:

const resp = await client.BalanceService.getTokenBalancesForWalletAddress(
    "eth-mainnet",
    "0xfc43f5f9dd45258b3aff31bdbe6561d97e8b71de",
    {
        quoteCurrency: "CAD",
        nft: true,
    }
);

3. 出口类型

所有的东西 interfaces 用于参数、查询参数和答复也从可用于自定义使用的软件包中导出.

例如,明确输入响应

import {
    GoldRushClient,
    type BalancesResponse,
    type BalanceItem,
} from "@covalenthq/client-sdk";

const resp = await client.BalanceService.getTokenBalancesForWalletAddress(
    "eth-mainnet",
    "0xfc43f5f9dd45258b3aff31bdbe6561d97e8b71de",
    {
        quoteCurrency: "CAD",
        nft: true,
    }
);

const data: BalancesResponse = resp.data;
const items: BalanceItem[] = resp.data.items;

4. 多链输入格式

SDK支持链式输入的下列格式:

1. 链名( 如 . eth-mainnet(中文(简体) )
2. 链式ID( 如. 1(中文(简体) )
3. 链名 Enum( 例如). ChainName.ETH_MAINNET(中文(简体) )
4. 链式ID Enum(例如. ChainID.ETH_MAINNET(中文(简体) )

5. 其他非经提名的方法

对于分解响应,GoldRush API最多可以支持每页100个项目. 然而,GoldRush SDK利用发电机 无缝取取出所有项目而用户无需处理 pagination。 。 。 .

例如,以下获取全部交易 0xfc43f5f9dd45258b3aff31bdbe6561d97e8b71de 在那之后

import { GoldRushClient } from "@covalenthq/client-sdk";

const ApiServices = async () => {
    const client = new GoldRushClient("<YOUR_API_KEY>");
    try {
        for await (const tx of client.TransactionService.getAllTransactionsForAddress(
            "eth-mainnet",
            "0xfc43f5f9dd45258b3aff31bdbe6561d97e8b71de"
        )) {
            console.log("tx", tx);
        }
    } catch (error) {
        console.log(error.message);
    }
};

6. 可执行 pagination 函数

采用加成方法后得到了改进 next() 财务报告和审定财务报表 prev() 支助职能。 这些功能有利于开发者通过我们 links 对象,包括 prev 财务报告和审定财务报表 next 字段。 而不是要求开发者手动提取这些字段的值并创建 JavaScript API 获取对 URL 值的调用, 新的 next() 财务报告和审定财务报表 prev() 函数提供了一种简化的方法,使开发者能够更高效地模拟这种行为.

import { GoldRushClient } from "@covalenthq/client-sdk";

const client = new GoldRushClient("<YOUR_API_KEY>");
const resp = await client.TransactionService.getAllTransactionsForAddressByPage(
    "eth-mainnet",
    "0xfc43f5f9dd45258b3aff31bdbe6561d97e8b71de"
); // assuming resp.data.current_page is 10
if (resp.data !== null) {
    const prevPage = await resp.data.prev(); // will retrieve page 9
    console.log(prevPage.data);
}

7. 功用功能

1. 大内页: 将输入格式化为 bigint 数值。 举个例子

   bigIntParser("-123"); // -123n
   

   您可以探索更多实例 这里

2. 计算纯度: 格式化为大而生的数字和大意为人友好的格式. 举个例子

   calculatePrettyBalance(1.5, 3, true, 4); // "0.0015"
   

   您可以探索更多实例 这里

3. 是 ValidApiKey 键:检查输入为有效的GoldRush API密钥. 举个例子

   isValidApiKey(cqt_wF123); // false
   

   您可以探索更多实例 这里

4. 紧急情况: 将大而生的数字和比值格式化为人类友好的货币格式. 举个例子

   prettifyCurrency(89.0, 2, "CAD"); // "CA$89.00"
   

   您可以探索更多实例 这里

5. 时间戳: 将 ISO 时间戳转换为各种可读格式

   timestampParser("2024-10-16T12:39:23.000Z", "descriptive"); // "October 16 2024 at 18:09:23"
   

   您可以探索更多实例 这里

8. 实时流动

GoldRush SDK现在支持通过WebSocket连接实时流出区块链数据. 这使得您可以订阅OHLCV(Open,High,Low, Close, Volume)的数据实时数据feed,用于交易对和符,新的DEX对创建,钱包活性等.

import {
    GoldRushClient,
    StreamingChain,
    StreamingInterval,
    StreamingTimeframe,
    StreamingProtocol,
} from "@covalenthq/client-sdk";

const client = new GoldRushClient(
    "<YOUR_API_KEY>",
    {},
    {
        onConnecting: () => console.log("Connecting to streaming service..."),
        onOpened: () => console.log("Connected to streaming service!"),
        onClosed: () => console.log("Disconnected from streaming service"),
        onError: (error) => console.error("Streaming error:", error),
    }
);

// Subscribe to OHLCV data for trading pairs
const unsubscribePairs = client.StreamingService.subscribeToOHLCVPairs(
    {
        chain_name: StreamingChain.BASE_MAINNET,
        pair_addresses: ["0x9c087Eb773291e50CF6c6a90ef0F4500e349B903"],
        interval: StreamingInterval.ONE_MINUTE,
        timeframe: StreamingTimeframe.ONE_HOUR,
    },
    {
        next: (data) => {
            console.log("Received OHLCV pair data:", data);
        },
        error: (error) => {
            console.error("Streaming error:", error);
        },
        complete: () => {
            console.log("Stream completed");
        },
    }
);

// Unsubscribe when done
// unsubscribePairs();

// Disconnect from streaming service when finished
// await client.StreamingService.disconnect();

多次订阅

SDK在内部使用单通 WebSocket 客户端,允许您通过同一程序创建多个订阅 GoldRushClient。 。 。 .

// Create a single client
const client = new GoldRushClient("<YOUR_API_KEY>");

// Create multiple subscriptions through the same connection
const unsubscribePairs = client.StreamingService.subscribeToOHLCVPairs(
    {
        chain_name: StreamingChain.BASE_MAINNET,
        pair_addresses: ["0x9c087Eb773291e50CF6c6a90ef0F4500e349B903"],
        interval: StreamingInterval.ONE_MINUTE,
        timeframe: StreamingTimeframe.ONE_HOUR,
    },
    {
        next: (data) => console.log("OHLCV Pairs:", data),
    }
);

const unsubscribeTokens = client.StreamingService.subscribeToOHLCVTokens(
    {
        chain_name: StreamingChain.BASE_MAINNET,
        token_addresses: ["0x4B6104755AfB5Da4581B81C552DA3A25608c73B8"],
        interval: StreamingInterval.ONE_MINUTE,
        timeframe: StreamingTimeframe.ONE_HOUR,
    },
    {
        next: (data) => console.log("OHLCV Tokens:", data),
    }
);

const unsubscribeWallet = client.StreamingService.subscribeToWalletActivity(
    {
        chain_name: StreamingChain.BASE_MAINNET,
        wallet_addresses: ["0xbaed383ede0e5d9d72430661f3285daa77e9439f"],
    },
    {
        next: (data) => console.log("Wallet Activity:", data),
    }
);

// Unsubscribe from individual streams when needed
// unsubscribePairs();
// unsubscribeTokens();
// unsubscribeWallet();

// Or disconnect from all streams at once
// await client.StreamingService.disconnect();

反应集成

对于反应应用程序,请使用 useEffect 连接到正确管理订阅生命周期 :

useEffect(() => {
    const unsubscribe = client.StreamingService.rawQuery(
        `subscription {
        ohlcvCandlesForPair(
          chain_name: BASE_MAINNET
          pair_addresses: ["0x9c087Eb773291e50CF6c6a90ef0F4500e349B903"],
          interval: StreamingInterval.ONE_MINUTE,
          timeframe: StreamingTimeframe.ONE_HOUR,
        ) {
          open
          high
          low
          close
          volume
          quote_rate
          volume_usd
          chain_name
          pair_address
          interval
          timeframe
          timestamp
        }
      }`,
        {},
        {
            next: (data) => console.log("Received streaming data:", data),
            error: (err) => console.error("Subscription error:", err),
            complete: () => console.info("Subscription completed"),
        }
    );

    // Cleanup function - unsubscribe when component unmounts
    return () => {
        unsubscribe();
    };
}, []);

原始查询

也可以使用原始 GraphQL 查询来进行更精简和选择性的数据假设:

const unsubscribeNewPairs = client.StreamingService.rawQuery(
    `subscription {
       newPairs(
         chain_name: BASE_MAINNET,
         protocols: [UNISWAP_V2, UNISWAP_V3]
       ) {
         chain_name
         protocol
         pair_address
         tx_hash
         liquidity
         base_token {
           contract_name
           contract_ticker_symbol
         }
         quote_token {
           contract_name
           contract_ticker_symbol
         }
       }
     }`,
    {},
    {
        next: (data) => console.log("Raw new pairs data:", data),
        error: (error) => console.error("Error:", error),
    }
);

// Raw query for token OHLCV data
const unsubscribeTokenOHLCV = client.StreamingService.rawQuery(
    `subscription {
      ohlcvCandlesForToken(
        chain_name: BASE_MAINNET
        token_addresses: ["0x4B6104755AfB5Da4581B81C552DA3A25608c73B8"]
        interval: ONE_MINUTE
        timeframe: ONE_HOUR
      ) {
        open
        high
        low
        close
        volume
        volume_usd
        quote_rate
        quote_rate_usd
        timestamp
        base_token {
          contract_name
          contract_ticker_symbol
        }
      }
    }`,
    {},
    {
        next: (data) => console.log("Raw token OHLCV data:", data),
        error: (error) => console.error("Error:", error),
    }
);

9. 标准化(错误)对策

所有答复都采用相同的标准格式

❴
    "data": <object>,
    "error": <boolean>,
    "error_message": <string>,
    "error_code": <number>
❵

支持的终点

GoldRush SDK向所有A级、B级和定价终点提供全面支持,分类如下: 服务 命名空间 :

捐款

欢迎发言、问题和特稿请求! 随便你看看 问题 页 次.

显示您的支持

如果这个计划能帮助你的话,就给你一个!

许可证

这个项目是 阿帕奇 - 2.0 有执照.