Merge pull request #12 from ideal-lab5/feat/9-murmurjs-move-communica…

…tion-with-idn-to-the-client

Feat/9 murmurjs move communication with idn to the client

.gitignore

@@ -1,3 +1,3 @@
-/dist
-/node_modules
+dist
+node_modules
 package-lock.json

README.md

@@ -2,4 +2,52 @@
 
 A wrapper to enable easy usage of murmur wallets in web apps.
 
-More coming soon.
+More coming soon.
+
+## Usage
+
+The Murmur Client depends on:
+
+- Axios for making HTTP requests to the Murmur API
+- Polkadot-js for interacting with the Ideal Network
+
+You need to configure an `axios` and a `polkadot-js` instances to be injected in the Murmur Client.
+
+```javascript
+import { ApiPromise, WsProvider, Keyring } from "@polkadot/api";
+import { KeyringPair } from "@polkadot/keyring/types";
+import axios from "axios";
+import { MurmurClient } from "murmur.js";
+
+/* Polkadot API initialization */
+const provider = new WsProvider("ws://127.0.0.1:9944");
+console.log("Provider initialized");
+const api = await ApiPromise.create({ provider });
+console.log("API initialized");
+
+/* Axios initialization */
+const httpClient = axios.create({
+  baseURL: "https://api.example.com",
+  headers: {
+    "Content-Type": "application/json",
+  },
+});
+
+/* Define the master account (optional, it falls back to `alice`) */
+const keyring = new Keyring({ type: "sr25519" });
+const alice = keyring.addFromUri("//Alice");
+
+/* MurmurClient initialization */
+const murmurClient = new MurmurClient(httpClient, api, alice);
+console.log("MurmurClient initialized");
+
+// Use the MurmurClient instance to make requests
+murmurClient
+  .authenticate("username", "password")
+  .then((response) => {
+    console.log(response);
+  })
+  .catch((error) => {
+    console.error(error);
+  });
+```

examples/create-execute/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "murmur-example-create-execute",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "@polkadot/api": "^13.2.1",
+    "axios": "^1.7.7",
+    "murmur.js": "file:../../../murmur.js"
+  }
+}

examples/create-execute/src/index.ts

@@ -0,0 +1,40 @@
+import { ApiPromise, WsProvider } from "@polkadot/api";
+import axios from "axios";
+import { MurmurClient } from "murmur.js";
+
+/* Polkadot API initialization */
+const provider = new WsProvider("ws://127.0.0.1:9944");
+console.log("Provider initialized");
+const api = await ApiPromise.create({ provider });
+console.log("API initialized");
+// Retrieve the chain & node information via rpc calls
+const [chain, nodeName, nodeVersion] = await Promise.all([
+  api.rpc.system.chain(),
+  api.rpc.system.name(),
+  api.rpc.system.version(),
+]);
+console.log(
+  `You are connected to chain ${chain} using ${nodeName} v${nodeVersion}`
+);
+
+/* Axios initialization */
+const httpClient = axios.create({
+  baseURL: "http://127.0.0.1:8000",
+  headers: {
+    "Content-Type": "application/json",
+  },
+});
+
+/* MurmurClient initialization */
+const murmurClient = new MurmurClient(httpClient, api);
+console.log("MurmurClient initialized");
+
+const loguinResult = await murmurClient.authenticate("admin", "password");
+console.log(loguinResult);
+
+await murmurClient.new(100, async (result: any) => {
+  console.log(`Tx Block Hash: ${result.status.asFinalized}`);
+  const bob = "5FHneW46xGXgs5mUiveU4sbTyGBzmstUspZC92UhjJM694ty";
+  const call = api.tx.balances.transferAllowDeath(bob, 1000000000000);
+  await murmurClient.execute(call);
+});

examples/create-execute/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es2017",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"]
+}

examples/simple-connect/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "murmur-example-simple-connect",
+  "version": "1.0.0",
+  "description": "",
+  "main": "dist/index.js",
+  "type": "module",
+  "scripts": {
+    "build": "tsc",
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "",
+  "license": "ISC",
+  "devDependencies": {
+    "typescript": "^4.9.5"
+  },
+  "dependencies": {
+    "@polkadot/api": "^13.2.1",
+    "axios": "^1.7.7",
+    "murmur.js": "file:../../../murmur.js"
+  }
+}

examples/simple-connect/src/index.ts

@@ -0,0 +1,30 @@
+import { ApiPromise, WsProvider } from "@polkadot/api";
+import axios from "axios";
+import { MurmurClient } from "murmur.js";
+
+/* Polkadot API initialization */
+const provider = new WsProvider("ws://127.0.0.1:9944");
+console.log("Provider initialized");
+const api = await ApiPromise.create({ provider });
+console.log("API initialized");
+// Retrieve the chain & node information via rpc calls
+const [chain, nodeName, nodeVersion] = await Promise.all([
+  api.rpc.system.chain(),
+  api.rpc.system.name(),
+  api.rpc.system.version(),
+]);
+console.log(
+  `You are connected to chain ${chain} using ${nodeName} v${nodeVersion}`
+);
+
+/* Axios initialization */
+const httpClient = axios.create({
+  baseURL: "https://api.example.com",
+  headers: {
+    "Content-Type": "application/json",
+  },
+});
+
+/* MurmurClient initialization */
+new MurmurClient(httpClient, api);
+console.log("MurmurClient initialized");

examples/simple-connect/tsconfig.json

@@ -0,0 +1,15 @@
+{
+  "compilerOptions": {
+    "target": "es2017",
+    "module": "esnext",
+    "moduleResolution": "node",
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "resolveJsonModule": true,
+    "forceConsistentCasingInFileNames": true
+  },
+  "include": ["src/**/*"]
+}

package.json

@@ -11,6 +11,7 @@
   },
   "author": "Ideal Labs <[email protected]>",
   "dependencies": {
+    "@polkadot/api": "^13.2.1",
     "axios": "^1.7.7"
   },
   "devDependencies": {