blockscout-typescript

An OpenAPI SDK generated with typescript-fetch for Blockscout REST APIs such as HYCHAIN.

Getting Started

npm install blockscout-typescript

import { Configuration, DefaultApi } from "blockscout-typescript";

const configuration = new Configuration({
  basePath: env.HYCHAIN_BLOCKSCOUT_REST_URL,
});

export const hychainBlockscout = new DefaultApi(configuration);

Known Issues

Pagination

The pagination support is lacking in the SDK due to it missing from the swagger.yaml. It is confirmed that the pagination works as expected if the next_page_params are passed correctly. You can see this in the Blockscout codebase.

Below is an example of doing pagination with the Address Transactions endpoint.

  let params: GetAddressTxsRequest = {
    addressHash: "0xC7899279eBA29CE4db5B759Df83ac83b4d9737C5",
  };

  while (true) {
    const result = await hychainBlockscout.getAddressTxs(params);

    const nextPageParams = result.nextPageParams;

    if (!nextPageParams) {
      break;
    }

    params = {
      ...params,
      ...nextPageParams,
    };
  }

Will update in the future. PRs welcome (;

Swagger Definition

The following endpoints are not in the SDK due to the swagger.yaml being incorrectly defined when using the generator.

• /transactions/{transaction_hash}/state-changes
• /smart-contracts/{address_hash}/methods-read
• /smart-contracts/{address_hash}/methods-read-proxy
• /smart-contracts/{address_hash}/methods-write
• /smart-contracts/{address_hash}/methods-write-proxy
• /smart-contracts/{address_hash}/query-read-method

SDK Information

This generator creates TypeScript/JavaScript client that utilizes Fetch API. The generated Node module can be used in the following environments:

Environment

• Node.js
• Webpack
• Browserify

Language level

• ES5 - you must have a Promises/A+ library installed
• ES6

Module system

• CommonJS
• ES6 module system

It can be used in both TypeScript and JavaScript. In TypeScript, the definition will be automatically resolved via package.json. (Reference)