Add an EdgeStakingSettings configuration

Author: swansontec

src/core/currency/wallet/currency-wallet-api.js

@@ -2,7 +2,7 @@
 
 import { add, div, lte, mul, sub } from 'biggystring'
 import { type Disklet } from 'disklet'
-import { bridgifyObject, onMethod, watchMethod } from 'yaob'
+import { bridgifyObject, onMethod, update, watchMethod } from 'yaob'
 
 import { CurrencyWalletSync } from '../../../client-side.js'
 import {
@@ -20,6 +20,7 @@ import {
   type EdgePaymentProtocolInfo,
   type EdgeReceiveAddress,
   type EdgeSpendInfo,
+  type EdgeStakingSettings,
   type EdgeTokenInfo,
   type EdgeTransaction,
   type EdgeWalletInfo
@@ -459,6 +460,23 @@ export function makeCurrencyWalletApi (
       return getMax('0', add(balance, '1'))
     },
 
+    get stakingSettings (): EdgeStakingSettings {
+      return engine.stakingSettings != null
+        ? engine.stakingSettings
+        : { stakingEnabled: false }
+    },
+
+    async changeStakingSettings (
+      stakingSettings: EdgeStakingSettings
+    ): Promise<EdgeTransaction> {
+      if (engine.changeStakingSettings == null) {
+        throw new Error('This currency does not support staking')
+      }
+      const tx = await engine.changeStakingSettings(stakingSettings)
+      update(out) // Check for changes to this.stakingSettings
+      return tx
+    },
+
     async parseUri (uri: string, currencyCode?: string): Promise<EdgeParsedUri> {
       const tools = await getCurrencyTools(ai, walletInfo.type)
       return tools.parseUri(

src/types/types.js

@@ -137,6 +137,7 @@ export type EdgeCurrencyInfo = {
   pluginName: string,
   denominations: Array<EdgeDenomination>,
   requiredConfirmations?: number,
+  supportsStaking?: boolean,
   walletType: string,
 
   // Configuration options:
@@ -223,6 +224,13 @@ export type EdgeSpendInfo = {
   otherParams?: Object
 }
 
+export type EdgeStakingSettings =
+  | { stakingEnabled: false }
+  | {
+      stakingEnabled: true,
+      delegateAddress: string
+    }
+
 // query data ----------------------------------------------------------
 
 export type EdgeDataDump = {
@@ -359,6 +367,12 @@ export type EdgeCurrencyEngine = {
     paymentProtocolUrl: string
   ) => Promise<EdgePaymentProtocolInfo>,
 
+  // Staking:
+  +stakingSettings?: EdgeStakingSettings,
+  changeStakingSettings?: (
+    stakingSettings: EdgeStakingSettings
+  ) => Promise<EdgeTransaction>,
+
   // Escape hatch:
   +otherMethods?: Object
 }
@@ -477,16 +491,20 @@ export type EdgeCurrencyWallet = {
   getEnabledTokens(): Promise<Array<string>>,
   addCustomToken(token: EdgeTokenInfo): Promise<mixed>,
 
-  // Transactions:
+  // Transaction history:
   getNumTransactions(opts?: EdgeCurrencyCodeOptions): Promise<number>,
   getTransactions(
     opts?: EdgeGetTransactionsOptions
   ): Promise<Array<EdgeTransaction>>,
+
+  // Addresses:
   getReceiveAddress(
     opts?: EdgeCurrencyCodeOptions
   ): Promise<EdgeReceiveAddress>,
   saveReceiveAddress(receiveAddress: EdgeReceiveAddress): Promise<mixed>,
   lockReceiveAddress(receiveAddress: EdgeReceiveAddress): Promise<mixed>,
+
+  // Sending:
   makeSpend(spendInfo: EdgeSpendInfo): Promise<EdgeTransaction>,
   signTx(tx: EdgeTransaction): Promise<EdgeTransaction>,
   broadcastTx(tx: EdgeTransaction): Promise<EdgeTransaction>,
@@ -502,6 +520,12 @@ export type EdgeCurrencyWallet = {
     paymentProtocolUrl: string
   ): Promise<EdgePaymentProtocolInfo>,
 
+  // Staking:
+  +stakingSettings: EdgeStakingSettings,
+  changeStakingSettings: (
+    stakingSettings: EdgeStakingSettings
+  ) => Promise<EdgeTransaction>,
+
   // Wallet management:
   resyncBlockchain(): Promise<mixed>,
   dumpData(): Promise<EdgeDataDump>,