Setup Scalar Network API

[0xdavid7]

• The Scalar Network API is the gateway to interact with the Scalar network
• It provides the openapi.yaml file

Prerequisites:

• Download openapi.yaml: https://github.com/scalarorg/simple-staking/tree/scalar/assets
• Install openapi-typescript then generate to the schema file, example:

pakage.json

{
   "scripts": {
         "generate-api": "rimraf ./src/types/schema.ts && openapi-typescript ./assets/openapi.yaml -o ./src/types/schema.ts"
     }
}

Refs: https://github.com/scalarorg/simple-staking/blob/scalar/src/types/schema.ts

• Setup OpenAPI and ScalarAPI client:

import createFetchClient from "openapi-fetch";
import createClient, { OpenapiQueryClient } from "openapi-react-query";

import { ProjectENV } from "@/env";
import { paths } from "@/types/schema";

const scalarFetchClient = createFetchClient<paths>({
  baseUrl: ProjectENV.NEXT_PUBLIC_SCALAR_API_URL,
});

const ScalarAPI: OpenapiQueryClient<paths> = createClient(scalarFetchClient);

export default ScalarAPI;

• Usage:

import ScalarAPI from "@/apis/scalar";

export const useScalarnetParams = () => {
  return ScalarAPI.useQuery("get", "/scalar/scalarnet/v1beta1/params", {});
};