test: integration tests for CheckCreate, CheckCancel, CheckCash (#1664)

* test checkCreate

* test CheckCancel

* test CheckCash

* add browser tests

test/integration/index.ts

@@ -4,6 +4,11 @@ export * from './transactions/payment'
 export * from './transactions/offerCreate'
 export * from './transactions/offerCancel'
 export * from './transactions/signerListSet'
+export * from './transactions/checkCancel'
+export * from './transactions/checkCash'
+export * from './transactions/checkCreate'
+export * from './transactions/depositPreauth'
+
 export * from './requests/accountChannels'
 export * from './requests/accountCurrencies'
 export * from './requests/accountInfo'

test/integration/transactions/checkCancel.ts

@@ -0,0 +1,65 @@
+import { assert } from 'chai'
+import _ from 'lodash'
+
+import { CheckCreate, CheckCancel } from 'xrpl-local'
+
+import serverUrl from '../serverUrl'
+import { setupClient, suiteClientSetup, teardownClient } from '../setup'
+import { generateFundedWallet, testTransaction } from '../utils'
+
+// how long before each test case times out
+const TIMEOUT = 20000
+
+describe('CheckCancel', function () {
+  this.timeout(TIMEOUT)
+
+  before(suiteClientSetup)
+  beforeEach(_.partial(setupClient, serverUrl))
+  afterEach(teardownClient)
+
+  it('base', async function () {
+    const wallet2 = await generateFundedWallet(this.client)
+    const setupTx: CheckCreate = {
+      TransactionType: 'CheckCreate',
+      Account: this.wallet.getClassicAddress(),
+      Destination: wallet2.getClassicAddress(),
+      SendMax: '50',
+    }
+
+    await testTransaction(this.client, setupTx, this.wallet)
+
+    // get check ID
+    const response1 = await this.client.request({
+      command: 'account_objects',
+      account: this.wallet.getClassicAddress(),
+      type: 'check',
+    })
+    assert.lengthOf(
+      response1.result.account_objects,
+      1,
+      'Should be exactly one check on the ledger',
+    )
+    const checkId = response1.result.account_objects[0].index
+
+    // actual test - cancel the check
+    const tx: CheckCancel = {
+      TransactionType: 'CheckCancel',
+      Account: this.wallet.getClassicAddress(),
+      CheckID: checkId,
+    }
+
+    await testTransaction(this.client, tx, this.wallet)
+
+    // confirm that the check no longer exists
+    const accountOffersResponse = await this.client.request({
+      command: 'account_objects',
+      account: this.wallet.getClassicAddress(),
+      type: 'check',
+    })
+    assert.lengthOf(
+      accountOffersResponse.result.account_objects,
+      0,
+      'Should be no checks on the ledger',
+    )
+  })
+})

test/integration/transactions/checkCash.ts

@@ -0,0 +1,68 @@
+import { assert } from 'chai'
+import _ from 'lodash'
+
+import { CheckCreate, CheckCash } from 'xrpl-local'
+
+import serverUrl from '../serverUrl'
+import { setupClient, suiteClientSetup, teardownClient } from '../setup'
+import { generateFundedWallet, testTransaction } from '../utils'
+
+// how long before each test case times out
+const TIMEOUT = 20000
+
+describe('CheckCash', function () {
+  this.timeout(TIMEOUT)
+
+  before(suiteClientSetup)
+  beforeEach(_.partial(setupClient, serverUrl))
+  afterEach(teardownClient)
+
+  it('base', async function () {
+    const wallet2 = await generateFundedWallet(this.client)
+    const amount = '500'
+
+    const setupTx: CheckCreate = {
+      TransactionType: 'CheckCreate',
+      Account: this.wallet.getClassicAddress(),
+      Destination: wallet2.getClassicAddress(),
+      SendMax: amount,
+    }
+
+    await testTransaction(this.client, setupTx, this.wallet)
+
+    // get check ID
+    const response1 = await this.client.request({
+      command: 'account_objects',
+      account: this.wallet.getClassicAddress(),
+      type: 'check',
+    })
+    assert.lengthOf(
+      response1.result.account_objects,
+      1,
+      'Should be exactly one check on the ledger',
+    )
+    const checkId = response1.result.account_objects[0].index
+
+    // actual test - cash the check
+    const tx: CheckCash = {
+      TransactionType: 'CheckCash',
+      Account: wallet2.getClassicAddress(),
+      CheckID: checkId,
+      Amount: amount,
+    }
+
+    await testTransaction(this.client, tx, wallet2)
+
+    // confirm that the check no longer exists
+    const accountOffersResponse = await this.client.request({
+      command: 'account_objects',
+      account: this.wallet.getClassicAddress(),
+      type: 'check',
+    })
+    assert.lengthOf(
+      accountOffersResponse.result.account_objects,
+      0,
+      'Should be no checks on the ledger',
+    )
+  })
+})

test/integration/transactions/checkCreate.ts

@@ -0,0 +1,43 @@
+import { assert } from 'chai'
+import _ from 'lodash'
+
+import { CheckCreate } from 'xrpl-local'
+
+import serverUrl from '../serverUrl'
+import { setupClient, suiteClientSetup, teardownClient } from '../setup'
+import { generateFundedWallet, testTransaction } from '../utils'
+
+// how long before each test case times out
+const TIMEOUT = 20000
+
+describe('CheckCreate', function () {
+  this.timeout(TIMEOUT)
+
+  before(suiteClientSetup)
+  beforeEach(_.partial(setupClient, serverUrl))
+  afterEach(teardownClient)
+
+  it('base', async function () {
+    const wallet2 = await generateFundedWallet(this.client)
+    const tx: CheckCreate = {
+      TransactionType: 'CheckCreate',
+      Account: this.wallet.getClassicAddress(),
+      Destination: wallet2.getClassicAddress(),
+      SendMax: '50',
+    }
+
+    await testTransaction(this.client, tx, this.wallet)
+
+    // confirm that the check actually went through
+    const accountOffersResponse = await this.client.request({
+      command: 'account_objects',
+      account: this.wallet.getClassicAddress(),
+      type: 'check',
+    })
+    assert.lengthOf(
+      accountOffersResponse.result.account_objects,
+      1,
+      'Should be exactly one check on the ledger',
+    )
+  })
+})

test/integration/utils.ts

@@ -84,7 +84,11 @@ export async function testTransaction(
   // check that the transaction was successful
   assert.equal(response.status, 'success')
   assert.equal(response.type, 'response')
-  assert.equal(response.result.engine_result, 'tesSUCCESS')
+  assert.equal(
+    response.result.engine_result,
+    'tesSUCCESS',
+    response.result.engine_result_message,
+  )
 
   // check that the transaction is on the ledger
   const signedTx = _.omit(response.result.tx_json, 'hash')