fix: updated readme

README.md

@@ -2,6 +2,12 @@
 
 This script allows to stake DOT via the Fireblocks system using the RAW signing API feature.
 
+## :warning: Breaking Change in 2.0.0 :warning:
+Version 2.0.0 introduces a breaking change; as per [this forum post](https://forum.polkadot.network/t/staking-controller-deprecation-plan-staking-ui-leads-comms/2748) on Polkadot - the controller is being deprecated.<br>
+As a result the following breaking changes were introduced:
+* The function `setController` will no longer work and will results in an error
+* The function `bond` no longer accepts 4 arguments, instead only 3 arguments - `vaultAccountId: string, amount?: number, rewardDestination?: string` (the `controller` argument was removed)
+
 ## Getting started
 
 1. Clone this repo locally

package.json

@@ -1,15 +1,16 @@
 {
   "name": "dot_staking",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "FB DOT Staking",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "postinstall": "echo \"!!!Breaking Change Introduced!!!\nPlease see README.md\""
   },
   "author": "",
   "license": "ISC",
   "dependencies": {
-    "@polkadot/api": "^10.2.1",
+    "@polkadot/api": "^10.9.1",
     "fireblocks-sdk": ">=1.7.1",
     "fs": "0.0.1-security",
     "path": "^0.12.7",

src/dot-staker.ts

@@ -195,7 +195,7 @@ export class DOTStaker {
      * @param controllerAddress - new controller address
      */
     public async setController(vaultAccountId: string, controllerAddress: string){
-        throw new Error("setController is no longer supported in DOT / KSM / WND, for more information: https://forum.polkadot.network/t/staking-controller-deprecation-plan-staking-ui-leads-comms/2748")
+        throw new Error("setController is no longer supported in DOT / KSM / WND, for more information see README.md")
     }