Masternode RPC (createmasternode, listmasternodes, getmasternode)

packages/jellyfish-api-core/__tests__/category/masternode/createMasternode.test.ts

@@ -0,0 +1,64 @@
+import { MasterNodeRegTestContainer } from '@defichain/testcontainers'
+import { ContainerAdapterClient } from '../../container_adapter_client'
+import { MasternodeState } from '../../../src/category/masternode'
+
+describe('Masternode', () => {
+  const container = new MasterNodeRegTestContainer()
+  const client = new ContainerAdapterClient(container)
+
+  beforeAll(async () => {
+    await container.start()
+    await container.waitForReady()
+    await container.waitForWalletCoinbaseMaturity()
+  })
+
+  afterAll(async () => {
+    await container.stop()
+  })
+
+  it('should create a masternode transaction', async () => {
+    const masternodesBefore = await client.masternode.listMasternodes()
+    const masternodesLengthBefore = Object.keys(masternodesBefore).length
+
+    const address = await client.wallet.getNewAddress()
+    const masternode = await client.masternode.createMasternode(address)
+
+    await container.generate(1)
+
+    const masternodesAfter = await client.masternode.listMasternodes()
+    const masternodesLengthAfter = Object.keys(masternodesAfter).length
+
+    expect(masternodesLengthAfter).toStrictEqual(masternodesLengthBefore + 1)
+    expect(typeof masternode).toStrictEqual('string')
+
+    for (const masternode in masternodesAfter) {
+      const createdMasternode = masternodesAfter[masternode]
+      if (createdMasternode.ownerAuthAddress === address) {
+        expect(typeof createdMasternode.ownerAuthAddress).toStrictEqual('string')
+        expect(typeof createdMasternode.operatorAuthAddress).toStrictEqual('string')
+        expect(typeof createdMasternode.creationHeight).toStrictEqual('number')
+        expect(typeof createdMasternode.resignHeight).toStrictEqual('number')
+        expect(typeof createdMasternode.resignTx).toStrictEqual('string')
+        expect(typeof createdMasternode.banHeight).toStrictEqual('number')
+        expect(typeof createdMasternode.banTx).toStrictEqual('string')
+        expect(createdMasternode.state).toStrictEqual(MasternodeState.PRE_ENABLED)
+        expect(typeof createdMasternode.state).toStrictEqual('string')
+        expect(typeof createdMasternode.mintedBlocks).toStrictEqual('number')
+        expect(typeof createdMasternode.targetMultiplier).toStrictEqual('number')
+      }
+    }
+  })
+
+  it('should create masternode transaction with specified UTXOS to spend', async () => {
+    const utxos = await client.wallet.listUnspent()
+    const inputs = utxos.map((utxo: { txid: string, vout: number }) => ({ txid: utxo.txid, vout: utxo.vout }))
+    const masternodeTransaction = await client.masternode.createMasternode(await client.wallet.getNewAddress(), undefined, { inputs })
+
+    expect(typeof masternodeTransaction).toStrictEqual('string')
+  })
+
+  it('should throw an error with invalid owner address', async () => {
+    const invalidAddress = 'invalidAddress'
+    await expect(client.masternode.createMasternode(invalidAddress)).rejects.toThrow('operatorAddress (invalidAddress) does not refer to a P2PKH or P2WPKH address')
+  })
+})

packages/jellyfish-api-core/__tests__/category/masternode/getMasternode.test.ts

@@ -0,0 +1,58 @@
+import { MasterNodeRegTestContainer } from '@defichain/testcontainers'
+import { ContainerAdapterClient } from '../../container_adapter_client'
+import { MasternodeState } from '../../../src/category/masternode'
+
+describe('Masternode', () => {
+  const container = new MasterNodeRegTestContainer()
+  const client = new ContainerAdapterClient(container)
+
+  beforeAll(async () => {
+    await container.start()
+    await container.waitForReady()
+    await container.waitForWalletCoinbaseMaturity()
+  })
+
+  afterAll(async () => {
+    await container.stop()
+  })
+
+  it('should get a masternode', async () => {
+    let id: string = ''
+
+    const address = await client.wallet.getNewAddress()
+    await client.masternode.createMasternode(address)
+
+    await container.generate(1)
+
+    const masterNodes = await client.masternode.listMasternodes()
+    for (const mnId in masterNodes) {
+      if (masterNodes[mnId].ownerAuthAddress === address) {
+        id = mnId
+      }
+    }
+
+    const masternode = await client.masternode.getMasternode(id)
+
+    for (const masternodeKey in masternode) {
+      const data = masternode[masternodeKey]
+      expect(typeof data.operatorAuthAddress).toStrictEqual('string')
+      expect(typeof data.ownerAuthAddress).toStrictEqual('string')
+      expect(typeof data.creationHeight).toStrictEqual('number')
+      expect(typeof data.resignHeight).toStrictEqual('number')
+      expect(typeof data.resignTx).toStrictEqual('string')
+      expect(typeof data.banHeight).toStrictEqual('number')
+      expect(typeof data.banTx).toStrictEqual('string')
+      expect(data.state).toStrictEqual(MasternodeState.PRE_ENABLED)
+      expect(typeof data.state).toStrictEqual('string')
+      expect(typeof data.mintedBlocks).toStrictEqual('number')
+      expect(typeof data.targetMultiplier).toStrictEqual('number')
+    }
+  })
+
+  it('should fail and throw an error with invalid masternode id', async () => {
+    const invalidId = '8d4d987dee688e400a0cdc899386f243250d3656d802231755ab4d28178c9816'
+    const promise = client.masternode.getMasternode(invalidId)
+
+    await expect(promise).rejects.toThrow('Masternode not found')
+  })
+})

packages/jellyfish-api-core/__tests__/category/masternode/listMasternodes.test.ts

@@ -0,0 +1,51 @@
+import { MasterNodeRegTestContainer } from '@defichain/testcontainers'
+import { ContainerAdapterClient } from '../../container_adapter_client'
+import { MasternodePagination } from '../../../src/category/masternode'
+
+describe('Masternode', () => {
+  const container = new MasterNodeRegTestContainer()
+  const client = new ContainerAdapterClient(container)
+
+  beforeAll(async () => {
+    await container.start()
+    await container.waitForReady()
+    await container.waitForWalletCoinbaseMaturity()
+  })
+
+  afterAll(async () => {
+    await container.stop()
+  })
+
+  it('should list masternodes', async () => {
+    const masternodes = await client.masternode.listMasternodes()
+
+    for (const masternode in masternodes) {
+      const createdMasternode = masternodes[masternode]
+      expect(typeof createdMasternode.ownerAuthAddress).toStrictEqual('string')
+      expect(typeof createdMasternode.operatorAuthAddress).toStrictEqual('string')
+      expect(typeof createdMasternode.creationHeight).toStrictEqual('number')
+      expect(typeof createdMasternode.resignHeight).toStrictEqual('number')
+      expect(typeof createdMasternode.resignTx).toStrictEqual('string')
+      expect(typeof createdMasternode.banHeight).toStrictEqual('number')
+      expect(typeof createdMasternode.banTx).toStrictEqual('string')
+      expect(typeof createdMasternode.state).toStrictEqual('string')
+      expect(typeof createdMasternode.mintedBlocks).toStrictEqual('number')
+      expect(typeof createdMasternode.targetMultiplier).toStrictEqual('number')
+    }
+  })
+
+  it('should list masternodes with verbose set to false to get just the ids', async () => {
+    const masternodes = await client.masternode.listMasternodes({}, false)
+
+    for (const value of Object.values(masternodes)) {
+      expect(typeof value).toStrictEqual('string')
+    }
+  })
+
+  it('should list masternodes with limit. Limited to 3 and should return 3', async () => {
+    const options: MasternodePagination = { limit: 3 }
+    const masternodes = await client.masternode.listMasternodes(options)
+
+    expect(Object.keys(masternodes).length).toStrictEqual(3)
+  })
+})

packages/jellyfish-api-core/src/category/masternode.ts

@@ -0,0 +1,99 @@
+import { ApiClient } from '../.'
+
+export enum MasternodeState {
+  PRE_ENABLED = 'PRE_ENABLED',
+  ENABLED = 'ENABLED',
+  PRE_RESIGNED = 'PRE_RESIGNED',
+  RESIGNED = 'RESIGNED',
+  PRE_BANNED = 'PRE_BANNED',
+  BANNED = 'BANNED'
+}
+
+export class Masternode {
+  private readonly client: ApiClient
+
+  constructor (client: ApiClient) {
+    this.client = client
+  }
+
+  /**
+   * Creates a masternode creation transaction with given owner and operator addresses.
+   *
+   * @param {string} ownerAddress Any valid address for keeping collateral amount
+   * @param {string} operatorAddress  Masternode operator auth address (P2PKH only, unique). If empty, owner address will be used.
+   * @param {CreateMasternodeOptions} options
+   * @param {UTXO[]} [options.inputs = []]
+   * @param {string} [options.inputs.txid] The transaction id
+   * @param {string} [options.inputs.vout] The output number
+   * @return {Promise<string>}
+   */
+  async createMasternode (
+    ownerAddress: string,
+    operatorAddress?: string,
+    options: CreateMasternodeOptions = { inputs: [] }
+  ): Promise<string> {
+    operatorAddress = operatorAddress ?? ownerAddress
+    return await this.client.call('createmasternode', [ownerAddress, operatorAddress, options.inputs], 'number')
+  }
+
+  /**
+   * Returns information about multiple masternodes.
+   *
+   * @param {MasternodePagination} pagination
+   * @param {string} [pagination.start]
+   * @param {boolean} [pagination.including_star = true] Include starting position.
+   * @param {string} [pagination.limit = 10000] Maximum number of orders to return.
+   * @param {boolean} [verbose = true] Flag for verbose list. Only ids are returned when false.
+   */
+  async listMasternodes (
+    pagination: MasternodePagination = {
+      including_start: true,
+      limit: 10000
+    },
+    verbose: boolean = true
+  ): Promise<MasternodeResult> {
+    return await this.client.call('listmasternodes', [pagination, verbose], 'number')
+  }
+
+  /**
+   * Returns information about a single masternode
+   *
+   * @param {string} masternodeId The masternode's id.
+   * @return {Promise<MasternodeResult>}
+   */
+  async getMasternode (masternodeId: string): Promise<MasternodeResult> {
+    return await this.client.call('getmasternode', [masternodeId], 'number')
+  }
+}
+
+export interface UTXO {
+  txid?: string
+  vout?: number
+}
+
+export interface CreateMasternodeOptions {
+  inputs?: UTXO[]
+}
+
+export interface MasternodePagination {
+  start?: string
+  including_start?: boolean
+  limit?: number
+}
+
+export interface MasternodeInfo {
+  ownerAuthAddress: string
+  operatorAuthAddress: string
+  creationHeight: number
+  resignHeight: number
+  resignTx: string
+  banHeight: number
+  banTx: string
+  state: MasternodeState
+  mintedBlocks: number
+  targetMultiplier: number
+}
+
+export interface MasternodeResult {
+  [id: string]: MasternodeInfo
+}

packages/jellyfish-api-core/src/index.ts

@@ -9,6 +9,7 @@ import { PoolPair } from './category/poolpair'
 import { Token } from './category/token'
 import { Oracle } from './category/oracle'
 import { Server } from './category/server'
+import { Masternode } from './category/masternode'
 
 export * from '@defichain/jellyfish-json'
 
@@ -22,6 +23,7 @@ export * as token from './category/token'
 export * as account from './category/account'
 export * as oracle from './category/oracle'
 export * as server from './category/server'
+export * as masternode from './category/masternode'
 
 /**
  * A protocol agnostic DeFiChain node client, RPC calls are separated into their category.
@@ -37,6 +39,7 @@ export abstract class ApiClient {
   public readonly token = new Token(this)
   public readonly oracle = new Oracle(this)
   public readonly server = new Server(this)
+  public readonly masternode = new Masternode(this)
 
   /**
    * A promise based procedure call handling