diff --git a/README.md b/README.md index db605e7ea..b3fa95e37 100644 --- a/README.md +++ b/README.md @@ -32,36 +32,47 @@ Documentation for Kosu packages is available in this repository, and hosted at [ ### Contract packages -Smart-contract packages (Solidity) including the core Kosu system contracts and SubContract SDK. +Smart-contract packages (Solidity) including the core Kosu system contracts and SubContract SDK and contract test suite. -| Package             | Version | Description | -| :----------------------------------------------------------- | :-------------------------------------------------------------- | :--------------------------------------------------------------------- | -| [`@kosu/system-contracts`](./packages/kosu-system-contracts) | ![npm](https://img.shields.io/npm/v/@kosu/system-contracts.svg) | The core Kosu contract system and test suite, implemented in Solidity. | -| [`@kosu/subcontract-sdk`](./packages/kosu-sdk-contracts) | ![npm](https://img.shields.io/npm/v/@kosu/subcontract-sdk.svg) | The Kosu `SubContract` interface and example implementations. | +| Package             | Version | Description | +| :----------------------------------------------------------- | :-------------------------------------------------------------- | :----------------------------------------------------------------------- | +| [`@kosu/system-contracts`](./packages/kosu-system-contracts) | ![npm](https://img.shields.io/npm/v/@kosu/system-contracts.svg) | The core Kosu contract system in Solidity (with low-level wrappers). | +| [`@kosu/solidity-tests`](./packages/kosu-system-contracts) | ![npm](https://img.shields.io/npm/v/@kosu/solidity-tests.svg) | TypeScript test suite for the Kosu contract system. | +| [`@kosu/subcontract-sdk`](./packages/kosu-sdk-contracts) | ![npm](https://img.shields.io/npm/v/@kosu/subcontract-sdk.svg) | The Kosu `SubContract` interface and example implementations. | +| [`@kosu/migrations`](./packages/kosu-migrations) | ![npm](https://img.shields.io/npm/v/@kosu/migrations.svg) | Scripts and utilities for deploying Kosu contracts to Ethereum networks. | ### Client packages +Kosu network clients (currently, only [`go-kosu`](./packages/go-kosu)). Includes validator implementation, full/light node's, CLI, and JSONRPC server. + | Package | Version | Description | | :------------------------------ | :---------------------------------------------------------- | :-------------------------------------------------------------------------------- | -| [`go-kosu`](./packages/go-kosu) | ![version](https://img.shields.io/badge/version-0.1.2-blue) | The reference implementation of the Kosu network in Go, built on Tendermint Core. | +| [`go-kosu`](./packages/go-kosu) | ![version](https://img.shields.io/badge/version-0.4.0-blue) | The reference implementation of the Kosu network in Go, built on Tendermint Core. | ### Library packages Client/server libraries for interacting with the Kosu network and contract system. -| Package             | Version | Description | -| :------------------------------------------------- | :--------------------------------------------------------- | :---------------------------------------------------------------------------- | -| [`@kosu/kosu.js`](./packages/kosu.js) | ![npm](https://img.shields.io/npm/v/@kosu/kosu.js.svg) | TypeScript library for interacting with the Kosu network and contract system. | -| [`@kosu/genesis-cli`](./packages/kosu-genesis-cli) | ![npm](https://img.shields.io/npm/v/@kosu/genesis-cli.svg) | Library and CLI for generating network genesis files from contract sate. | +| Package             | Version | Description | +| :--------------------------------------------------------- | :-------------------------------------------------------------- | :------------------------------------------------------------------------- | +| [`@kosu/kosu.js`](./packages/kosu.js) | ![npm](https://img.shields.io/npm/v/@kosu/kosu.js.svg) | Exports all Kosu helper classes, utility functions, and contract wrappers. | +| [`@kosu/node-client`](./packages/kosu-node-client-kosu) | ![npm](https://img.shields.io/npm/v/@kosu/node-client.svg) | TypeScript client for interacting with a Kosu node over JSONRPC. | +| [`@kosu/genesis-cli`](./packages/kosu-genesis-cli) | ![npm](https://img.shields.io/npm/v/@kosu/genesis-cli.svg) | Library and CLI for generating network genesis files from contract sate. | +| [`@kosu/contract-utils`](./packages/kosu-contract-utils) | ![npm](https://img.shields.io/npm/v/@kosu/contract-utils.svg) | Utilities for interacting with Kosu (decoding event logs, etc.). | +| [`@kosu/contract-helpers`](./packages/kosu-contract-utils) | ![npm](https://img.shields.io/npm/v/@kosu/contract-helpers.svg) | High-level convenience wrappers for interacting with Kosu contracts. | ### Utility/development packages -| Package             | Version | Description | -| :------------------------------------------------ | :----------------------------------------------------------- | :------------------------------------------------------------------- | -| [`@kosu/dev-images`](./packages/dev-images) | ![npm](https://img.shields.io/npm/v/@kosu/dev-images.svg) | Development docker images and supporting scripts for Kosu packages. | -| [`@kosu/tslint-config`](./packages/tslint-config) | ![npm](https://img.shields.io/npm/v/@kosu/tslint-config.svg) | TypeScript linter base configuration for Kosu TypeScript projects. | -| [`@kosu/tsc-config`](./packages/tsc-config) | ![npm](https://img.shields.io/npm/v/@kosu/tsc-config.svg) | TypeScript compiler base configuration for Kosu TypeScript projects. | -| [`@kosu/web-helpers`](./packages/web-helpers) | ![npm](https://img.shields.io/npm/v/@kosu/web-helpers.svg) | Simple web interface for interacting with the Kosu contract system. | +| Package             | Version | Description | +| :--------------------------------------------------------------- | :---------------------------------------------------------------- | :------------------------------------------------------------------- | +| [`@kosu/deployed-addresses`](./packages/kosu-deployed-addresses) | ![npm](https://img.shields.io/npm/v/@kosu/deployed-addresses.svg) | Kosu contract addresses for various Ethereum networks. | +| [`@kosu/test-helpers`](./packages/kosu-test-helpers) | ![npm](https://img.shields.io/npm/v/@kosu/test-helpers.svg) | Helpful utilities for testing building Kosu contract-related tests. | +| [`@kosu/types`](./packages/kosu-types) | ![npm](https://img.shields.io/npm/v/@kosu/types.svg) | TypeScript type definitions for Kosu projects. | +| [`@kosu/dev-images`](./packages/dev-images) | ![npm](https://img.shields.io/npm/v/@kosu/dev-images.svg) | Development docker images and supporting scripts for Kosu packages. | +| [`@kosu/kosu-geth`](./packages/kosu-geth) | ![version](https://img.shields.io/badge/version-0.1.1-blue) | Geth PoA configuration for private Kosu test networks (CI, etc.). | +| [`@kosu/tslint-config`](./packages/tslint-config) | ![npm](https://img.shields.io/npm/v/@kosu/tslint-config.svg) | TypeScript linter base configuration for Kosu TypeScript projects. | +| [`@kosu/tsc-config`](./packages/tsc-config) | ![npm](https://img.shields.io/npm/v/@kosu/tsc-config.svg) | TypeScript compiler base configuration for Kosu TypeScript projects. | +| [`@kosu/web-helpers`](./packages/web-helpers) | ![npm](https://img.shields.io/npm/v/@kosu/web-helpers.svg) | Simple web interface for interacting with the Kosu contract system. | ## Install Instructions @@ -91,7 +102,7 @@ This will also install Node.js if it is not already installed. brew install yarn ``` -#### Geth tools +#### Ethereum tools To install the `go-ethereum` suite with `brew`: @@ -100,7 +111,7 @@ brew tap ethereum/ethereum brew install ethereum ``` -#### Jq +#### Jq (JSON query) To install `jq` (JSON parsing binary): diff --git a/packages/go-kosu/package.json b/packages/go-kosu/package.json index 5d0b4f55d..fb8db22be 100644 --- a/packages/go-kosu/package.json +++ b/packages/go-kosu/package.json @@ -1,7 +1,7 @@ { "name": "@kosu/go-kosu", "private": true, - "version": "v0.4.0", + "version": "0.4.0", "description": "Package file used to configure go-kosu builds with up-to-date contract addresses", "repository": "https://github.com/ParadigmFoundation/kosu-monorepo/blob/master/packages/go-kosu", "license": "MIT",