From 02f81ee20353b41ad69ac7007052d40b3a47543a Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Sat, 19 Mar 2022 06:58:49 -0700 Subject: [PATCH 1/2] fix(transactoin): Adding API documentation --- src/transaction.js | 21 ++++++++++++++++++++- 1 file changed, 20 insertions(+), 1 deletion(-) diff --git a/src/transaction.js b/src/transaction.js index 228a190..b9917d1 100644 --- a/src/transaction.js +++ b/src/transaction.js @@ -20,7 +20,26 @@ class Transaction { this.psfSlpIndexer = new PsfSlpIndexer(config) } - // Proxy the call to the psf-slp-indexer. + /** + * @api Transaction.get() get() + * @apiName get + * @apiGroup Transaction + * @apiDescription + * Returns an object of transaction data, including addresses for input UTXOs. + * If it is a SLP token transaction, the token information for inputs and + * outputs will also be included. + * + * + * @apiExample Example usage: + * (async () => { + * try { + * let txData = await bchjs.Transaction.get("0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098"); + * console.log(txData); + * } catch(error) { + * console.error(error) + * } + * })() + */ async get (txid) { return await this.psfSlpIndexer.tx(txid) } From dcadad189b1475d75745b29a846e825819dc65ad Mon Sep 17 00:00:00 2001 From: Chris Troutner Date: Sat, 19 Mar 2022 07:00:27 -0700 Subject: [PATCH 2/2] fix(getTokenInfo): Adding API documentation --- src/transaction.js | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) diff --git a/src/transaction.js b/src/transaction.js index b9917d1..e2a7a59 100644 --- a/src/transaction.js +++ b/src/transaction.js @@ -44,6 +44,26 @@ class Transaction { return await this.psfSlpIndexer.tx(txid) } + /** + * @api Transaction.getTokenInfo() getTokenInfo() + * @apiName getTokenInfo + * @apiGroup Transaction + * @apiDescription + * Given the TXID of a token transaction, it will return data about that + * token by retrieving the data from the Genesis transaction and docoding + * the OP_RETURN. + * + * + * @apiExample Example usage: + * (async () => { + * try { + * let txData = await bchjs.Transaction.getTokenInfo("0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098"); + * console.log(txData); + * } catch(error) { + * console.error(error) + * } + * })() + */ // A wrapper for decodeOpReturn(). Returns false if txid is not an SLP tx. // Returns the token data if the txid is an SLP tx. async getTokenInfo (txid) {