@avalabs/glacier-sdk 2.8.0-alpha.79 → 2.8.0-alpha.8

package/src/glacierClient.ts

@@ -0,0 +1,190 @@
+import { HttpClient, HttpOptions } from '@avalabs/utils-sdk';
+import {
+  ChainInfo,
+  Chains,
+  CurrencyCode,
+  Erc20Balances,
+  Erc721Balances,
+  ListTransactionDetails,
+  NativeBalance,
+  TransactionDetails,
+} from './generated/models';
+import { HealthStatusCheck } from './types';
+
+export class GlacierClient {
+  private httpClient: HttpClient;
+  constructor(
+    private baseUrl: string,
+    private version = 'v1',
+    private httpOptions?: HttpOptions
+  ) {
+    this.httpClient = new HttpClient(
+      `${this.baseUrl}/${this.version}`,
+      this.httpOptions
+    );
+  }
+  /**
+   *
+   * @name HealthCheck
+   * @summary Get the health of the service.
+   * @request GET:/${version}/health-check
+   * @response `200` `{ status?: string, info?: Record<string, { status?: string }>, error?: Record<string, { status?: string }>, details?: Record<string, { status?: string }> }` The Health Check is successful
+   * @response `503` `{ status?: string, info?: Record<string, { status?: string }>, error?: Record<string, { status?: string }>, details?: Record<string, { status?: string }> }` The Health Check is not successful
+   */
+  healthCheck(
+    params: Record<string, any> = {},
+    customOptions: HttpOptions = {}
+  ) {
+    return this.httpClient.get<HealthStatusCheck>(
+      `/health-check`,
+      params,
+      customOptions
+    );
+  }
+
+  /**
+   * No description
+   *
+   * @name GetNativeBalance
+   * @summary Get native token balance of a wallet address for a given chain.
+   * @request GET:/v1/chains/{chainId}/addresses/{address}/balances:getNative
+   * @response `200` `NativeBalanceDto`
+   */
+  getNativeBalance(
+    chainId: string,
+    address: string,
+    query?: {
+      currency?: CurrencyCode;
+    },
+    params: Record<string, any> = {},
+    customOptions: HttpOptions = {}
+  ) {
+    return this.httpClient.get<NativeBalance>(
+      `/chains/${chainId}/addresses/${address}/balances:getNative`,
+      { ...query, ...params },
+      customOptions
+    );
+  }
+  /**
+   *
+   * @name ListErc20Balances
+   * @summary Get erc-20 token balances of a wallet address for a given chain.
+   * @request GET:/v1/chains/{chainId}/addresses/{address}/balances:listErc20
+   * @response `200` `Erc20BalancesDto`
+   */
+  listErc20Balances(
+    chainId: string,
+    address: string,
+    query?: {
+      pageSize?: number;
+      pageToken?: string;
+      currency?: CurrencyCode;
+    },
+    params: Record<string, any> = {},
+    customOptions: HttpOptions = {}
+  ) {
+    return this.httpClient.get<Erc20Balances>(
+      `/chains/${chainId}/addresses/${address}/balances:listErc20`,
+      { ...query, ...params },
+      customOptions
+    );
+  }
+  /**
+   * No description
+   *
+   * @name ListErc721Balances
+   * @summary Get erc-721 token balances of a wallet address for a given chain.
+   * @request GET:/v1/chains/{chainId}/addresses/{address}/balances:listErc721
+   * @response `200` `Erc721BalancesDto`
+   */
+  listErc721Balances(
+    chainId: string,
+    address: string,
+    query?: {
+      pageSize?: number;
+      pageToken?: string;
+      currency?: CurrencyCode;
+    },
+    params: Record<string, any> = {},
+    customOptions: HttpOptions = {}
+  ) {
+    return this.httpClient.get<Erc721Balances>(
+      `/chains/${chainId}/addresses/${address}/balances:listErc721`,
+      { ...query, ...params },
+      customOptions
+    );
+  }
+  /**
+   * @description Gets a list of transactions where the given wallet address had an on-chain interaction for a given chain. The erc20 transfers, erc721 transfers, and internal transactions returned as part of the native transactions are only those where the address had an interaction. Therefore the transactions returned from this list may not be complete representations of the on-chain data. For a complete view of a transaction use the `/chains/:chainId/transactions/:txHash` endpoint.
+   *
+   * @name ListTransactions
+   * @summary Gets a list of transactions for a wallet address and chain.
+   * @request GET:/v1/chains/{chainId}/addresses/{address}/transactions
+   * @response `200` `ListTransactionDetailsDto`
+   */
+  listTransactions(
+    chainId: string,
+    address: string,
+    query?: { pageSize?: number; pageToken?: string },
+    params: Record<string, any> = {},
+    customOptions: HttpOptions = {}
+  ) {
+    return this.httpClient.get<ListTransactionDetails>(
+      `/chains/${chainId}/addresses/${address}/transactions`,
+      { ...query, ...params },
+      customOptions
+    );
+  }
+  /**
+   *
+   * @name GetTransaction
+   * @summary Gets the details of a single transaction.
+   * @request GET:/v1/chains/{chainId}/transactions/{txHash}
+   * @response `200` `TransactionDetailsDto`
+   */
+  getTransaction(
+    chainId: string,
+    txHash: string,
+    params: Record<string, any> = {},
+    customOptions: HttpOptions = {}
+  ) {
+    return this.httpClient.get<TransactionDetails>(
+      `/chains/${chainId}/transactions/${txHash}`,
+      params,
+      customOptions
+    );
+  }
+  /**
+   *
+   * @name SupportedChains
+   * @summary Gets the list of chains supported by the api.
+   * @request GET:/v1/chains
+   * @response `200` `ChainsDto`
+   */
+  supportedChains(
+    params: Record<string, any> = {},
+    customOptions: HttpOptions = {}
+  ) {
+    return this.httpClient.get<Chains>(`/chains`, params, customOptions);
+  }
+
+  /**
+   * No description
+   *
+   * @name GetChainInfo
+   * @summary Gets chain information by chain id.
+   * @request GET:/v1/chains/{chainId}
+   * @response `200` `ChainInfoDto`
+   */
+  getChainInfo(
+    chainId: string,
+    params: Record<string, any> = {},
+    customOptions: HttpOptions = {}
+  ) {
+    return this.httpClient.get<ChainInfo>(
+      `/chains/${chainId}`,
+      params,
+      customOptions
+    );
+  }
+}

package/src/types.ts

@@ -0,0 +1,6 @@
+export interface HealthStatusCheck {
+  status?: string;
+  info?: Record<string, { status?: string }>;
+  error?: Record<string, { status?: string }>;
+  details?: Record<string, { status?: string }>;
+}

package/swagger/generateModels.js

@@ -0,0 +1,40 @@
+const { generateApi } = require('swagger-typescript-api');
+const path = require('path');
+const fs = require('fs');
+
+const SCHEMA_URL = 'https://glacier-api-dev.avax.network/api-json';
+
+const OUTPUT_FOLDER = path.resolve(process.cwd(), 'src/generated');
+
+const dataContractFilenames = { raw: 'data-contracts.ts', actual: 'models.ts' };
+
+generateApi({
+  output: OUTPUT_FOLDER,
+  url: SCHEMA_URL,
+  modular: true,
+  generateClient: false,
+  generateResponses: false,
+  hooks: {
+    onFormatTypeName: (_typeName, rawTypeName) => {
+      // remove Dto suffix from type name
+      if (rawTypeName.includes('Dto')) {
+        return rawTypeName.replace(/Dto/g, '');
+      }
+    },
+  },
+})
+  .then(({ files }) => {
+    files.forEach(({ name }) => {
+      if (name === dataContractFilenames.raw) {
+        // rename data contract file name
+        fs.rename(
+          path.resolve(OUTPUT_FOLDER, dataContractFilenames.raw),
+          path.resolve(OUTPUT_FOLDER, dataContractFilenames.actual),
+          () => {
+            // noop
+          }
+        );
+      }
+    });
+  })
+  .catch(console.error);

package/tsconfig.json

@@ -0,0 +1,7 @@
+{
+  "extends": "../../tsconfig.json",
+  "compilerOptions": {
+    "plugins": [{ "transform": "@zerollup/ts-transform-paths" }]
+  },
+  "include": ["src"]
+}