refactor: add verify() function (#1552)

* refactor: add verify() function

test/models/payment.ts

@@ -3,9 +3,10 @@ import { assert } from 'chai'
 import { ValidationError } from 'xrpl-local/common/errors'
 
 import {
-  PaymentTransactionFlags,
   verifyPayment,
-} from '../../src/models/transactions/payment'
+  verify,
+  PaymentTransactionFlags,
+} from '../../src/models/transactions'
 
 /**
  * PaymentTransaction Verification Testing.
@@ -22,15 +23,26 @@ describe('Payment', function () {
       Amount: '1234',
       Destination: 'rfkE1aSy9G8Upk4JssnwBxhEv5p4mn2KTy',
       DestinationTag: 1,
+      Fee: '12',
+      Flags: 2147483648,
+      LastLedgerSequence: 65953073,
+      Sequence: 65923914,
+      SigningPubKey:
+        '02F9E33F16DF9507705EC954E3F94EB5F10D1FC4A354606DBE6297DBB1096FE654',
+      TxnSignature:
+        '3045022100E3FAE0EDEC3D6A8FF6D81BC9CF8288A61B7EEDE8071E90FF9314CB4621058D10022043545CF631706D700CEE65A1DB83EFDD185413808292D9D90F14D87D3DC2D8CB',
       InvoiceID:
         '6F1DFD1D0FE8A32E40E1F2C05CF1C15545BAB56B617F9C6C2D63A6B704BEF59B',
-      Paths: [[{ currency: 'BTC', issuer: 'apsoeijf90wp34fh' }]],
+      Paths: [
+        [{ currency: 'BTC', issuer: 'r9vbV3EHvXWjSkeQ6CAcYVPGeq7TuiXY2X' }],
+      ],
       SendMax: '100000000',
     } as any
   })
 
   it(`verifies valid PaymentTransaction`, function () {
     assert.doesNotThrow(() => verifyPayment(paymentTransaction))
+    assert.doesNotThrow(() => verify(paymentTransaction))
   })
 
   it(`throws when Amount is missing`, function () {
@@ -40,6 +52,11 @@ describe('Payment', function () {
       ValidationError,
       'PaymentTransaction: missing field Amount',
     )
+    assert.throws(
+      () => verify(paymentTransaction),
+      ValidationError,
+      'PaymentTransaction: missing field Amount',
+    )
   })
 
   it(`throws when Amount is invalid`, function () {
@@ -49,6 +66,11 @@ describe('Payment', function () {
       ValidationError,
       'PaymentTransaction: invalid Amount',
     )
+    assert.throws(
+      () => verify(paymentTransaction),
+      ValidationError,
+      'PaymentTransaction: invalid Amount',
+    )
   })
 
   it(`throws when Destination is missing`, function () {
@@ -58,6 +80,11 @@ describe('Payment', function () {
       ValidationError,
       'PaymentTransaction: missing field Destination',
     )
+    assert.throws(
+      () => verify(paymentTransaction),
+      ValidationError,
+      'PaymentTransaction: missing field Destination',
+    )
   })
 
   it(`throws when Destination is invalid`, function () {
@@ -67,6 +94,11 @@ describe('Payment', function () {
       ValidationError,
       'PaymentTransaction: invalid Destination',
     )
+    assert.throws(
+      () => verify(paymentTransaction),
+      ValidationError,
+      'PaymentTransaction: invalid Destination',
+    )
   })
 
   it(`throws when DestinationTag is not a number`, function () {
@@ -76,6 +108,11 @@ describe('Payment', function () {
       ValidationError,
       'PaymentTransaction: DestinationTag must be a number',
     )
+    assert.throws(
+      () => verify(paymentTransaction),
+      ValidationError,
+      'PaymentTransaction: DestinationTag must be a number',
+    )
   })
 
   it(`throws when InvoiceID is not a string`, function () {
@@ -85,6 +122,11 @@ describe('Payment', function () {
       ValidationError,
       'PaymentTransaction: InvoiceID must be a string',
     )
+    assert.throws(
+      () => verify(paymentTransaction),
+      ValidationError,
+      'PaymentTransaction: InvoiceID must be a string',
+    )
   })
 
   it(`throws when Paths is invalid`, function () {
@@ -94,6 +136,11 @@ describe('Payment', function () {
       ValidationError,
       'PaymentTransaction: invalid Paths',
     )
+    assert.throws(
+      () => verify(paymentTransaction),
+      ValidationError,
+      'PaymentTransaction: invalid Paths',
+    )
   })
 
   it(`throws when SendMax is invalid`, function () {
@@ -103,18 +150,25 @@ describe('Payment', function () {
       ValidationError,
       'PaymentTransaction: invalid SendMax',
     )
+    assert.throws(
+      () => verify(paymentTransaction),
+      ValidationError,
+      'PaymentTransaction: invalid SendMax',
+    )
   })
 
   it(`verifies valid DeliverMin with tfPartialPayment flag set as a number`, function () {
     paymentTransaction.DeliverMin = '10000'
     paymentTransaction.Flags = PaymentTransactionFlags.tfPartialPayment
     assert.doesNotThrow(() => verifyPayment(paymentTransaction))
+    assert.doesNotThrow(() => verify(paymentTransaction))
   })
 
   it(`verifies valid DeliverMin with tfPartialPayment flag set as a boolean`, function () {
     paymentTransaction.DeliverMin = '10000'
     paymentTransaction.Flags = { tfPartialPayment: true }
     assert.doesNotThrow(() => verifyPayment(paymentTransaction))
+    assert.doesNotThrow(() => verify(paymentTransaction))
   })
 
   it(`throws when DeliverMin is invalid`, function () {
@@ -125,6 +179,11 @@ describe('Payment', function () {
       ValidationError,
       'PaymentTransaction: invalid DeliverMin',
     )
+    assert.throws(
+      () => verify(paymentTransaction),
+      ValidationError,
+      'PaymentTransaction: invalid DeliverMin',
+    )
   })
 
   it(`throws when tfPartialPayment flag is missing with valid DeliverMin`, function () {
@@ -134,5 +193,10 @@ describe('Payment', function () {
       ValidationError,
       'PaymentTransaction: tfPartialPayment flag required with DeliverMin',
     )
+    assert.throws(
+      () => verify(paymentTransaction),
+      ValidationError,
+      'PaymentTransaction: tfPartialPayment flag required with DeliverMin',
+    )
   })
 })