Merge pull request #1111 from near/ledger-path-msg

fix: added message for Ledger users

Author: gagdiez

CHANGELOG.md

@@ -3,6 +3,12 @@
 ## [unreleased]
 - ...
 
+## `4.0.12` [03-19-2024]
+- New: Added back Ledger support, please notice that the `--useLedger` does not set the path anymore, use `--ledgerPath` for this.
+- New: Added back all `validator` commands.
+- New: Added `add-credentials` command to add credentials to the `near-cli` config file.
+- Fixes: Multitude of small fixes, see each release note for more details.
+
 ## `4.0.0` [01-23-2024]
 - Reorganized code to simplify its maintenance.
 - New: Fixed `create-account` can now create `TLA`, `sub-accounts` and `.testnet/.near` accounts.

README.md

@@ -1,14 +1,26 @@
 # NEAR CLI (command line interface)
 
-[![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/near/near-cli)
-
 NEAR CLI is a Node.js application that relies on [`near-api-js`](https://github.com/near/near-api-js) to connect to and interact with the NEAR blockchain. Create accounts, access keys, sign & send transactions with this versatile command line interface tool.
 
 **Note:** Node.js version 16+ is required to run NEAR CLI.
 
+## 🚨 v4.0.0 Notes
+This release is a major reorganization of the codebase to simplify its maintenance. It also includes a few new features and a multitude of small fixes.
+
+The most notable changes are:
+- **Ledger users**, please notice that the `--useLedger` does not set the path anymore, use `--ledgerPath` for this
+  - Please check the commands that support Ledger for more details
+- Users can now import credentials using the `add-credentials` command
+- The `generate-key` command now has a `--saveImplicit` option to save the key as an implicit account
+- Users can create `testnet` pre-funded accounts using the `--useFaucet` option 
+- Accounts cannot create `TLA` with less than 32 characters anymore (this is a NEAR protocol change)
+- Removed unnecessary options from commands, e.g. `view` now does not take an `--accountId` or `--masterAccount`
+- If a command does not work, please first check the commands help to see if the options have changed
+  - For example, run `near create-account` to see how options might have changed
+
 ## Release notes
 
-**Release notes and unreleased changes can be found in the [CHANGELOG](CHANGELOG.md)**
+Release notes and unreleased changes can be found in the [CHANGELOG](CHANGELOG.md)
 
 ## Overview
 
@@ -37,7 +49,6 @@ _Click on a command for more information and examples._
 | **TRANSACTIONS**                                |                                                                                           |
 | [`near tx-status`](#near-tx-status)             | queries a transaction's status by `txHash`                                                |
 
-
 ---
 
 ## Setup
@@ -111,6 +122,9 @@ export NEAR_NETWORK=mainnet
 near send-near ... --networkId mainnet
 ```
 
+> [!WARNING]
+> In previous versions, `near-cli` used `NEAR_ENV` to set the network. This can still be used, but `NEAR_NETWORK` has priority over `NEAR_ENV` if both are set.
+
 ---
 
 ### Custom RPC server selection
@@ -123,7 +137,7 @@ Clear them in case you want to get back to the default RPC server.
 
 Example:
 ```bash
-export NEAR_TESTNET_RPC=<put_your_rpc_server_url_here>
+export NEAR_TESTNET_RPC=https://rpc.testnet.near.org
 ```
 ---
 

bin/near-cli.js

@@ -5,8 +5,9 @@ yargs // eslint-disable-line
     .strict()
     .scriptName('near')
     .middleware(require('../utils/check-version'))
-    .middleware(require('../middleware/print-options'))
     .middleware(require('../middleware/key-store'))
+    .middleware(require('../middleware/retro-ledger'))
+    .middleware(require('../middleware/print-options'))
     .command(require('../commands/credentials/add'))
     .command(require('../commands/keys/add'))
     .command(require('../commands/contract/call'))

middleware/retro-ledger.js

@@ -0,0 +1,16 @@
+// In v3.5.0 the argument `useLedgerKey` was a string, in v4.0.0 this was change to a boolean
+// Sadly, yargs assumes that --useLedgerKey='anything' is FALSE
+// Here we detect if an argument is `useLedgerKey=` and guide the user to the correct format
+
+module.exports = async function ledgerOptions() {
+    let path = '';
+
+    process.argv.forEach(arg => {
+        path = arg.includes('--useLedgerKey=') ? arg.split('=')[1] : path;
+    });
+
+    if (path != '') { 
+        console.log(`\nPlease use --useLedgerKey --ledgerPath="${path}" instead of --useLedgerKey="${path}"\n`);
+        process.exit(0);
+    }
+};

package.json

@@ -1,6 +1,6 @@
 {
   "name": "near-cli",
-  "version": "4.0.11",
+  "version": "4.0.13",
   "description": "Simple CLI for interacting with NEAR Protocol",
   "engines": {
     "node": ">= 16"

utils/connect.js

@@ -1,10 +1,12 @@
 const { connect: nearConnect } = require('near-api-js');
 const { getConfig } = require('../config');
 const { getPublicKeyForPath, signForPath } = require('./ledger');
+const chalk = require('chalk');
 
 module.exports = async function connect({ keyStore, ...options }) {
     // If using Ledger, override the signer so that it uses the Ledger device
     if (options.signWithLedger) { 
+        console.log(chalk`\nUsing Ledger with path {blue ${options.ledgerPath}}, change path with {blue --ledgerPath}\n`);
         options.signer = {
             getPublicKey: () => getPublicKeyForPath(options.ledgerPath),
             signMessage: (m) => signForPath(m, options.ledgerPath)

utils/ledger.js

@@ -18,10 +18,12 @@ async function getPublicKeyForPath(hdKeyPath) {
     // cache keys to avoid confirming on Ledger multiple times
     if (cachedPublicKeys[hdKeyPath]) return cachedPublicKeys[hdKeyPath];
 
+    console.log('Trying to connect with Ledger...');
+
     transport = await TransportNodeHid.create();
     client = await createClient(transport);
 
-    console.log('Getting Public Key from Ledger...');
+    console.log('Getting public key from Ledger...');
 
     try {
         const rawPublicKey = await client.getPublicKey(hdKeyPath);