[Platform][API]GetUpgradePhases + example

examples/platformvm/buildAddressStateTx.ts

@@ -30,7 +30,7 @@ const InitAvalanche = async () => {
   await avalanche.fetchNetworkSettings()
   pchain = avalanche.PChain()
   pKeychain = pchain.keyChain()
-  // X-kopernikus1g65uqn6t77p656w64023nh8nd9updzmxh8ttv3
+  // P-kopernikus1g65uqn6t77p656w64023nh8nd9updzmxh8ttv3
   pKeychain.importKey(privKey)
 
   pAddressStrings = pchain.keyChain().getAddressStrings()
@@ -47,6 +47,7 @@ const main = async (): Promise<any> => {
   )
 
   const unsignedTx: UnsignedTx = await pchain.buildAddressStateTx(
+    0,
     undefined,
     pAddressStrings,
     pAddressStrings,

examples/platformvm/buildDepositTx.ts

@@ -53,6 +53,7 @@ const main = async (): Promise<any> => {
   )
 
   const unsignedTx: UnsignedTx = await pchain.buildDepositTx(
+    0,
     undefined,
     pAddressStrings,
     pAddressStrings,

examples/platformvm/getUpgradePhases.ts

@@ -1,7 +1,6 @@
 import { Avalanche } from "caminojs/index"
 import { PlatformVMAPI } from "caminojs/apis/platformvm"
 import { ExamplesConfig } from "../common/examplesConfig"
-import { json } from "stream/consumers"
 
 const config: ExamplesConfig = require("../common/examplesConfig.json")
 const avalanche: Avalanche = new Avalanche(

package.json

@@ -4,7 +4,7 @@
   "description": "Camino Platform JS Library",
   "main": "dist/index.js",
   "scripts": {
-    "build": "rm -rf dist && npx tsc -b",
+    "build": "rm -rf dist && npx tsc -b tsconfig_build.json",
     "bundle": "webpack --mode production",
     "docshtml": "npx typedoc --plugin typedoc-plugin-external-module-name --mode file src",
     "docsmd": "npx typedoc --readme none --plugin typedoc-plugin-markdown,typedoc-plugin-external-module-name --theme markdown --out docsMD src",

src/apis/platformvm/api.ts

@@ -81,7 +81,8 @@ import {
   GetDepositsResponse,
   Owner,
   OwnerParam,
-  MultisigAliasParams
+  MultisigAliasParams,
+  UpgradePhasesReply
 } from "./interfaces"
 import { TransferableInput } from "./inputs"
 import { TransferableOutput } from "./outputs"
@@ -737,6 +738,20 @@ export class PlatformVMAPI extends JRPCAPI {
     return response.data.result
   }
 
+  /**
+   * Retrieves the current phases.
+   *
+   * @returns Returns a Promise of a UpgradePhasesReply.
+   */
+  getUpgradePhases = async (): Promise<UpgradePhasesReply> => {
+    const response: RequestResponseData = await this.callMethod(
+      "platform.getUpgradePhases"
+    )
+    return {
+      SunrisePhase: parseInt(response.data.result.sunrisePhase)
+    }
+  }
+
   /**
    * Samples `Size` validators from the current validator set.
    *

src/apis/platformvm/interfaces.ts

@@ -355,3 +355,7 @@ export interface ClaimAmountParams {
   owners: OutputOwners
   sigIdxs: number[]
 }
+
+export interface UpgradePhasesReply {
+  SunrisePhase: number
+}

tsconfig.json

@@ -19,8 +19,8 @@
       "caminojs/*": ["./src/*"]
     }
   },
-  "exclude": ["node_modules", "examples_", "*/**/*.test.ts", "e2e_tests"],
-  "include": ["src/"],
+  "exclude": ["node_modules", "*/**/*.test.ts", "e2e_tests"],
+  "include": ["src/", "examples/"],
   "typeAcquisition": {
     "enable": true,
     "exclude": ["bn.js"]

tsconfig_build.json

@@ -0,0 +1,28 @@
+{
+  "compilerOptions": {
+    "outDir": "./dist/",
+    "baseUrl": ".",
+    "module": "commonjs",
+    "target": "ES2015",
+    "lib": ["dom", "es2016"],
+    "declaration": true,
+    "resolveJsonModule": true,
+    "skipLibCheck": true,
+    "inlineSourceMap": true,
+    "inlineSources": true,
+    "declarationMap": true,
+    "noFallthroughCasesInSwitch": true,
+    "strictFunctionTypes": true,
+    "esModuleInterop": true,
+    "typeRoots": ["./typings/**", "./node_modules/@types"],
+    "paths": {
+      "caminojs/*": ["./src/*"]
+    }
+  },
+  "exclude": ["node_modules", "*/**/*.test.ts", "e2e_tests"],
+  "include": ["src/"],
+  "typeAcquisition": {
+    "enable": true,
+    "exclude": ["bn.js"]
+  }
+}