Merge pull request #975 from IntersectMBO/add-support-for-nodejs-grpc

Add support for node.js GRPC

Author: palas

cardano-wasm/lib-wrapper/cardano-api.js

@@ -10,15 +10,23 @@ import { createInitializer } from './main.js';
 const wasmUrl = './cardano-wasm.wasm';
 
 const getWasi = async () => {
-    const { WASI } = await import("https://unpkg.com/@bjorn3/[email protected]/dist/index.js");
-    return new WASI([], [], []);
+  const { WASI } = await import("https://unpkg.com/@bjorn3/[email protected]/dist/index.js");
+  return new WASI([], [], []);
 };
 
 const loadWasmModule = async (importObject) => {
   const response = await fetch("./cardano-wasm.wasm");
   return await WebAssembly.instantiateStreaming(response, importObject);
 };
 
-const initialise = createInitializer(getWasi, loadWasmModule);
+const createClient = function (address) {
+  return {
+    node: new cardano_node.node.NodePromiseClient(address, null, null),
+    query: new cardano_node.query.QueryServicePromiseClient(address, null, null),
+    submit: new cardano_node.submit.SubmitServicePromiseClient(address, null, null)
+  }
+}
+
+const initialise = createInitializer(getWasi, loadWasmModule, createClient);
 export default initialise;
 

cardano-wasm/lib-wrapper/main.js

@@ -14,7 +14,7 @@
 
 const __exports = {};
 
-export function createInitializer(getWasi, loadWasmModule) {
+export function createInitializer(getWasi, loadWasmModule, createClient) {
   /**
    * Global utilities module used in JS foreign imports in WASM
    */
@@ -35,6 +35,8 @@ export function createInitializer(getWasi, loadWasmModule) {
     }
   }
 
+  globalThis.createClient = createClient;
+
   return async function initialise() {
 
     const ghc_wasm_jsffi = (await eval(`import('./cardano-wasm.js')`)).default;

cardano-wasm/npm-wrapper/README.md

@@ -58,6 +58,13 @@ To run this file, you can simply use Node.js:
 node index.js
 ```
 
+When using `node.js`, the `grpc` module will use normal GRPC and can be used with UNIX socket files as follows:
+
+```bash
+    const grpc = await api.newGrpcConnection("unix:///path/to/cardano-node/rpc/socket/node1/rpc.sock");
+    const era = await grpc.getEra();
+```
+
 ### Webpack
 
 Alternatively you can use `cardano-wasm` as part of a `webpack` project, but you'll need to install `html-webpack-plugin` and `copy-webpack-plugin`:
@@ -117,6 +124,8 @@ module.exports = {
 
 Your `webpack.config.js` configuration may vary, but it could be necessary to adjust the `target`, `experiments`, `devtool`, `plugins`, and `module` keys as shown in the example above.
 
+When using from the browser, the `grpc` module uses `web-grpc`, so the RPC socket from `cardano-node` needs to be proxied with a tool like `envoy` (see the [README.md](https://github.com/IntersectMBO/cardano-api/tree/master/cardano-wasm) at GitHub repo for more info).
+
 -----
 
 ## 📖 API Reference

cardano-wasm/npm-wrapper/package.json

@@ -52,14 +52,17 @@
   },
   "devDependencies": {
     "@rollup/plugin-commonjs": "^28.0.6",
+    "@rollup/plugin-json": "^6.1.0",
     "@rollup/plugin-node-resolve": "^16.0.1",
+    "jest": "^29.7.0",
     "rollup": "^4.52.3",
     "rollup-plugin-copy": "^3.5.0",
-    "rollup-plugin-string": "^3.0.0",
-    "jest": "^29.7.0"
+    "rollup-plugin-string": "^3.0.0"
   },
   "dependencies": {
-    "@bjorn3/browser_wasi_shim": "^0.4.2"
+    "@bjorn3/browser_wasi_shim": "^0.4.2",
+    "@grpc/grpc-js": "^1.10.9",
+    "google-protobuf": "^4.0.0"
   },
   "jest": {
     "testEnvironment": "node"

cardano-wasm/npm-wrapper/rollup.config.js

@@ -2,10 +2,12 @@ import resolve from '@rollup/plugin-node-resolve';
 import commonjs from '@rollup/plugin-commonjs';
 import copy from 'rollup-plugin-copy';
 import { string } from 'rollup-plugin-string';
+import json from '@rollup/plugin-json';
 
 const isProduction = process.env.NODE_ENV === 'production';
 
 const plugins = [
+  json(),
   resolve({ browser: true }),
   string({
     include: '**/cardano_node_grpc_web_pb.js',
@@ -45,7 +47,7 @@ export default [
       })
     ],
     // Mark Node.js built-in modules as external so they are not bundled.
-    external: ['fs/promises', 'path', 'url', 'wasi']
+    external: ['fs/promises', 'path', 'url', 'wasi', '@grpc/grpc-js', 'google-protobuf']
   },
 
   // --- Browser Builds ---

cardano-wasm/npm-wrapper/src/browser.js

@@ -16,7 +16,15 @@ const loadWasmModule = async (importObject) => {
     return await WebAssembly.instantiateStreaming(response, importObject);
 };
 
-const initialise = createInitializer(getWasiInstance, loadWasmModule);
+const createClient = function (address) {
+    return {
+        node: new cardano_node.node.NodePromiseClient(address, null, null),
+        query: new cardano_node.query.QueryServicePromiseClient(address, null, null),
+        submit: new cardano_node.submit.SubmitServicePromiseClient(address, null, null)
+    }
+}
+
+const initialise = createInitializer(getWasiInstance, loadWasmModule, createClient);
 
 export default initialise;
 

cardano-wasm/npm-wrapper/src/node.js

@@ -3,9 +3,12 @@ import { readFile } from 'fs/promises';
 import { fileURLToPath } from 'url';
 import path from 'path';
 import { WASI } from '@bjorn3/browser_wasi_shim';
+import * as grpc_js from '@grpc/grpc-js';
+import * as Clients from './node/node-index.js';
+import { promisify } from 'node:util';
 
 const getWasi = async () => {
-    return new WASI([], [], []);
+  return new WASI([], [], []);
 };
 
 const loadWasmModule = async (importObject) => {
@@ -16,6 +19,34 @@ const loadWasmModule = async (importObject) => {
   return { instance: new WebAssembly.Instance(module, importObject), module };
 };
 
-const initialise = createInitializer(getWasi, loadWasmModule);
+function promisifyClient(client) {
+  const promisedClient = {};
+
+  for (const key of Object.keys(Object.getPrototypeOf(client))) {
+    // Ensure it is an API method
+    if (key[0] !== '_' && typeof client[key] === 'function') {
+      // We use .bind(client) to ensure the method is called
+      // in the correct context of the client instance.
+      promisedClient[key] = promisify(client[key].bind(client));
+    }
+  }
+  return promisedClient;
+}
+
+const createClient = (address) => {
+  const credentials = grpc_js.credentials.createInsecure();
+  globalThis.cardano_node = {
+    node: Clients.node_messages,
+    query: Clients.query_messages,
+    submit: Clients.submit_messages
+  };
+  return {
+    node: promisifyClient(new Clients.default.node.NodeClient(address, credentials)),
+    query: promisifyClient(new Clients.default.query.QueryServiceClient(address, credentials)),
+    submit: promisifyClient(new Clients.default.submit.SubmitServiceClient(address, credentials))
+  };
+};
+
+const initialise = createInitializer(getWasi, loadWasmModule, createClient);
 export default initialise;
 

cardano-wasm/src/Cardano/Wasm/Internal/JavaScript/GRPC.hs

@@ -10,10 +10,7 @@ import GHC.Wasm.Prim
 import Cardano.Wasm.Internal.Api.Tx (ProtocolParamsJSON(..))
 
 -- | Create a GRPC-web client for the Cardano API.
-foreign import javascript safe "{ node: new cardano_node.node.NodePromiseClient($1, null, null), \
-                                  query: new cardano_node.query.QueryServicePromiseClient($1, null, null), \
-                                  submit: new cardano_node.submit.SubmitServicePromiseClient($1, null, null) \
-                                }"
+foreign import javascript safe "globalThis.createClient($1)"
   js_newWebGrpcClientImpl :: JSString -> IO JSVal
 
 js_newWebGrpcClient :: String -> IO JSVal