chore(release): Regenerate docs

Author: nduchak

README.md

@@ -2,7 +2,7 @@
 [![npm](https://img.shields.io/npm/v/@aeternity/aepp-sdk.svg)](https://www.npmjs.com/package/@aeternity/aepp-cli)
 [![npm](https://img.shields.io/npm/l/@aeternity/aepp-sdk.svg)](https://www.npmjs.com/package/@aeternity/aepp-cli)
 
-# ️⚠️ [WIP] aepp-cli-js
+# aepp-cli-js
 Command Line Interface for the æternity blockchain.
 
 ## Disclaimer
@@ -16,8 +16,6 @@ check out the [develop branch].
 
 
 ## Installation
-> ️⚠️ **TODO**: The package is not yet published, so you can only install it by cloning this project.
->
 You can install this `CLI` using your preferred tool (`yarn` or `npm`). Here's an `npm` example
 ```
 npm install --global @aeternity/aepp-cli

docs/bin/aecli-account.md

@@ -322,6 +322,31 @@ program
   .action(async (walletPath, ...arguments) => await Account.getAccountNonce(walletPath, utils.cli.getCmdFromArguments(arguments)))
 
 
+```
+
+
+
+
+
+
+
+## Initialize `generateKeyPairs` command
+
+You can use this command to generate KeyPair's.
+
+Example: `aecli account generate 10 --force
+
+
+  
+
+```js
+program
+  .command('generate <count>')
+  .option('--forcePrompt', 'Force prompting')
+  .description('Generate keyPairs')
+  .action(async (count, ...arguments) => await Account.generateKeyPairs(count, utils.cli.getCmdFromArguments(arguments)))
+
+
 
 ```
 

docs/bin/aecli-contract.md

@@ -106,6 +106,7 @@ Example: `aecli contract compile ./mycontract.contract`
 ```js
 program
   .command('compile <file>')
+  .option('--backend [backend]', 'Compiler backend("fate" | "aevm")', utils.constant.COMPILER_BACKEND)
   .description('Compile a contract')
   .action(async (file, ...arguments) => await Contract.compile(file, utils.cli.getCmdFromArguments(arguments)))
 
@@ -131,6 +132,7 @@ Example: `aecli contract encodeData ./mycontract.contract testFn 1 2`
 ```js
 program
   .command('encodeData <source> <fn> [args...]')
+  .option('--backend [backend]', 'Compiler backend("fate" | "aevm")', utils.constant.COMPILER_BACKEND)
   .description('Encode contract call data')
   .action(async (source, fn, args, ...arguments) => await Contract.encodeData(source, fn, args, utils.cli.getCmdFromArguments(arguments)))
 
@@ -156,6 +158,7 @@ Example: `aecli contract decodeData cb_asdasdasdasdasdas int`
 ```js
 program
   .command('decodeData <data> <returnType>')
+  .option('--backend [backend]', 'Compiler backend("fate" | "aevm")', utils.constant.COMPILER_BACKEND)
   .description('Decode contract data')
   .action(async (data, returnType, ...arguments) => await Contract.decodeData(data, returnType, utils.cli.getCmdFromArguments(arguments)))
 
@@ -185,6 +188,7 @@ program
   .option('--sourcePath [sourcePath]', 'Path to contract source')
   .option('--code [code]', 'Compiler contract code')
   .option('--fn [fn]', 'Function name')
+  .option('--backend [backend]', 'Compiler backend("fate" | "aevm")', utils.constant.COMPILER_BACKEND)
   .description('Decode contract call data')
   .action(async (data, ...arguments) => await Contract.decodeCallData(data, utils.cli.getCmdFromArguments(arguments)))
 

docs/bin/aecli-tx.md

@@ -202,6 +202,7 @@ program
   .command('name-claim <accountId> <salt> <domain> <nonce>')
   .option('-T, --ttl [ttl]', 'Validity of the transaction in number of blocks (default forever)', utils.constant.TX_TTL)
   .option('-F, --fee [fee]', 'Transaction fee.')
+  .option('--nameFee [nameFee]', 'Name fee.', utils.constant.NAME_FEE)
   .description('Build name claim transaction.')
   .action(async (accountId, salt, domain, nonce, ...arguments) => await Transaction.nameClaim(accountId, salt, domain, nonce, utils.cli.getCmdFromArguments(arguments)))
 
@@ -285,6 +286,7 @@ program
   .option('--deposit [deposit]', 'Deposit', 0)
   .option('-G --gas [gas]', 'Amount of gas to deploy the contract', utils.constant.GAS)
   .option('--vmVersion [vmVersion]', 'VM version', utils.constant.VM_VERSION)
+  .option('--abiVersion [abiVersion]', 'ABI version', utils.constant.DEFAULT_CONTRACT_PARAMS.abiVersion)
   .description('Build contract create transaction.')
   .action(async (ownerId, contractBytecode, initCallData, nonce, ...arguments) => await Transaction.contractDeploy(ownerId, contractBytecode, initCallData, nonce, utils.cli.getCmdFromArguments(arguments)))
 
@@ -312,6 +314,8 @@ program
   .option('-T, --ttl [ttl]', 'Validity of the transaction in number of blocks (default forever)', utils.constant.TX_TTL)
   .option('-F, --fee [fee]', 'Transaction fee.')
   .option('-G --gas [gas]', 'Amount of gas to deploy the contract', utils.constant.GAS)
+  .option('--abiVersion [abiVersion]', 'VM version', utils.constant.DEFAULT_CONTRACT_PARAMS.abiVersion)
+  .option('--vmVersion [vmVersion]', 'ABI version', utils.constant.VM_VERSION)
   .description('Build contract create transaction.')
   .action(async (callerId, contractId, callData, nonce, ...arguments) => await Transaction.contractCall(callerId, contractId, callData, nonce, utils.cli.getCmdFromArguments(arguments)))
 

docs/bin/commands/account.md

@@ -42,6 +42,7 @@ This script initialize all `account` function
  *  PERFORMANCE OF THIS SOFTWARE.
  */
 
+import { generateKeyPair } from '@aeternity/aepp-sdk/es/utils/crypto'
 import { generateSecureWallet, generateSecureWalletFromPrivKey } from '../utils/account'
 import { HASH_TYPES } from '../utils/constant'
 import { initClientByWalletFile } from '../utils/cli'
@@ -67,7 +68,7 @@ this function allow you to `sign` transaction's
 
 ```js
 async function sign (walletPath, tx, options) {
-  let { json } = options
+  const { json } = options
   try {
 
 ```
@@ -113,6 +114,7 @@ Get `keyPair` by `walletPath`, decrypt using password and initialize `Account` f
         printUnderscored('Unsigned', tx)
         printUnderscored('Signed', signedTx)
       }
+      process.exit(0)
     })
   } catch (e) {
     printError(e.message)
@@ -184,6 +186,7 @@ if waitMined false
       json
         ? print({ tx })
         : printTransaction(tx, json)
+      process.exit(0)
     })
   } catch (e) {
     printError(e.message)
@@ -258,6 +261,7 @@ if waitMined false
       } else {
         printTransaction(tx, json)
       }
+      process.exit(0)
     })
   } catch (e) {
     printError(e.message)
@@ -305,6 +309,7 @@ Get `keyPair` by `walletPath`, decrypt using password and initialize `Ae` client
         printUnderscored('Balance', await client.balance(keypair.publicKey, { height: +height, hash }))
         printUnderscored('ID', await client.address())
         printUnderscored('Nonce', nonce)
+        process.exit(0)
       }
     )
   } catch (e) {
@@ -329,7 +334,7 @@ This function allow you retrieve account `public` and `private` keys
 
 ```js
 async function getAddress (walletPath, options) {
-  const { privateKey, forcePrompt = false } = options
+  const { privateKey, forcePrompt = false, json } = options
   try {
 
 ```
@@ -350,12 +355,24 @@ Get `keyPair` by `walletPath`, decrypt using password and initialize `Ae` client
 
     await handleApiError(
       async () => {
-        printUnderscored('Address', await client.address())
-        if (privateKey) {
-          if (forcePrompt || await prompt(PROMPT_TYPE.confirm, { message: 'Are you sure you want print your secret key?' })) {
-            printUnderscored('Secret Key', keypair.secretKey)
+        if (json) {
+          if (privateKey) {
+            if (forcePrompt || await prompt(PROMPT_TYPE.confirm, { message: 'Are you sure you want print your secret key?' })) {
+              printUnderscored('Secret Key', keypair.secretKey)
+              print({ publicKey: await client.address(), secretKey: keypair.secretKey })
+            }
+          } else {
+            print({ publicKey: await client.address() })
+          }
+        } else {
+          printUnderscored('Address', await client.address())
+          if (privateKey) {
+            if (forcePrompt || await prompt(PROMPT_TYPE.confirm, { message: 'Are you sure you want print your secret key?' })) {
+              printUnderscored('Secret Key', keypair.secretKey)
+            }
           }
         }
+        process.exit(0)
       }
     )
   } catch (e) {
@@ -380,6 +397,7 @@ This function allow you retrieve account `nonce`
 
 ```js
 async function getAccountNonce (walletPath, options) {
+  const { json } = options
   try {
 
 ```
@@ -401,9 +419,18 @@ Get `keyPair` by `walletPath`, decrypt using password and initialize `Ae` client
     await handleApiError(
       async () => {
         const nonce = await client.getAccountNonce(keypair.publicKey)
-        printUnderscored('ID', keypair.publicKey)
-        printUnderscored('Nonce', nonce - 1)
-        printUnderscored('Next Nonce', nonce)
+        if (json) {
+          print({
+            id: keypair.publicKey,
+            nonce: nonce - 1,
+            nextNonce: nonce
+          })
+        } else {
+          printUnderscored('ID', keypair.publicKey)
+          printUnderscored('Nonce', nonce - 1)
+          printUnderscored('Next Nonce', nonce)
+        }
+        process.exit(0)
       }
     )
   } catch (e) {
@@ -427,9 +454,52 @@ This function allow you to generate `keypair` and write it to secure `ethereum`
 
 
 ```js
-async function createSecureWallet (walletPath, { output, password, overwrite }) {
+async function createSecureWallet (walletPath, { output, password, overwrite, json }) {
+  try {
+    const { publicKey, path } = await generateSecureWallet(walletPath, { output, password, overwrite })
+    if (json) {
+      print({
+        publicKey,
+        path
+      })
+    } else {
+      printUnderscored('Address', publicKey)
+      printUnderscored('Path', path)
+    }
+    process.exit(0)
+  } catch (e) {
+    printError(e.message)
+  }
+}
+
+
+```
+
+
+
+
+
+
+
+## Create secure `wallet` file from `private-key`
+This function allow you to generate `keypair` from `private-key` and write it to secure `ethereum` like key-file
+
+
+  
+
+```js
+async function createSecureWalletByPrivKey (walletPath, priv, { output, password, overwrite, json }) {
   try {
-    await generateSecureWallet(walletPath, { output, password, overwrite })
+    const { publicKey, path } = await generateSecureWalletFromPrivKey(walletPath, priv, { output, password, overwrite })
+    if (json) {
+      print({
+        publicKey,
+        path
+      })
+    } else {
+      printUnderscored('Address', publicKey)
+      printUnderscored('Path', path)
+    }
     process.exit(0)
   } catch (e) {
     printError(e.message)
@@ -452,12 +522,30 @@ This function allow you to generate `keypair` from `private-key` and write it to
 
 
 ```js
-async function createSecureWalletByPrivKey (walletPath, priv, { output, password, overwrite }) {
+async function generateKeyPairs (count = 1, { forcePrompt, json }) {
   try {
-    await generateSecureWalletFromPrivKey(walletPath, priv, { output, password, overwrite })
+    if (!Number.isInteger(+count)) {
+      throw new Error('Count must be an Number')
+    }
+    if (forcePrompt || await prompt(PROMPT_TYPE.confirm, { message: 'Are you sure you want print your secret key?' })) {
+      const accounts = Array.from(Array(parseInt(count))).map(_ => generateKeyPair(false))
+      if (json) {
+        print(JSON.stringify(accounts, null, 2))
+      } else {
+        accounts.forEach((acc, i) => {
+          printUnderscored('Account index', i)
+          printUnderscored('Public Key', acc.publicKey)
+          printUnderscored('Secret Key', acc.secretKey)
+          print('')
+        })
+      }
+    } else {
+      process.exit(0)
+    }
     process.exit(0)
   } catch (e) {
     printError(e.message)
+    process.exit(1)
   }
 }
 
@@ -469,7 +557,8 @@ export const Account = {
   createSecureWallet,
   createSecureWalletByPrivKey,
   sign,
-  transferFunds
+  transferFunds,
+  generateKeyPairs
 }
 
 

docs/bin/commands/aens.md

@@ -194,6 +194,7 @@ Update `name` pointer
 
       print(`Name ${domain} claimed`)
       printUnderscored('Transaction hash', hash)
+      process.exit(0)
     })
   } catch (e) {
     printError(e.message)
@@ -298,6 +299,7 @@ Create `transferName` transaction
       const transferTX = await client.aensTransfer(name.id, address, { ttl, nameTtl, nonce })
       print('Transfer Success')
       printUnderscored('Transaction hash', transferTX.hash)
+      process.exit(0)
     })
   } catch (e) {
     printError(e.message)
@@ -403,6 +405,7 @@ Create `updateName` transaction
       const updateNameTx = await client.aensUpdate(name.id, address, { ttl, nameTtl, nonce })
       print('Update Success')
       printUnderscored('Transaction Hash', updateNameTx.hash)
+      process.exit(0)
     })
   } catch (e) {
     printError(e.message)
@@ -502,6 +505,7 @@ Create `revokeName` transaction
       const revokeTx = await client.aensRevoke(name.id, { ttl, nonce })
       print('Revoke Success')
       printUnderscored('Transaction hash', revokeTx.hash)
+      process.exit(0)
     })
   } catch (e) {
     printError(e.message)
@@ -550,6 +554,7 @@ Check if `name` is unavailable and we can revoke it
         await updateNameStatus(domain)(client),
         json
       )
+      process.exit(0)
     })
   } catch (e) {
     printError(e.message)