Create README.md, references and examples for sentinel-js-sdk

README.md

@@ -0,0 +1,75 @@
+# sentinel-js-sdk
+
+The Sentinel JS SDK relays on [CosmJS](https://github.com/cosmos/cosmjs) and it was developed following the official [tutorial](https://tutorials.cosmos.network/tutorials/7-cosmjs/), it take also inspiration from other open source Cosmos SDK.
+
+The SDK exstends the followings:
+- [@cosmjs/stargate/StargateClient](https://cosmos.github.io/cosmjs/latest/stargate/classes/StargateClient.html) as `SentinelClient`
+- [@cosmjs/stargate/SigningStargateClient](https://cosmos.github.io/cosmjs/latest/stargate/classes/SigningStargateClient.html) `SigningSentinelClient`
+- [@cosmjs/stargate/QueryClient](https://cosmos.github.io/cosmjs/latest/stargate/classes/QueryClient.html) as `client.sentinelQuery`
+
+## clients
+```javascript
+import { SentinelClient } from "@sentinel-official/sentinel-js-sdk";
+
+const rpc = "https://rpc.sentinel.co:443"
+const client = await SentinelClient.connect(rpc)
+```
+
+If you need to sign and broadcasting a tx you need to a `SigningClient`.
+```javascript
+import { SigningSentinelClient } from "@sentinel-official/sentinel-js-sdk";
+import { DirectSecp256k1HdWallet } from "@cosmjs/proto-signing"
+import { GasPrice } from "@cosmjs/stargate"
+
+const wallet = await DirectSecp256k1HdWallet.fromMnemonic(mnemonic, { prefix: "sent" });
+const [account] = await wallet.getAccounts();
+
+const rpc = "https://rpc.sentinel.co:443"
+
+# With a default GasPrice:
+const customDenom = "udvpn"
+const gasPrice = GasPrice.fromString(`0.2${customDenom}`);
+const client = await SigningSentinelClient.connectWithSigner(rpc, wallet, {
+    gasPrice: gasPrice
+})
+
+# Without a default GasPrice
+const client = await SigningSentinelClient.connectWithSigner(rpc, wallet)
+```
+
+You can also set other default parameters: https://cosmos.github.io/cosmjs/latest/stargate/interfaces/SigningStargateClientOptions.html.
+
+## protobuf
+All the .proto files are compiled using [protoc](https://grpc.io/docs/protoc-installation/) and [ts-proto](https://github.com/stephenh/ts-proto) as plugin. The compile .ts proto files are under src/protobuf. If you want to compile again you can use [scripts/generate-proto.sh](scripts/generate-proto.sh). The script require `git` and `protoc` it will automatically download all the .proto definitions from [sentinel-hub](https://github.com/sentinel-official/hub/tree/development/proto/sentinel) and relative third parties.
+
+## examples
+The official [cosmjs examples](https://gist.github.com/webmaster128/8444d42a7eceeda2544c8a59fbd7e1d9) can be used as well.
+Just remember to replace `StargateClient` with `SentinelClient` and `SigningStargateClient` with `SigningSentinelClient`.
+
+The repository provide currently a `nodejs script` example and a `keplr` one (based on: https://tutorials.cosmos.network/tutorials/7-cosmjs/4-with-keplr.html).
+
+If you want to use a local version of sdk (for testing purpose) you had to compile the src folder into dist and then link the package with npm.
+```bash
+npm run build
+npm link
+cd examples/<choose-an-example>
+npm link @sentinel-official/sentinel-js-sdk
+```
+
+### run keplr example
+```bash
+cd examples/keplr
+npm i
+npm i @sentinel-official/sentinel-js-sdk
+npm run dev
+```
+Navigate to: http://127.0.0.1:3000/.
+### run nodejs example
+```bash
+cd examples/node
+npm i
+npm i @sentinel-official/sentinel-js-sdk
+npm i ts-node
+ts-node main.ts
+```
+