Merge pull request #10 from getsafle/feature-get-balance

Feature get balance
getsafle · Feb 18, 2022 · 9550f43 · 9550f43
2 parents a2a9ff2 + c5d2433
commit 9550f43
Show file tree

Hide file tree

Showing 5 changed files with 23 additions and 6 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,3 +21,9 @@
 ##### Implement import wallet functionality
 
 - Added importWallet() to import account using privateKey.
+
+### 1.1.0 (2022-02-16)
+
+##### Implement get balance functionality
+
+- Added getBalance() to fetch the balance in native currency.
diff --git a/README.md b/README.md
@@ -7,9 +7,9 @@
 ## Initialize the Eth Controller class
 
 ```
-const controller = require('@getsafle/vault-eth-controller');
+const { KeyringController, getBalance } = require('@getsafle/vault-eth-controller');
 
-const ethController = new controller({
+const ethController = new KeyringController({
   encryptor: {
     // An optional object for defining encryption schemes:
     // Defaults to Browser-native SubtleCrypto.
@@ -64,5 +64,11 @@ const signedMsg = await ethController.signMessage(msgParams);
 ### Sign Typed Data (EIP-712)
 
 ```
-const signedData = await ethController.signTypedMessage (msgParams);
+const signedData = await ethController.signTypedMessage(msgParams);
+```
+
+### Get balance
+
+```
+const balance = await getBalance(address, web3);
 ```
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "@getsafle/vault-eth-controller",
-  "version": "1.0.2",
+  "version": "1.1.0",
   "description": "Ethereum controller for safle vault.",
   "main": "src/index.js",
   "scripts": {

diff --git a/src/index.js b/src/index.js
@@ -510,4 +510,9 @@ class KeyringController extends EventEmitter {
   }
 }
 
-module.exports = KeyringController
+const getBalance = async (address, web3) => {
+  const balance = await web3.eth.getBalance(address);
+  return { balance: web3.utils.fromWei(balance, 'ether') }
+}
+
+module.exports = { KeyringController, getBalance }