feat: integrates new chain-sdk into akashjs

Author: stalniy

.env.sample

@@ -1 +1,2 @@
-MNEMONIC='<your wallet mnemonic>'
+MNEMONIC='<your wallet mnemonic>'
+RPC_ENDPOINT=https://rpc.sandbox-2.aksh.pw:443 # sandbox RPC node url (others - https://github.com/akash-network/net)

README.md

@@ -2,6 +2,9 @@
 
 ![build:main](https://github.com/ovrclk/akashjs/actions/workflows/release.yml/badge.svg?branch=main)
 
+**DEPRECATED:** akashjs examples are deprecated and won't be updated with the next network upgrade. Please switch to [chain-sdk](https://github.com/akash-network/chain-sdk/tree/main/ts) which provides more developer-friendly API with IDE autocomplete support
+
+
 Connect and communicate with the Akash Network. Pure JS library can be used in browser for unsigned transactions, and with node.js for full compatibility.
 
 ## Packages
@@ -143,4 +146,3 @@ npm run setup-git-hooks
 - Set `DEBUG=akashjs:*` environment variable for detailed logs
 
 PRs are welcome! By adhering to these guidelines and leveraging our automated systems, we can maintain a high-quality codebase and streamline our development processes.
-

examples/README.md

@@ -1,5 +1,7 @@
 # AkashJS Examples
 
+**DEPRECATED:** akashjs examples are deprecated and won't be updated with the next network upgrade. Please switch to [chain-sdk](https://github.com/akash-network/chain-sdk/tree/main/ts) which provides more developer-friendly API with IDE autocomplete support
+
 This directory contains several examples of how to interact with the Akash networking using AkashJS and CosmJS.
 
 ## Setup
@@ -62,13 +64,7 @@ Install the following dependencies for general usage and signing transactions wi
 npm i @akashnetwork/akash-api @akashnetwork/akashjs @cosmjs/stargate @cosmjs/proto-signing
 ```
 
-If you want to create wallets
-
-```bash
-npm i @cosmjs/launchpad
-```
-
-For [amino encoding](https://docs.cosmos.network/main/learn/advanced/encoding#encoding-1)
+If you want to create wallets with [amino encoding](https://docs.cosmos.network/main/learn/advanced/encoding#encoding-1)
 
 ```bash
 npm i @cosmjs/amino
@@ -81,7 +77,7 @@ The following code shows an example of the process for creating a new Akash wall
 A new wallet can be initialized by calling `Secp256k1HdWallet.generate` from @cosmjs/launchpad, and passing `{ prefix: "akash" }`.
 
 ```ts
-import { Secp256k1HdWallet } from "@cosmjs/launchpad";
+import { Secp256k1HdWallet } from "@cosmjs/amino";
 
 // the first parameter for generate is the size of the mnemonic, default is 12
 const wallet = await Secp256k1HdWallet.generate(undefined, { prefix: "akash" });
@@ -90,7 +86,7 @@ const wallet = await Secp256k1HdWallet.generate(undefined, { prefix: "akash" });
 After the wallet is created, specific private/public key pairs are available via `getAccounts`.
 
 ```ts
-import { Secp256k1HdWallet } from "@cosmjs/launchpad";
+import { Secp256k1HdWallet } from "@cosmjs/amino";
 
 const wallet = await Secp256k1HdWallet.generate(undefined, { prefix: "akash" });
 
@@ -101,7 +97,7 @@ const [account] = await wallet.getAccounts();
 The account address, as well as its public key, are available as properties on this account object.
 
 ```ts
-import { Secp256k1HdWallet } from "@cosmjs/launchpad";
+import { Secp256k1HdWallet } from "@cosmjs/amino";
 
 const wallet = await Secp256k1HdWallet.generate(undefined, { prefix: "akash" });
 
@@ -116,7 +112,7 @@ const { address, pubkey } = account;
 Cosmjs does not publicly expose the private key for accounts. Instead, messages are passed into the wallet for signing. This can be done directly, as shown below.
 
 ```ts
-import { Secp256k1HdWallet, StdSignDoc } from "@cosmjs/launchpad";
+import { Secp256k1HdWallet, StdSignDoc } from "@cosmjs/amino";
 
 function getMessage(): StdSignDoc {
   // implements custom message

examples/create_deployment.ts

@@ -1,26 +1,31 @@
+/**
+ * akashjs examples are working but deprecated.
+ * PLEASE switch to chain-sdk which provides more developer-friendly API with IDE autocomplete support:
+ * https://github.com/akash-network/chain-sdk/tree/main/ts
+ */
+
 import fs from "fs";
 import path from "path";
 import https from "https";
 import { SigningStargateClient } from "@cosmjs/stargate";
-import { MsgCreateDeployment } from "@akashnetwork/akash-api/akash/deployment/v1beta3";
-import { QueryClientImpl as QueryProviderClient, QueryProviderRequest } from "@akashnetwork/akash-api/akash/provider/v1beta3";
-import { QueryBidsRequest, QueryClientImpl as QueryMarketClient, MsgCreateLease, BidID } from "@akashnetwork/akash-api/akash/market/v1beta4";
+import { MsgCreateDeployment, QueryProviderRequest, QueryProviderResponse } from "@akashnetwork/chain-sdk/private-types/akash.v1beta4";
+import { BidID, Source } from "@akashnetwork/chain-sdk/private-types/akash.v1";
+import { QueryBidsRequest, MsgCreateLease, QueryBidsResponse } from "@akashnetwork/chain-sdk/private-types/akash.v1beta5";
 import * as cert from "@akashnetwork/akashjs/build/certificates";
 import { getRpc } from "@akashnetwork/akashjs/build/rpc";
 import { SDL } from "@akashnetwork/akashjs/build/sdl";
 import { getAkashTypeRegistry } from "@akashnetwork/akashjs/build/stargate";
 import { CertificatePem } from "@akashnetwork/akashjs/build/certificates/certificate-manager/CertificateManager";
 import { certificateManager } from "@akashnetwork/akashjs/build/certificates/certificate-manager";
 import { DirectSecp256k1HdWallet, Registry } from "@cosmjs/proto-signing";
-import dotenv from "dotenv";
-
-dotenv.config({ path: "../.env" });
-
-// In case you want to test on a sandbox environment, uncomment the following line and comment the following line
-// const rpcEndpoint = "https://rpc.sandbox-01.aksh.pw";
+import { createRpcRequest } from "./grpc_client";
+import { QueryInput } from "@akashnetwork/chain-sdk";
+import "./setup";
 
-// Update this with your RPC endpoint
-const rpcEndpoint = "https://rpc.akashnet.net:443";
+const rpcEndpoint = process.env.RPC_ENDPOINT || "";
+if (!rpcEndpoint) {
+  throw new Error("RPC_ENDPOINT environment variable is not set. Please set the environment variable in the .env file. See .env.sample for more information.");
+}
 
 // Update this environment variable with your wallet mnemonic
 const mnemonic = process.env.MNEMONIC || "";
@@ -35,7 +40,7 @@ const certificatePath = path.resolve(__dirname, "./fixtures/cert.json");
 type Deployment = {
   id: {
     owner: string;
-    dseq: number;
+    dseq: number | string;
   };
 };
 
@@ -91,6 +96,7 @@ async function loadOrCreateCertificate(wallet: DirectSecp256k1HdWallet, client:
   const accounts = await wallet.getAccounts();
   // check to see if we can load the certificate from the fixtures folder
 
+  console.log("Accounts:", accounts[0].address);
   if (fs.existsSync(certificatePath)) {
     return loadCertificate(certificatePath);
   }
@@ -142,15 +148,17 @@ async function createDeployment(sdl: SDL, wallet: DirectSecp256k1HdWallet, clien
   const deployment = {
     id: {
       owner: accounts[0].address,
-      dseq: blockheight
+      dseq: String(blockheight)
     },
     groups: groups,
     deposit: {
-      denom: "uakt",
-      amount: "5000000"
+      sources: [Source.balance],
+      amount: {
+        denom: "uakt",
+        amount: "5000000"
+      },
     },
-    version: await sdl.manifestVersion(),
-    depositor: accounts[0].address
+    hash: await sdl.manifestVersion(),
   };
 
   const fee = {
@@ -164,7 +172,7 @@ async function createDeployment(sdl: SDL, wallet: DirectSecp256k1HdWallet, clien
   };
 
   const msg = {
-    typeUrl: "/akash.deployment.v1beta3.MsgCreateDeployment",
+    typeUrl: `/${MsgCreateDeployment.$type}`,
     value: MsgCreateDeployment.fromPartial(deployment)
   };
 
@@ -177,23 +185,29 @@ async function createDeployment(sdl: SDL, wallet: DirectSecp256k1HdWallet, clien
   throw new Error(`Could not create deployment: ${tx.rawLog} `);
 }
 
-async function fetchBid(dseq: number, owner: string) {
+async function fetchBid(dseq: number | string, owner: string) {
   const rpc = await getRpc(rpcEndpoint);
-  const client = new QueryMarketClient(rpc);
-  const request = QueryBidsRequest.fromPartial({
+
+  const request: QueryInput<QueryBidsRequest> = {
     filters: {
       owner: owner,
       dseq: dseq
     }
-  });
+  };
 
   const startTime = Date.now();
   const timeout = 1000 * 60 * 5;
 
+  const getBids = createRpcRequest(rpc, {
+    methodName: "akash.market.v1beta5.Bids",
+    requestType: QueryBidsRequest,
+    responseType: QueryBidsResponse
+  });
+
   while (Date.now() - startTime < timeout) {
     console.log("Fetching bids...");
     await new Promise(resolve => setTimeout(resolve, 5000));
-    const bids = await client.Bids(request);
+    const bids = await getBids(request);
 
     if (bids.bids.length > 0 && bids.bids[0].bid !== undefined) {
       console.log("Bid fetched!");
@@ -213,12 +227,12 @@ async function createLease(deployment: Deployment, wallet: DirectSecp256k1HdWall
   const bid = await fetchBid(dseq, owner);
   const accounts = await wallet.getAccounts();
 
-  if (bid.bidId === undefined) {
+  if (bid.id === undefined) {
     throw new Error("Bid ID is undefined");
   }
 
   const lease = {
-    bidId: bid.bidId
+    bidId: bid.id
   };
 
   const fee = {
@@ -240,7 +254,7 @@ async function createLease(deployment: Deployment, wallet: DirectSecp256k1HdWall
 
   if (tx.code !== undefined && tx.code === 0) {
     return {
-      id: BidID.toJSON(bid.bidId) as {
+      id: BidID.toJSON(bid.id) as {
         owner: string;
         dseq: number;
         provider: string;
@@ -308,26 +322,30 @@ async function sendManifest(sdl: SDL, lease: Lease, wallet: DirectSecp256k1HdWal
 
   const { dseq, provider } = lease.id;
   const rpc = await getRpc(rpcEndpoint);
-  const client = new QueryProviderClient(rpc);
-  const request = QueryProviderRequest.fromPartial({
-    owner: provider
+  const getProvider = createRpcRequest(rpc, {
+    methodName: "akash.provider.v1beta4.Provider",
+    requestType: QueryProviderRequest,
+    responseType: QueryProviderResponse
   });
 
-  const tx = await client.Provider(request);
+  const providerResponse = await getProvider({
+    owner: provider
+  });
 
-  if (tx.provider === undefined) {
+  if (providerResponse.provider === undefined) {
     throw new Error(`Could not find provider ${provider}`);
   }
 
-  const providerInfo = tx.provider;
+  const providerInfo = providerResponse.provider;
   const manifest = sdl.manifestSortedJSON();
   const path = `/deployment/${dseq}/manifest`;
 
   const uri = new URL(providerInfo.hostUri);
   const agent = new https.Agent({
     cert: certificate.cert,
     key: certificate.privateKey,
-    rejectUnauthorized: false
+    rejectUnauthorized: false,
+    servername: "" // required to disable SNI, so the provider API will use mTLS authentication (e.i., self-signed certificates)
   });
 
   await new Promise((resolve, reject) => {

examples/create_wallet.ts

@@ -1,4 +1,10 @@
-import { Secp256k1HdWallet } from "@cosmjs/launchpad";
+/**
+ * akashjs examples are working but deprecated.
+ * PLEASE switch to chain-sdk which provides more developer-friendly API with IDE autocomplete support:
+ * https://github.com/akash-network/chain-sdk/tree/main/ts
+ */
+
+import { Secp256k1HdWallet } from "@cosmjs/amino";
 
 async function main() {
   const wallet = await Secp256k1HdWallet.generate(undefined, { prefix: "akash" });

examples/details_of_single_provider.ts

@@ -1,16 +1,35 @@
-import { QueryClientImpl, QueryProviderRequest, QueryProviderResponse } from "@akashnetwork/akash-api/akash/provider/v1beta3";
+/**
+ * akashjs examples are working but deprecated.
+ * PLEASE switch to chain-sdk which provides more developer-friendly API with IDE autocomplete support:
+ * https://github.com/akash-network/chain-sdk/tree/main/ts
+ */
+
+import { QueryProviderRequest, QueryProviderResponse } from "@akashnetwork/chain-sdk/private-types/akash.v1beta4";
 import { getRpc } from "@akashnetwork/akashjs/build/rpc";
+import { createRpcRequest } from "./grpc_client";
+import "./setup";
+
+const rpcEndpoint = process.env.RPC_ENDPOINT || "";
+if (!rpcEndpoint) {
+  throw new Error("RPC_ENDPOINT environment variable is not set. Please set the environment variable in the .env file. See .env.sample for more information.");
+}
+
+if (!process.env.PROVIDER_ADDRESS) {
+  throw new Error("PROVIDER_ADDRESS environment variable is not set.");
+}
 
 async function main() {
-  const client = new QueryClientImpl(await getRpc("http://rpc.akashnet.net"));
+  const getProviderInfo = createRpcRequest(await getRpc(rpcEndpoint), {
+    methodName: "akash.provider.v1beta4.Provider",
+    requestType: QueryProviderRequest,
+    responseType: QueryProviderResponse
+  });
 
-  const getProviderInfoRequest = QueryProviderRequest.fromPartial({
-    owner: "akashSomeProviderAddress"
+  const providerResponse = await getProviderInfo({
+    owner: process.env.PROVIDER_ADDRESS
   });
-  const providerResponse = await client.Provider(getProviderInfoRequest);
-  const data = QueryProviderResponse.toJSON(providerResponse);
 
-  console.log(data);
+  console.log(providerResponse);
 }
 
 main();

examples/estimate_gas.ts

@@ -1,25 +1,55 @@
+/**
+ * akashjs examples are working but deprecated.
+ * PLEASE switch to chain-sdk which provides more developer-friendly API with IDE autocomplete support:
+ * https://github.com/akash-network/chain-sdk/tree/main/ts
+ */
+
 import { DirectSecp256k1HdWallet, Registry } from "@cosmjs/proto-signing";
 import { SigningStargateClient } from "@cosmjs/stargate";
-import { MsgCloseDeployment } from "@akashnetwork/akash-api/akash/deployment/v1beta3";
+import { MsgCloseDeployment, QueryDeploymentsRequest, QueryDeploymentsResponse } from "@akashnetwork/chain-sdk/private-types/akash.v1beta4";
 import { getAkashTypeRegistry, getTypeUrl } from "@akashnetwork/akashjs/build/stargate";
-import dotenv from "dotenv";
+import { createRpcRequest } from "./grpc_client";
+import { getRpc } from "../src/rpc";
+import "./setup";
+
+// You can use your own RPC node, or get a list of public nodes from akashjs
+const rpcEndpoint = process.env.RPC_ENDPOINT || "";
+if (!rpcEndpoint) {
+  throw new Error("RPC_ENDPOINT environment variable is not set. Please set the environment variable in the .env file. See .env.sample for more information.");
+}
 
-dotenv.config({ path: "../.env" });
+const mnemonic = process.env.MNEMONIC || "";
+if (!mnemonic) {
+  throw new Error("MNEMONIC environment variable is not set. Please set the environment variable in the .env file. See .env.sample for more information.");
+}
 
 async function main() {
-  const mnemonic = process.env.MNEMONIC || "";
-  if (!mnemonic) {
-    throw new Error("MNEMONIC environment variable is not set. Please set the environment variable in the .env file. See .env.sample for more information.");
-  }
   const wallet = await DirectSecp256k1HdWallet.fromMnemonic(mnemonic, { prefix: "akash" });
 
   // get first account
   const [account] = await wallet.getAccounts();
 
+  const getDeployments = createRpcRequest(await getRpc(rpcEndpoint), {
+    methodName: "akash.deployment.v1beta4.Deployments",
+    requestType: QueryDeploymentsRequest,
+    responseType: QueryDeploymentsResponse
+  });
+
+  const {deployments} = await getDeployments({
+    filters: {
+      owner: account.address
+    }
+  });
+
+  if (deployments.length === 0) {
+    throw new Error(`No deployments found for account: ${account.address}`);
+  }
+  const deployment = deployments[0];
+
   // Use the encode method for the message to wrap the data
   const message = MsgCloseDeployment.fromPartial({
     id: {
-      dseq: "555555",
+      dseq: deployment.deployment?.id?.dseq?.toString() || "",
       owner: account.address
     }
   });
@@ -30,9 +60,6 @@ async function main() {
     value: message
   };
 
-  // You can use your own RPC node, or get a list of public nodes from akashjs
-  const rpcEndpoint = "http://rpc.akashnet.net";
-
   const myRegistry = new Registry(getAkashTypeRegistry());
 
   const client = await SigningStargateClient.connectWithSigner(rpcEndpoint, wallet, {