mirror of
https://github.com/Xahau/xahau.js.git
synced 2025-11-27 15:45:48 +00:00
docs: finalizes documentation for xrpl.js (#1703)
docs: Adds JSDoc comments to all functions and interfaces
This commit is contained in:
@@ -1,53 +1,63 @@
|
||||
// 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'
|
||||
// )
|
||||
/*
|
||||
* 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'
|
||||
// }
|
||||
// }
|
||||
// }
|
||||
/*
|
||||
* 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'
|
||||
/*
|
||||
* 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)
|
||||
// })
|
||||
/*
|
||||
* 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()
|
||||
// }
|
||||
/*
|
||||
* client.disconnect()
|
||||
* }
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user