refactor: update snippets to be compatible with xrpl.js

.eslintrc.js

@@ -27,6 +27,7 @@ module.exports = {
 
   plugins: [],
   extends: ['@xrplf/eslint-config/base', 'plugin:mocha/recommended'],
+  ignorePatterns: ['snippets/src/*.ts'],
   rules: {
     // Certain rippled APIs require snake_case naming
     '@typescript-eslint/naming-convention': [
@@ -61,18 +62,6 @@ module.exports = {
         '@typescript-eslint/no-magic-numbers': 'off',
       },
     },
-    {
-      files: ['snippets/src/*.ts'],
-      rules: {
-        'import/unambiguous': 'off',
-        'import/no-unused-modules': 'off',
-        // Each file has a particular flow.
-        'max-lines-per-function': 'off',
-        'max-statements': 'off',
-        // Snippets have logs on console to better understand the working.
-        'no-console': 'off',
-      },
-    },
     {
       files: ['test/**/*.ts'],
       rules: {

snippets/src/getTransaction.ts

@@ -1,26 +1,41 @@
-/*
- * import {Client} from '../../dist/npm'
- * import {TransactionMetadata} from 'xrpl-local/models/common/transaction'
- */
+import {
+  Client,
+  LedgerResponse,
+  TxResponse,
+  TransactionMetadata,
+} from '../../dist/npm'
 
-// const client = new Client('wss://s.altnet.rippletest.net:51233')
+const client = new Client('wss://s.altnet.rippletest.net:51233')
 
-// getTransaction()
+async function getTransaction(): Promise<void> {
+  await client.connect()
+  const ledger: LedgerResponse = await client.request({
+    command: 'ledger',
+    transactions: true,
+    ledger_index: 'validated',
+  })
+  console.log(ledger)
 
-/*
- * async function getTransaction() {
- *   await client.connect()
- *   const ledger = await client.request({command: 'ledger', transactions: true})
- *   console.log(ledger)
- *   const tx = await client.request({
- *     command: 'tx',
- *     transaction: ledger.result.ledger.transactions[0] as string
- *   })
- *   console.log(tx)
- *   console.log(
- *     'deliveredAmount:',
- *     (tx.result.meta as TransactionMetadata).DeliveredAmount
- *   )
- *   process.exit(0)
- * }
- */
+  const transactions = ledger.result.ledger.transactions
+  if (transactions) {
+    const tx: TxResponse = await client.request({
+      command: 'tx',
+      transaction: transactions[0],
+    })
+    console.log(tx)
+
+    /*
+     * delivered_amount is the amount actually received by the destination account.
+     * Use this field to determine how much was delivered, regardless of whether the transaction is a partial payment.
+     * https://xrpl.org/transaction-metadata.html#delivered_amount
+     */
+    console.log(
+      'delivered_amount:',
+      (tx.result.meta as TransactionMetadata).delivered_amount,
+    )
+  }
+
+  await client.disconnect()
+}
+
+void getTransaction()

snippets/src/paths.ts

@@ -1,63 +1,49 @@
-// import {Client} from '../../dist/npm'
-
-/*
- * const client = new Client(
- *   // 'wss://s.altnet.rippletest.net:51233'
- *   // 'ws://35.158.96.209:51233'
- *   'ws://34.210.87.206:51233'
- * )
- */
-
-// sign()
-
-/*
- * async function sign() {
- *   await client.connect()
- *   const pathfind: any = {
- *     source: {
- *       address: 'r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59',
- *       amount: {
- *         currency: 'drops',
- *         value: '100'
- *       }
- *     },
- *     destination: {
- *       address: 'rKT4JX4cCof6LcDYRz8o3rGRu7qxzZ2Zwj',
- *       amount: {
- *         currency: 'USD',
- *         counterparty: 'rVnYNK9yuxBz4uP8zC8LEFokM2nqH3poc'
- *       }
- *     }
- *   }
- */
-
-/*
- *   await client
- *     .getPaths(pathfind)
- *     .then(async (data) => {
- *       console.log('paths:', JSON.stringify(data))
- *       const fakeSecret = 'shsWGZcmZz6YsWWmcnpfr6fLTdtFV'
- */
-
-/*
- *       pathfind.paths = data[0].paths
- *       pathfind.destination = data[0].destination
- *       await client
- *         .preparePayment('r9cZA1mLK5R5Am25ArfXFmqgNwjZgnfk59', pathfind)
- *         .then((ret) => {
- *           const signed = client.sign(ret.txJSON, fakeSecret)
- *           console.log('signed:', signed)
- *         })
- *         .catch((err) => {
- *           console.log('ERR 1:', JSON.stringify(err))
- *         })
- *     })
- *     .catch((err) => {
- *       console.log('ERR 2:', err)
- *     })
- */
-
-/*
- *   client.disconnect()
- * }
- */
+import { Client, Payment, RipplePathFindResponse } from '../../dist/npm'
+
+const client = new Client('wss://s.altnet.rippletest.net:51233')
+
+async function createTxWithPaths(): Promise<void> {
+  await client.connect()
+
+  const { wallet } = await client.fundWallet()
+  const destination_account = 'rKT4JX4cCof6LcDYRz8o3rGRu7qxzZ2Zwj'
+  const destination_amount = {
+    value: '0.001',
+    currency: 'USD',
+    issuer: 'rVnYNK9yuxBz4uP8zC8LEFokM2nqH3poc',
+  }
+
+  const request = {
+    command: 'ripple_path_find',
+    source_account: wallet.classicAddress,
+    source_currencies: [
+      {
+        currency: 'XRP',
+      },
+    ],
+    destination_account,
+    destination_amount,
+  }
+
+  const resp: RipplePathFindResponse = await client.request(request)
+  console.log(resp)
+
+  const paths = resp.result.alternatives[0].paths_computed
+  console.log(paths)
+
+  const tx: Payment = {
+    TransactionType: 'Payment',
+    Account: wallet.classicAddress,
+    Amount: destination_amount,
+    Destination: destination_account,
+    Paths: paths,
+  }
+
+  await client.autofill(tx)
+  const signed = wallet.sign(tx)
+  console.log('signed:', signed)
+
+  await client.disconnect()
+}
+
+void createTxWithPaths()

src/models/ledger/Ledger.ts

@@ -1,5 +1,4 @@
-import { Transaction } from '../transactions'
-import { TransactionMetadata } from '../transactions/metadata'
+import { Transaction, TransactionMetadata } from '../transactions'
 
 import LedgerEntry from './LedgerEntry'
 

src/models/methods/accountTx.ts

@@ -1,6 +1,5 @@
 import { LedgerIndex } from '../common'
-import { Transaction } from '../transactions'
-import { TransactionMetadata } from '../transactions/metadata'
+import { Transaction, TransactionMetadata } from '../transactions'
 
 import { BaseRequest, BaseResponse } from './baseMethod'
 

src/models/methods/transactionEntry.ts

@@ -1,6 +1,5 @@
 import { LedgerIndex } from '../common'
-import { Transaction } from '../transactions'
-import { TransactionMetadata } from '../transactions/metadata'
+import { Transaction, TransactionMetadata } from '../transactions'
 
 import { BaseRequest, BaseResponse } from './baseMethod'
 

src/models/methods/tx.ts

@@ -1,5 +1,4 @@
-import { Transaction } from '../transactions'
-import { TransactionMetadata } from '../transactions/metadata'
+import { Transaction, TransactionMetadata } from '../transactions'
 
 import { BaseRequest, BaseResponse } from './baseMethod'
 

src/models/transactions/index.ts

@@ -1,4 +1,5 @@
 export { validate, TransactionAndMetadata, Transaction } from './transaction'
+export { TransactionMetadata } from './metadata'
 export {
   AccountSetAsfFlags,
   AccountSetTfFlags,

src/utils/hashes/hashLedger.ts

@@ -9,8 +9,7 @@ import { decode, encode } from 'ripple-binary-codec'
 import { ValidationError, XrplError } from '../../errors'
 import type { Ledger } from '../../models/ledger'
 import { LedgerEntry } from '../../models/ledger'
-import { Transaction } from '../../models/transactions'
-import { TransactionMetadata } from '../../models/transactions/metadata'
+import { Transaction, TransactionMetadata } from '../../models/transactions'
 
 import HashPrefix from './HashPrefix'
 import sha512Half from './sha512Half'