readme

tools/gateway-js/gateway-lib/README.md

@@ -0,0 +1,58 @@
+# Obscuro Gateway JS
+
+A JavaScript library for the gateway, providing streamlined access and functionalities for interacting with the Obscuro network.
+
+## Table of Contents
+
+- [Features](#features)
+- [Installation](#installation)
+- [Usage](#usage)
+- [Build](#build)
+- [Contribute](#contribute)
+- [License](#license)
+
+## Features
+
+- Seamless connection to Obscuro Network.
+- Easy-to-use methods for joining and authenticating.
+- External consumption support through CDN or NPM.
+
+## Installation
+
+To install `obscuro-gateway-js`, use npm:
+
+\`\`\`bash
+npm install obscuro-gateway-js
+\`\`\`
+
+## Usage
+
+\`\`\`javascript
+
+const Gateway = require('obscuro-gateway-js');
+
+const gateway = new Gateway(httpURL, wsURL, provider);
+await gateway.join();
+await gateway.registerAccount(account);
+
+\`\`\`
+
+## Build
+
+To build for development:
+
+\`\`\`bash
+npm run dev
+\`\`\`
+
+For production:
+
+\`\`\`bash
+npm run build
+\`\`\`
+
+The production build will be available for external consumption on GitHub Pages at `https://go-obscuro.github.io/obscuronet/gateway.bundle.js`.
+
+## Contribute
+
+Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

tools/gateway-js/gateway-lib/gateway.js

@@ -24,7 +24,7 @@ class Gateway {
         }
     }
 
-    async registerAccount(privateKey, address) {
+    async registerAccount(address) {
         const message = `Register ${this.userID} for ${address.toLowerCase()}`;
         let signature = ""
 

tools/gateway-js/gateway-lib/gateway.test.js

@@ -44,7 +44,7 @@ describe('Gateway', () => {
             request: jest.fn().mockResolvedValue("mockSignature")
         })
 
-        const result = await gateway.registerAccount('privateKey', 'address');
+        const result = await gateway.registerAccount( 'address');
 
         expect(result).toBe('Account registered');
     });
@@ -54,6 +54,6 @@ describe('Gateway', () => {
             request: jest.fn().mockRejectedValue(new Error('Signature error')),
         })
 
-        await expect(gateway.registerAccount('privateKey', 'address')).rejects.toThrow('Failed to sign message. Error: Signature error');
+        await expect(gateway.registerAccount('address')).rejects.toThrow('Failed to sign message. Error: Signature error');
     });
 });