improve docs and custom address

luaswap · May 27, 2020 · cf4841f · cf4841f
1 parent 27d0ddb
commit cf4841f
Show file tree

Hide file tree

Showing 7 changed files with 178 additions and 50 deletions.
diff --git a/README.md b/README.md
@@ -9,10 +9,10 @@ npm install --save bridgejs
 
 ```javascript
 const BridgeJS = require('bridgejs')
-const bridgejs = await BridgeJS.setProvider('https://bridge.tomochain.com')
+const bridgejs = await BridgeJS.setProvider()
 
 // get network information
-let info = await BridgeJS.networkInformation('https://bridge.tomochain.com')
+let info = await BridgeJS.networkInformation()
 console.log(info)
 
 // wait for new deposit
@@ -24,6 +24,8 @@ bridgejs.wrapWatch({ tokenSymbol }).then((ev) => {
 })
 ```
 
+Read more [BridgeJS Document](https://tomochain.github.io/bridgejs/BridgeJS.html)
+
 Or you can use `bridge-cli` binary:
 ```
 cd /tmp && wget https://github.com/tomochain/bridgejs/releases/download/[VERSION]/bridge-cli.[VERSION].linux-x64 -O bridge-cli

diff --git a/bridge-cli b/bridge-cli
@@ -77,7 +77,7 @@ function run() {
                 type : 'input',
                 name : 'endpoint',
                 message : 'Enter TomoBridge endpoint...',
-                default: 'https://bridge.devnet.tomochain.com'
+                default: 'https://bridge.tomochain.com'
             }]
             if (!params.keystore) {
                 questions.push({
@@ -196,12 +196,14 @@ function run() {
     commander
         .command('get-wrap-txs')
         .description('get wrap transactions')
-        .requiredOption('-p --page <page>', 'page number')
-        .requiredOption('-l --limit <limit>', 'limit number')
+        .option('-p --page <page>', 'page number')
+        .option('-l --limit <limit>', 'limit number')
+        .option('-a --address <address>', 'user address')
         .action(async (params) => {
             await bridgejs.getWrapTransactions({
-                page: params.page,
-                limit: params.limit
+                page: params.page || 1,
+                limit: params.limit || 10,
+                userAddress: params.address
             })
             .then(data => {
                 console.log(data)
@@ -211,12 +213,14 @@ function run() {
     commander
         .command('get-unwrap-txs')
         .description('get unwrap transactions')
-        .requiredOption('-p --page <page>', 'page number')
-        .requiredOption('-l --limit <limit>', 'limit number')
+        .option('-p --page <page>', 'page number')
+        .option('-l --limit <limit>', 'limit number')
+        .option('-a --address <address>', 'user address')
         .action(async (params) => {
             await bridgejs.getUnwrapTransactions({
-                page: params.page,
-                limit: params.limit
+                page: params.page || 1,
+                limit: params.limit || 10,
+                userAddress: params.address
             })
             .then(data => {
                 console.log(data)

diff --git a/bridge.js b/bridge.js
@@ -59,8 +59,8 @@ class BridgeJS {
 
     /**
 	 * Initial the SDK
-	 * @param {string} endpoint - The Url to the node
-	 * @param {string} pkey - The private key of the coinbase
+	 * @param {string} [endpoint=https://bridge.tomochain.com] - The Url to the node
+	 * @param {string} [pkey=random] - The private key of the coinbase
 	 */
     static setProvider(endpoint = 'https://bridge.tomochain.com', pkey = '') {
         return BridgeJS.networkInformation(endpoint).then((config) => {
@@ -149,13 +149,14 @@ class BridgeJS {
      * Get latest deposit transaction
      * @param {Object} wrap The wrap information
      * @param {string} wrap.tokenSymbol - The token symbol
+     * @param {string} wrap.userAddress - The user address
      * 
      * @returns {Object} Transaction object(inner and outter networks)
      */
-    async getDepositTransaction ({ tokenSymbol }) {
+    async getDepositTransaction ({ tokenSymbol, userAddress = this.coinbase }) {
         return new Promise((resolve, reject) => {
             try {
-                let url = urljoin(this.endpoint, 'api/wrap/getTransaction/deposit/', tokenSymbol, this.coinbase)
+                let url = urljoin(this.endpoint, 'api/wrap/getTransaction/deposit/', tokenSymbol, userAddress)
                 let options = {
                     method: 'GET',
                     url: url,
@@ -183,16 +184,17 @@ class BridgeJS {
     }
 
     /**
-     * Get latest withdraw transction
+     * Get latest withdraw transaction
      * @param {Object} unwrap The unwrap information
      * @param {String} unwrap.tokenSymbol Token symbol
+     * @param {string} wrap.userAddress - The user address
      * 
      * @returns {Object} Transaction object(inner and outter networks)
      */
-    async getWithdrawTransaction ({ tokenSymbol }) {
+    async getWithdrawTransaction ({ tokenSymbol, userAddress = this.coinbase }) {
         return new Promise((resolve, reject) => {
             try {
-                let url = urljoin(this.endpoint, 'api/wrap/getTransaction/withdraw/', tokenSymbol, this.coinbase)
+                let url = urljoin(this.endpoint, 'api/wrap/getTransaction/withdraw/', tokenSymbol, userAddress)
                 let options = {
                     method: 'GET',
                     url: url,
@@ -308,15 +310,16 @@ class BridgeJS {
      * @param {Object} object Input object
      * @param {Number} object.limit Limit number of records per page
      * @param {Number} object.page Page number
+     * @param {string} wrap.userAddress - The user address
      * 
      * @returns {Object} Transaction object(inner and outter networks)
      */
-    async getWrapTransactions ({ limit, page }) {
+    async getWrapTransactions ({ limit, page, userAddress = this.coinbase }) {
         return new Promise((resolve, reject) => {
             try {
                 let url = urljoin(
                     this.endpoint, 'api/transactions/getWrapTxs/',
-                    `?address=${this.coinbase}`,
+                    `?address=${userAddress}`,
                     `&page=${page}`,
                     `&limit=${limit}`
                 )
@@ -352,15 +355,16 @@ class BridgeJS {
      * @param {Object} object Input object
      * @param {Number} object.limit Limit number of records per page
      * @param {Number} object.page Page number
+     * @param {string} wrap.userAddress - The user address
      * 
      * @returns {Object} Transaction object(inner and outter networks)
      */
-    async getUnwrapTransactions ({ tokenSymbol, limit, page }) {
+    async getUnwrapTransactions ({ tokenSymbol, limit, page, userAddress = this.coinbase }) {
         return new Promise((resolve, reject) => {
             try {
                 let url = urljoin(
                     this.endpoint, 'api/transactions/getUnwrapTxs/',
-                    `?address=${this.coinbase}`,
+                    `?address=${userAddress}`,
                     `&page=${page}`,
                     `&limit=${limit}`
                 )
@@ -463,7 +467,6 @@ class BridgeJS {
                 txParams
             )
             let check = true, receipt
-            console.log('Verify tx...')
             await sleep(5000)
             while (check) {
                 receipt = await this.provider.getTransactionReceipt(result.hash || '')