[PlatformAPI] GetDeposits / Fix GetDepositOffers

examples/platformvm/getAllDepositOffers.ts

@@ -1,9 +1,5 @@
 import { Avalanche } from "caminojs/index"
-import {
-  KeyChain,
-  PlatformVMAPI,
-  GetAllDepositOffersResponse
-} from "caminojs/apis/platformvm"
+import { KeyChain, PlatformVMAPI } from "caminojs/apis/platformvm"
 import { ExamplesConfig } from "../common/examplesConfig"
 import { DefaultLocalGenesisPrivateKey, PrivateKeyPrefix } from "caminojs/utils"
 
@@ -33,9 +29,9 @@ const main = async (): Promise<any> => {
   await InitAvalanche()
 
   const active = true
-  const response: GetAllDepositOffersResponse =
-    await pchain.getAllDepositOffers(active)
-  console.log(response.depositOffers)
+  const depositOffers = await pchain.getAllDepositOffers(active)
+  console.log(depositOffers)
+  console.log("start: ", depositOffers[0].start.toNumber())
 }
 
 main()

examples/platformvm/getDeposits.ts

@@ -0,0 +1,46 @@
+import { Avalanche } from "caminojs/index"
+import {
+  GetUTXOsResponse,
+  KeyChain,
+  PlatformVMAPI,
+  UTXOSet
+} from "caminojs/apis/platformvm"
+import { ExamplesConfig } from "../common/examplesConfig"
+import { DefaultLocalGenesisPrivateKey, PrivateKeyPrefix } from "caminojs/utils"
+
+const config: ExamplesConfig = require("../common/examplesConfig.json")
+const avalanche: Avalanche = new Avalanche(
+  config.host,
+  config.port,
+  config.protocol,
+  config.networkID
+)
+
+const privKey: string = `${PrivateKeyPrefix}${DefaultLocalGenesisPrivateKey}`
+
+let pchain: PlatformVMAPI
+let pKeychain: KeyChain
+let pAddressStrings: string[]
+
+const InitAvalanche = async () => {
+  await avalanche.fetchNetworkSettings()
+  pchain = avalanche.PChain()
+  pKeychain = pchain.keyChain()
+  pKeychain.importKey(privKey)
+  pAddressStrings = pchain.keyChain().getAddressStrings()
+}
+
+const main = async (): Promise<any> => {
+  await InitAvalanche()
+
+  const platformVMUTXOResponse: GetUTXOsResponse = await pchain.getUTXOs(
+    pAddressStrings
+  )
+  const utxoSet: UTXOSet = platformVMUTXOResponse.utxos
+  const txIDs = utxoSet.getLockedTxIDs()
+
+  const deposits = await pchain.getDeposits(txIDs.depositIDs)
+  console.log(deposits)
+}
+
+main()

src/apis/platformvm/api.ts

@@ -36,7 +36,9 @@ import {
   DelegationFeeError
 } from "../../utils/errors"
 import {
+  APIDeposit,
   BalanceDict,
+  DepositOffer,
   GetCurrentValidatorsParams,
   GetPendingValidatorsParams,
   GetRewardUTXOsParams,
@@ -73,7 +75,9 @@ import {
   GetClaimablesParams,
   GetClaimablesResponse,
   GetAllDepositOffersParams,
-  GetAllDepositOffersResponse
+  GetAllDepositOffersResponse,
+  GetDepositsParams,
+  GetDepositsResponse
 } from "./interfaces"
 import { TransferableInput } from "./inputs"
 import { TransferableOutput } from "./outputs"
@@ -586,17 +590,61 @@ export class PlatformVMAPI extends JRPCAPI {
    *
    * @returns Promise for a list containing deposit offers.
    */
-  getAllDepositOffers = async (
-    active: boolean
-  ): Promise<GetAllDepositOffersResponse> => {
+  getAllDepositOffers = async (active: boolean): Promise<DepositOffer[]> => {
     const params: GetAllDepositOffersParams = {
       active
     }
     const response: RequestResponseData = await this.callMethod(
       "platform.getAllDepositOffers",
       params
     )
-    return response.data.result as GetAllDepositOffersResponse
+
+    const offers: GetAllDepositOffersResponse = response.data.result
+    return offers.depositOffers.map((offer) => {
+      return {
+        id: offer.id,
+        interestRateNominator: new BN(offer.interestRateNominator),
+        start: new BN(offer.start),
+        end: new BN(offer.end),
+        minAmount: new BN(offer.minAmount),
+        minDuration: offer.minDuration,
+        maxDuration: offer.maxDuration,
+        unlockPeriodDuration: offer.unlockPeriodDuration,
+        noRewardsPeriodDuration: offer.noRewardsPeriodDuration,
+        memo: offer.memo,
+        flags: new BN(offer.flags)
+      } as DepositOffer
+    })
+  }
+
+  /**
+   * Returns deposits coressponding to requested txIDs.
+   *
+   * @param depositTxIDs A list of txIDs (cb58) to request deposits for.
+   *
+   * @returns Promise for a list containing deposits.
+   */
+  getDeposits = async (depositTxIDs: string[]): Promise<APIDeposit[]> => {
+    const params: GetDepositsParams = {
+      depositTxIDs
+    }
+    const response: RequestResponseData = await this.callMethod(
+      "platform.getDeposits",
+      params
+    )
+
+    const deposits: GetDepositsResponse = response.data.result
+    return deposits.deposits.map((deposit) => {
+      return {
+        depositTxID: deposit.depositTxID,
+        depositOfferID: deposit.depositOfferID,
+        unlockedAmount: new BN(deposit.unlockedAmount),
+        claimedRewardAmount: new BN(deposit.claimedRewardAmount),
+        start: new BN(deposit.start),
+        duration: deposit.duration,
+        amount: new BN(deposit.amount)
+      } as APIDeposit
+    })
   }
 
   /**

src/apis/platformvm/interfaces.ts

@@ -259,18 +259,36 @@ export interface GetAllDepositOffersResponse {
   depositOffers: DepositOffer[]
 }
 
-interface DepositOffer {
-  ID: string
-  InterestRateNominator: number
-  Start: number
-  End: number
-  MinAmount: number
-  MinDuration: number
-  MaxDuration: number
-  UnlockPeriodDuration: number
-  NoRewardsPeriodDuration: number
-  Memo: string
-  Flags: number
+export interface DepositOffer {
+  id: string
+  interestRateNominator: BN
+  start: BN
+  end: BN
+  minAmount: BN
+  minDuration: number
+  maxDuration: number
+  unlockPeriodDuration: number
+  noRewardsPeriodDuration: number
+  memo: string
+  flags: BN
+}
+
+export interface GetDepositsParams {
+  depositTxIDs: string[]
+}
+
+export interface GetDepositsResponse {
+  deposits: APIDeposit[]
+}
+
+export interface APIDeposit {
+  depositTxID: string
+  depositOfferID: string
+  unlockedAmount: BN
+  claimedRewardAmount: BN
+  start: BN
+  duration: number
+  amount: BN
 }
 
 export interface GetMaxStakeAmountParams {