[docs update] update docs

Author: mike-diamond

src/StakeWiseSDK.ts

@@ -38,6 +38,20 @@ class StakeWiseSDK {
     }
 
     const provider = options.provider || createProvider(options)
+    const originalGetSigner = provider.getSigner
+
+    provider.getSigner = async function (address?: string) {
+      const providerError = 'To send this transaction, please provide BrowserProvider to the StakeWiseSDK'
+
+      try {
+        const signer = await originalGetSigner.bind(this)(address)
+
+        return signer
+      }
+      catch (error) {
+        throw new Error(providerError)
+      }
+    }
 
     const contracts = createContracts({ provider, config })
 

website/setup/installation-setup.md

@@ -25,22 +25,37 @@ webpackConfig.module.rules.push(
 ```typescript
 import { StakeWiseSDK, Network } from '@stakewise/v3-sdk'
 
+// sdk without provider allows to call methods to get data such as `sdk.vault.getVault`,
+// but doesn't allow to send transactions such as `sdk.vault.deposit`
 const sdk = new StakeWiseSDK({
   network: Network.Mainnet,
   endpoints: {
     web3: 'https://mainnet.infura.io/v3/...',
   },
 })
 
+// sdk with provider allows to call methods to get data and send transactions
+const provider = new BrowserProvider(window.ethereum, {
+  name: 'mainnet',
+  chainId: Network.Mainnet,
+})
+
+const sdk = new StakeWiseSDK({
+  network: Network.Mainnet,
+  provider: new BrowserProvider(window.ethereum, {
+    name: 'mainnet',
+    chainId: Network.Mainnet,
+  }),
+})
 ```
 
 #### SDK Constructor Arguments:
 
-| Name               | Type                                                             | Required | Description               |
-|--------------------|------------------------------------------------------------------|----------|---------------------------|
-| network            | `Network`                                                        | **Yes**  | Chain id |
-| provider           | `BrowserProvider or JsonRpcProvider`                             | **No**   | You can provide your implementation of the provender for ethers |
-| endpoints.web3     | `string OR Array<(string \| { url: string, headers: Headers })>` | **No**   | Your urls for connecting to blockchain. This parameter is required if `provider` is not provided. If more than one URL is provided, they will be used as fallbacks. |
-| endpoints.subgraph | `string`                                                         | **No**   | stakewise subgraph url |
-| endpoints.api      | `string`                                                         | **No**   | stakewise backend url |
+| Name               | Type                                                               | Required | Description                                                                                                                                                         |
+|--------------------|--------------------------------------------------------------------|----------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| network            | `Network`                                                          | **Yes**  | Chain id                                                                                                                                                            |
+| provider           | `BrowserProvider` or `JsonRpcProvider`                             | **No**   | You can provide your implementation of the provender for ethers. This parameter is required to send transactions.                                                   |
+| endpoints.web3     | `string` or `Array<(string \| { url: string, headers: Headers })>` | **No**   | Your urls for connecting to blockchain. This parameter is required if `provider` is not provided. If more than one URL is provided, they will be used as fallbacks. |
+| endpoints.subgraph | `string`                                                           | **No**   | stakewise subgraph url                                                                                                                                              |
+| endpoints.api      | `string`                                                           | **No**   | stakewise backend url                                                                                                                                               |