Add updateInfoPayload implementation

CHANGELOG.md

@@ -2,6 +2,9 @@
 
 ## Unreleased
 
+- added: Implemented common `updateInfoPayload` method for all plugins
+- changed: (Ethereum) Include network fee info for core info payload
+
 ## 4.11.1 (2024-07-08)
 
 changed: Upgrade @polkadot/api to v12.1.1
@@ -20,7 +23,7 @@ changed: Upgrade @polkadot/api to v12.1.1
 
 - added: (Ethereum/Solana) Add BOBBY
 - added: (zkSync) Add ZK
-- changed: (Piratechain) Allow  `derivePublicKey` to fail in case native code isn't present
+- changed: (Piratechain) Allow `derivePublicKey` to fail in case native code isn't present
 - removed: (Zcash/Piratechain) Remove `defaultBirthdayHeight`
 
 ## 4.8.0 (2024-06-10)

src/algorand/AlgorandTools.ts

@@ -16,8 +16,9 @@ import {
 import { PluginEnvironment } from '../common/innerPlugin'
 import { validateToken } from '../common/tokenHelpers'
 import { encodeUriCommon, parseUriCommon } from '../common/uriHelpers'
-import { getLegacyDenomination } from '../common/utils'
+import { getLegacyDenomination, mergeDeeply } from '../common/utils'
 import {
+  AlgorandInfoPayload,
   AlgorandNetworkInfo,
   asAlgorandPrivateKeys,
   asMaybeContractAddressLocation,
@@ -155,4 +156,15 @@ export async function makeCurrencyTools(
   return new AlgorandTools(env)
 }
 
+export async function updateInfoPayload(
+  env: PluginEnvironment<AlgorandNetworkInfo>,
+  infoPayload: AlgorandInfoPayload
+): Promise<void> {
+  // In the future, other fields might not be "network info" fields
+  const { ...networkInfo } = infoPayload
+
+  // Update plugin NetworkInfo:
+  env.networkInfo = mergeDeeply(env.networkInfo, networkInfo)
+}
+
 export { makeCurrencyEngine } from './AlgorandEngine'

src/algorand/algorandInfo.ts

@@ -3,7 +3,11 @@ import { EdgeCurrencyInfo, EdgeTokenMap } from 'edge-core-js/types'
 import { makeOuterPlugin } from '../common/innerPlugin'
 import { makeMetaTokens } from '../common/tokenHelpers'
 import type { AlgorandTools } from './AlgorandTools'
-import { AlgorandNetworkInfo, asAlgorandInfoPayload } from './algorandTypes'
+import {
+  AlgorandInfoPayload,
+  AlgorandNetworkInfo,
+  asAlgorandInfoPayload
+} from './algorandTypes'
 
 const builtinTokens: EdgeTokenMap = {
   '31566704': {
@@ -72,10 +76,14 @@ const currencyInfo: EdgeCurrencyInfo = {
   metaTokens: makeMetaTokens(builtinTokens)
 }
 
-export const algorand = makeOuterPlugin<AlgorandNetworkInfo, AlgorandTools>({
+export const algorand = makeOuterPlugin<
+  AlgorandNetworkInfo,
+  AlgorandTools,
+  AlgorandInfoPayload
+>({
   builtinTokens,
   currencyInfo,
-  infoPayloadCleaner: asAlgorandInfoPayload,
+  asInfoPayload: asAlgorandInfoPayload,
   networkInfo,
 
   checkEnvironment: () => {

src/algorand/algorandTestnetInfo.ts

@@ -3,7 +3,11 @@ import { EdgeCurrencyInfo, EdgeTokenMap } from 'edge-core-js/types'
 import { makeOuterPlugin } from '../common/innerPlugin'
 import { makeMetaTokens } from '../common/tokenHelpers'
 import type { AlgorandTools } from './AlgorandTools'
-import { AlgorandNetworkInfo, asAlgorandInfoPayload } from './algorandTypes'
+import {
+  AlgorandInfoPayload,
+  AlgorandNetworkInfo,
+  asAlgorandInfoPayload
+} from './algorandTypes'
 
 const builtinTokens: EdgeTokenMap = {
   '10458941': {
@@ -67,11 +71,12 @@ const currencyInfo: EdgeCurrencyInfo = {
 
 export const algorandtestnet = makeOuterPlugin<
   AlgorandNetworkInfo,
-  AlgorandTools
+  AlgorandTools,
+  AlgorandInfoPayload
 >({
   builtinTokens,
   currencyInfo,
-  infoPayloadCleaner: asAlgorandInfoPayload,
+  asInfoPayload: asAlgorandInfoPayload,
   networkInfo,
 
   checkEnvironment: () => {

src/algorand/algorandTypes.ts

@@ -37,11 +37,6 @@ export interface AlgorandNetworkInfo {
   minimumAddressBalance: string
 }
 
-export const asAlgorandInfoPayload = asObject({
-  algodServers: asOptional(asArray(asString)),
-  indexerServers: asOptional(asArray(asString))
-})
-
 export const asAccountInformation = asObject({
   // address: asString,
   amount: asNumber,
@@ -257,3 +252,13 @@ export const asAlgorandWalletConnectPayload = asObject({
     )
   )
 }).withRest
+
+//
+// Info Payload
+//
+
+export const asAlgorandInfoPayload = asObject({
+  algodServers: asOptional(asArray(asString)),
+  indexerServers: asOptional(asArray(asString))
+})
+export type AlgorandInfoPayload = ReturnType<typeof asAlgorandInfoPayload>

src/binance/BinanceTools.ts

@@ -15,10 +15,11 @@ import {
 
 import { PluginEnvironment } from '../common/innerPlugin'
 import { encodeUriCommon, parseUriCommon } from '../common/uriHelpers'
-import { getLegacyDenomination } from '../common/utils'
+import { getLegacyDenomination, mergeDeeply } from '../common/utils'
 import {
   asBnbPrivateKey,
   asSafeBnbWalletInfo,
+  BinanceInfoPayload,
   BinanceNetworkInfo
 } from './binanceTypes'
 
@@ -152,4 +153,15 @@ export async function makeCurrencyTools(
   return new BinanceTools(env)
 }
 
+export async function updateInfoPayload(
+  env: PluginEnvironment<BinanceNetworkInfo>,
+  infoPayload: BinanceInfoPayload
+): Promise<void> {
+  // In the future, other fields might not be "network info" fields
+  const { ...networkInfo } = infoPayload
+
+  // Update plugin NetworkInfo:
+  env.networkInfo = mergeDeeply(env.networkInfo, networkInfo)
+}
+
 export { makeCurrencyEngine } from './BinanceEngine'

src/binance/binanceInfo.ts

@@ -2,7 +2,11 @@ import { EdgeCurrencyInfo } from 'edge-core-js/types'
 
 import { makeOuterPlugin } from '../common/innerPlugin'
 import type { BinanceTools } from './BinanceTools'
-import { asBinanceInfoPayload, BinanceNetworkInfo } from './binanceTypes'
+import {
+  asBinanceInfoPayload,
+  BinanceInfoPayload,
+  BinanceNetworkInfo
+} from './binanceTypes'
 
 const networkInfo: BinanceNetworkInfo = {
   binanceApiServers: [
@@ -37,9 +41,13 @@ const currencyInfo: EdgeCurrencyInfo = {
   memoOptions: [{ type: 'text', memoName: 'memo', maxLength: 128 }]
 }
 
-export const binance = makeOuterPlugin<BinanceNetworkInfo, BinanceTools>({
+export const binance = makeOuterPlugin<
+  BinanceNetworkInfo,
+  BinanceTools,
+  BinanceInfoPayload
+>({
   currencyInfo,
-  infoPayloadCleaner: asBinanceInfoPayload,
+  asInfoPayload: asBinanceInfoPayload,
   networkInfo,
 
   async getInnerPlugin() {

src/binance/binanceTypes.ts

@@ -14,11 +14,6 @@ export interface BinanceNetworkInfo {
   beaconChainApiServers: string[]
 }
 
-export const asBinanceInfoPayload = asObject({
-  binanceApiServers: asOptional(asArray(asString)),
-  beaconChainApiServers: asOptional(asArray(asString))
-})
-
 export const asBinanceApiNodeInfo = asObject({
   sync_info: asObject({
     latest_block_height: asNumber
@@ -89,3 +84,13 @@ export const asBnbPrivateKey = asObject({
   binanceKey: asString,
   binanceMnemonic: asString
 })
+
+//
+// Info Payload
+//
+
+export const asBinanceInfoPayload = asObject({
+  binanceApiServers: asOptional(asArray(asString)),
+  beaconChainApiServers: asOptional(asArray(asString))
+})
+export type BinanceInfoPayload = ReturnType<typeof asBinanceInfoPayload>

src/cardano/CardanoTools.ts

@@ -16,10 +16,11 @@ import { base16 } from 'rfc4648'
 
 import { PluginEnvironment } from '../common/innerPlugin'
 import { encodeUriCommon, parseUriCommon } from '../common/uriHelpers'
-import { getLegacyDenomination } from '../common/utils'
+import { getLegacyDenomination, mergeDeeply } from '../common/utils'
 import {
   asCardanoPrivateKeys,
   asSafeCardanoWalletInfo,
+  CardanoInfoPayload,
   CardanoNetworkInfo,
   EpochParams,
   SafeCardanoWalletInfo
@@ -193,3 +194,14 @@ export async function makeCurrencyTools(
 }
 
 export { makeCurrencyEngine } from './CardanoEngine'
+
+export async function updateInfoPayload(
+  env: PluginEnvironment<CardanoNetworkInfo>,
+  infoPayload: CardanoInfoPayload
+): Promise<void> {
+  // In the future, other fields might not be "network info" fields
+  const { ...networkInfo } = infoPayload
+
+  // Update plugin NetworkInfo:
+  env.networkInfo = mergeDeeply(env.networkInfo, networkInfo)
+}

src/cardano/cardanoInfo.ts

@@ -2,7 +2,11 @@ import { EdgeCurrencyInfo } from 'edge-core-js/types'
 
 import { makeOuterPlugin } from '../common/innerPlugin'
 import type { CardanoTools } from './CardanoTools'
-import { asCardanoInfoPayload, CardanoNetworkInfo } from './cardanoTypes'
+import {
+  asCardanoInfoPayload,
+  CardanoInfoPayload,
+  CardanoNetworkInfo
+} from './cardanoTypes'
 
 const networkInfo: CardanoNetworkInfo = {
   networkId: 1,
@@ -29,9 +33,13 @@ const currencyInfo: EdgeCurrencyInfo = {
   ]
 }
 
-export const cardano = makeOuterPlugin<CardanoNetworkInfo, CardanoTools>({
+export const cardano = makeOuterPlugin<
+  CardanoNetworkInfo,
+  CardanoTools,
+  CardanoInfoPayload
+>({
   currencyInfo,
-  infoPayloadCleaner: asCardanoInfoPayload,
+  asInfoPayload: asCardanoInfoPayload,
   networkInfo,
 
   checkEnvironment: () => {

src/cardano/cardanoTestnetInfo.ts

@@ -2,7 +2,11 @@ import { EdgeCurrencyInfo } from 'edge-core-js/types'
 
 import { makeOuterPlugin } from '../common/innerPlugin'
 import type { CardanoTools } from './CardanoTools'
-import { asCardanoInfoPayload, CardanoNetworkInfo } from './cardanoTypes'
+import {
+  asCardanoInfoPayload,
+  CardanoInfoPayload,
+  CardanoNetworkInfo
+} from './cardanoTypes'
 
 const networkInfo: CardanoNetworkInfo = {
   networkId: 0,
@@ -29,20 +33,22 @@ const currencyInfo: EdgeCurrencyInfo = {
   ]
 }
 
-export const cardanotestnet = makeOuterPlugin<CardanoNetworkInfo, CardanoTools>(
-  {
-    currencyInfo,
-    infoPayloadCleaner: asCardanoInfoPayload,
-    networkInfo,
-
-    checkEnvironment: () => {
-      if (global.BigInt == null) {
-        throw new Error('Cardano Testnet requires bigint support')
-      }
-    },
-
-    async getInnerPlugin() {
-      return await import('./CardanoTools')
+export const cardanotestnet = makeOuterPlugin<
+  CardanoNetworkInfo,
+  CardanoTools,
+  CardanoInfoPayload
+>({
+  currencyInfo,
+  asInfoPayload: asCardanoInfoPayload,
+  networkInfo,
+
+  checkEnvironment: () => {
+    if (global.BigInt == null) {
+      throw new Error('Cardano Testnet requires bigint support')
     }
+  },
+
+  async getInnerPlugin() {
+    return await import('./CardanoTools')
   }
-)
+})

src/cardano/cardanoTypes.ts

@@ -20,12 +20,6 @@ export interface CardanoNetworkInfo {
   maestroServer: string
 }
 
-export const asCardanoInfoPayload = asObject({
-  koiosServer: asOptional(asString),
-  blockfrostServer: asOptional(asString),
-  maestroServer: asOptional(asString)
-})
-
 export type SafeCardanoWalletInfo = ReturnType<typeof asSafeCardanoWalletInfo>
 export const asSafeCardanoWalletInfo = asWalletInfo(
   asObject({
@@ -266,3 +260,14 @@ export const asCardanoInitOptions = asObject({
   maestroApiKey: asOptional(asString)
 })
 export type CardanoInitOptions = ReturnType<typeof asCardanoInitOptions>
+
+//
+// Info Payload
+//
+
+export const asCardanoInfoPayload = asObject({
+  koiosServer: asOptional(asString),
+  blockfrostServer: asOptional(asString),
+  maestroServer: asOptional(asString)
+})
+export type CardanoInfoPayload = ReturnType<typeof asCardanoInfoPayload>