@nemtus/symbol-sdk-openapi-generator-typescript-fetch

v0.6.0

Published

4 days ago

Symbol SDK for TypeScript with OpenAPI Generator typescript-fetch

0High
0Medium
0Low

yasunori-matsuoka

ymuichiro

blockchain symbol sdk typescript

symbol-sdk-openapi-generator-typescript-fetch

Symbol SDK for TypeScript with OpenAPI Generator typescript-fetch

Note: Currently, This is a very experimental level.

| Type | Status/Link | | --------- | -------------------- | | CI status | | | Latest npm publish status | | | npm package link | https://www.npmjs.com/package/@nemtus/symbol-sdk-openapi-generator-typescript-fetch |

For package users

Install

npm install @nemtus/symbol-sdk-openapi-generator-typescript-fetch

Usage

Example with no requestParameters

import {
  Configuration,
  ConfigurationParameters,
  NodeInfoDTO,
  NodeRoutesApi,
} from '@nemtus/symbol-sdk-openapi-generator-typescript-fetch';

const configurationParameters: ConfigurationParameters = {
  basePath: 'https://symbol-main-1.nemtus.com:3001',
};
const configuration: Configuration = new Configuration(configurationParameters);
const nodeRoutesApi: NodeRoutesApi = new NodeRoutesApi(configuration);
const response: NodeInfoDTO = await nodeRoutesApi.getNodeInfo();
console.dir(response, { depth: null });
/* Example: 
{
  version: 16777991,
  publicKey: '2CEFBCE2E5EA5DD5BA61B302C33002CDA1EDB122EFD18713AF02ABFA9C73A28C',
  networkGenerationHashSeed: '57F7DA205008026C776CB6AED843393F04CD458E0AA2D9F1D5F31A402072B2D6',
  roles: 3,
  port: 7900,
  networkIdentifier: 104,
  friendlyName: 'NEMTUS',
  host: 'symbol-main-1.nemtus.com',
  nodePublicKey: 'B56A3C73CA345A00CDDC84CFDF711CD67B2CCE10BEB82CB74835086774FE587F',
}
*/

Example with requestParameters

import {
  AccountInfoDTO,
  AccountRoutesApi,
  AccountRoutesApiGetAccountInfoRequest,
  Configuration,
  ConfigurationParameters,
} from '@nemtus/symbol-sdk-openapi-generator-typescript-fetch';

const configurationParameters: ConfigurationParameters = {
  basePath: 'https://symbol-main-1.nemtus.com:3001',
};
const configuration: Configuration = new Configuration(configurationParameters);
const accountRoutesApi: AccountRoutesApi = new AccountRoutesApi(configuration);
const requestParameters: AccountRoutesApiGetAccountInfoRequest = {
  accountId: 'NCSIOEWE2364XXP65426W3RUGBRYOAGR3KMMCIA',
};
const response: AccountInfoDTO = await accountRoutesApi.getAccountInfo(requestParameters);
console.dir(response, { depth: null });
// Example: 
/*
{
  account: {
    version: 1,
    address: '68A48712C4D6FDCBDDFEEF35EB6E3430638700D1DA98C120',
    addressHeight: '1',
    publicKey: 'B86304B01045894ED9250B3DCD6313DC2EC0DD529B4E864EA376A2F341D3CFD4',
    publicKeyHeight: '447',
    accountType: 1,
    supplementalPublicKeys: {
      linked: {
        publicKey: '5F87A37D1EAD570F4D0FD4C11A9D5EED5ABE82EF2E992B97CCDAC84F241470E0'
      },
      vrf: {
        publicKey: '806E9448598C922B371DA8CFD7E16E8F5F53594B3AECE13F0708778A4480A752'
      }
    },
    activityBuckets: [
      {
        startHeight: '1447200',
        totalFeesPaid: '0',
        beneficiaryCount: 0,
        rawScore: '476538883720'
      },
      {
        startHeight: '1446480',
        totalFeesPaid: '0',
        beneficiaryCount: 1,
        rawScore: '476509686441'
      },
      {
        startHeight: '1445760',
        totalFeesPaid: '0',
        beneficiaryCount: 1,
        rawScore: '476481049034'
      },
      {
        startHeight: '1445040',
        totalFeesPaid: '0',
        beneficiaryCount: 1,
        rawScore: '476353869759'
      },
      {
        startHeight: '1444320',
        totalFeesPaid: '0',
        beneficiaryCount: 1,
        rawScore: '476325431930'
      }
    ],
    mosaics: [
      { id: '6BED913FA20223F8', amount: '516203401572' },
      { id: '24F7CF825DBCDD42', amount: '499999886' },
      { id: '310378C18A140D1B', amount: '923' },
      { id: '6AE25FA5E8CA0646', amount: '1000000000' }
    ],
    importance: '476509686441',
    importanceHeight: '1447200'
  },
  id: '60517BE5CCA17918A561056D'
}
*/

Example with CDN

<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8" />
    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
    <meta name="viewport" content="width=device-width, initial-scale=1.0" />
    <title>Document</title>
    <!-- Load from CDN or a single file bundled with webpack -->
    <script src="https://cdn.jsdelivr.net/npm/@nemtus/[email protected]/index.min.js"></script>
  </head>
  <body>
    <script>
      (async () => {
        const symbolSdk = window.symbolSdkOpenAPIGeneratorTypeScriptFetch;
        const configurationParameters = {
          basePath: 'http://symbol-main-1.nemtus.com:3000',
        };
        const configuration = new symbolSdk.Configuration(configurationParameters);

        const nodeRoutesApi = new symbolSdk.NodeRoutesApi(configuration);
        const responseNodeInfo = await nodeRoutesApi.getNodeInfo();
        console.log(responseNodeInfo);

        const accountRoutesApi = new symbolSdk.AccountRoutesApi(configuration);
        const requestParameters = {
          accountId: 'NCSIOEWE2364XXP65426W3RUGBRYOAGR3KMMCIA',
        };
        const responseAccountInfo = await accountRoutesApi.getAccountInfo(requestParameters);
        console.log(responseAccountInfo);
      })();
    </script>
  </body>
</html>

For Package Developers

0. Prerequisite

Clone the repository

git clone [email protected]:nemtus/symbol-sdk-openapi-generator-typescript-fetch.git

git clone https://github.com/nemtus/symbol-sdk-openapi-generator-typescript-fetch.git

Install Java

If you don't have java installed, you need to install it (required by the OpenAPI Generator).

1. Install the OpenAPI spec package

This project consumes the OpenAPI spec from the @nemtus/symbol-openapi npm package (a devDependency), which is built and published from the nemtus/symbol mirror fork. npm ci installs the bundled openapi3.yml into node_modules/@nemtus/symbol-openapi/ — no HTTP fetch is required. (Previously this spec was downloaded as a release asset, and before that built locally from a git submodule, which pulled in vulnerable build tooling.)

npm ci

To bump the spec, bump the @nemtus/symbol-openapi version in package.json (or merge the Dependabot PR) and regenerate.

2. Generate REST API Client Code

npm run openapi:set:version
npm run openapi:generate
npm run build

Then, REST API client code will be generated in src/api and bundled into dist. Do not edit src/api manually.

3. Tests

Test for CDN with Playwright

cd tests/browser-cdn
npm ci
npx playwright install chromium
npm run test

Test for Node.js CommonJS JavaScript with vitest

cd tests/nodejs-javascript
npm ci
npm run test

Test for Node.js ES Modules TypeScript with vitest

cd tests/nodejs-typescript
npm ci
npm run test

We use

@nemtus/symbol-openapi (built/published from the nemtus/symbol mirror fork) for the openapi3.yml spec
OpenAPI Generator to generate REST API client codes
- Especially typescript-fetch Generator
cosmos-client/cosmos-client-ts as a reference of package structure

We would like to thank all the contributors to the above tools.