diff --git a/CHANGELOG.md b/CHANGELOG.md index 2ec0c32..aedfd02 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -62,4 +62,9 @@ ### 1.4.4 (2023-06-23) -- update sign transaction to accept private key in case of imported wallet, null by default \ No newline at end of file +- update sign transaction to accept private key in case of imported wallet, null by default + + +### 1.4.5 (2023-07-05) + +- Adding badges for Readme.md \ No newline at end of file diff --git a/README.md b/README.md index ee5a026..6e6efed 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,24 @@ -# Vault Eth Controller +# Vault-eth-Controller -## Install +[![npm version](https://badge.fury.io/js/@getsafle%2Fvault-eth-controller.svg)](https://badge.fury.io/js/@getsafle%2Fvault-eth-controller) Static Badge [![Discussions][discussions-badge]][discussions-link] + Static Badge + +A Module written in javascript for managing various keyrings of Ethereum accounts, encrypting them, and using them. + +- [Installation](#installation) +- [Initialize the Eth Controller class](#initialize-the-eth-controller-class) +- [Methods](#methods) + - [Generate Keyring with 1 account and encrypt](#generate-keyring-with-1-account-and-encrypt) + - [Restore a keyring with the first account using a mnemonic](#restore-a-keyring-with-the-first-account-using-a-mnemonic) + - [Add a new account to the keyring object](#add-a-new-account-to-the-keyring-object) + - [Export the private key of an address present in the keyring](#export-the-private-key-of-an-address-present-in-the-keyring) + - [Sign a transaction](#sign-a-transaction) + - [Sign a message](#sign-a-message) + - [Get balance](#get-balance) + + + +## Installation `npm install --save @getsafle/vault-eth-controller` @@ -90,3 +108,5 @@ const receipt = await ethController.sendTransaction(signedTx, web3); ``` const fees = await ethController.getFees(rawTx, web3); ``` +[discussions-badge]: https://img.shields.io/badge/Code_Quality-passing-rgba +[discussions-link]: https://github.com/getsafle/vault-eth-controller/actions diff --git a/package-lock.json b/package-lock.json index 88b15f2..33577e6 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "@getsafle/vault-eth-controller", - "version": "1.4.4", + "version": "1.4.5", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index 997cc51..3f89281 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@getsafle/vault-eth-controller", - "version": "1.4.4", + "version": "1.4.5", "description": "Ethereum controller for safle vault.", "main": "src/index.js", "scripts": {