xahau.js/packages/xrpl/test/wallet/signer.test.ts

import { assert } from 'chai'
import { decode, encode } from 'ripple-binary-codec'

import { Transaction, ValidationError } from '../../src'
import { Wallet } from '../../src/Wallet'
import { multisign, verifySignature } from '../../src/Wallet/signer'

const publicKey =
  '030E58CDD076E798C84755590AAF6237CA8FAE821070A59F648B517A30DC6F589D'
const privateKey =
  '00141BA006D3363D2FB2785E8DF4E44D3A49908780CB4FB51F6D217C08C021429F'
const address = 'rhvh5SrgBL5V8oeV9EpDuVszeJSSCEkbPc'
const verifyWallet = new Wallet(publicKey, privateKey)

const tx: Transaction = {
  TransactionType: 'Payment',
  Account: address,
  Destination: 'rQ3PTWGLCbPz8ZCicV5tCX3xuymojTng5r',
  Amount: '20000000',
  Sequence: 1,
  Fee: '12',
  SigningPubKey: publicKey,
}

describe('Signer', function () {
  let multisignTxToCombine1
  let multisignTxToCombine2
  let multisignJSON
  let expectedMultisign

  beforeEach(function () {
    multisignTxToCombine1 = {
      Account: 'rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC',
      Fee: '30000',
      Flags: 262144,
      LimitAmount: {
        currency: 'USD',
        issuer: 'rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh',
        value: '100',
      },
      Sequence: 2,
      Signers: [
        {
          Signer: {
            Account: 'rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW',
            SigningPubKey:
              '02B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF',
            TxnSignature:
              '30450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E5',
          },
        },
      ],
      SigningPubKey: '',
      TransactionType: 'TrustSet',
    } as Transaction

    multisignTxToCombine2 = {
      Account: 'rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC',
      Fee: '30000',
      Flags: 262144,
      LimitAmount: {
        currency: 'USD',
        issuer: 'rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh',
        value: '100',
      },
      Sequence: 2,
      Signers: [
        {
          Signer: {
            Account: 'rJvuSQhQR37czfxRou4vNWaM97uEhT4ShE',
            SigningPubKey:
              '02B78EEA571B2633180834CC6E7B4ED84FBF6811D12ECB59410E0C92D13B7726F5',
            TxnSignature:
              '304502210098009CEFA61EE9843BB7FC29B78CFFAACF28352A4A7CF3AAE79EF12D79BA50910220684F116266E5E4519A7A33F7421631EB8494082BE51A8B03FECCB3E59F77154A',
          },
        },
      ],
      SigningPubKey: '',
      TransactionType: 'TrustSet',
    } as Transaction

    multisignJSON = {
      Account: 'rEuLyBCvcw4CFmzv8RepSiAoNgF8tTGJQC',
      Fee: '30000',
      Flags: 262144,
      LimitAmount: {
        currency: 'USD',
        issuer: 'rHb9CJAWyB4rj91VRWn96DkukG4bwdtyTh',
        value: '100',
      },
      Sequence: 2,
      Signers: [
        {
          Signer: {
            Account: 'rsA2LpzuawewSBQXkiju3YQTMzW13pAAdW',
            SigningPubKey:
              '02B3EC4E5DD96029A647CFA20DA07FE1F85296505552CCAC114087E66B46BD77DF',
            TxnSignature:
              '30450221009C195DBBF7967E223D8626CA19CF02073667F2B22E206727BFE848FF42BEAC8A022048C323B0BED19A988BDBEFA974B6DE8AA9DCAE250AA82BBD1221787032A864E5',
          },
        },
        {
          Signer: {
            Account: 'rJvuSQhQR37czfxRou4vNWaM97uEhT4ShE',
            SigningPubKey:
              '02B78EEA571B2633180834CC6E7B4ED84FBF6811D12ECB59410E0C92D13B7726F5',
            TxnSignature:
              '304502210098009CEFA61EE9843BB7FC29B78CFFAACF28352A4A7CF3AAE79EF12D79BA50910220684F116266E5E4519A7A33F7421631EB8494082BE51A8B03FECCB3E59F77154A',
          },
        },
      ],
      SigningPubKey: '',
      TransactionType: 'TrustSet',
    }
    expectedMultisign = encode(multisignJSON)
  })

  it('multisign runs successfully with Transaction objects', function () {
    const transactions = [multisignTxToCombine1, multisignTxToCombine2]

    assert.deepEqual(multisign(transactions), expectedMultisign)
  })

  it('multisign runs successfully with X-address', function () {
    multisignTxToCombine1.Account =
      'XVJfK5FpouB7gtk3kaZHqbgV4Bswir4ccz3rsJw9oMf71tc'
    multisignTxToCombine2.Account =
      'XVJfK5FpouB7gtk3kaZHqbgV4Bswir4ccz3rsJw9oMf71tc'

    const transactions = [multisignTxToCombine1, multisignTxToCombine2]

    assert.deepEqual(multisign(transactions), expectedMultisign)
  })

  it('multisign runs successfully with tx_blobs', function () {
    const transactions = [multisignTxToCombine1, multisignTxToCombine2]

    const encodedTransactions: string[] = transactions.map((transaction) =>
      encode(transaction),
    )

    assert.deepEqual(multisign(encodedTransactions), expectedMultisign)
  })

  it('multisign throws a validation error when there are no transactions', function () {
    const transactions = []
    assert.throws(() => multisign(transactions), ValidationError)
  })

  it('multisign throws when trying to combine two different transactions', function () {
    const differentMultisignedTx: Transaction = {
      TransactionType: 'Payment',
      Sequence: 1,
      Amount: '20000000',
      Fee: '12',
      SigningPubKey: '',
      Account: 'rhvh5SrgBL5V8oeV9EpDuVszeJSSCEkbPc',
      Destination: 'rQ3PTWGLCbPz8ZCicV5tCX3xuymojTng5r',
      Signers: [
        {
          Signer: {
            SigningPubKey:
              '02A8A44DB3D4C73EEEE11DFE54D2029103B776AA8A8D293A91D645977C9DF5F544',
            TxnSignature:
              '3044022077BCE143B9A0B51A7716BB93CBC0C99FB41BA339D91A87CB9E47DA80A7EF660802205C81AA49D408771F65A131200CCBFC536ACFE212C1414E05E43B56BE1F9380F2',
            Account: 'rHLEki8gPUMnF72JnuALvnAMRhRemzhRke',
          },
        },
      ],
    }

    const transactions = [multisignTxToCombine1, differentMultisignedTx]

    assert.throws(() => multisign(transactions))
  })

  it('multisign throws when trying to combine transaction with normal signature', function () {
    const signedTxBlob =
      '120000228000000024013A0F74201B013A0FC36140000000014FB18068400000000000000C732102A8A44DB3D4C73EEEE11DFE54D2029103B776AA8A8D293A91D645977C9DF5F544744730450221009ECB5324717E14DD6970126271F05BC2626D2A8FA9F3797555D417F8257C1E6002206BDD74A0F30425F2BA9DB69C90F21B3E27735C190FB4F3A640F066ACBBF06AD98114B3263BD0A9BF9DFDBBBBD07F536355FF477BF0E98314F667B0CA50CC7709A220B0561B85E53A48461FA8'

    const transactions = [signedTxBlob]

    assert.throws(() => multisign(transactions), /forMultisign/u)
  })

  it('verifySignature succeeds for valid signed transaction blob', function () {
    const signedTx = verifyWallet.sign(tx)

    assert.isTrue(verifySignature(signedTx.tx_blob))
  })

  it('verifySignature succeeds for valid signed transaction object', function () {
    const signedTx = verifyWallet.sign(tx)

    assert.isTrue(
      verifySignature(decode(signedTx.tx_blob) as unknown as Transaction),
    )
  })

  it('verifySignature returns false for invalid signing key', function () {
    const signedTx = verifyWallet.sign(tx)

    const decodedTx = decode(signedTx.tx_blob) as unknown as Transaction

    // Use a different key for validation
    decodedTx.SigningPubKey =
      '0330E7FC9D56BB25D6893BA3F317AE5BCF33B3291BD63DB32654A313222F7FD020'

    assert.isFalse(verifySignature(decodedTx))
  })

  it('verifySignature throws for a missing public key', function () {
    const signedTx = verifyWallet.sign(tx)

    const decodedTx = decode(signedTx.tx_blob) as unknown as Transaction

    // Use a different key for validation
    delete decodedTx.SigningPubKey

    assert.throws(() => {
      verifySignature(decodedTx)
    }, `Transaction is missing a public key, SigningPubKey`)
  })
})