Rosetta SDK 1.4.1

.eslintignore

@@ -0,0 +1,2 @@
+**/node_modules/**
+**/dist

.eslintrc.json

@@ -0,0 +1,9 @@
+{
+    "parserOptions": {
+        "ecmaVersion": 8,
+        "sourceType": "module"
+    },
+    "rules": {
+        "semi": "error"
+    }
+}

.gitignore

@@ -0,0 +1 @@
+**/node_modules

LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2020 DigiByte Foundation NZ Limited
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

README.md

@@ -1,2 +1,88 @@
-# digibyte-rosetta-nodeapi
-Coinbase Rosetta Node API Implementation
+<p align="center">
+  <a href="https://www.rosetta-api.org">
+    <img width="90%" alt="Rosetta" src="https://www.rosetta-api.org/img/rosetta_header.png">
+  </a>
+</p>
+<h3 align="center">
+   Rosetta SDK
+</h3>
+<p align="center">
+NodeJS Rosetta SDK to create and interact with Rosetta API Implementations
+</p>
+<p align="center">
+  <!--<a href="https://circleci.com/gh/DigiByte-Core/digibyte-rosetta-nodeapi/tree/master"><img src="https://circleci.com/gh/DigiByte-Core/digibyte-rosetta-nodeapi/tree/master.svg?style=shield" /></a>-->
+  <a href="https://coveralls.io/github/DigiByte-Core/digibyte-rosetta-nodeapi"><img src="https://coveralls.io/repos/github/DigiByte-Core/digibyte-rosetta-nodeapi/badge.svg" /></a>
+  <a href="https://github.com/DigiByte-Core/digibyte-rosetta-nodeapi/blob/master/LICENSE.txt"><img src="https://img.shields.io/github/license/DigiByte-Core/digibyte-rosetta-nodeapi.svg" /></a>
+</p>
+
+# RosettaSDK (JS) [experimental]
+Supported Rosetta Protocol Version: 1.4.1
+
+This project is a port of the official Go reference implementation. All features, except a [few exceptions](docs/api_limitations.md), have been ported to JS.
+
+⚠️ WARNING ⚠️
+Due to the lack of funding, I wasn't able to continue the work on `rosetta-node-sdk`.
+
+## Motivation
+Coinbase's [Official Go Reference Implementation](https://github.com/coinbase/rosetta-sdk-go.git) is a thouroughly tested and wonderful SDK Implementation. However, as many developers are better suited to use NodeJS/Javascript, DigiByte decided to port the reference implementation to NodeJS while maintaining support for all it's core components.  
+
+## Documentation
+
+### Prerequisites
+- NodeJS >= 10.6
+- NPM >= 6.10.0
+
+The code was written on a Mac, so assuming all should work smoothly on Linux-based computers. However, there is no reason not to run this library on Windows-based machines. If you find an OS-related problem, please open an issue and it will be resolved.
+
+### Installation
+```bash
+npm install --save rosetta-node-sdk
+```
+
+### Tests
+This project is thoroughly tested using > 300 automated tests. Run `npm run test` to see how they all work out.
+
+### Usage
+All Core components are accessible as follows:
+```Javascript
+const RosettaSDK = require('rosetta-node-sdk');
+const {
+  Asserter,
+  Server,
+  Reconciler,
+  Client,
+  Fetcher,
+  Syncer,
+  Parser,
+  SyncerEvents,
+  Errors,
+
+  Utils,
+  InternalModels,
+
+  logger,
+
+  version, // '1.4.1'
+} = RosettaSDK;
+```
+
+### Components
+- **Asserter** - Syntactical and semantical type validator. This Asserter can be used to validate Requests/Responses. Constructors exist that ease the creation of an asserter. For example, `NewClientWithResponses` can be used in order to create a server validator by only passing the network responses.
+- **Server** - The Server Component eases the development of a custom server implementation. Examples on how to build such a server are located in [examples](./examples).
+- **Reconciler** - Use the Reconciler in order to validate that the balances computed by parsing the blocks are the equal to the balances computed by a node.
+- **Client** - Client request library [`rosetta-node-sdk-client`](https://github.com/SmartArray/rosetta-node-sdk-client)
+- **Fetcher** - Convenience Wrapper Class for `Client`
+- **Syncer** - Makes use of `Fetcher` class in order to download blocks in logical order.
+- **Parser** - Parses and groups BalanceOperations of a block. 
+- **SyncerEvents** - Syncer Events. Mainly `BLOCK_ADDED`, `BLOCK_REMOVED`, `SYNC_CANCELLED`
+- **Errors** - Error Classes for the different components: `AsserterError`, `FetcherError`, `InputError`, `ParserError`, `InternalError`,  `ReconcilerError`, `SyncerError`. 
+- **Utils** - Utility functions, commonly used internally by the core components.
+- **InternalModels** - Models, that are commonly used internally.
+- **logger** - Default Logger Singleton Class.
+- **version** - Specifies the version of this SDK. This semver is equal to the Rosetta API SDK for convencience.
+
+### ToDos
+- [ ] Setup CI (`npm run test` will execute 313 tests)
+- [ ] Support `keys` (cryptographic API) 
+- [ ] Documentation 
+- [ ] Test Reconciler in live environment

docs/api_limitations.md

@@ -0,0 +1,14 @@
+# API Limitations
+This Rosetta JS SDK contains a port of every essential core component that is available in the offical Go reference implementation, except a few exceptions:
+
+☑️ Asserter
+☑️ Controllers
+☑️ Fetcher
+☑️ Parser
+☑️ Reconciler
+☑️ Server
+❌ Keys (may be ported to NodeJS in future)
+
+# Client Package
+This project makes extensive use of the Rosetta Client Library [`rosetta-node-sdk-client`](https://github.com/SmartArray/rosetta-node-sdk-client), that was generated with the OpenAPI Generator. 
+It does not contain TypeScript Wrappers. So if you want to use Typescript Classes for your server implementation, you should generate your own using the OpenAPI Generator Toolsuite.

examples/basic/README.md

@@ -0,0 +1,12 @@
+# Basic Example Server
+is directory demonstrates how to write a Rosetta Node server and how
+to use either the Client package or Fetcher package to communicate
+with that server.
+
+Each subdirectory contains a separate project.
+The projects were all ported from Go, to maintain maintability.
+
+## Steps
+1. Run `node server`
+2. Run `node client` (in a new terminal window)
+2. Run `node fetcher` (in a new terminal window)

examples/basic/client/index.js

@@ -0,0 +1,86 @@
+/**
+ * Copyright (c) 2020 DigiByte Foundation NZ Limited
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+const RosettaSDK = require('../../..');
+const RosettaClient = RosettaSDK.Client;
+
+// Create an instance of APIClient and configure it.
+const APIClient = new RosettaClient.ApiClient();
+APIClient.basePath = 'http://localhost:8080';
+APIClient.agent = 'rosetta-sdk-node';
+APIClient.timeout = 10 * 1000; // 10 seconds
+
+async function startClient() {
+  // Step1: Create an instance of RosettaSDK Client
+  const networkAPI = new RosettaClient.NetworkApi(APIClient).promises;
+
+  // Step 2: Get all available networks
+  const metadataRequest = new RosettaClient.MetadataRequest();
+  const networkList = await networkAPI.networkList(metadataRequest);
+  if (networkList.network_identifiers.length == 0) {
+    console.error('Server did not respond with any network identifier');
+    return;
+  }
+
+  // Step 3: Print the primary network
+  const primaryNetwork = networkList.network_identifiers[0];
+  console.log(`Primary Network: ${primaryNetwork}`);
+
+  // Step 4: Fetch the network status
+  const networkRequest = new RosettaClient.NetworkRequest(primaryNetwork);
+  const networkStatus = await networkAPI.networkStatus(networkRequest);
+
+  // Step 5: Print Network Status
+  console.log(`Network Status: ${networkStatus}`);
+
+  // Step 6: Asserter (ToDo?)
+  // Response Assertions are already handled by the server.
+
+  // Step 7: Fetch the Network Options
+  const networkOptions = await networkAPI.networkOptions(networkRequest);
+
+  // Step 8: Print Network Options
+  console.log(`Network Options: ${networkOptions}`);
+
+  // Step 9: Asserter (ToDo?), refer to step 6.
+  // Step 10: ClientAsserter, refer to step 6.
+  // ...
+
+  // Step 11: Fetch current block
+  const blockIdentifier = RosettaClient.PartialBlockIdentifier.constructFromObject({
+    hash: networkStatus.current_block_identifier,
+  });
+  const blockRequest = new RosettaClient.BlockRequest(primaryNetwork, blockIdentifier);
+  const block = await networkAPI.block(blockRequest);
+
+  // Step 12: Print the block
+  console.log(`Current Block: ${block}`);
+
+  // Step 13: Assert the block response is valid, refer to step 6
+
+  // Step 14: Print transactions in that block
+  block.OtherTransactions.forEach(tx => {
+    console.log(`  Transaction: ${tx}`);
+  });
+};
+
+startClient()
+  .catch(e => console.error(e));

examples/basic/fetcher/index.js

@@ -0,0 +1,57 @@
+/**
+ * Copyright (c) 2020 DigiByte Foundation NZ Limited
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+const RosettaSDK = require('../../..');
+
+// Create an instance of Fetcher
+const fetcher = new RosettaSDK.Fetcher({
+  server: {
+    protocol: 'http',
+    host: 'localhost',
+    port: '8080',
+  },
+});
+
+const main = (async function () {
+  const { primaryNetwork, networkStatus } = await fetcher.initializeAsserter();
+
+  console.log(`Primary Network: ${JSON.stringify(primaryNetwork)}`);
+  console.log(`Network Status: ${JSON.stringify(networkStatus)}`);
+
+  const block = await fetcher.blockRetry(
+    primaryNetwork,
+    new RosettaSDK.Utils.constructPartialBlockIdentifier(networkStatus.current_block_identifier),
+  );
+
+  console.log(`Current Block: ${JSON.stringify(block)}`);
+
+  const blockMap = fetcher.blockRange(
+    primaryNetwork,
+    networkStatus.genesis_block_identifier.index,
+    networkStatus.genesis_block_identifier.index + 10,
+  );
+
+  console.log(`Current Range: ${JSON.stringify(blockMap)}`);
+});
+
+main().catch(e => {
+  console.error(e);
+})

examples/basic/server/index.js

@@ -0,0 +1,48 @@
+/**
+ * Copyright (c) 2020 DigiByte Foundation NZ Limited
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+const RosettaSDK = require('../../..');
+
+const ServiceHandlers = require('./services');
+const networkIdentifier = require('./network');
+
+const asserter = RosettaSDK.Asserter.NewServer(
+  ['Transfer', 'Reward'],
+  false,
+  [networkIdentifier],
+);
+
+/* Create a server configuration */
+const Server = new RosettaSDK.Server({
+  URL_PORT: 8080,
+});
+
+// Register global asserter
+Server.useAsserter(asserter);
+
+/* Data API: Network */
+Server.register('/network/list', ServiceHandlers.Network.networkList);
+Server.register('/network/options', ServiceHandlers.Network.networkOptions);
+Server.register('/network/status', ServiceHandlers.Network.networkStatus);
+
+/* Data API: Block */
+Server.register('/block', ServiceHandlers.Block.block);
+Server.register('/block/transaction', ServiceHandlers.Block.blockTransaction);

examples/basic/server/network.js

@@ -0,0 +1,25 @@
+/**
+ * Copyright (c) 2020 DigiByte Foundation NZ Limited
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy of
+ * this software and associated documentation files (the "Software"), to deal in
+ * the Software without restriction, including without limitation the rights to
+ * use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
+ * the Software, and to permit persons to whom the Software is furnished to do so,
+ * subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in all
+ * copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
+ * FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
+ * COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
+ * IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
+ * CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+ */
+
+const RosettaSDK = require('../../..');
+const networkIdentifier = new RosettaSDK.Client.NetworkIdentifier('Rosetta', 'Testnet');
+
+module.exports = networkIdentifier;