chain-sdk library

[baktun14]

Library Overview

• protobuf (this is done already)
• api
  • grpc
    • Investigate https://github.com/grpc/grpc-web
  • rest
    • using protobuf types, generate a simple api to abtract all the logic to connect to grpc and encode the payload, with proper typing for incoming/outgoing data
    • same thing for rest, but for query building the parameters and have all the possible routes with proper
• certificate
  • move from https://github.com/akash-network/akashjs/blob/main/src/certificates/certificate-manager/CertificateManager.ts
• sdl
  • move from https://github.com/akash-network/akashjs/blob/main/src/sdl/SDL/SDL.ts
  • move from https://github.com/akash-network/console/tree/main/apps/deploy-web/src/utils/sdl
    • We implemented sdl import from yaml and generator from object to yaml. The generator will have to be re-designed because it currently received an object of the type of the SDL builder form, which is not technically 1:1 with the SDL spec.

Usage

api/grpc

import { ChainSDK } from "@akashnetwork/chain-sdk/chain-sdk"

// Using the sdk instance
const chainSdk = new ChainSDK({
  rest: "https://api.akashnet.net",
  rpc: "https://rpc.akashnet.net"
});

// Querying data from api or grpc with typed parameters
// https://api.akashnet.net/akash/deployment/v1beta3/deployments/info?id.owner=akash1234&id.dseq=1234;
const response = await axios.get(chainSdk.rest.deployments.info({ owner: "akash1234", dseq: "1234" }));
const deployment = response.data.deployment; // Typed response

// Potential grpc usage
const response = await chainSdk.grpc.deployments.info({ owner: "akash1234", dseq: "1234" });

protobuf

// Importing the protobuf types
import { MsgCreateBid } from "@akashnetwork/chain-sdk/akash/market/v1beta4";

certificates

// Certificate utils
import { certificateManager } from "@akashnetwork/chain-sdk/certificate";

const { cert: crtpem, publicKey: pubpem, privateKey: encryptedKey } = certificateManager.generatePEM(address);

sdl

import { SDL, v2Sdl, NetworkId } from "@akashnetwork/chain-sdk/sdl";

export function getSdl(yamlJson: string | v2Sdl, networkType: NetworkType, networkId: NetworkId) {
  return isValidString(yamlJson) ? SDL.fromString(yamlJson, networkType, networkId) : new SDL(yamlJson, networkType, networkId);
}