From f2033613ce99b3583cba455911c91eed55a2166b Mon Sep 17 00:00:00 2001 From: gagdiez Date: Tue, 19 Mar 2024 13:29:17 +0100 Subject: [PATCH] chore: update changelog & readme --- CHANGELOG.md | 6 ++++++ README.md | 24 +++++++++++++++++++----- 2 files changed, 25 insertions(+), 5 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 381ffce6..ab396e7f 100644 --- a/CHANGELOG.md +++ b/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. diff --git a/README.md b/README.md index 68b9797c..fd853e03 100644 --- a/README.md +++ b/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= +export NEAR_TESTNET_RPC=https://rpc.testnet.near.org ``` ---