kosu-docs: add new packages

ParadigmFoundation · Oct 25, 2019 · 09ac0f2 · 09ac0f2
1 parent 38e8f3b
commit 09ac0f2
Show file tree

Hide file tree

Showing 10 changed files with 1,064 additions and 3 deletions.
diff --git a/packages/kosu-docs/docs/.vuepress/config.js b/packages/kosu-docs/docs/.vuepress/config.js
@@ -44,15 +44,14 @@ module.exports = {
                 ],
             },
             {
-                title: "Kosu.js",
+                title: "Kosu Contract Helpers",
                 collapsable: true,
                 food: "2.svg",
                 children: [
                     "./kosu-contract-helpers/",
                     "./kosu-contract-helpers/classes/kosu",
                     "./kosu-contract-helpers/classes/kosutoken",
                     "./kosu-contract-helpers/classes/eventemitter",
-                    "./kosu-contract-helpers/classes/nodeclient",
                     "./kosu-contract-helpers/classes/ordergateway",
                     "./kosu-contract-helpers/classes/orderhelper",
                     "./kosu-contract-helpers/classes/posterregistry",
@@ -62,7 +61,7 @@ module.exports = {
                 ],
             },
             {
-                title: "Kosu system contracts",
+                title: "Kosu System Contracts",
                 collapsable: true,
                 food: "3.svg",
                 children: [
@@ -89,6 +88,42 @@ module.exports = {
                 food: "5.svg",
                 children: ["./kosu-genesis-cli/", "./kosu-genesis-cli/globals"],
             },
+            {
+                title: "Kosu Node Client",
+                collapsable: true,
+                food: "6.svg",
+                children: ["./kosu-node-client/", "./kosu-node-client/classes/nodeclient"],
+            },
+            {
+                title: "Kosu Migrations",
+                collapsable: true,
+                food: "7.svg",
+                children: ["./kosu-migrations/"],
+            },
+            {
+                title: "Kosu Deployed Addresses",
+                collapsable: true,
+                food: "8.svg",
+                children: ["./kosu-deployed-addresses/", "./kosu-deployed-addresses/globals"],
+            },
+            {
+                title: "Kosu.js",
+                collapsable: true,
+                food: "9.svg",
+                children: ["./kosu.js/"],
+            },
+            {
+                title: "Order Server",
+                collapsable: true,
+                food: "10.svg",
+                children: ["./order-server/"],
+            },
+            {
+                title: "Development Images",
+                collapsable: true,
+                food: "11.svg",
+                children: ["./dev-images/"],
+            },
         ],
     },
 };
diff --git a/packages/kosu-docs/docs/dev-images/README.md b/packages/kosu-docs/docs/dev-images/README.md
@@ -0,0 +1,24 @@
+# `@kosu/dev-images`
+
+Development and CI docker images and supporting scripts for the Kosu project.
+
+All images defined in this repository are publicly available, and hosted by Google Container Registry. Images can be pulled with:
+
+```bash
+$ docker pull gcr.io/kosu-io/$IMAGE_NAME
+```
+
+## General images
+
+Convenient images for development within the Kosu-monorepo. Can be used as drop-in replacements for the images they inherit from (shown in parenthesis).
+
+-   `gcr.io/kosu-io/node-lts` (`node:lts`): Custom Node.js image with all necessary binaries needed to build `kosu-monorepo` pre-installed. Drop-in replacement for `node:lts` image.
+
+## CI Images
+
+Docker images used for [Kosu's continuous-integration](https://ci.kosu.io) suite are defined in the [`./ci`](./ci) folder. We use [DroneCI](https://drone.io) and the `ci` images are used to run tests for various Kosu packages.
+
+The current CI images defined in `dev-images` are listed below.
+
+-   `gcr.io/kosu-io/go-kosu-ci`: Custom `golang` image used to run `go-kosu` CI tests.
+-   `gcr.io/kosu-io/node-ci`: Custom Node.js (Debian-based) image used for the Kosu contract system CI suite and JS libraries (includes `kosu-monorepo` source build into image).
diff --git a/packages/kosu-docs/docs/kosu-deployed-addresses/README.md b/packages/kosu-docs/docs/kosu-deployed-addresses/README.md
@@ -0,0 +1,58 @@
+> **[Kosu Deployed Addresses](README.md)**
+
+[Globals](globals.md) /
+
+# Kosu Deployed Addresses
+
+This repository exposes the deployed addresses of the Kosu protocol contract system.
+
+### Ropsten
+
+-   **Network ID:** 3
+-   **ETHNET URL:** `https://ropsten.infura.io`
+
+| Contract Name                                                                                    | Last Deploy Date | Deployed Address                                                                                                              |
+| ------------------------------------------------------------------------------------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| [OrderGateway](../kosu-system-contracts/contracts/external/OrderGateway.sol)                     | 09/12/19         | [0xe3c53988b77c2b3fd2b847719743bdb6e1e66843](https://ropsten.etherscan.io/address/0xe3c53988b77c2b3fd2b847719743bdb6e1e66843) |
+| [AuthorizedAddresses](../kosu-system-contracts/contracts/access_control/AuthorizedAddresses.sol) | 09/12/19         | [0x93b79200cd23841371024427c39c5e4cd19957c9](https://ropsten.etherscan.io/address/0x93b79200cd23841371024427c39c5e4cd19957c9) |
+| [EventEmitter](../kosu-system-contracts/contracts/event/EventEmitter.sol)                        | 09/12/19         | [0xd55dfe66deccbfdcd462098c6bda59666fd9dafe](https://ropsten.etherscan.io/address/0xd55dfe66deccbfdcd462098c6bda59666fd9dafe) |
+| [KosuToken](../kosu-system-contracts/contracts/lib/KosuToken.sol)                                | 09/12/19         | [0x47f3bbc35acd3f8c5b2b8948c39f23f3c6e21f5a](https://ropsten.etherscan.io/address/0x47f3bbc35acd3f8c5b2b8948c39f23f3c6e21f5a) |
+| [Treasury](../kosu-system-contracts/contracts/treasury/Treasury.sol)                             | 09/12/19         | [0x3a1d181217a5dad549d398a1c17490daecdda3b4](https://ropsten.etherscan.io/address/0x3a1d181217a5dad549d398a1c17490daecdda3b4) |
+| [Voting](../kosu-system-contracts/contracts/voting/Voting.sol)                                   | 09/12/19         | [0x2442336571bb044f8793fcdff0d46f65d278e376](https://ropsten.etherscan.io/address/0x2442336571bb044f8793fcdff0d46f65d278e376) |
+| [PosterRegistry](../kosu-system-contracts/contracts/poster/PosterRegistry.sol)                   | 09/12/19         | [0x510733f64b49a502c75e57c9f63bd8c9f49b542c](https://ropsten.etherscan.io/address/0x510733f64b49a502c75e57c9f63bd8c9f49b542c) |
+| [ValidatorRegistry](../kosu-system-contracts/contracts/validator/ValidatorRegistry.sol)          | 09/12/19         | [0xf12a3c3728d86fcbe02d34a5dbf4bb3c7dd90351](https://ropsten.etherscan.io/address/0xf12a3c3728d86fcbe02d34a5dbf4bb3c7dd90351) |
+| [ZeroExV2SubContract](../kosu-system-contracts/contracts/sub-contracts/ZeroExV2SubContract.sol)  | 09/12/19         | [0xb395b261f8256c91c143ef3f74c014def1de1f39](https://ropsten.etherscan.io/address/0xb395b261f8256c91c143ef3f74c014def1de1f39) |
+
+### Kosu Dev PoA
+
+-   **Network ID:** 6174
+-   **ETHNET URL:** `https://ethnet.zaidan.io/kosu`
+
+| Contract Name                                                                                    | Last Deploy Date | Deployed Address                           |
+| ------------------------------------------------------------------------------------------------ | ---------------- | ------------------------------------------ |
+| [OrderGateway](../kosu-system-contracts/contracts/external/OrderGateway.sol)                     | 09/17/19         | 0xb8fda6341f80cbae987ab5cd00dce502097e3152 |
+| [AuthorizedAddresses](../kosu-system-contracts/contracts/access_control/AuthorizedAddresses.sol) | 09/17/19         | 0xe473109cb41c773fd2fe01e83c6e51356f9585d6 |
+| [EventEmitter](../kosu-system-contracts/contracts/event/EventEmitter.sol)                        | 09/17/19         | 0x2f3afeff0914f33769cdfbf3fcf870c33b26c311 |
+| [KosuToken](../kosu-system-contracts/contracts/lib/KosuToken.sol)                                | 09/17/19         | 0xcc868306d6188b2b12757a7c3926042b4d3c4e29 |
+| [Treasury](../kosu-system-contracts/contracts/treasury/Treasury.sol)                             | 09/17/19         | 0x46572f9082dd2429c2c138fa9483a67d4f29d423 |
+| [Voting](../kosu-system-contracts/contracts/voting/Voting.sol)                                   | 09/17/19         | 0x5d60c93d8b48682cd387c8be7e9461b67ecfbea1 |
+| [PosterRegistry](../kosu-system-contracts/contracts/poster/PosterRegistry.sol)                   | 09/17/19         | 0x7e6534b8205713246e91a14b462d2dbcac3ede17 |
+| [ValidatorRegistry](../kosu-system-contracts/contracts/validator/ValidatorRegistry.sol)          | 09/17/19         | 0x301bb008f2a8a3cae9918743fe43428551392773 |
+| [ZeroExV2SubContract](../kosu-system-contracts/contracts/sub-contracts/ZeroExV2SubContract.sol)  | 09/17/19         | 0x0265e7d1b094787cb13174e18a1cefc41279a6c9 |
+
+### Kosu CI Test
+
+-   **Network ID:** 6175
+-   **ETHNET URL:** `http://kosu-geth:8545`
+
+| Contract Name                                                                                    | Last Deploy Date | Deployed Address                           |
+| ------------------------------------------------------------------------------------------------ | ---------------- | ------------------------------------------ |
+| [OrderGateway](../kosu-system-contracts/contracts/external/OrderGateway.sol)                     | 09/17/19         | 0xb8fda6341f80cbae987ab5cd00dce502097e3152 |
+| [AuthorizedAddresses](../kosu-system-contracts/contracts/access_control/AuthorizedAddresses.sol) | 09/17/19         | 0xe473109cb41c773fd2fe01e83c6e51356f9585d6 |
+| [EventEmitter](../kosu-system-contracts/contracts/event/EventEmitter.sol)                        | 09/17/19         | 0x2f3afeff0914f33769cdfbf3fcf870c33b26c311 |
+| [KosuToken](../kosu-system-contracts/contracts/lib/KosuToken.sol)                                | 09/17/19         | 0xcc868306d6188b2b12757a7c3926042b4d3c4e29 |
+| [Treasury](../kosu-system-contracts/contracts/treasury/Treasury.sol)                             | 09/17/19         | 0x46572f9082dd2429c2c138fa9483a67d4f29d423 |
+| [Voting](../kosu-system-contracts/contracts/voting/Voting.sol)                                   | 09/17/19         | 0x5d60c93d8b48682cd387c8be7e9461b67ecfbea1 |
+| [PosterRegistry](../kosu-system-contracts/contracts/poster/PosterRegistry.sol)                   | 09/17/19         | 0x7e6534b8205713246e91a14b462d2dbcac3ede17 |
+| [ValidatorRegistry](../kosu-system-contracts/contracts/validator/ValidatorRegistry.sol)          | 09/17/19         | 0x301bb008f2a8a3cae9918743fe43428551392773 |
+| [ZeroExV2SubContract](../kosu-system-contracts/contracts/sub-contracts/ZeroExV2SubContract.sol)  | 09/17/19         | 0x0265e7d1b094787cb13174e18a1cefc41279a6c9 |
diff --git a/packages/kosu-docs/docs/kosu-deployed-addresses/globals.md b/packages/kosu-docs/docs/kosu-deployed-addresses/globals.md
@@ -0,0 +1,52 @@
+> **[Kosu Deployed Addresses](README.md)**
+
+[Globals](globals.md) /
+
+# Kosu Deployed Addresses
+
+## Index
+
+### Functions
+
+* [getAddressesForNetwork](globals.md#const-getaddressesfornetwork)
+* [getReceiptsForNetwork](globals.md#const-getreceiptsfornetwork)
+
+## Functions
+
+### `Const` getAddressesForNetwork
+
+▸ **getAddressesForNetwork**(`networkId`: number | string): *`KosuAddresses`*
+
+*Defined in [index.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/b1686609/packages/kosu-deployed-addresses/src/index.ts#L20)*
+
+Get the deployment addresses for a desired network by id.
+
+**Parameters:**
+
+Name | Type | Description |
+------ | ------ | ------ |
+`networkId` | number \| string | Ethereum network id. |
+
+**Returns:** *`KosuAddresses`*
+
+The addresses for the Kosu contracts.
+
+___
+
+### `Const` getReceiptsForNetwork
+
+▸ **getReceiptsForNetwork**(`networkId`: number | string): *`KosuDeploymentReceipts`*
+
+*Defined in [index.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/blob/b1686609/packages/kosu-deployed-addresses/src/index.ts#L10)*
+
+Get the deployment receipts for a desired network by id.
+
+**Parameters:**
+
+Name | Type | Description |
+------ | ------ | ------ |
+`networkId` | number \| string | Ethereum network id. |
+
+**Returns:** *`KosuDeploymentReceipts`*
+
+The deployment receipts for the Kosu contracts.
diff --git a/packages/kosu-docs/docs/kosu-migrations/README.md b/packages/kosu-docs/docs/kosu-migrations/README.md
@@ -0,0 +1,81 @@
+# Kosu Migrations
+
+This repository contains the migrations necessary to initialize the Kosu contract system.
+
+These contracts are **under active development and may change extensively at any time**.
+
+## kosu-migrate cli utility
+
+The `kosu-migrate` utility is included as a binary to the packages.
+
+```
+Options:
+  --version            Show version number                             [boolean]
+  --rpc-url            Full RPC url  [string] [default: "http://localhost:8545"]
+  --force-fresh        Ensure the deploying address has no previous network
+                       transactions                                    [boolean]
+  --bond-tokens, -b    Bond tokens for available addresses             [boolean]
+  --rpc-bond           Bond tokens for all available unlocked addresses in the
+                       provided rpc-url                                [boolean]
+  --bond-only          Skip migrations and bond tokens                 [boolean]
+  --ether-to-bond, -e  Value in ether to bond for all available addresses
+                       (addresses with insufficient balance are skipped)
+                                                          [number] [default: 60]
+  -h, --help           Show help                                       [boolean]
+
+```
+
+## Deployed addresses
+
+Below are the deployed addresses for the core Kosu protocol contract system on the Ropsten test network, as well as an internal test network.
+
+### Ropsten
+
+-   **Network ID:** 3
+-   **ETHNET URL:** `https://ropsten.infura.io`
+
+| Contract Name                                                                                    | Last Deploy Date | Deployed Address                                                                                                              |
+| ------------------------------------------------------------------------------------------------ | ---------------- | ----------------------------------------------------------------------------------------------------------------------------- |
+| [OrderGateway](../kosu-system-contracts/contracts/external/OrderGateway.sol)                     | 09/12/19         | [0xe3c53988b77c2b3fd2b847719743bdb6e1e66843](https://ropsten.etherscan.io/address/0xe3c53988b77c2b3fd2b847719743bdb6e1e66843) |
+| [AuthorizedAddresses](../kosu-system-contracts/contracts/access_control/AuthorizedAddresses.sol) | 09/12/19         | [0x93b79200cd23841371024427c39c5e4cd19957c9](https://ropsten.etherscan.io/address/0x93b79200cd23841371024427c39c5e4cd19957c9) |
+| [EventEmitter](../kosu-system-contracts/contracts/event/EventEmitter.sol)                        | 09/12/19         | [0xd55dfe66deccbfdcd462098c6bda59666fd9dafe](https://ropsten.etherscan.io/address/0xd55dfe66deccbfdcd462098c6bda59666fd9dafe) |
+| [KosuToken](../kosu-system-contracts/contracts/lib/KosuToken.sol)                                | 09/12/19         | [0x47f3bbc35acd3f8c5b2b8948c39f23f3c6e21f5a](https://ropsten.etherscan.io/address/0x47f3bbc35acd3f8c5b2b8948c39f23f3c6e21f5a) |
+| [Treasury](../kosu-system-contracts/contracts/treasury/Treasury.sol)                             | 09/12/19         | [0x3a1d181217a5dad549d398a1c17490daecdda3b4](https://ropsten.etherscan.io/address/0x3a1d181217a5dad549d398a1c17490daecdda3b4) |
+| [Voting](../kosu-system-contracts/contracts/voting/Voting.sol)                                   | 09/12/19         | [0x2442336571bb044f8793fcdff0d46f65d278e376](https://ropsten.etherscan.io/address/0x2442336571bb044f8793fcdff0d46f65d278e376) |
+| [PosterRegistry](../kosu-system-contracts/contracts/poster/PosterRegistry.sol)                   | 09/12/19         | [0x510733f64b49a502c75e57c9f63bd8c9f49b542c](https://ropsten.etherscan.io/address/0x510733f64b49a502c75e57c9f63bd8c9f49b542c) |
+| [ValidatorRegistry](../kosu-system-contracts/contracts/validator/ValidatorRegistry.sol)          | 09/12/19         | [0xf12a3c3728d86fcbe02d34a5dbf4bb3c7dd90351](https://ropsten.etherscan.io/address/0xf12a3c3728d86fcbe02d34a5dbf4bb3c7dd90351) |
+| [ZeroExV2SubContract](../kosu-system-contracts/contracts/sub-contracts/ZeroExV2SubContract.sol)  | 09/12/19         | [0xb395b261f8256c91c143ef3f74c014def1de1f39](https://ropsten.etherscan.io/address/0xb395b261f8256c91c143ef3f74c014def1de1f39) |
+
+### Kosu Dev PoA
+
+-   **Network ID:** 6174
+-   **ETHNET URL:** `https://ethnet.zaidan.io/kosu`
+
+| Contract Name                                                                                    | Last Deploy Date | Deployed Address                           |
+| ------------------------------------------------------------------------------------------------ | ---------------- | ------------------------------------------ |
+| [OrderGateway](../kosu-system-contracts/contracts/external/OrderGateway.sol)                     | 09/17/19         | 0xb8fda6341f80cbae987ab5cd00dce502097e3152 |
+| [AuthorizedAddresses](../kosu-system-contracts/contracts/access_control/AuthorizedAddresses.sol) | 09/17/19         | 0xe473109cb41c773fd2fe01e83c6e51356f9585d6 |
+| [EventEmitter](../kosu-system-contracts/contracts/event/EventEmitter.sol)                        | 09/17/19         | 0x2f3afeff0914f33769cdfbf3fcf870c33b26c311 |
+| [KosuToken](../kosu-system-contracts/contracts/lib/KosuToken.sol)                                | 09/17/19         | 0xcc868306d6188b2b12757a7c3926042b4d3c4e29 |
+| [Treasury](../kosu-system-contracts/contracts/treasury/Treasury.sol)                             | 09/17/19         | 0x46572f9082dd2429c2c138fa9483a67d4f29d423 |
+| [Voting](../kosu-system-contracts/contracts/voting/Voting.sol)                                   | 09/17/19         | 0x5d60c93d8b48682cd387c8be7e9461b67ecfbea1 |
+| [PosterRegistry](../kosu-system-contracts/contracts/poster/PosterRegistry.sol)                   | 09/17/19         | 0x7e6534b8205713246e91a14b462d2dbcac3ede17 |
+| [ValidatorRegistry](../kosu-system-contracts/contracts/validator/ValidatorRegistry.sol)          | 09/17/19         | 0x301bb008f2a8a3cae9918743fe43428551392773 |
+| [ZeroExV2SubContract](../kosu-system-contracts/contracts/sub-contracts/ZeroExV2SubContract.sol)  | 09/17/19         | 0x0265e7d1b094787cb13174e18a1cefc41279a6c9 |
+
+### Kosu CI Test
+
+-   **Network ID:** 6175
+-   **ETHNET URL:** `http://kosu-geth:8545`
+
+| Contract Name                                                                                    | Last Deploy Date | Deployed Address                           |
+| ------------------------------------------------------------------------------------------------ | ---------------- | ------------------------------------------ |
+| [OrderGateway](../kosu-system-contracts/contracts/external/OrderGateway.sol)                     | 09/17/19         | 0xb8fda6341f80cbae987ab5cd00dce502097e3152 |
+| [AuthorizedAddresses](../kosu-system-contracts/contracts/access_control/AuthorizedAddresses.sol) | 09/17/19         | 0xe473109cb41c773fd2fe01e83c6e51356f9585d6 |
+| [EventEmitter](../kosu-system-contracts/contracts/event/EventEmitter.sol)                        | 09/17/19         | 0x2f3afeff0914f33769cdfbf3fcf870c33b26c311 |
+| [KosuToken](../kosu-system-contracts/contracts/lib/KosuToken.sol)                                | 09/17/19         | 0xcc868306d6188b2b12757a7c3926042b4d3c4e29 |
+| [Treasury](../kosu-system-contracts/contracts/treasury/Treasury.sol)                             | 09/17/19         | 0x46572f9082dd2429c2c138fa9483a67d4f29d423 |
+| [Voting](../kosu-system-contracts/contracts/voting/Voting.sol)                                   | 09/17/19         | 0x5d60c93d8b48682cd387c8be7e9461b67ecfbea1 |
+| [PosterRegistry](../kosu-system-contracts/contracts/poster/PosterRegistry.sol)                   | 09/17/19         | 0x7e6534b8205713246e91a14b462d2dbcac3ede17 |
+| [ValidatorRegistry](../kosu-system-contracts/contracts/validator/ValidatorRegistry.sol)          | 09/17/19         | 0x301bb008f2a8a3cae9918743fe43428551392773 |
+| [ZeroExV2SubContract](../kosu-system-contracts/contracts/sub-contracts/ZeroExV2SubContract.sol)  | 09/17/19         | 0x0265e7d1b094787cb13174e18a1cefc41279a6c9 |