feat(rawtx): add decodeRawTransaction function

docs/node/CATEGORIES/04-rawtx.md

@@ -43,6 +43,41 @@ interface CreateRawTxOut {
 }
 ```
 
+## decodeRawTransaction
+
+Return a JSON object representing the serialized, hex-encoded transaction.
+If iswitness is not present, heuristic tests will be used in decoding.
+If true, only witness deserialization will be tried.
+If false, only non-witness deserialization will be tried.
+This boolean should reflect whether the transaction has inputs
+(e.g. fully valid, or on-chain transactions), if known by the caller.
+
+```ts title="client.rawtx.decodeRawTransaction()"
+interface rawtx {
+  decodeRawTransaction (
+    hexstring: string,
+    iswitness: boolean
+  ): Promise<RawTransaction>
+}
+
+interface RawTransaction {
+  in_active_chain?: boolean
+  txid: string
+  hash: string
+  version: number
+  size: number
+  vsize: number
+  weight: number
+  locktime: number
+  vin: Vin[]
+  vout: Vout[]
+  hex: string
+  blockhash: string
+  confirmations: number
+  time: number
+  blocktime: number
+}
+```
 
 ## signRawTransactionWithKey
 

packages/jellyfish-api-core/__tests__/category/rawtx/decodeRawTransaction.test.ts

@@ -0,0 +1,69 @@
+import { MasterNodeRegTestContainer } from '@defichain/testcontainers/dist/index'
+import { ContainerAdapterClient } from '../../container_adapter_client'
+import { RpcApiError } from '../../../src'
+
+describe('poolpair update', () => {
+  const container = new MasterNodeRegTestContainer()
+  const client = new ContainerAdapterClient(container)
+
+  beforeAll(async () => {
+    await container.start()
+    await container.waitForWalletCoinbaseMaturity()
+  })
+
+  afterAll(async () => {
+    await container.stop()
+  })
+
+  it('should decode a witness transaction', async () => {
+    const encrawtx = '010000000001010000000000000072c1a6a246ae63f74f931e8365e15a089c68d61900000000000000000000ffffffff0100e1f50500000000000102616100000000'
+    const decrawtx = await client.rawtx.decodeRawTransaction(encrawtx, true)
+
+    expect(decrawtx.txid).toStrictEqual('d006b4ece5d4adbd6f46b3a6f65f4a230caf6c44d8510e4340d0f26b7ceeb44a')
+    expect(decrawtx.hash).toStrictEqual('23f0c1f68f0a43bb434494933a5a0f6f9636261f33b036b7700d96e264aceeda')
+    expect(decrawtx.version).toStrictEqual(1)
+    expect(decrawtx.size).toStrictEqual(66)
+    expect(decrawtx.vsize).toStrictEqual(62)
+    expect(decrawtx.weight).toStrictEqual(246)
+    expect(decrawtx.locktime).toStrictEqual(0)
+    expect(decrawtx.vin[0].txid).toStrictEqual('000000000019d6689c085ae165831e934ff763ae46a2a6c17200000000000000')
+    expect(decrawtx.vin[0].vout).toStrictEqual(0)
+    expect(decrawtx.vin[0].scriptSig.asm).toStrictEqual('')
+    expect(decrawtx.vin[0].scriptSig.hex).toStrictEqual('')
+    expect(decrawtx.vin[0].txinwitness).toStrictEqual(['6161'])
+    expect(decrawtx.vin[0].sequence).toStrictEqual(4294967295)
+    expect(decrawtx.vout[0].value).toStrictEqual(1)
+    expect(decrawtx.vout[0].n).toStrictEqual(0)
+    expect(decrawtx.vout[0].scriptPubKey.asm).toStrictEqual('')
+    expect(decrawtx.vout[0].scriptPubKey.hex).toStrictEqual('')
+    expect(decrawtx.vout[0].scriptPubKey.type).toStrictEqual('nonstandard')
+  })
+
+  it('should throw an error when for decode as non-witness a witness transaction', async () => {
+    const encrawtx = '010000000001010000000000000072c1a6a246ae63f74f931e8365e15a089c68d61900000000000000000000ffffffff0100e1f50500000000000102616100000000'
+    await expect(client.rawtx.decodeRawTransaction(encrawtx, false)).rejects.toThrow(RpcApiError)
+  })
+
+  it('should decode a non-witness transaction', async () => {
+    const encrawtx = '01000000010000000000000072c1a6a246ae63f74f931e8365e15a089c68d61900000000000000000000ffffffff0100e1f505000000000000000000'
+    const decrawtx = await client.rawtx.decodeRawTransaction(encrawtx, true)
+
+    expect(decrawtx.txid).toStrictEqual('d006b4ece5d4adbd6f46b3a6f65f4a230caf6c44d8510e4340d0f26b7ceeb44a')
+    expect(decrawtx.hash).toStrictEqual('d006b4ece5d4adbd6f46b3a6f65f4a230caf6c44d8510e4340d0f26b7ceeb44a')
+    expect(decrawtx.version).toStrictEqual(1)
+    expect(decrawtx.size).toStrictEqual(60)
+    expect(decrawtx.vsize).toStrictEqual(60)
+    expect(decrawtx.weight).toStrictEqual(240)
+    expect(decrawtx.locktime).toStrictEqual(0)
+    expect(decrawtx.vin[0].txid).toStrictEqual('000000000019d6689c085ae165831e934ff763ae46a2a6c17200000000000000')
+    expect(decrawtx.vin[0].vout).toStrictEqual(0)
+    expect(decrawtx.vin[0].scriptSig.asm).toStrictEqual('')
+    expect(decrawtx.vin[0].scriptSig.hex).toStrictEqual('')
+    expect(decrawtx.vin[0].sequence).toStrictEqual(4294967295)
+    expect(decrawtx.vout[0].value).toStrictEqual(1)
+    expect(decrawtx.vout[0].n).toStrictEqual(0)
+    expect(decrawtx.vout[0].scriptPubKey.asm).toStrictEqual('')
+    expect(decrawtx.vout[0].scriptPubKey.hex).toStrictEqual('')
+    expect(decrawtx.vout[0].scriptPubKey.type).toStrictEqual('nonstandard')
+  })
+})

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

@@ -44,6 +44,24 @@ export class RawTx {
     ], 'number')
   }
 
+  /**
+   * Return a JSON object representing the serialized, hex-encoded transaction.
+   * If iswitness is not present, heuristic tests will be used in decoding.
+   * If true, only witness deserialization will be tried.
+   * If false, only non-witness deserialization will be tried.
+   * This boolean should reflect whether the transaction has inputs
+   * (e.g. fully valid, or on-chain transactions), if known by the caller.
+   *
+   * @param {string} hexstring The transaction hex string
+   * @param {boolean} iswitness Whether the transaction hex is a serialized witness transaction.
+   */
+  async decodeRawTransaction (
+    hexstring: string,
+    iswitness: boolean
+  ): Promise<RawTransaction> {
+    return await this.client.call('decoderawtransaction', [hexstring, iswitness], 'number')
+  }
+
   /**
    * Sign inputs for raw transaction (serialized, hex-encoded), providing an array of base58-encoded private keys that
    * will be the keys used to sign the transaction. An optional array of previous transaction outputs that this