From d7e4261b2146bd1c8a241e08af16e035a3f1d759 Mon Sep 17 00:00:00 2001 From: Henry Harder Date: Mon, 14 Oct 2019 15:14:09 -0700 Subject: [PATCH 1/4] update packages that don't need docs scripts --- packages/kosu-solidity-tests/package.json | 3 +-- packages/kosu.js/package.json | 7 ++----- 2 files changed, 3 insertions(+), 7 deletions(-) diff --git a/packages/kosu-solidity-tests/package.json b/packages/kosu-solidity-tests/package.json index c8d990bc2..182fea073 100644 --- a/packages/kosu-solidity-tests/package.json +++ b/packages/kosu-solidity-tests/package.json @@ -15,8 +15,7 @@ "clean": "shx rm -rf dist/", "contracts:test:ci": "ts-mocha -p tsconfig.json test/* --slow 2000 --timeout 0 -b -- geth", "coverage": "ts-mocha -p tsconfig.json test/* --slow 2000 --timeout 100000 -- runCoverage && istanbul report html && open coverage/index.html", - "lint": "tslint -p .", - "docs": "node scripts/devdoc.js ./generated-artifacts ./docs" + "lint": "tslint -p ." }, "config": { "kosu_ganache_image": "gcr.io/kosu-io/kosu-ganache", diff --git a/packages/kosu.js/package.json b/packages/kosu.js/package.json index afeb7b62d..32f47389a 100644 --- a/packages/kosu.js/package.json +++ b/packages/kosu.js/package.json @@ -8,8 +8,7 @@ "build": "tsc", "clean": "shx rm -rf dist/", "lint": "tslint -p .", - "lint:fix": "tslint -p . --fix", - "docs": "typedoc ./src" + "lint:fix": "tslint -p . --fix" }, "repository": { "type": "git", @@ -36,9 +35,7 @@ "simple-mock": "^0.8.0", "source-map-support": "^0.5.12", "ts-mocha": "^6.0.0", - "ts-node": "^8.1.0", - "typedoc": "^0.14.2", - "typedoc-plugin-markdown": "^2.0.1" + "ts-node": "^8.1.0" }, "publishConfig": { "access": "public" From 05f11d378796c6fe73241b04e0f5f4f3c7bcfa43 Mon Sep 17 00:00:00 2001 From: Henry Harder Date: Mon, 14 Oct 2019 15:14:20 -0700 Subject: [PATCH 2/4] update CD docs steps --- cloudbuild/main.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cloudbuild/main.yaml b/cloudbuild/main.yaml index 2e446e688..b9dda0b4d 100644 --- a/cloudbuild/main.yaml +++ b/cloudbuild/main.yaml @@ -31,8 +31,8 @@ steps: "-m", "rsync", "-r", "-c", "-d", - "./packages/kosu.js/docs", - "gs://kosu-docs/kosu.js" + "./packages/kosu-contract-helpers/docs", + "gs://kosu-docs/kosu-contract-helpers" ] - name: "gcr.io/cloud-builders/gsutil" From ddabdf0990313d2fb94e508218e1b89375930e39 Mon Sep 17 00:00:00 2001 From: Henry Harder Date: Mon, 14 Oct 2019 15:15:10 -0700 Subject: [PATCH 3/4] update docs site config --- packages/kosu-docs/docs/.vuepress/config.js | 22 ++++++++++----------- packages/kosu-docs/load.sh | 3 ++- 2 files changed, 13 insertions(+), 12 deletions(-) diff --git a/packages/kosu-docs/docs/.vuepress/config.js b/packages/kosu-docs/docs/.vuepress/config.js index 0ec5379f4..97ec2732e 100644 --- a/packages/kosu-docs/docs/.vuepress/config.js +++ b/packages/kosu-docs/docs/.vuepress/config.js @@ -48,17 +48,17 @@ module.exports = { collapsable: true, food: "2.svg", children: [ - "./kosu.js/", - "./kosu.js/classes/kosu", - "./kosu.js/classes/kosutoken", - "./kosu.js/classes/eventemitter", - "./kosu.js/classes/nodeclient", - "./kosu.js/classes/ordergateway", - "./kosu.js/classes/orderhelper", - "./kosu.js/classes/posterregistry", - "./kosu.js/classes/treasury", - "./kosu.js/classes/validatorregistry", - "./kosu.js/classes/voting", + "./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", + "./kosu-contract-helpers/classes/treasury", + "./kosu-contract-helpers/classes/validatorregistry", + "./kosu-contract-helpers/classes/voting", ], }, { diff --git a/packages/kosu-docs/load.sh b/packages/kosu-docs/load.sh index debee099e..5b37c6dc0 100755 --- a/packages/kosu-docs/load.sh +++ b/packages/kosu-docs/load.sh @@ -36,7 +36,8 @@ fi # load latest built docs from public kosu storage log "$LOADING_DOCS" -gsutil -m rsync -r -c -d gs://kosu-docs/kosu.js ./docs/kosu.js +gsutil -m rsync -r -c -d gs://kosu-docs/kosu-genesis-cli ./docs/kosu-genesis-cli +gsutil -m rsync -r -c -d gs://kosu-docs/kosu-contract-helpers ./docs/kosu-contract-helpers gsutil -m rsync -r -c -d gs://kosu-docs/kosu-system-contracts ./docs/kosu-system-contracts gsutil -m rsync -r -c -d gs://kosu-docs/go-kosu ./docs/go-kosu From dc34daaa0c00300cd3be96942d8c5395c003e0ee Mon Sep 17 00:00:00 2001 From: Henry Harder Date: Mon, 14 Oct 2019 15:16:57 -0700 Subject: [PATCH 4/4] docs: regenerate and update --- .../docs/classes/eventemitter.md | 16 +- .../docs/classes/kosu.md | 50 +-- .../docs/classes/kosutoken.md | 32 +- .../docs/classes/nodeclient.md | 46 +-- .../docs/classes/ordergateway.md | 44 +- .../docs/classes/orderhelper.md | 76 ++-- .../docs/classes/posterregistry.md | 22 +- .../docs/classes/treasury.md | 28 +- .../docs/classes/validatorregistry.md | 66 +-- .../docs/classes/voting.md | 26 +- .../kosu-contract-helpers/docs/globals.md | 187 ++------- .../docs/interfaces/decodedkosulogargs.md | 9 - .../docs/interfaces/kosuoptions.md | 122 ------ .../docs/interfaces/kosuutils.md | 43 -- .../docs/interfaces/logwithdecodedkosuargs.md | 49 --- .../docs/interfaces/order.md | 90 ----- .../docs/interfaces/orderargument.md | 32 -- .../docs/interfaces/orderrejectioninfo.md | 32 -- .../docs/interfaces/ordervalidationresult.md | 32 -- .../docs/interfaces/postableorder.md | 113 ------ .../docs/interfaces/poster.md | 32 -- .../docs/interfaces/roundinfo.md | 50 --- .../docs/interfaces/takeableorder.md | 104 ----- .../docs/interfaces/validator.md | 95 ----- .../README.md | 0 .../classes/eventemitter.md | 16 +- .../classes/kosu.md | 50 +-- .../classes/kosutoken.md | 32 +- .../classes/nodeclient.md | 46 +-- .../classes/ordergateway.md | 44 +- .../classes/orderhelper.md | 191 +++++++++ .../classes/posterregistry.md | 22 +- .../classes/treasury.md | 28 +- .../classes/validatorregistry.md | 66 +-- .../classes/voting.md | 26 +- .../docs/kosu-contract-helpers/globals.md | 277 +++++++++++++ .../kosu-docs/docs/kosu-genesis-cli/README.md | 1 + .../docs/kosu-genesis-cli/globals.md | 22 +- .../kosu-genesis-cli/interfaces/appstate.md | 8 +- .../interfaces/consensusparams.md | 19 +- .../interfaces/genesisblock.md | 10 +- .../interfaces/genesisvalidator.md | 14 +- .../interfaces/initialvalidatorinfo.md | 6 +- .../interfaces/snapshotlisting.md | 12 +- .../interfaces/snapshotposter.md | 14 +- .../interfaces/snapshotvalidator.md | 10 +- .../PosterRegistryProxy.md | 99 ----- .../docs/kosu-system-contracts/README.md | 41 -- .../docs/kosu.js/classes/orderhelper.md | 191 --------- packages/kosu-docs/docs/kosu.js/globals.md | 378 ------------------ .../kosu.js/interfaces/decodedkosulogargs.md | 9 - .../docs/kosu.js/interfaces/kosuoptions.md | 122 ------ .../docs/kosu.js/interfaces/kosuutils.md | 43 -- .../interfaces/logwithdecodedkosuargs.md | 49 --- .../docs/kosu.js/interfaces/order.md | 90 ----- .../docs/kosu.js/interfaces/orderargument.md | 32 -- .../kosu.js/interfaces/orderrejectioninfo.md | 32 -- .../interfaces/ordervalidationresult.md | 32 -- .../docs/kosu.js/interfaces/postableorder.md | 113 ------ .../docs/kosu.js/interfaces/poster.md | 32 -- .../docs/kosu.js/interfaces/roundinfo.md | 50 --- .../docs/kosu.js/interfaces/takeableorder.md | 104 ----- .../docs/kosu.js/interfaces/validator.md | 95 ----- packages/kosu-genesis-cli/docs/globals.md | 22 +- .../docs/interfaces/appstate.md | 8 +- .../docs/interfaces/consensusparams.md | 12 +- .../docs/interfaces/genesisblock.md | 10 +- .../docs/interfaces/genesisvalidator.md | 8 +- .../docs/interfaces/initialvalidatorinfo.md | 6 +- .../docs/interfaces/snapshotlisting.md | 10 +- .../docs/interfaces/snapshotposter.md | 4 +- .../docs/interfaces/snapshotvalidator.md | 10 +- .../kosu-system-contracts/docs/KosuToken.md | 17 - .../kosu-system-contracts/docs/Treasury.md | 31 +- .../docs/ValidatorRegistry.md | 26 +- 75 files changed, 995 insertions(+), 2991 deletions(-) delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/decodedkosulogargs.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/kosuoptions.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/kosuutils.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/logwithdecodedkosuargs.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/order.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/orderargument.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/orderrejectioninfo.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/ordervalidationresult.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/postableorder.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/poster.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/roundinfo.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/takeableorder.md delete mode 100644 packages/kosu-contract-helpers/docs/interfaces/validator.md rename packages/kosu-docs/docs/{kosu.js => kosu-contract-helpers}/README.md (100%) rename packages/kosu-docs/docs/{kosu.js => kosu-contract-helpers}/classes/eventemitter.md (69%) rename packages/kosu-docs/docs/{kosu.js => kosu-contract-helpers}/classes/kosu.md (65%) rename packages/kosu-docs/docs/{kosu.js => kosu-contract-helpers}/classes/kosutoken.md (77%) rename packages/kosu-docs/docs/{kosu.js => kosu-contract-helpers}/classes/nodeclient.md (77%) rename packages/kosu-docs/docs/{kosu.js => kosu-contract-helpers}/classes/ordergateway.md (50%) create mode 100644 packages/kosu-docs/docs/kosu-contract-helpers/classes/orderhelper.md rename packages/kosu-docs/docs/{kosu.js => kosu-contract-helpers}/classes/posterregistry.md (69%) rename packages/kosu-docs/docs/{kosu.js => kosu-contract-helpers}/classes/treasury.md (76%) rename packages/kosu-docs/docs/{kosu.js => kosu-contract-helpers}/classes/validatorregistry.md (66%) rename packages/kosu-docs/docs/{kosu.js => kosu-contract-helpers}/classes/voting.md (72%) create mode 100644 packages/kosu-docs/docs/kosu-contract-helpers/globals.md delete mode 100644 packages/kosu-docs/docs/kosu-system-contracts/PosterRegistryProxy.md delete mode 100644 packages/kosu-docs/docs/kosu-system-contracts/README.md delete mode 100644 packages/kosu-docs/docs/kosu.js/classes/orderhelper.md delete mode 100644 packages/kosu-docs/docs/kosu.js/globals.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/decodedkosulogargs.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/kosuoptions.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/kosuutils.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/logwithdecodedkosuargs.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/order.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/orderargument.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/orderrejectioninfo.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/ordervalidationresult.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/postableorder.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/poster.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/roundinfo.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/takeableorder.md delete mode 100644 packages/kosu-docs/docs/kosu.js/interfaces/validator.md diff --git a/packages/kosu-contract-helpers/docs/classes/eventemitter.md b/packages/kosu-contract-helpers/docs/classes/eventemitter.md index 8e17d1a38..ed3ccc1e1 100644 --- a/packages/kosu-contract-helpers/docs/classes/eventemitter.md +++ b/packages/kosu-contract-helpers/docs/classes/eventemitter.md @@ -28,17 +28,17 @@ to subscribe to future events. ### constructor -\+ **new EventEmitter**(`options`: [KosuOptions](../interfaces/kosuoptions.md)): _[EventEmitter](eventemitter.md)_ +\+ **new EventEmitter**(`options`: `KosuOptions`): _[EventEmitter](eventemitter.md)_ -_Defined in [EventEmitter.ts:47](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L47)_ +_Defined in [EventEmitter.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L49)_ Create a new `EventEmitter` instance. **Parameters:** -| Name | Type | Description | -| --------- | ------------------------------------------- | --------------------------------------------------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | Options object with `web3Wrapper` and optional `eventEmitterAddress`. | +| Name | Type | Description | +| --------- | ------------- | --------------------------------------------------------------------- | +| `options` | `KosuOptions` | Options object with `web3Wrapper` and optional `eventEmitterAddress`. | **Returns:** _[EventEmitter](eventemitter.md)_ @@ -48,7 +48,7 @@ Create a new `EventEmitter` instance. ▸ **getAddress**(): _`Promise`_ -_Defined in [EventEmitter.ts:63](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L63)_ +_Defined in [EventEmitter.ts:65](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L65)_ Return the address of the configured deployed contract. If not already cached, will return the deployed address for the detected network ID (if available). @@ -61,7 +61,7 @@ will return the deployed address for the detected network ID (if available). ▸ **getFutureDecodedLogs**(`start`: number, `callback`: function): _`Timeout`_ -_Defined in [EventEmitter.ts:109](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L109)_ +_Defined in [EventEmitter.ts:111](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L111)_ **`todo`** document better (and confirm) @@ -91,7 +91,7 @@ A callback function to be called on an array of each new event log. ▸ **getPastDecodedLogs**(`config`: `FilterObject`): _`Promise>>`_ -_Defined in [EventEmitter.ts:82](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L82)_ +_Defined in [EventEmitter.ts:84](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L84)_ Get all past decoded logs from the Kosu `EventEmitter` contract, with the oldest event at position 0. diff --git a/packages/kosu-contract-helpers/docs/classes/kosu.md b/packages/kosu-contract-helpers/docs/classes/kosu.md index c468c3c08..784bc6853 100644 --- a/packages/kosu-contract-helpers/docs/classes/kosu.md +++ b/packages/kosu-contract-helpers/docs/classes/kosu.md @@ -28,7 +28,6 @@ contracts. ### Properties -- [Signature](kosu.md#signature) - [eventEmitter](kosu.md#eventemitter) - [kosuToken](kosu.md#kosutoken) - [node](kosu.md#node) @@ -47,9 +46,9 @@ contracts. ### constructor -\+ **new Kosu**(`options`: [KosuOptions](../interfaces/kosuoptions.md)): _[Kosu](kosu.md)_ +\+ **new Kosu**(`options`: `KosuOptions`): _[Kosu](kosu.md)_ -_Defined in [Kosu.ts:137](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L137)_ +_Defined in [Kosu.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L132)_ Create a new `kosu` instance and instantiate wrappers for each Kosu system contract. @@ -61,30 +60,19 @@ of transactions and generation of signatures will not be possible. **Parameters:** -| Name | Type | Description | -| --------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | An options object used to configure `kosu` and the configured contract instances. A custom `provider` may be supplied. | +| Name | Type | Description | +| --------- | ------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `options` | `KosuOptions` | An options object used to configure `kosu` and the configured contract instances. A custom `provider` may be supplied. | **Returns:** _[Kosu](kosu.md)_ ## Properties -### Signature - -• **Signature**: _`Signature`_ - -_Defined in [Kosu.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L132)_ - -Utilities for generating and recovering signatures for use within the -Kosu system. - ---- - ### eventEmitter • **eventEmitter**: _[EventEmitter](eventemitter.md)_ -_Defined in [Kosu.ts:118](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L118)_ +_Defined in [Kosu.ts:119](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L119)_ The `eventEmitter` enables the query of and subscription to decoded event logs from the Kosu `EventEmitter` contract. @@ -95,7 +83,7 @@ logs from the Kosu `EventEmitter` contract. • **kosuToken**: _[KosuToken](kosutoken.md)_ -_Defined in [Kosu.ts:83](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L83)_ +_Defined in [Kosu.ts:84](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L84)_ The `kosuToken` provides methods for interacting with the KOSU ERC-20 token. @@ -105,7 +93,7 @@ The `kosuToken` provides methods for interacting with the KOSU ERC-20 token. • **node**: _[NodeClient](nodeclient.md)_ -_Defined in [Kosu.ts:58](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L58)_ +_Defined in [Kosu.ts:59](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L59)_ A JSONRPC client for a Kosu node, enabled if a `kosuNodeUrl` is provided to the Kosu constructor (as part of the options object). @@ -118,7 +106,7 @@ Enables access to the `go-kosu` JSONRPC-API, including subscriptions. • **orderGateway**: _[OrderGateway](ordergateway.md)_ -_Defined in [Kosu.ts:70](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L70)_ +_Defined in [Kosu.ts:71](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L71)_ The `orderGateway` instance provides access to the `OrderGateway` contract which is used to direct settlement of orders to their corresponding @@ -133,7 +121,7 @@ type, based on a `SubContract` address. • **orderHelper**: _[OrderHelper](orderhelper.md)_ -_Defined in [Kosu.ts:78](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L78)_ +_Defined in [Kosu.ts:79](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L79)_ The `orderHelper` instance provides methods for generating and signing maker orders, signing orders for submission to the Kosu network, and @@ -146,7 +134,7 @@ submitting orders for settlement on the Ethereum blockchain via the • **posterRegistry**: _[PosterRegistry](posterregistry.md)_ -_Defined in [Kosu.ts:103](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L103)_ +_Defined in [Kosu.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L104)_ The `posterRegistry` instance enables users to interact with the Kosu `PosterRegistry` contract to bond and un-bond KOSU tokens to access the @@ -158,7 +146,7 @@ order relay feature of the Kosu network. • **treasury**: _[Treasury](treasury.md)_ -_Defined in [Kosu.ts:89](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L89)_ +_Defined in [Kosu.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L90)_ The `treasury` instance provides access to functionality of the Kosu `Treasury` contract, such as deposits/withdrawals and allowance management. @@ -167,9 +155,9 @@ The `treasury` instance provides access to functionality of the Kosu ### utils -• **utils**: _[KosuUtils](../interfaces/kosuutils.md)_ +• **utils**: _`KosuUtils`_ -_Defined in [Kosu.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L126)_ +_Defined in [Kosu.ts:127](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L127)_ Common and helpful utility methods and constants for interacting with the Kosu contract system and Ethereum blockchain. @@ -180,7 +168,7 @@ Kosu contract system and Ethereum blockchain. • **validatorRegistry**: _[ValidatorRegistry](validatorregistry.md)_ -_Defined in [Kosu.ts:112](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L112)_ +_Defined in [Kosu.ts:113](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L113)_ The `validatorRegistry` instance enables interaction with the `ValidatorRegistry` token-curated registry system. The system enables users to submit proposals @@ -194,7 +182,7 @@ It also provides query access to past challenges and the current listings. • **version**: _string_ -_Defined in [Kosu.ts:137](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L137)_ +_Defined in [Kosu.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L132)_ The current `@kosu/kosu.js` package version. @@ -204,7 +192,7 @@ The current `@kosu/kosu.js` package version. • **voting**: _[Voting](voting.md)_ -_Defined in [Kosu.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L96)_ +_Defined in [Kosu.ts:97](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L97)_ The `voting` instance provides access to the Kosu `voting` contract and allows users to participate in voting on governance measures, and claiming @@ -216,7 +204,7 @@ rewards for correctly participating in winning polls. • **web3**: _`Web3`_ -_Defined in [Kosu.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L41)_ +_Defined in [Kosu.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L42)_ The primary `web3` instance provides access to an Ethereum node's JSONRPC API and utilities. This instance is used to interact with each Kosu contract @@ -228,7 +216,7 @@ wrapper and can be used to directly access the `web3` API. • **web3Wrapper**: _`Web3Wrapper`_ -_Defined in [Kosu.ts:48](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L48)_ +_Defined in [Kosu.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L49)_ The `web3Wrapper` is used for some extended features, and provides a higher-level API to the same underlying `web3` provider. It it used to diff --git a/packages/kosu-contract-helpers/docs/classes/kosutoken.md b/packages/kosu-contract-helpers/docs/classes/kosutoken.md index b92006eae..01f6da03b 100644 --- a/packages/kosu-contract-helpers/docs/classes/kosutoken.md +++ b/packages/kosu-contract-helpers/docs/classes/kosutoken.md @@ -39,9 +39,9 @@ If instantiated outside the `Kosu` class, an instance of `web3` and of the ### constructor -\+ **new KosuToken**(`options`: [KosuOptions](../interfaces/kosuoptions.md)): _[KosuToken](kosutoken.md)_ +\+ **new KosuToken**(`options`: `KosuOptions`): _[KosuToken](kosutoken.md)_ -_Defined in [KosuToken.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L37)_ +_Defined in [KosuToken.ts:39](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L39)_ Creates a new KosuToken instance, supplied with an options object. @@ -57,9 +57,9 @@ const kosuToken = new KosuToken(options); **Parameters:** -| Name | Type | Description | -| --------- | ------------------------------------------- | -------------------------------------------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | initialization options object (incl. `web3` and `web3wrapper`) | +| Name | Type | Description | +| --------- | ------------- | -------------------------------------------------------------- | +| `options` | `KosuOptions` | initialization options object (incl. `web3` and `web3wrapper`) | **Returns:** _[KosuToken](kosutoken.md)_ @@ -69,7 +69,7 @@ const kosuToken = new KosuToken(options); ▸ **allowance**(`owner`: string, `spender`: string): _`Promise`_ -_Defined in [KosuToken.ts:151](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L151)_ +_Defined in [KosuToken.ts:153](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L153)_ Reads approved allowance for a given `owner` and `spender` account. @@ -90,7 +90,7 @@ The allowance granted to the `spender` in units of wei. ▸ **approve**(`spender`: string, `value`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:139](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L139)_ +_Defined in [KosuToken.ts:141](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L141)_ Sets approval for user to transfer tokens on `coinbase`'s behalf. @@ -111,7 +111,7 @@ The transaction receipt after it has been included in a block. ▸ **balanceOf**(`owner`: string): _`Promise`_ -_Defined in [KosuToken.ts:102](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L102)_ +_Defined in [KosuToken.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L104)_ Reads the balance for a user address, returned in wei. @@ -131,7 +131,7 @@ The `owner`'s KOSU balance in wei. ▸ **bondTokens**(`value`: `BigNumber`, `minPayout`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:185](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L185)_ +_Defined in [KosuToken.ts:187](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L187)_ Sends ether to the contract to bond tokens. @@ -152,7 +152,7 @@ Logs from the transaction block. ▸ **estimateEtherToToken**(`etherInput`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:162](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L162)_ +_Defined in [KosuToken.ts:164](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L164)_ Calculated tokens to be minted from deposited ether. @@ -172,7 +172,7 @@ Estimation of tokens to be minted. ▸ **estimateTokenToEther**(`tokensToBurn`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:173](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L173)_ +_Defined in [KosuToken.ts:175](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L175)_ Calculates ether to be returned for burning tokens. @@ -192,7 +192,7 @@ Estimation of ether to be returned. ▸ **pay**(`value`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:209](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L209)_ +_Defined in [KosuToken.ts:211](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L211)_ Sends ether to the contract to bond tokens. @@ -212,7 +212,7 @@ Logs from the transaction block. ▸ **releaseTokens**(`tokensToBurn`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:198](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L198)_ +_Defined in [KosuToken.ts:200](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L200)_ Releases tokens to be burned and return bonded ether. @@ -232,7 +232,7 @@ Logs from the transaction block. ▸ **totalSupply**(): _`Promise`_ -_Defined in [KosuToken.ts:91](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L91)_ +_Defined in [KosuToken.ts:93](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L93)_ Reads the total supply of KOSU, resolves to a `BigNumber` of the amount of tokens in units of wei. @@ -247,7 +247,7 @@ The total KOSU supply in wei. ▸ **transfer**(`to`: string, `value`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:114](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L114)_ +_Defined in [KosuToken.ts:116](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L116)_ Transfers tokens to an address, from the current `coinbase` account. @@ -268,7 +268,7 @@ The transaction's receipt after inclusion in a block. ▸ **transferFrom**(`from`: string, `to`: string, `value`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:127](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L127)_ +_Defined in [KosuToken.ts:129](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L129)_ Transfers token from an address to a destination address. diff --git a/packages/kosu-contract-helpers/docs/classes/nodeclient.md b/packages/kosu-contract-helpers/docs/classes/nodeclient.md index 8220d0a1e..81dba300d 100644 --- a/packages/kosu-contract-helpers/docs/classes/nodeclient.md +++ b/packages/kosu-contract-helpers/docs/classes/nodeclient.md @@ -59,7 +59,7 @@ View the Kosu RPC documentation [here.](https://docs.kosu.io/go-kosu/kosu_rpc.ht \+ **new NodeClient**(`url`: string, `options?`: `WebsocketProviderOptions`): _[NodeClient](nodeclient.md)_ -_Defined in [NodeClient.ts:69](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L69)_ +_Defined in [NodeClient.ts:70](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L70)_ Create a new NodeClient (`node`) via a connection to a Kosu node serving the Kosu JSONRPC/WebSocket. @@ -86,7 +86,7 @@ const node = new NodeClient("wss://localhost:14342", { timeout: 1000 }); ▪ **NODE_ID_HASH_OFFSET**: _number_ = 20 -_Defined in [NodeClient.ts:38](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L38)_ +_Defined in [NodeClient.ts:39](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L39)_ Kosu validator node IDs are the first 20 bytes of the SHA-256 hash of the public key. @@ -97,7 +97,7 @@ public key. ▪ **PUBLIC_KEY_LENGTH**: _number_ = 32 -_Defined in [NodeClient.ts:32](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L32)_ +_Defined in [NodeClient.ts:33](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L33)_ Kosu validator public key's are 32 bytes long. @@ -107,7 +107,7 @@ Kosu validator public key's are 32 bytes long. ▸ **addOrders**(...`orders`: any[]): _`Promise`_ -_Defined in [NodeClient.ts:101](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L101)_ +_Defined in [NodeClient.ts:102](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L102)_ See [`kosu_addOrders`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#addorders) @@ -134,7 +134,7 @@ ID's of the accepted orders. ▸ **latestHeight**(): _`Promise`_ -_Defined in [NodeClient.ts:112](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L112)_ +_Defined in [NodeClient.ts:113](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L113)_ See [`kosu_latestHeight`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#latestheight) @@ -150,7 +150,7 @@ The most recent Kosu block number. ▸ **numberPosters**(): _`Promise`_ -_Defined in [NodeClient.ts:123](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L123)_ +_Defined in [NodeClient.ts:124](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L124)_ See [`kosu_numberPosters`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#numberposters) @@ -166,7 +166,7 @@ The total number of poster accounts the node is tracking. ▸ **queryPoster**(`address`: string): _`Promise`_ -_Defined in [NodeClient.ts:135](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L135)_ +_Defined in [NodeClient.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L136)_ See [`kosu_queryPoster`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#queryposter) @@ -189,7 +189,7 @@ Balance and order limit data for the specified poster account. ▸ **queryValidator**(`nodeId`: string): _`Promise`_ -_Defined in [NodeClient.ts:156](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L156)_ +_Defined in [NodeClient.ts:157](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L157)_ See [`kosu_queryValidator`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#queryvalidator) @@ -216,7 +216,7 @@ Information about the requested validator (see `Validator`). ▸ **remainingLimit**(): _`Promise`_ -_Defined in [NodeClient.ts:173](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L173)_ +_Defined in [NodeClient.ts:174](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L174)_ See [`kosu_remainingLimit`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#remaininglimit) @@ -234,7 +234,7 @@ The unutilized order bandwidth for the current period. ▸ **roundInfo**(): _`Promise`_ -_Defined in [NodeClient.ts:185](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L185)_ +_Defined in [NodeClient.ts:186](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L186)_ See [`kosu_roundInfo`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#roundinfo) @@ -251,7 +251,7 @@ Information about the current rebalance period. ▸ **subscribeToBlocks**(`cb`: function): _`Promise`_ -_Defined in [NodeClient.ts:241](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L241)_ +_Defined in [NodeClient.ts:242](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L242)_ Read about Kosu subscriptions [here](https://docs.kosu.io/go-kosu/kosu_rpc.html#subscriptions). @@ -284,7 +284,7 @@ A UUID that can be used to cancel the new subscription (see `node.unsubscribe()` ▸ **subscribeToOrders**(`cb`: function): _`Promise`_ -_Defined in [NodeClient.ts:226](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L226)_ +_Defined in [NodeClient.ts:227](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L227)_ Read about Kosu subscriptions [here](https://docs.kosu.io/go-kosu/kosu_rpc.html#subscriptions). @@ -317,7 +317,7 @@ A UUID that can be used to cancel the new subscription (see `node.unsubscribe()` ▸ **subscribeToRebalances**(`cb`: function): _`Promise`_ -_Defined in [NodeClient.ts:256](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L256)_ +_Defined in [NodeClient.ts:257](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L257)_ Read about Kosu subscriptions [here](https://docs.kosu.io/go-kosu/kosu_rpc.html#subscriptions). @@ -332,13 +332,13 @@ information (starting block, ending block, etc.). A callback function to handle new rebalance information. -▸ (`roundInfo`: [RoundInfo](../interfaces/roundinfo.md)): _void_ +▸ (`roundInfo`: `RoundInfo`): _void_ **Parameters:** -| Name | Type | -| ----------- | --------------------------------------- | -| `roundInfo` | [RoundInfo](../interfaces/roundinfo.md) | +| Name | Type | +| ----------- | ----------- | +| `roundInfo` | `RoundInfo` | **Returns:** _`Promise`_ @@ -350,7 +350,7 @@ A UUID that can be used to cancel the new subscription (see `node.unsubscribe()` ▸ **totalOrders**(): _`Promise`_ -_Defined in [NodeClient.ts:198](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L198)_ +_Defined in [NodeClient.ts:199](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L199)_ See [`kosu_totalOrders`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#totalorders) @@ -367,7 +367,7 @@ The total number of orders posted since network genesis. ▸ **unsubscribe**(`subscriptionId`: string): _`Promise`_ -_Defined in [NodeClient.ts:265](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L265)_ +_Defined in [NodeClient.ts:266](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L266)_ Cancel an active subscription. @@ -385,7 +385,7 @@ Cancel an active subscription. ▸ **validators**(): _`Promise`_ -_Defined in [NodeClient.ts:210](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L210)_ +_Defined in [NodeClient.ts:211](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L211)_ See [`kosu_validators`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#validators) @@ -402,7 +402,7 @@ Information about all active Kosu validators (see `Validator`). ▸ **publicKeyToNodeId**(`publicKey`: string): _string_ -_Defined in [NodeClient.ts:51](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L51)_ +_Defined in [NodeClient.ts:52](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L52)_ Convert a Kosu/Tendermint public key to the corresponding node ID. @@ -424,7 +424,7 @@ The node ID (tendermint "address") for that public key. ### ▪ **DEFAULT_OPTIONS**: _object_ -_Defined in [NodeClient.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L27)_ +_Defined in [NodeClient.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L28)_ The default options specify a connection timeout of 3s, all other defaults are inherited from `WebsocketProviderOptions`. @@ -433,4 +433,4 @@ are inherited from `WebsocketProviderOptions`. • **timeout**: _number_ = 3000 -_Defined in [NodeClient.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L27)_ +_Defined in [NodeClient.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L28)_ diff --git a/packages/kosu-contract-helpers/docs/classes/ordergateway.md b/packages/kosu-contract-helpers/docs/classes/ordergateway.md index 6db0df055..d140e0abe 100644 --- a/packages/kosu-contract-helpers/docs/classes/ordergateway.md +++ b/packages/kosu-contract-helpers/docs/classes/ordergateway.md @@ -36,17 +36,17 @@ specified SubContract during serialization and signature generation. ### constructor -\+ **new OrderGateway**(`options`: [KosuOptions](../interfaces/kosuoptions.md)): _[OrderGateway](ordergateway.md)_ +\+ **new OrderGateway**(`options`: `KosuOptions`): _[OrderGateway](ordergateway.md)_ -_Defined in [OrderGateway.ts:46](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderGateway.ts#L46)_ +_Defined in [OrderGateway.ts:48](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L48)_ Create a new OrderGateway instance. **Parameters:** -| Name | Type | Description | -| --------- | ------------------------------------------- | ------------------------------------------ | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | Instantiation options (see `KosuOptions`). | +| Name | Type | Description | +| --------- | ------------- | ------------------------------------------ | +| `options` | `KosuOptions` | Instantiation options (see `KosuOptions`). | **Returns:** _[OrderGateway](ordergateway.md)_ @@ -54,18 +54,18 @@ Create a new OrderGateway instance. ### amountRemaining -▸ **amountRemaining**(`order`: [Order](../interfaces/order.md)): _`Promise`_ +▸ **amountRemaining**(`order`: `Order`): _`Promise`_ -_Defined in [OrderGateway.ts:150](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderGateway.ts#L150)_ +_Defined in [OrderGateway.ts:152](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L152)_ Checks amount of partial exchange tokens remaining, depending on the implementation of the SubContract specified in the supplied order. **Parameters:** -| Name | Type | Description | -| ------- | ------------------------------- | --------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | The Kosu order to check amount remaining for. | +| Name | Type | Description | +| ------- | ------- | --------------------------------------------- | +| `order` | `Order` | The Kosu order to check amount remaining for. | **Returns:** _`Promise`_ @@ -78,7 +78,7 @@ implementation of the `amountRemaining` method. ▸ **arguments**(`subContract`: string): _`Promise`_ -_Defined in [OrderGateway.ts:117](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderGateway.ts#L117)_ +_Defined in [OrderGateway.ts:119](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L119)_ Read the required arguments from a deployed SubContract. @@ -96,17 +96,17 @@ The JSON array that defines the arguments for the SubContract. ### isValid -▸ **isValid**(`order`: [Order](../interfaces/order.md)): _`Promise`_ +▸ **isValid**(`order`: `Order`): _`Promise`_ -_Defined in [OrderGateway.ts:134](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderGateway.ts#L134)_ +_Defined in [OrderGateway.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L136)_ Checks validity of order data according the order's SubContract implementation. **Parameters:** -| Name | Type | Description | -| ------- | ------------------------------- | -------------------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | Kosu order to validate against `isValid` implementation. | +| Name | Type | Description | +| ------- | ------- | -------------------------------------------------------- | +| `order` | `Order` | Kosu order to validate against `isValid` implementation. | **Returns:** _`Promise`_ @@ -114,9 +114,9 @@ Checks validity of order data according the order's SubContract implementation. ### participate -▸ **participate**(`order`: [Order](../interfaces/order.md), `taker`: string): _`Promise`_ +▸ **participate**(`order`: `Order`, `taker`: string): _`Promise`_ -_Defined in [OrderGateway.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderGateway.ts#L96)_ +_Defined in [OrderGateway.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L98)_ Participate in a trade as a taker (or on behalf of one), by submitting the maker order, and the Ethereum address of the taker. The fill transaction @@ -125,10 +125,10 @@ SubContract settlement logic. **Parameters:** -| Name | Type | Description | -| ------- | ------------------------------- | ------------------------------------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | A signed Kosu maker order object with a valid `subContract`. | -| `taker` | string | The Ethereum address of the taker (should be available through provider). | +| Name | Type | Description | +| ------- | ------- | ------------------------------------------------------------------------- | +| `order` | `Order` | A signed Kosu maker order object with a valid `subContract`. | +| `taker` | string | The Ethereum address of the taker (should be available through provider). | **Returns:** _`Promise`_ diff --git a/packages/kosu-contract-helpers/docs/classes/orderhelper.md b/packages/kosu-contract-helpers/docs/classes/orderhelper.md index 8271d5235..5e14ffd04 100644 --- a/packages/kosu-contract-helpers/docs/classes/orderhelper.md +++ b/packages/kosu-contract-helpers/docs/classes/orderhelper.md @@ -37,7 +37,7 @@ of transactions. \+ **new OrderHelper**(`web3`: `Web3`, `orderGateway`: [OrderGateway](ordergateway.md)): _[OrderHelper](orderhelper.md)_ -_Defined in [OrderHelper.ts:24](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L24)_ +_Defined in [OrderHelper.ts:25](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L25)_ Create a new `OrderHelper` instance (requires a provider via supplied `web3` instance). @@ -55,17 +55,17 @@ instance). ### makeOrder -▸ **makeOrder**(`order`: [Order](../interfaces/order.md)): _`Promise`_ +▸ **makeOrder**(`order`: `Order`): _`Promise`_ -_Defined in [OrderHelper.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L44)_ +_Defined in [OrderHelper.ts:45](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L45)_ Sign and complete a maker order (requires a pre-configured Order object). **Parameters:** -| Name | Type | Description | -| ------- | ------------------------------- | ------------------------- | -| `order` | [Order](../interfaces/order.md) | Order to sign as a maker. | +| Name | Type | Description | +| ------- | ------- | ------------------------- | +| `order` | `Order` | Order to sign as a maker. | **Returns:** _`Promise`_ @@ -75,17 +75,17 @@ The supplied maker order with an appended `makerSignature`. ### makerHex -▸ **makerHex**(`order`: [Order](../interfaces/order.md)): _`Promise`_ +▸ **makerHex**(`order`: `Order`): _`Promise`_ -_Defined in [OrderHelper.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L104)_ +_Defined in [OrderHelper.ts:105](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L105)_ Generate the maker hex (serialized `makerValues`). **Parameters:** -| Name | Type | Description | -| ------- | ------------------------------- | -------------------------- | -| `order` | [Order](../interfaces/order.md) | Order to get maker hex for | +| Name | Type | Description | +| ------- | ------- | -------------------------- | +| `order` | `Order` | Order to get maker hex for | **Returns:** _`Promise`_ @@ -93,19 +93,19 @@ Generate the maker hex (serialized `makerValues`). ### prepareForPost -▸ **prepareForPost**(`order`: [Order](../interfaces/order.md), `poster`: string): _`Promise`_ +▸ **prepareForPost**(`order`: `Order`, `poster`: string): _`Promise`_ -_Defined in [OrderHelper.ts:76](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L76)_ +_Defined in [OrderHelper.ts:77](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L77)_ Sign and order as a poster and append the poster signature to an order prior to submission to the Kosu relay network. **Parameters:** -| Name | Type | Default | Description | -| -------- | ------------------------------- | ----------- | ----------------------------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | - | Order to prepare (by appending a poster signature). | -| `poster` | string | order.maker | Poster address to sign order with, defaults to the order's maker. | +| Name | Type | Default | Description | +| -------- | ------- | ----------- | ----------------------------------------------------------------- | +| `order` | `Order` | - | Order to prepare (by appending a poster signature). | +| `poster` | string | order.maker | Poster address to sign order with, defaults to the order's maker. | **Returns:** _`Promise`_ @@ -115,17 +115,17 @@ The maker order now signed and prepared for post with an appended `posterSignatu ### recoverMaker -▸ **recoverMaker**(`order`: [Order](../interfaces/order.md)): _`Promise`_ +▸ **recoverMaker**(`order`: `Order`): _`Promise`_ -_Defined in [OrderHelper.ts:114](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L114)_ +_Defined in [OrderHelper.ts:115](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L115)_ Recover the maker address from a signed order. **Parameters:** -| Name | Type | Description | -| ------- | ------------------------------- | --------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | A signed order to recover maker address from. | +| Name | Type | Description | +| ------- | ------- | --------------------------------------------- | +| `order` | `Order` | A signed order to recover maker address from. | **Returns:** _`Promise`_ @@ -133,18 +133,18 @@ Recover the maker address from a signed order. ### recoverPoster -▸ **recoverPoster**(`order`: [PostableOrder](../interfaces/postableorder.md)): _`Promise`_ +▸ **recoverPoster**(`order`: `PostableOrder`): _`Promise`_ -_Defined in [OrderHelper.ts:125](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L125)_ +_Defined in [OrderHelper.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L126)_ Recover the poster address from a maker order that has been signed from a poster. **Parameters:** -| Name | Type | Description | -| ------- | ----------------------------------------------- | ---------------------------------------------------------- | -| `order` | [PostableOrder](../interfaces/postableorder.md) | Order to recover poster from (must be signed by a poster). | +| Name | Type | Description | +| ------- | --------------- | ---------------------------------------------------------- | +| `order` | `PostableOrder` | Order to recover poster from (must be signed by a poster). | **Returns:** _`Promise`_ @@ -152,17 +152,17 @@ poster. ### serialize -▸ **serialize**(`order`: [Order](../interfaces/order.md)): _`Promise`_ +▸ **serialize**(`order`: `Order`): _`Promise`_ -_Defined in [OrderHelper.ts:135](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L135)_ +_Defined in [OrderHelper.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L136)_ Generates the contract submission bytes from the arguments of provided order. **Parameters:** -| Name | Type | Description | -| ------- | ------------------------------- | ------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | Order to generate contract input bytes for. | +| Name | Type | Description | +| ------- | ------- | ------------------------------------------- | +| `order` | `Order` | Order to generate contract input bytes for. | **Returns:** _`Promise`_ @@ -170,9 +170,9 @@ Generates the contract submission bytes from the arguments of provided order. ### takeOrder -▸ **takeOrder**(`order`: [TakeableOrder](../interfaces/takeableorder.md), `taker`: string): _`Promise`_ +▸ **takeOrder**(`order`: `TakeableOrder`, `taker`: string): _`Promise`_ -_Defined in [OrderHelper.ts:64](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L64)_ +_Defined in [OrderHelper.ts:65](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L65)_ Take a signed maker order on the Ethereum blockchain via the order's specified SubContract, from the supplied taker address (should be available @@ -180,10 +180,10 @@ via configured `web` provider). **Parameters:** -| Name | Type | Description | -| ------- | ----------------------------------------------- | --------------------------------------------------------------------------- | -| `order` | [TakeableOrder](../interfaces/takeableorder.md) | A signed and fillable maker order object. | -| `taker` | string | The Ethereum address of the taker (must be available to sign via provider). | +| Name | Type | Description | +| ------- | --------------- | --------------------------------------------------------------------------- | +| `order` | `TakeableOrder` | A signed and fillable maker order object. | +| `taker` | string | The Ethereum address of the taker (must be available to sign via provider). | **Returns:** _`Promise`_ diff --git a/packages/kosu-contract-helpers/docs/classes/posterregistry.md b/packages/kosu-contract-helpers/docs/classes/posterregistry.md index cabf84940..b8658c2d8 100644 --- a/packages/kosu-contract-helpers/docs/classes/posterregistry.md +++ b/packages/kosu-contract-helpers/docs/classes/posterregistry.md @@ -32,18 +32,18 @@ and to view their balance, as well as the cumulative lockup. ### constructor -\+ **new PosterRegistry**(`options`: [KosuOptions](../interfaces/kosuoptions.md), `treasury`: [Treasury](treasury.md)): _[PosterRegistry](posterregistry.md)_ +\+ **new PosterRegistry**(`options`: `KosuOptions`, `treasury`: [Treasury](treasury.md)): _[PosterRegistry](posterregistry.md)_ -_Defined in [PosterRegistry.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L41)_ +_Defined in [PosterRegistry.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L43)_ Create a new PosterRegistry instance. **Parameters:** -| Name | Type | Description | -| ---------- | ------------------------------------------- | ------------------------------------------ | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | Instantiation options (see `KosuOptions`). | -| `treasury` | [Treasury](treasury.md) | Treasury integration instance. | +| Name | Type | Description | +| ---------- | ----------------------- | ------------------------------------------ | +| `options` | `KosuOptions` | Instantiation options (see `KosuOptions`). | +| `treasury` | [Treasury](treasury.md) | Treasury integration instance. | **Returns:** _[PosterRegistry](posterregistry.md)_ @@ -53,7 +53,7 @@ Create a new PosterRegistry instance. ▸ **pay**(`value`: `BigNumber`): _`Promise`_ -_Defined in [PosterRegistry.ts:149](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L149)_ +_Defined in [PosterRegistry.ts:151](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L151)_ Sends ether to the contract to bond and register tokens for posting. @@ -73,7 +73,7 @@ Logs from the transaction block. ▸ **registerTokens**(`amount`: `BigNumber`): _`Promise`_ -_Defined in [PosterRegistry.ts:107](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L107)_ +_Defined in [PosterRegistry.ts:109](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L109)_ Register tokens into the PosterRegistry contract by bonding KOSU tokens. @@ -93,7 +93,7 @@ A transaction receipt from the mined `register` transaction. ▸ **releaseTokens**(`amount`: `BigNumber`): _`Promise`_ -_Defined in [PosterRegistry.ts:138](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L138)_ +_Defined in [PosterRegistry.ts:140](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L140)_ Release tokens from the PosterRegistry for the `coinbase` address (un-bond). @@ -113,7 +113,7 @@ A transaction receipt from the mined `register` transaction. ▸ **tokensContributed**(): _`Promise`_ -_Defined in [PosterRegistry.ts:85](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L85)_ +_Defined in [PosterRegistry.ts:87](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L87)_ Reads total KOSU tokens contributed to registry. @@ -127,7 +127,7 @@ The total pool of locked KOSU tokens in units of wei. ▸ **tokensRegisteredFor**(`address`: string): _`Promise`_ -_Defined in [PosterRegistry.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L96)_ +_Defined in [PosterRegistry.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L98)_ Reads number of tokens registered for a given address. diff --git a/packages/kosu-contract-helpers/docs/classes/treasury.md b/packages/kosu-contract-helpers/docs/classes/treasury.md index fc2cba9da..c15fb6bba 100644 --- a/packages/kosu-contract-helpers/docs/classes/treasury.md +++ b/packages/kosu-contract-helpers/docs/classes/treasury.md @@ -41,18 +41,18 @@ constructor must include the Treasury's ABI (from the compiled Solidity source). ### constructor -\+ **new Treasury**(`options`: [KosuOptions](../interfaces/kosuoptions.md), `kosuToken`: [KosuToken](kosutoken.md)): _[Treasury](treasury.md)_ +\+ **new Treasury**(`options`: `KosuOptions`, `kosuToken`: [KosuToken](kosutoken.md)): _[Treasury](treasury.md)_ -_Defined in [Treasury.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L49)_ +_Defined in [Treasury.ts:51](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L51)_ Creates a new Treasury instance. **Parameters:** -| Name | Type | Description | -| ----------- | ------------------------------------------- | --------------------------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | Initialization options (see `KosuOptions`). | -| `kosuToken` | [KosuToken](kosutoken.md) | Configured/instantiated `KosuToken` instance. | +| Name | Type | Description | +| ----------- | ------------------------- | --------------------------------------------- | +| `options` | `KosuOptions` | Initialization options (see `KosuOptions`). | +| `kosuToken` | [KosuToken](kosutoken.md) | Configured/instantiated `KosuToken` instance. | **Returns:** _[Treasury](treasury.md)_ @@ -62,7 +62,7 @@ Creates a new Treasury instance. • **kosuToken**: _[KosuToken](kosutoken.md)_ -_Defined in [Treasury.ts:33](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L33)_ +_Defined in [Treasury.ts:35](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L35)_ An instance of the `KosuToken` class to communicate with the KOSU ERC-20 token. @@ -72,7 +72,7 @@ An instance of the `KosuToken` class to communicate with the KOSU ERC-20 token. ▸ **approveTreasury**(`value`: `BigNumber`): _`Promise`_ -_Defined in [Treasury.ts:210](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L210)_ +_Defined in [Treasury.ts:212](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L212)_ Approve the treasury to transfer KOSU on behalf of the user's `coinbase` account. @@ -102,7 +102,7 @@ The decoded transaction receipt, after the TX has been mined. ▸ **currentBalance**(`address`: string): _`Promise`_ -_Defined in [Treasury.ts:172](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L172)_ +_Defined in [Treasury.ts:174](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L174)_ Read the available (current) treasury balance for a provided `address`. @@ -134,7 +134,7 @@ The user's current treasury balance (in wei). ▸ **deposit**(`value`: `BigNumber`): _`Promise`_ -_Defined in [Treasury.ts:99](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L99)_ +_Defined in [Treasury.ts:101](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L101)_ Deposit tokens in the treasury, from the detected `coinbase` account. @@ -163,7 +163,7 @@ The decoded transaction receipt, after the TX has been included in a block. ▸ **pay**(`value`: `BigNumber`): _`Promise`_ -_Defined in [Treasury.ts:221](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L221)_ +_Defined in [Treasury.ts:223](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L223)_ Sends ether to the contract to bond and deposit tokens. @@ -183,7 +183,7 @@ Logs from the transaction block. ▸ **systemBalance**(`address`: string): _`Promise`_ -_Defined in [Treasury.ts:151](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L151)_ +_Defined in [Treasury.ts:153](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L153)_ Read the total system balance of KOSU for a provided `address` string. @@ -215,7 +215,7 @@ The user's total KOSU system balance, in wei. ▸ **treasuryAllowance**(): _`Promise`_ -_Defined in [Treasury.ts:191](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L191)_ +_Defined in [Treasury.ts:193](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L193)_ View the current treasury allowance for the detected `coinbase` account. @@ -240,7 +240,7 @@ The current KOSU approval for the Treasury for the current user, in wei. ▸ **withdraw**(`value`: `BigNumber`): _`Promise`_ -_Defined in [Treasury.ts:130](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L130)_ +_Defined in [Treasury.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L132)_ Withdraw tokens from treasury to the detected `coinbase` account. diff --git a/packages/kosu-contract-helpers/docs/classes/validatorregistry.md b/packages/kosu-contract-helpers/docs/classes/validatorregistry.md index 2ebffcac5..8e987107d 100644 --- a/packages/kosu-contract-helpers/docs/classes/validatorregistry.md +++ b/packages/kosu-contract-helpers/docs/classes/validatorregistry.md @@ -50,18 +50,18 @@ Integration with ValidatorRegistry contract on an Ethereum blockchain. ### constructor -\+ **new ValidatorRegistry**(`options`: [KosuOptions](../interfaces/kosuoptions.md), `treasury`: [Treasury](treasury.md)): _[ValidatorRegistry](validatorregistry.md)_ +\+ **new ValidatorRegistry**(`options`: `KosuOptions`, `treasury`: [Treasury](treasury.md)): _[ValidatorRegistry](validatorregistry.md)_ -_Defined in [ValidatorRegistry.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L18)_ +_Defined in [ValidatorRegistry.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L20)_ Create a new ValidatorRegistry instance. **Parameters:** -| Name | Type | Description | -| ---------- | ------------------------------------------- | ----------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | instantiation options | -| `treasury` | [Treasury](treasury.md) | treasury integration instance | +| Name | Type | Description | +| ---------- | ----------------------- | ----------------------------- | +| `options` | `KosuOptions` | instantiation options | +| `treasury` | [Treasury](treasury.md) | treasury integration instance | **Returns:** _[ValidatorRegistry](validatorregistry.md)_ @@ -71,7 +71,7 @@ Create a new ValidatorRegistry instance. ▸ **applicationPeriod**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:64](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L64)_ +_Defined in [ValidatorRegistry.ts:66](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L66)_ Reads the application period @@ -83,7 +83,7 @@ Reads the application period ▸ **challengeListing**(`_pubKey`: string, `_details`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:256](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L256)_ +_Defined in [ValidatorRegistry.ts:258](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L258)_ Starts a challenge of a listing @@ -102,7 +102,7 @@ Starts a challenge of a listing ▸ **challengePeriod**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:80](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L80)_ +_Defined in [ValidatorRegistry.ts:82](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L82)_ Reads the challenge period @@ -114,7 +114,7 @@ Reads the challenge period ▸ **claimRewards**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:285](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L285)_ +_Defined in [ValidatorRegistry.ts:287](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L287)_ Claims the rewards of a generating/burning listing @@ -132,7 +132,7 @@ Claims the rewards of a generating/burning listing ▸ **claimWinnings**(`challengeId`: `BigNumber`): _`Promise`_ -_Defined in [ValidatorRegistry.ts:315](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L315)_ +_Defined in [ValidatorRegistry.ts:317](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L317)_ Claims winnings from complete challenge @@ -150,7 +150,7 @@ Claims winnings from complete challenge ▸ **commitPeriod**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:72](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L72)_ +_Defined in [ValidatorRegistry.ts:74](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L74)_ Reads the commit period @@ -162,7 +162,7 @@ Reads the commit period ▸ **confirmListing**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:245](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L245)_ +_Defined in [ValidatorRegistry.ts:247](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L247)_ Confirms listing after application period @@ -180,7 +180,7 @@ Confirms listing after application period ▸ **convertPubKey**(`_pubKey`: string): _string_ -_Defined in [ValidatorRegistry.ts:326](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L326)_ +_Defined in [ValidatorRegistry.ts:328](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L328)_ Converts public key to hex if input is not currently in hex @@ -200,7 +200,7 @@ hex encoded tendermint public key ▸ **exitPeriod**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:88](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L88)_ +_Defined in [ValidatorRegistry.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L90)_ Reads the exit period @@ -212,7 +212,7 @@ Reads the exit period ▸ **finalizeExit**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:305](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L305)_ +_Defined in [ValidatorRegistry.ts:307](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L307)_ Finalizes the exit of a listing @@ -230,7 +230,7 @@ Finalizes the exit of a listing ▸ **getAllChallenges**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:199](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L199)_ +_Defined in [ValidatorRegistry.ts:201](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L201)_ Reads all challenges @@ -242,7 +242,7 @@ Reads all challenges ▸ **getAllListings**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:162](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L162)_ +_Defined in [ValidatorRegistry.ts:164](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L164)_ Reads the registered listings @@ -254,7 +254,7 @@ Reads the registered listings ▸ **getChallenge**(`challengeId`: `BigNumber`): _`Promise`_ -_Defined in [ValidatorRegistry.ts:180](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L180)_ +_Defined in [ValidatorRegistry.ts:182](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L182)_ Reads the challenge by challengeId @@ -272,7 +272,7 @@ Reads the challenge by challengeId ▸ **getChallenges**(`challengeIds`: `BigNumber`[]): _`Promise`_ -_Defined in [ValidatorRegistry.ts:190](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L190)_ +_Defined in [ValidatorRegistry.ts:192](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L192)_ Reads the challenges by challengeIds @@ -290,7 +290,7 @@ Reads the challenges by challengeIds ▸ **getListing**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:146](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L146)_ +_Defined in [ValidatorRegistry.ts:148](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L148)_ Reads the listing for public key @@ -308,7 +308,7 @@ Reads the listing for public key ▸ **getListings**(`_pubKeys`: string[]): _`Promise`_ -_Defined in [ValidatorRegistry.ts:154](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L154)_ +_Defined in [ValidatorRegistry.ts:156](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L156)_ Reads the requested listings @@ -326,7 +326,7 @@ Reads the requested listings ▸ **hexToBase64**(`_pubKey`: string): _string_ -_Defined in [ValidatorRegistry.ts:350](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L350)_ +_Defined in [ValidatorRegistry.ts:352](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L352)_ Converts hex encoded public key back to tendermint base64 @@ -346,7 +346,7 @@ Base64 tendermint public key ▸ **initExit**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:295](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L295)_ +_Defined in [ValidatorRegistry.ts:297](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L297)_ Initializes an exit of a listing from the registry @@ -364,7 +364,7 @@ Initializes an exit of a listing from the registry ▸ **kosuToken**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:128](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L128)_ +_Defined in [ValidatorRegistry.ts:130](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L130)_ Reads the kosuToken address @@ -376,7 +376,7 @@ Reads the kosuToken address ▸ **listingKeys**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L136)_ +_Defined in [ValidatorRegistry.ts:138](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L138)_ Reads the current listing keys @@ -388,7 +388,7 @@ Reads the current listing keys ▸ **maxRewardRate**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:170](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L170)_ +_Defined in [ValidatorRegistry.ts:172](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L172)_ Reads the max reward rate @@ -400,7 +400,7 @@ Reads the max reward rate ▸ **minimumBalance**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L104)_ +_Defined in [ValidatorRegistry.ts:106](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L106)_ Reads the minimum balance @@ -412,7 +412,7 @@ Reads the minimum balance ▸ **registerListing**(`_pubKey`: string, `_tokensToStake`: `BigNumber`, `_rewardRate`: `BigNumber`, `_details`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:212](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L212)_ +_Defined in [ValidatorRegistry.ts:214](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L214)_ Register a new listing @@ -433,7 +433,7 @@ Register a new listing ▸ **resolveChallenge**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:275](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L275)_ +_Defined in [ValidatorRegistry.ts:277](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L277)_ Resolves challenge of a listing @@ -451,7 +451,7 @@ Resolves challenge of a listing ▸ **rewardPeriod**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L96)_ +_Defined in [ValidatorRegistry.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L98)_ Reads the reward period @@ -463,7 +463,7 @@ Reads the reward period ▸ **stakeholderCut**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:112](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L112)_ +_Defined in [ValidatorRegistry.ts:114](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L114)_ Reads the stakeholder cut @@ -475,7 +475,7 @@ Reads the stakeholder cut ▸ **voting**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:120](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L120)_ +_Defined in [ValidatorRegistry.ts:122](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L122)_ Reads the Voting contract address diff --git a/packages/kosu-contract-helpers/docs/classes/voting.md b/packages/kosu-contract-helpers/docs/classes/voting.md index ddcf3fe6a..6a69d7312 100644 --- a/packages/kosu-contract-helpers/docs/classes/voting.md +++ b/packages/kosu-contract-helpers/docs/classes/voting.md @@ -30,18 +30,18 @@ Integration with Voting contract on an Ethereum blockchain. ### constructor -\+ **new Voting**(`options`: [KosuOptions](../interfaces/kosuoptions.md), `treasury`: [Treasury](treasury.md)): _[Voting](voting.md)_ +\+ **new Voting**(`options`: `KosuOptions`, `treasury`: [Treasury](treasury.md)): _[Voting](voting.md)_ -_Defined in [Voting.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L18)_ +_Defined in [Voting.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L20)_ Create a new Voting instance. **Parameters:** -| Name | Type | Description | -| ---------- | ------------------------------------------- | ----------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | instantiation options | -| `treasury` | [Treasury](treasury.md) | treasury integration instance | +| Name | Type | Description | +| ---------- | ----------------------- | ----------------------------- | +| `options` | `KosuOptions` | instantiation options | +| `treasury` | [Treasury](treasury.md) | treasury integration instance | **Returns:** _[Voting](voting.md)_ @@ -51,7 +51,7 @@ Create a new Voting instance. ▸ **commitVote**(`_pollId`: `BigNumber`, `_vote`: string, `_tokensToCommit`: `BigNumber`): _`Promise`_ -_Defined in [Voting.ts:67](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L67)_ +_Defined in [Voting.ts:69](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L69)_ Commits vote to voting contract @@ -71,7 +71,7 @@ Commits vote to voting contract ▸ **encodeVote**(`_voteOption`: string, `_voteSalt`: string): _string_ -_Defined in [Voting.ts:165](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L165)_ +_Defined in [Voting.ts:167](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L167)_ Encodes a vote by hashing the option and salt @@ -92,7 +92,7 @@ Encoded vote ▸ **revealVote**(`_pollId`: `BigNumber`, `_voteOption`: `BigNumber`, `_voteSalt`: `BigNumber`): _`Promise`_ -_Defined in [Voting.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L96)_ +_Defined in [Voting.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L98)_ Reveals vote on voting contract @@ -112,7 +112,7 @@ Reveals vote on voting contract ▸ **totalRevealedTokens**(`_pollId`: `BigNumber`): _`Promise`_ -_Defined in [Voting.ts:134](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L134)_ +_Defined in [Voting.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L136)_ Reads the total winning tokens for poll @@ -130,7 +130,7 @@ Reads the total winning tokens for poll ▸ **totalWinningTokens**(`_pollId`: `BigNumber`): _`Promise`_ -_Defined in [Voting.ts:124](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L124)_ +_Defined in [Voting.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L126)_ Reads the total winning tokens for poll @@ -148,7 +148,7 @@ Reads the total winning tokens for poll ▸ **userWinningTokens**(`_pollId`: `BigNumber`, `_userAddress`: string): _`Promise`_ -_Defined in [Voting.ts:145](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L145)_ +_Defined in [Voting.ts:147](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L147)_ Reads users winning tokens committed for poll @@ -167,7 +167,7 @@ Reads users winning tokens committed for poll ▸ **winningOption**(`_pollId`: `BigNumber`): _`Promise`_ -_Defined in [Voting.ts:114](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L114)_ +_Defined in [Voting.ts:116](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L116)_ Reads the winning option for poll diff --git a/packages/kosu-contract-helpers/docs/globals.md b/packages/kosu-contract-helpers/docs/globals.md index 8f746fc53..d6e6a8adf 100644 --- a/packages/kosu-contract-helpers/docs/globals.md +++ b/packages/kosu-contract-helpers/docs/globals.md @@ -19,31 +19,13 @@ - [ValidatorRegistry](classes/validatorregistry.md) - [Voting](classes/voting.md) -### Interfaces - -- [DecodedKosuLogArgs](interfaces/decodedkosulogargs.md) -- [KosuOptions](interfaces/kosuoptions.md) -- [KosuUtils](interfaces/kosuutils.md) -- [LogWithDecodedKosuArgs](interfaces/logwithdecodedkosuargs.md) -- [Order](interfaces/order.md) -- [OrderArgument](interfaces/orderargument.md) -- [OrderRejectionInfo](interfaces/orderrejectioninfo.md) -- [OrderValidationResult](interfaces/ordervalidationresult.md) -- [PostableOrder](interfaces/postableorder.md) -- [Poster](interfaces/poster.md) -- [RoundInfo](interfaces/roundinfo.md) -- [TakeableOrder](interfaces/takeableorder.md) -- [Validator](interfaces/validator.md) - ### Variables -- [NULL_ADDRESS](globals.md#const-null_address) - [version](globals.md#const-version) ### Functions - [\_serialize](globals.md#_serialize) -- [toBytes32](globals.md#tobytes32) ### Object literals @@ -53,19 +35,11 @@ ## Variables -### `Const` NULL_ADDRESS - -• **NULL_ADDRESS**: _string_ = "0x0000000000000000000000000000000000000000" - -_Defined in [utils.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/utils.ts#L12)_ - ---- - ### `Const` version • **version**: _any_ = process.env.npm_package_version || require("../package.json").version -_Defined in [Kosu.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L18)_ +_Defined in [Kosu.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L19)_ ## Functions @@ -73,7 +47,7 @@ _Defined in [Kosu.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blo ▸ **\_serialize**(`_arguments`: any, `values`: any): _string_ -_Defined in [OrderSerializer.ts:8](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L8)_ +_Defined in [OrderSerializer.ts:9](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L9)_ **Parameters:** @@ -84,35 +58,17 @@ _Defined in [OrderSerializer.ts:8](https://github.com/ParadigmFoundation/kosu-mo **Returns:** _string_ ---- - -### toBytes32 - -▸ **toBytes32**(`value`: string): _string_ - -_Defined in [utils.ts:8](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/utils.ts#L8)_ - -Convert an arbitrary string to a `bytes32` version. - -**Parameters:** - -| Name | Type | Description | -| ------- | ------ | --------------------------------------------------------- | -| `value` | string | String value to be converted into bytes32 representation. | - -**Returns:** _string_ - ## Object literals ### `Const` KosuEndpoints ### ▪ **KosuEndpoints**: _object_ -_Defined in [EventEmitter.ts:7](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L7)_ +_Defined in [EventEmitter.ts:9](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L9)_ ▪ **1**: _object_ -_Defined in [EventEmitter.ts:8](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L8)_ +_Defined in [EventEmitter.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L10)_ - **http**: _string_ = `https://ethnet.zaidan.io/mainnet` @@ -120,7 +76,7 @@ _Defined in [EventEmitter.ts:8](https://github.com/ParadigmFoundation/kosu-monor ▪ **3**: _object_ -_Defined in [EventEmitter.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L12)_ +_Defined in [EventEmitter.ts:14](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L14)_ - **http**: _string_ = `https://ethnet.zaidan.io/ropsten` @@ -128,7 +84,7 @@ _Defined in [EventEmitter.ts:12](https://github.com/ParadigmFoundation/kosu-mono ▪ **42**: _object_ -_Defined in [EventEmitter.ts:16](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L16)_ +_Defined in [EventEmitter.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L18)_ - **http**: _string_ = `https://ethnet.zaidan.io/kovan` @@ -136,7 +92,7 @@ _Defined in [EventEmitter.ts:16](https://github.com/ParadigmFoundation/kosu-mono ▪ **6174**: _object_ -_Defined in [EventEmitter.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L20)_ +_Defined in [EventEmitter.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L22)_ - **http**: _string_ = `https://ethnet.zaidan.io/kosu` @@ -148,92 +104,92 @@ _Defined in [EventEmitter.ts:20](https://github.com/ParadigmFoundation/kosu-mono ### ▪ **OrderSerializer**: _object_ -_Defined in [OrderSerializer.ts:51](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L51)_ +_Defined in [OrderSerializer.ts:52](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L52)_ could add to utils (or create order-utils pacakge) ### makerHex -▸ **makerHex**(`order`: [Order](interfaces/order.md), `_arguments`: any): _string_ +▸ **makerHex**(`order`: `Order`, `_arguments`: any): _string_ -_Defined in [OrderSerializer.ts:97](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L97)_ +_Defined in [OrderSerializer.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L98)_ Generate the maker hex from order **Parameters:** -| Name | Type | Description | -| ------------ | ---------------------------- | ---------------------------------------- | -| `order` | [Order](interfaces/order.md) | to generate hex from | -| `_arguments` | any | Argument json defined in the subContract | +| Name | Type | Description | +| ------------ | ------- | ---------------------------------------- | +| `order` | `Order` | to generate hex from | +| `_arguments` | any | Argument json defined in the subContract | **Returns:** _string_ ### posterSignatureHex -▸ **posterSignatureHex**(`order`: [Order](interfaces/order.md), `_arguments`: any): _string_ +▸ **posterSignatureHex**(`order`: `Order`, `_arguments`: any): _string_ -_Defined in [OrderSerializer.ts:73](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L73)_ +_Defined in [OrderSerializer.ts:74](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L74)_ Generates hex to be used for the poster signing process **Parameters:** -| Name | Type | Description | -| ------------ | ---------------------------- | ---------------------------------------- | -| `order` | [Order](interfaces/order.md) | Order to get data for | -| `_arguments` | any | Argument json defined in the subContract | +| Name | Type | Description | +| ------------ | ------- | ---------------------------------------- | +| `order` | `Order` | Order to get data for | +| `_arguments` | any | Argument json defined in the subContract | **Returns:** _string_ ### recoverMaker -▸ **recoverMaker**(`order`: [Order](interfaces/order.md), `_arguments`: any[]): _string_ +▸ **recoverMaker**(`order`: `Order`, `_arguments`: any[]): _string_ -_Defined in [OrderSerializer.ts:125](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L125)_ +_Defined in [OrderSerializer.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L126)_ Recovers the maker from the signed information **Parameters:** -| Name | Type | Description | -| ------------ | ---------------------------- | ---------------------------------------- | -| `order` | [Order](interfaces/order.md) | to recover address from | -| `_arguments` | any[] | Argument json defined in the subContract | +| Name | Type | Description | +| ------------ | ------- | ---------------------------------------- | +| `order` | `Order` | to recover address from | +| `_arguments` | any[] | Argument json defined in the subContract | **Returns:** _string_ ### recoverPoster -▸ **recoverPoster**(`order`: [PostableOrder](interfaces/postableorder.md), `_arguments`: any[]): _string_ +▸ **recoverPoster**(`order`: `PostableOrder`, `_arguments`: any[]): _string_ -_Defined in [OrderSerializer.ts:87](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L87)_ +_Defined in [OrderSerializer.ts:88](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L88)_ Recovers the poster from the poster signature **Parameters:** -| Name | Type | Description | -| ------------ | -------------------------------------------- | ---------------------------------------- | -| `order` | [PostableOrder](interfaces/postableorder.md) | Order to recover address that signed | -| `_arguments` | any[] | Argument json defined in the subContract | +| Name | Type | Description | +| ------------ | --------------- | ---------------------------------------- | +| `order` | `PostableOrder` | Order to recover address that signed | +| `_arguments` | any[] | Argument json defined in the subContract | **Returns:** _string_ ### serialize -▸ **serialize**(`_arguments`: any, `order`: [Order](interfaces/order.md)): _string_ +▸ **serialize**(`_arguments`: any, `order`: `Order`): _string_ -_Defined in [OrderSerializer.ts:58](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L58)_ +_Defined in [OrderSerializer.ts:59](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L59)_ Serializes the data into bytes **Parameters:** -| Name | Type | Description | -| ------------ | ---------------------------- | ---------------------------------------- | -| `_arguments` | any | Argument json defined in the subContract | -| `order` | [Order](interfaces/order.md) | Order to serialize | +| Name | Type | Description | +| ------------ | ------- | ---------------------------------------- | +| `_arguments` | any | Argument json defined in the subContract | +| `order` | `Order` | Order to serialize | **Returns:** _string_ @@ -243,15 +199,13 @@ Serializes the data into bytes ### ▪ **Signature**: _object_ -_Defined in [Signature.ts:7](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Signature.ts#L7)_ - -_Defined in [types.d.ts:45](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L45)_ +_Defined in [Signature.ts:6](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Signature.ts#L6)_ ### generate ▸ **generate**(`web3`: `Web3`, `messageHex`: string, `signer`: string): _`Promise`_ -_Defined in [Signature.ts:16](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Signature.ts#L16)_ +_Defined in [Signature.ts:15](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Signature.ts#L15)_ Generates a signature for a message hex using calls to a provider though web3 @@ -267,25 +221,11 @@ Generates a signature for a message hex using calls to a provider though web3 A vrs signature -▸ **generate**(`web3`: `Web3`, `messageHex`: string, `signer`: string): _`Promise`_ - -_Defined in [types.d.ts:46](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L46)_ - -**Parameters:** - -| Name | Type | -| ------------ | ------ | -| `web3` | `Web3` | -| `messageHex` | string | -| `signer` | string | - -**Returns:** _`Promise`_ - ### recoverAddress ▸ **recoverAddress**(`messageHex`: any, `signature`: string): _string_ -_Defined in [Signature.ts:38](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Signature.ts#L38)_ +_Defined in [Signature.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Signature.ts#L37)_ Recovers address from a message hex and signature @@ -298,24 +238,11 @@ Recovers address from a message hex and signature **Returns:** _string_ -▸ **recoverAddress**(`messageHex`: any, `signature`: string): _string_ - -_Defined in [types.d.ts:48](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L48)_ - -**Parameters:** - -| Name | Type | -| ------------ | ------ | -| `messageHex` | any | -| `signature` | string | - -**Returns:** _string_ - ### sign ▸ **sign**(`web3`: `Web3`, `messageHex`: string, `signer`: string): _`Promise`_ -_Defined in [Signature.ts:56](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Signature.ts#L56)_ +_Defined in [Signature.ts:55](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Signature.ts#L55)_ Sign hex with provided address @@ -329,25 +256,11 @@ Sign hex with provided address **Returns:** _`Promise`_ -▸ **sign**(`web3`: `Web3`, `messageHex`: string, `signer`: string): _`Promise`_ - -_Defined in [types.d.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L49)_ - -**Parameters:** - -| Name | Type | -| ------------ | ------ | -| `web3` | `Web3` | -| `messageHex` | string | -| `signer` | string | - -**Returns:** _`Promise`_ - ### validate ▸ **validate**(`messageHex`: string, `signature`: string, `signer`: string): _boolean_ -_Defined in [Signature.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Signature.ts#L28)_ +_Defined in [Signature.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Signature.ts#L27)_ Validates the signature of a messageHex is from the provided signer @@ -362,17 +275,3 @@ Validates the signature of a messageHex is from the provided signer **Returns:** _boolean_ boolean representing if the signer in fact generated the signature with this message - -▸ **validate**(`messageHex`: string, `signature`: string, `signer`: string): _boolean_ - -_Defined in [types.d.ts:47](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L47)_ - -**Parameters:** - -| Name | Type | -| ------------ | ------ | -| `messageHex` | string | -| `signature` | string | -| `signer` | string | - -**Returns:** _boolean_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/decodedkosulogargs.md b/packages/kosu-contract-helpers/docs/interfaces/decodedkosulogargs.md deleted file mode 100644 index 75e5d3a0c..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/decodedkosulogargs.md +++ /dev/null @@ -1,9 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [DecodedKosuLogArgs](decodedkosulogargs.md) / - -# Interface: DecodedKosuLogArgs - -## Hierarchy - -- **DecodedKosuLogArgs** diff --git a/packages/kosu-contract-helpers/docs/interfaces/kosuoptions.md b/packages/kosu-contract-helpers/docs/interfaces/kosuoptions.md deleted file mode 100644 index e9a333c15..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/kosuoptions.md +++ /dev/null @@ -1,122 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [KosuOptions](kosuoptions.md) / - -# Interface: KosuOptions - -## Hierarchy - -- **KosuOptions** - -## Index - -### Properties - -- [eventEmitterAddress](kosuoptions.md#optional-eventemitteraddress) -- [kosuNodeUrl](kosuoptions.md#optional-kosunodeurl) -- [kosuTokenAddress](kosuoptions.md#optional-kosutokenaddress) -- [networkId](kosuoptions.md#optional-networkid) -- [orderGatewayAddress](kosuoptions.md#optional-ordergatewayaddress) -- [posterRegistryAddress](kosuoptions.md#optional-posterregistryaddress) -- [provider](kosuoptions.md#optional-provider) -- [treasuryAddress](kosuoptions.md#optional-treasuryaddress) -- [validatorRegistryAddress](kosuoptions.md#optional-validatorregistryaddress) -- [votingAddress](kosuoptions.md#optional-votingaddress) -- [web3](kosuoptions.md#optional-web3) -- [web3Wrapper](kosuoptions.md#optional-web3wrapper) - -## Properties - -### `Optional` eventEmitterAddress - -• **eventEmitterAddress**? : _string_ - -_Defined in [types.d.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L10)_ - ---- - -### `Optional` kosuNodeUrl - -• **kosuNodeUrl**? : _string_ - -_Defined in [types.d.ts:6](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L6)_ - ---- - -### `Optional` kosuTokenAddress - -• **kosuTokenAddress**? : _string_ - -_Defined in [types.d.ts:9](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L9)_ - ---- - -### `Optional` networkId - -• **networkId**? : _number | string_ - -_Defined in [types.d.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L3)_ - ---- - -### `Optional` orderGatewayAddress - -• **orderGatewayAddress**? : _string_ - -_Defined in [types.d.ts:11](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L11)_ - ---- - -### `Optional` posterRegistryAddress - -• **posterRegistryAddress**? : _string_ - -_Defined in [types.d.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L12)_ - ---- - -### `Optional` provider - -• **provider**? : _[provider](kosuoptions.md#optional-provider)_ - -_Defined in [types.d.ts:2](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L2)_ - ---- - -### `Optional` treasuryAddress - -• **treasuryAddress**? : _string_ - -_Defined in [types.d.ts:8](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L8)_ - ---- - -### `Optional` validatorRegistryAddress - -• **validatorRegistryAddress**? : _string_ - -_Defined in [types.d.ts:13](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L13)_ - ---- - -### `Optional` votingAddress - -• **votingAddress**? : _string_ - -_Defined in [types.d.ts:7](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L7)_ - ---- - -### `Optional` web3 - -• **web3**? : _`Web3`_ - -_Defined in [types.d.ts:4](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L4)_ - ---- - -### `Optional` web3Wrapper - -• **web3Wrapper**? : _`Web3Wrapper`_ - -_Defined in [types.d.ts:5](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L5)_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/kosuutils.md b/packages/kosu-contract-helpers/docs/interfaces/kosuutils.md deleted file mode 100644 index f47269703..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/kosuutils.md +++ /dev/null @@ -1,43 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [KosuUtils](kosuutils.md) / - -# Interface: KosuUtils - -## Hierarchy - -- **KosuUtils** - -## Index - -### Properties - -- [NULL_ADDRESS](kosuutils.md#null_address) - -### Methods - -- [toBytes32](kosuutils.md#tobytes32) - -## Properties - -### NULL_ADDRESS - -• **NULL_ADDRESS**: _string_ - -_Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L42)_ - -## Methods - -### toBytes32 - -▸ **toBytes32**(`value`: string): _number | string | `BN`_ - -_Defined in [types.d.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L41)_ - -**Parameters:** - -| Name | Type | -| ------- | ------ | -| `value` | string | - -**Returns:** _number | string | `BN`_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/logwithdecodedkosuargs.md b/packages/kosu-contract-helpers/docs/interfaces/logwithdecodedkosuargs.md deleted file mode 100644 index 6ee97677b..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/logwithdecodedkosuargs.md +++ /dev/null @@ -1,49 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [LogWithDecodedKosuArgs](logwithdecodedkosuargs.md) / - -# Interface: LogWithDecodedKosuArgs <**A, B**> - -## Type parameters - -▪ **A** - -▪ **B** - -## Hierarchy - -- any - - - **LogWithDecodedKosuArgs** - -## Index - -### Properties - -- [args](logwithdecodedkosuargs.md#args) -- [decodedArgs](logwithdecodedkosuargs.md#decodedargs) -- [event](logwithdecodedkosuargs.md#event) - -## Properties - -### args - -• **args**: _`A`_ - -_Defined in [types.d.ts:56](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L56)_ - ---- - -### decodedArgs - -• **decodedArgs**: _`B`_ - -_Defined in [types.d.ts:57](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L57)_ - ---- - -### event - -• **event**: _string_ - -_Defined in [types.d.ts:55](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L55)_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/order.md b/packages/kosu-contract-helpers/docs/interfaces/order.md deleted file mode 100644 index 306fe31e6..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/order.md +++ /dev/null @@ -1,90 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [Order](order.md) / - -# Interface: Order - -## Hierarchy - -- **Order** - - - [PostableOrder](postableorder.md) - - - [TakeableOrder](takeableorder.md) - -## Index - -### Properties - -- [arguments](order.md#optional-arguments) -- [id](order.md#id) -- [maker](order.md#maker) -- [makerSignature](order.md#optional-makersignature) -- [makerValues](order.md#makervalues) -- [poster](order.md#poster) -- [subContract](order.md#subcontract) -- [takerValues](order.md#optional-takervalues) - -## Properties - -### `Optional` arguments - -• **arguments**? : _any_ - -_Defined in [types.d.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L22)_ - ---- - -### id - -• **id**: _any_ - -_Defined in [types.d.ts:23](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L23)_ - ---- - -### maker - -• **maker**: _string_ - -_Defined in [types.d.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L18)_ - ---- - -### `Optional` makerSignature - -• **makerSignature**? : _any_ - -_Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L21)_ - ---- - -### makerValues - -• **makerValues**: _any_ - -_Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L19)_ - ---- - -### poster - -• **poster**: _string_ - -_Defined in [types.d.ts:24](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L24)_ - ---- - -### subContract - -• **subContract**: _string_ - -_Defined in [types.d.ts:17](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L17)_ - ---- - -### `Optional` takerValues - -• **takerValues**? : _any_ - -_Defined in [types.d.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L20)_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/orderargument.md b/packages/kosu-contract-helpers/docs/interfaces/orderargument.md deleted file mode 100644 index 2bb833d7c..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/orderargument.md +++ /dev/null @@ -1,32 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [OrderArgument](orderargument.md) / - -# Interface: OrderArgument - -## Hierarchy - -- **OrderArgument** - -## Index - -### Properties - -- [datatype](orderargument.md#datatype) -- [name](orderargument.md#name) - -## Properties - -### datatype - -• **datatype**: _string_ - -_Defined in [types.d.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L37)_ - ---- - -### name - -• **name**: _string_ - -_Defined in [types.d.ts:36](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L36)_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/orderrejectioninfo.md b/packages/kosu-contract-helpers/docs/interfaces/orderrejectioninfo.md deleted file mode 100644 index e07a22465..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/orderrejectioninfo.md +++ /dev/null @@ -1,32 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [OrderRejectionInfo](orderrejectioninfo.md) / - -# Interface: OrderRejectionInfo - -## Hierarchy - -- **OrderRejectionInfo** - -## Index - -### Properties - -- [order](orderrejectioninfo.md#order) -- [reason](orderrejectioninfo.md#reason) - -## Properties - -### order - -• **order**: _string_ - -_Defined in [types.d.ts:66](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L66)_ - ---- - -### reason - -• **reason**: _string_ - -_Defined in [types.d.ts:67](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L67)_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/ordervalidationresult.md b/packages/kosu-contract-helpers/docs/interfaces/ordervalidationresult.md deleted file mode 100644 index 7f4128d05..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/ordervalidationresult.md +++ /dev/null @@ -1,32 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [OrderValidationResult](ordervalidationresult.md) / - -# Interface: OrderValidationResult - -## Hierarchy - -- **OrderValidationResult** - -## Index - -### Properties - -- [accepted](ordervalidationresult.md#accepted) -- [rejected](ordervalidationresult.md#rejected) - -## Properties - -### accepted - -• **accepted**: _string[]_ - -_Defined in [types.d.ts:61](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L61)_ - ---- - -### rejected - -• **rejected**: _[OrderRejectionInfo](orderrejectioninfo.md)[]_ - -_Defined in [types.d.ts:62](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L62)_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/postableorder.md b/packages/kosu-contract-helpers/docs/interfaces/postableorder.md deleted file mode 100644 index 2356799ee..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/postableorder.md +++ /dev/null @@ -1,113 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [PostableOrder](postableorder.md) / - -# Interface: PostableOrder - -## Hierarchy - -- [Order](order.md) - - - **PostableOrder** - -## Index - -### Properties - -- [arguments](postableorder.md#optional-arguments) -- [id](postableorder.md#id) -- [maker](postableorder.md#maker) -- [makerSignature](postableorder.md#optional-makersignature) -- [makerValues](postableorder.md#makervalues) -- [poster](postableorder.md#poster) -- [posterSignature](postableorder.md#postersignature) -- [subContract](postableorder.md#subcontract) -- [takerValues](postableorder.md#optional-takervalues) - -## Properties - -### `Optional` arguments - -• **arguments**? : _any_ - -_Inherited from [Order](order.md).[arguments](order.md#optional-arguments)_ - -_Defined in [types.d.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L22)_ - ---- - -### id - -• **id**: _any_ - -_Inherited from [Order](order.md).[id](order.md#id)_ - -_Defined in [types.d.ts:23](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L23)_ - ---- - -### maker - -• **maker**: _string_ - -_Inherited from [Order](order.md).[maker](order.md#maker)_ - -_Defined in [types.d.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L18)_ - ---- - -### `Optional` makerSignature - -• **makerSignature**? : _any_ - -_Inherited from [Order](order.md).[makerSignature](order.md#optional-makersignature)_ - -_Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L21)_ - ---- - -### makerValues - -• **makerValues**: _any_ - -_Inherited from [Order](order.md).[makerValues](order.md#makervalues)_ - -_Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L19)_ - ---- - -### poster - -• **poster**: _string_ - -_Inherited from [Order](order.md).[poster](order.md#poster)_ - -_Defined in [types.d.ts:24](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L24)_ - ---- - -### posterSignature - -• **posterSignature**: _string_ - -_Defined in [types.d.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L28)_ - ---- - -### subContract - -• **subContract**: _string_ - -_Inherited from [Order](order.md).[subContract](order.md#subcontract)_ - -_Defined in [types.d.ts:17](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L17)_ - ---- - -### `Optional` takerValues - -• **takerValues**? : _any_ - -_Inherited from [Order](order.md).[takerValues](order.md#optional-takervalues)_ - -_Defined in [types.d.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L20)_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/poster.md b/packages/kosu-contract-helpers/docs/interfaces/poster.md deleted file mode 100644 index 33db7afad..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/poster.md +++ /dev/null @@ -1,32 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [Poster](poster.md) / - -# Interface: Poster - -## Hierarchy - -- **Poster** - -## Index - -### Properties - -- [balance](poster.md#balance) -- [limit](poster.md#limit) - -## Properties - -### balance - -• **balance**: _`BigNumber`_ - -_Defined in [types.d.ts:71](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L71)_ - ---- - -### limit - -• **limit**: _number_ - -_Defined in [types.d.ts:72](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L72)_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/roundinfo.md b/packages/kosu-contract-helpers/docs/interfaces/roundinfo.md deleted file mode 100644 index b52cfc203..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/roundinfo.md +++ /dev/null @@ -1,50 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [RoundInfo](roundinfo.md) / - -# Interface: RoundInfo - -## Hierarchy - -- **RoundInfo** - -## Index - -### Properties - -- [endsAt](roundinfo.md#endsat) -- [limit](roundinfo.md#limit) -- [number](roundinfo.md#number) -- [startsAt](roundinfo.md#startsat) - -## Properties - -### endsAt - -• **endsAt**: _number_ - -_Defined in [types.d.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L90)_ - ---- - -### limit - -• **limit**: _number_ - -_Defined in [types.d.ts:91](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L91)_ - ---- - -### number - -• **number**: _number_ - -_Defined in [types.d.ts:88](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L88)_ - ---- - -### startsAt - -• **startsAt**: _number_ - -_Defined in [types.d.ts:89](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L89)_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/takeableorder.md b/packages/kosu-contract-helpers/docs/interfaces/takeableorder.md deleted file mode 100644 index b924024e0..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/takeableorder.md +++ /dev/null @@ -1,104 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [TakeableOrder](takeableorder.md) / - -# Interface: TakeableOrder - -## Hierarchy - -- [Order](order.md) - - - **TakeableOrder** - -## Index - -### Properties - -- [arguments](takeableorder.md#optional-arguments) -- [id](takeableorder.md#id) -- [maker](takeableorder.md#maker) -- [makerSignature](takeableorder.md#optional-makersignature) -- [makerValues](takeableorder.md#makervalues) -- [poster](takeableorder.md#poster) -- [subContract](takeableorder.md#subcontract) -- [takerValues](takeableorder.md#takervalues) - -## Properties - -### `Optional` arguments - -• **arguments**? : _any_ - -_Inherited from [Order](order.md).[arguments](order.md#optional-arguments)_ - -_Defined in [types.d.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L22)_ - ---- - -### id - -• **id**: _any_ - -_Inherited from [Order](order.md).[id](order.md#id)_ - -_Defined in [types.d.ts:23](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L23)_ - ---- - -### maker - -• **maker**: _string_ - -_Inherited from [Order](order.md).[maker](order.md#maker)_ - -_Defined in [types.d.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L18)_ - ---- - -### `Optional` makerSignature - -• **makerSignature**? : _any_ - -_Inherited from [Order](order.md).[makerSignature](order.md#optional-makersignature)_ - -_Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L21)_ - ---- - -### makerValues - -• **makerValues**: _any_ - -_Inherited from [Order](order.md).[makerValues](order.md#makervalues)_ - -_Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L19)_ - ---- - -### poster - -• **poster**: _string_ - -_Inherited from [Order](order.md).[poster](order.md#poster)_ - -_Defined in [types.d.ts:24](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L24)_ - ---- - -### subContract - -• **subContract**: _string_ - -_Inherited from [Order](order.md).[subContract](order.md#subcontract)_ - -_Defined in [types.d.ts:17](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L17)_ - ---- - -### takerValues - -• **takerValues**: _any_ - -_Overrides [Order](order.md).[takerValues](order.md#optional-takervalues)_ - -_Defined in [types.d.ts:32](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L32)_ diff --git a/packages/kosu-contract-helpers/docs/interfaces/validator.md b/packages/kosu-contract-helpers/docs/interfaces/validator.md deleted file mode 100644 index d99843db4..000000000 --- a/packages/kosu-contract-helpers/docs/interfaces/validator.md +++ /dev/null @@ -1,95 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [Validator](validator.md) / - -# Interface: Validator - -## Hierarchy - -- **Validator** - -## Index - -### Properties - -- [active](validator.md#active) -- [applied](validator.md#applied) -- [balance](validator.md#balance) -- [firstVote](validator.md#firstvote) -- [lastProposed](validator.md#lastproposed) -- [lastVoted](validator.md#lastvoted) -- [power](validator.md#power) -- [publicKey](validator.md#publickey) -- [totalVotes](validator.md#totalvotes) - -## Properties - -### active - -• **active**: _number_ - -_Defined in [types.d.ts:83](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L83)_ - ---- - -### applied - -• **applied**: _number_ - -_Defined in [types.d.ts:84](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L84)_ - ---- - -### balance - -• **balance**: _`BigNumber`_ - -_Defined in [types.d.ts:76](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L76)_ - ---- - -### firstVote - -• **firstVote**: _number_ - -_Defined in [types.d.ts:79](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L79)_ - ---- - -### lastProposed - -• **lastProposed**: _number_ - -_Defined in [types.d.ts:81](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L81)_ - ---- - -### lastVoted - -• **lastVoted**: _number_ - -_Defined in [types.d.ts:80](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L80)_ - ---- - -### power - -• **power**: _number_ - -_Defined in [types.d.ts:77](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L77)_ - ---- - -### publicKey - -• **publicKey**: _string_ - -_Defined in [types.d.ts:78](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L78)_ - ---- - -### totalVotes - -• **totalVotes**: _number_ - -_Defined in [types.d.ts:82](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L82)_ diff --git a/packages/kosu-docs/docs/kosu.js/README.md b/packages/kosu-docs/docs/kosu-contract-helpers/README.md similarity index 100% rename from packages/kosu-docs/docs/kosu.js/README.md rename to packages/kosu-docs/docs/kosu-contract-helpers/README.md diff --git a/packages/kosu-docs/docs/kosu.js/classes/eventemitter.md b/packages/kosu-docs/docs/kosu-contract-helpers/classes/eventemitter.md similarity index 69% rename from packages/kosu-docs/docs/kosu.js/classes/eventemitter.md rename to packages/kosu-docs/docs/kosu-contract-helpers/classes/eventemitter.md index 8e17d1a38..ed3ccc1e1 100644 --- a/packages/kosu-docs/docs/kosu.js/classes/eventemitter.md +++ b/packages/kosu-docs/docs/kosu-contract-helpers/classes/eventemitter.md @@ -28,17 +28,17 @@ to subscribe to future events. ### constructor -\+ **new EventEmitter**(`options`: [KosuOptions](../interfaces/kosuoptions.md)): _[EventEmitter](eventemitter.md)_ +\+ **new EventEmitter**(`options`: `KosuOptions`): _[EventEmitter](eventemitter.md)_ -_Defined in [EventEmitter.ts:47](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L47)_ +_Defined in [EventEmitter.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L49)_ Create a new `EventEmitter` instance. **Parameters:** -| Name | Type | Description | -| --------- | ------------------------------------------- | --------------------------------------------------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | Options object with `web3Wrapper` and optional `eventEmitterAddress`. | +| Name | Type | Description | +| --------- | ------------- | --------------------------------------------------------------------- | +| `options` | `KosuOptions` | Options object with `web3Wrapper` and optional `eventEmitterAddress`. | **Returns:** _[EventEmitter](eventemitter.md)_ @@ -48,7 +48,7 @@ Create a new `EventEmitter` instance. ▸ **getAddress**(): _`Promise`_ -_Defined in [EventEmitter.ts:63](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L63)_ +_Defined in [EventEmitter.ts:65](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L65)_ Return the address of the configured deployed contract. If not already cached, will return the deployed address for the detected network ID (if available). @@ -61,7 +61,7 @@ will return the deployed address for the detected network ID (if available). ▸ **getFutureDecodedLogs**(`start`: number, `callback`: function): _`Timeout`_ -_Defined in [EventEmitter.ts:109](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L109)_ +_Defined in [EventEmitter.ts:111](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L111)_ **`todo`** document better (and confirm) @@ -91,7 +91,7 @@ A callback function to be called on an array of each new event log. ▸ **getPastDecodedLogs**(`config`: `FilterObject`): _`Promise>>`_ -_Defined in [EventEmitter.ts:82](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L82)_ +_Defined in [EventEmitter.ts:84](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L84)_ Get all past decoded logs from the Kosu `EventEmitter` contract, with the oldest event at position 0. diff --git a/packages/kosu-docs/docs/kosu.js/classes/kosu.md b/packages/kosu-docs/docs/kosu-contract-helpers/classes/kosu.md similarity index 65% rename from packages/kosu-docs/docs/kosu.js/classes/kosu.md rename to packages/kosu-docs/docs/kosu-contract-helpers/classes/kosu.md index c468c3c08..784bc6853 100644 --- a/packages/kosu-docs/docs/kosu.js/classes/kosu.md +++ b/packages/kosu-docs/docs/kosu-contract-helpers/classes/kosu.md @@ -28,7 +28,6 @@ contracts. ### Properties -- [Signature](kosu.md#signature) - [eventEmitter](kosu.md#eventemitter) - [kosuToken](kosu.md#kosutoken) - [node](kosu.md#node) @@ -47,9 +46,9 @@ contracts. ### constructor -\+ **new Kosu**(`options`: [KosuOptions](../interfaces/kosuoptions.md)): _[Kosu](kosu.md)_ +\+ **new Kosu**(`options`: `KosuOptions`): _[Kosu](kosu.md)_ -_Defined in [Kosu.ts:137](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L137)_ +_Defined in [Kosu.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L132)_ Create a new `kosu` instance and instantiate wrappers for each Kosu system contract. @@ -61,30 +60,19 @@ of transactions and generation of signatures will not be possible. **Parameters:** -| Name | Type | Description | -| --------- | ------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | An options object used to configure `kosu` and the configured contract instances. A custom `provider` may be supplied. | +| Name | Type | Description | +| --------- | ------------- | ---------------------------------------------------------------------------------------------------------------------- | +| `options` | `KosuOptions` | An options object used to configure `kosu` and the configured contract instances. A custom `provider` may be supplied. | **Returns:** _[Kosu](kosu.md)_ ## Properties -### Signature - -• **Signature**: _`Signature`_ - -_Defined in [Kosu.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L132)_ - -Utilities for generating and recovering signatures for use within the -Kosu system. - ---- - ### eventEmitter • **eventEmitter**: _[EventEmitter](eventemitter.md)_ -_Defined in [Kosu.ts:118](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L118)_ +_Defined in [Kosu.ts:119](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L119)_ The `eventEmitter` enables the query of and subscription to decoded event logs from the Kosu `EventEmitter` contract. @@ -95,7 +83,7 @@ logs from the Kosu `EventEmitter` contract. • **kosuToken**: _[KosuToken](kosutoken.md)_ -_Defined in [Kosu.ts:83](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L83)_ +_Defined in [Kosu.ts:84](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L84)_ The `kosuToken` provides methods for interacting with the KOSU ERC-20 token. @@ -105,7 +93,7 @@ The `kosuToken` provides methods for interacting with the KOSU ERC-20 token. • **node**: _[NodeClient](nodeclient.md)_ -_Defined in [Kosu.ts:58](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L58)_ +_Defined in [Kosu.ts:59](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L59)_ A JSONRPC client for a Kosu node, enabled if a `kosuNodeUrl` is provided to the Kosu constructor (as part of the options object). @@ -118,7 +106,7 @@ Enables access to the `go-kosu` JSONRPC-API, including subscriptions. • **orderGateway**: _[OrderGateway](ordergateway.md)_ -_Defined in [Kosu.ts:70](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L70)_ +_Defined in [Kosu.ts:71](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L71)_ The `orderGateway` instance provides access to the `OrderGateway` contract which is used to direct settlement of orders to their corresponding @@ -133,7 +121,7 @@ type, based on a `SubContract` address. • **orderHelper**: _[OrderHelper](orderhelper.md)_ -_Defined in [Kosu.ts:78](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L78)_ +_Defined in [Kosu.ts:79](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L79)_ The `orderHelper` instance provides methods for generating and signing maker orders, signing orders for submission to the Kosu network, and @@ -146,7 +134,7 @@ submitting orders for settlement on the Ethereum blockchain via the • **posterRegistry**: _[PosterRegistry](posterregistry.md)_ -_Defined in [Kosu.ts:103](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L103)_ +_Defined in [Kosu.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L104)_ The `posterRegistry` instance enables users to interact with the Kosu `PosterRegistry` contract to bond and un-bond KOSU tokens to access the @@ -158,7 +146,7 @@ order relay feature of the Kosu network. • **treasury**: _[Treasury](treasury.md)_ -_Defined in [Kosu.ts:89](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L89)_ +_Defined in [Kosu.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L90)_ The `treasury` instance provides access to functionality of the Kosu `Treasury` contract, such as deposits/withdrawals and allowance management. @@ -167,9 +155,9 @@ The `treasury` instance provides access to functionality of the Kosu ### utils -• **utils**: _[KosuUtils](../interfaces/kosuutils.md)_ +• **utils**: _`KosuUtils`_ -_Defined in [Kosu.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L126)_ +_Defined in [Kosu.ts:127](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L127)_ Common and helpful utility methods and constants for interacting with the Kosu contract system and Ethereum blockchain. @@ -180,7 +168,7 @@ Kosu contract system and Ethereum blockchain. • **validatorRegistry**: _[ValidatorRegistry](validatorregistry.md)_ -_Defined in [Kosu.ts:112](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L112)_ +_Defined in [Kosu.ts:113](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L113)_ The `validatorRegistry` instance enables interaction with the `ValidatorRegistry` token-curated registry system. The system enables users to submit proposals @@ -194,7 +182,7 @@ It also provides query access to past challenges and the current listings. • **version**: _string_ -_Defined in [Kosu.ts:137](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L137)_ +_Defined in [Kosu.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L132)_ The current `@kosu/kosu.js` package version. @@ -204,7 +192,7 @@ The current `@kosu/kosu.js` package version. • **voting**: _[Voting](voting.md)_ -_Defined in [Kosu.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L96)_ +_Defined in [Kosu.ts:97](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L97)_ The `voting` instance provides access to the Kosu `voting` contract and allows users to participate in voting on governance measures, and claiming @@ -216,7 +204,7 @@ rewards for correctly participating in winning polls. • **web3**: _`Web3`_ -_Defined in [Kosu.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L41)_ +_Defined in [Kosu.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L42)_ The primary `web3` instance provides access to an Ethereum node's JSONRPC API and utilities. This instance is used to interact with each Kosu contract @@ -228,7 +216,7 @@ wrapper and can be used to directly access the `web3` API. • **web3Wrapper**: _`Web3Wrapper`_ -_Defined in [Kosu.ts:48](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L48)_ +_Defined in [Kosu.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L49)_ The `web3Wrapper` is used for some extended features, and provides a higher-level API to the same underlying `web3` provider. It it used to diff --git a/packages/kosu-docs/docs/kosu.js/classes/kosutoken.md b/packages/kosu-docs/docs/kosu-contract-helpers/classes/kosutoken.md similarity index 77% rename from packages/kosu-docs/docs/kosu.js/classes/kosutoken.md rename to packages/kosu-docs/docs/kosu-contract-helpers/classes/kosutoken.md index b92006eae..01f6da03b 100644 --- a/packages/kosu-docs/docs/kosu.js/classes/kosutoken.md +++ b/packages/kosu-docs/docs/kosu-contract-helpers/classes/kosutoken.md @@ -39,9 +39,9 @@ If instantiated outside the `Kosu` class, an instance of `web3` and of the ### constructor -\+ **new KosuToken**(`options`: [KosuOptions](../interfaces/kosuoptions.md)): _[KosuToken](kosutoken.md)_ +\+ **new KosuToken**(`options`: `KosuOptions`): _[KosuToken](kosutoken.md)_ -_Defined in [KosuToken.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L37)_ +_Defined in [KosuToken.ts:39](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L39)_ Creates a new KosuToken instance, supplied with an options object. @@ -57,9 +57,9 @@ const kosuToken = new KosuToken(options); **Parameters:** -| Name | Type | Description | -| --------- | ------------------------------------------- | -------------------------------------------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | initialization options object (incl. `web3` and `web3wrapper`) | +| Name | Type | Description | +| --------- | ------------- | -------------------------------------------------------------- | +| `options` | `KosuOptions` | initialization options object (incl. `web3` and `web3wrapper`) | **Returns:** _[KosuToken](kosutoken.md)_ @@ -69,7 +69,7 @@ const kosuToken = new KosuToken(options); ▸ **allowance**(`owner`: string, `spender`: string): _`Promise`_ -_Defined in [KosuToken.ts:151](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L151)_ +_Defined in [KosuToken.ts:153](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L153)_ Reads approved allowance for a given `owner` and `spender` account. @@ -90,7 +90,7 @@ The allowance granted to the `spender` in units of wei. ▸ **approve**(`spender`: string, `value`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:139](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L139)_ +_Defined in [KosuToken.ts:141](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L141)_ Sets approval for user to transfer tokens on `coinbase`'s behalf. @@ -111,7 +111,7 @@ The transaction receipt after it has been included in a block. ▸ **balanceOf**(`owner`: string): _`Promise`_ -_Defined in [KosuToken.ts:102](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L102)_ +_Defined in [KosuToken.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L104)_ Reads the balance for a user address, returned in wei. @@ -131,7 +131,7 @@ The `owner`'s KOSU balance in wei. ▸ **bondTokens**(`value`: `BigNumber`, `minPayout`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:185](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L185)_ +_Defined in [KosuToken.ts:187](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L187)_ Sends ether to the contract to bond tokens. @@ -152,7 +152,7 @@ Logs from the transaction block. ▸ **estimateEtherToToken**(`etherInput`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:162](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L162)_ +_Defined in [KosuToken.ts:164](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L164)_ Calculated tokens to be minted from deposited ether. @@ -172,7 +172,7 @@ Estimation of tokens to be minted. ▸ **estimateTokenToEther**(`tokensToBurn`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:173](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L173)_ +_Defined in [KosuToken.ts:175](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L175)_ Calculates ether to be returned for burning tokens. @@ -192,7 +192,7 @@ Estimation of ether to be returned. ▸ **pay**(`value`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:209](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L209)_ +_Defined in [KosuToken.ts:211](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L211)_ Sends ether to the contract to bond tokens. @@ -212,7 +212,7 @@ Logs from the transaction block. ▸ **releaseTokens**(`tokensToBurn`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:198](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L198)_ +_Defined in [KosuToken.ts:200](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L200)_ Releases tokens to be burned and return bonded ether. @@ -232,7 +232,7 @@ Logs from the transaction block. ▸ **totalSupply**(): _`Promise`_ -_Defined in [KosuToken.ts:91](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L91)_ +_Defined in [KosuToken.ts:93](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L93)_ Reads the total supply of KOSU, resolves to a `BigNumber` of the amount of tokens in units of wei. @@ -247,7 +247,7 @@ The total KOSU supply in wei. ▸ **transfer**(`to`: string, `value`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:114](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L114)_ +_Defined in [KosuToken.ts:116](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L116)_ Transfers tokens to an address, from the current `coinbase` account. @@ -268,7 +268,7 @@ The transaction's receipt after inclusion in a block. ▸ **transferFrom**(`from`: string, `to`: string, `value`: `BigNumber`): _`Promise`_ -_Defined in [KosuToken.ts:127](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/KosuToken.ts#L127)_ +_Defined in [KosuToken.ts:129](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L129)_ Transfers token from an address to a destination address. diff --git a/packages/kosu-docs/docs/kosu.js/classes/nodeclient.md b/packages/kosu-docs/docs/kosu-contract-helpers/classes/nodeclient.md similarity index 77% rename from packages/kosu-docs/docs/kosu.js/classes/nodeclient.md rename to packages/kosu-docs/docs/kosu-contract-helpers/classes/nodeclient.md index 8220d0a1e..81dba300d 100644 --- a/packages/kosu-docs/docs/kosu.js/classes/nodeclient.md +++ b/packages/kosu-docs/docs/kosu-contract-helpers/classes/nodeclient.md @@ -59,7 +59,7 @@ View the Kosu RPC documentation [here.](https://docs.kosu.io/go-kosu/kosu_rpc.ht \+ **new NodeClient**(`url`: string, `options?`: `WebsocketProviderOptions`): _[NodeClient](nodeclient.md)_ -_Defined in [NodeClient.ts:69](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L69)_ +_Defined in [NodeClient.ts:70](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L70)_ Create a new NodeClient (`node`) via a connection to a Kosu node serving the Kosu JSONRPC/WebSocket. @@ -86,7 +86,7 @@ const node = new NodeClient("wss://localhost:14342", { timeout: 1000 }); ▪ **NODE_ID_HASH_OFFSET**: _number_ = 20 -_Defined in [NodeClient.ts:38](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L38)_ +_Defined in [NodeClient.ts:39](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L39)_ Kosu validator node IDs are the first 20 bytes of the SHA-256 hash of the public key. @@ -97,7 +97,7 @@ public key. ▪ **PUBLIC_KEY_LENGTH**: _number_ = 32 -_Defined in [NodeClient.ts:32](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L32)_ +_Defined in [NodeClient.ts:33](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L33)_ Kosu validator public key's are 32 bytes long. @@ -107,7 +107,7 @@ Kosu validator public key's are 32 bytes long. ▸ **addOrders**(...`orders`: any[]): _`Promise`_ -_Defined in [NodeClient.ts:101](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L101)_ +_Defined in [NodeClient.ts:102](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L102)_ See [`kosu_addOrders`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#addorders) @@ -134,7 +134,7 @@ ID's of the accepted orders. ▸ **latestHeight**(): _`Promise`_ -_Defined in [NodeClient.ts:112](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L112)_ +_Defined in [NodeClient.ts:113](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L113)_ See [`kosu_latestHeight`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#latestheight) @@ -150,7 +150,7 @@ The most recent Kosu block number. ▸ **numberPosters**(): _`Promise`_ -_Defined in [NodeClient.ts:123](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L123)_ +_Defined in [NodeClient.ts:124](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L124)_ See [`kosu_numberPosters`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#numberposters) @@ -166,7 +166,7 @@ The total number of poster accounts the node is tracking. ▸ **queryPoster**(`address`: string): _`Promise`_ -_Defined in [NodeClient.ts:135](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L135)_ +_Defined in [NodeClient.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L136)_ See [`kosu_queryPoster`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#queryposter) @@ -189,7 +189,7 @@ Balance and order limit data for the specified poster account. ▸ **queryValidator**(`nodeId`: string): _`Promise`_ -_Defined in [NodeClient.ts:156](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L156)_ +_Defined in [NodeClient.ts:157](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L157)_ See [`kosu_queryValidator`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#queryvalidator) @@ -216,7 +216,7 @@ Information about the requested validator (see `Validator`). ▸ **remainingLimit**(): _`Promise`_ -_Defined in [NodeClient.ts:173](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L173)_ +_Defined in [NodeClient.ts:174](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L174)_ See [`kosu_remainingLimit`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#remaininglimit) @@ -234,7 +234,7 @@ The unutilized order bandwidth for the current period. ▸ **roundInfo**(): _`Promise`_ -_Defined in [NodeClient.ts:185](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L185)_ +_Defined in [NodeClient.ts:186](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L186)_ See [`kosu_roundInfo`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#roundinfo) @@ -251,7 +251,7 @@ Information about the current rebalance period. ▸ **subscribeToBlocks**(`cb`: function): _`Promise`_ -_Defined in [NodeClient.ts:241](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L241)_ +_Defined in [NodeClient.ts:242](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L242)_ Read about Kosu subscriptions [here](https://docs.kosu.io/go-kosu/kosu_rpc.html#subscriptions). @@ -284,7 +284,7 @@ A UUID that can be used to cancel the new subscription (see `node.unsubscribe()` ▸ **subscribeToOrders**(`cb`: function): _`Promise`_ -_Defined in [NodeClient.ts:226](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L226)_ +_Defined in [NodeClient.ts:227](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L227)_ Read about Kosu subscriptions [here](https://docs.kosu.io/go-kosu/kosu_rpc.html#subscriptions). @@ -317,7 +317,7 @@ A UUID that can be used to cancel the new subscription (see `node.unsubscribe()` ▸ **subscribeToRebalances**(`cb`: function): _`Promise`_ -_Defined in [NodeClient.ts:256](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L256)_ +_Defined in [NodeClient.ts:257](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L257)_ Read about Kosu subscriptions [here](https://docs.kosu.io/go-kosu/kosu_rpc.html#subscriptions). @@ -332,13 +332,13 @@ information (starting block, ending block, etc.). A callback function to handle new rebalance information. -▸ (`roundInfo`: [RoundInfo](../interfaces/roundinfo.md)): _void_ +▸ (`roundInfo`: `RoundInfo`): _void_ **Parameters:** -| Name | Type | -| ----------- | --------------------------------------- | -| `roundInfo` | [RoundInfo](../interfaces/roundinfo.md) | +| Name | Type | +| ----------- | ----------- | +| `roundInfo` | `RoundInfo` | **Returns:** _`Promise`_ @@ -350,7 +350,7 @@ A UUID that can be used to cancel the new subscription (see `node.unsubscribe()` ▸ **totalOrders**(): _`Promise`_ -_Defined in [NodeClient.ts:198](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L198)_ +_Defined in [NodeClient.ts:199](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L199)_ See [`kosu_totalOrders`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#totalorders) @@ -367,7 +367,7 @@ The total number of orders posted since network genesis. ▸ **unsubscribe**(`subscriptionId`: string): _`Promise`_ -_Defined in [NodeClient.ts:265](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L265)_ +_Defined in [NodeClient.ts:266](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L266)_ Cancel an active subscription. @@ -385,7 +385,7 @@ Cancel an active subscription. ▸ **validators**(): _`Promise`_ -_Defined in [NodeClient.ts:210](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L210)_ +_Defined in [NodeClient.ts:211](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L211)_ See [`kosu_validators`.](https://docs.kosu.io/go-kosu/kosu_rpc.html#validators) @@ -402,7 +402,7 @@ Information about all active Kosu validators (see `Validator`). ▸ **publicKeyToNodeId**(`publicKey`: string): _string_ -_Defined in [NodeClient.ts:51](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L51)_ +_Defined in [NodeClient.ts:52](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L52)_ Convert a Kosu/Tendermint public key to the corresponding node ID. @@ -424,7 +424,7 @@ The node ID (tendermint "address") for that public key. ### ▪ **DEFAULT_OPTIONS**: _object_ -_Defined in [NodeClient.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L27)_ +_Defined in [NodeClient.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L28)_ The default options specify a connection timeout of 3s, all other defaults are inherited from `WebsocketProviderOptions`. @@ -433,4 +433,4 @@ are inherited from `WebsocketProviderOptions`. • **timeout**: _number_ = 3000 -_Defined in [NodeClient.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/NodeClient.ts#L27)_ +_Defined in [NodeClient.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/NodeClient.ts#L28)_ diff --git a/packages/kosu-docs/docs/kosu.js/classes/ordergateway.md b/packages/kosu-docs/docs/kosu-contract-helpers/classes/ordergateway.md similarity index 50% rename from packages/kosu-docs/docs/kosu.js/classes/ordergateway.md rename to packages/kosu-docs/docs/kosu-contract-helpers/classes/ordergateway.md index 6db0df055..d140e0abe 100644 --- a/packages/kosu-docs/docs/kosu.js/classes/ordergateway.md +++ b/packages/kosu-docs/docs/kosu-contract-helpers/classes/ordergateway.md @@ -36,17 +36,17 @@ specified SubContract during serialization and signature generation. ### constructor -\+ **new OrderGateway**(`options`: [KosuOptions](../interfaces/kosuoptions.md)): _[OrderGateway](ordergateway.md)_ +\+ **new OrderGateway**(`options`: `KosuOptions`): _[OrderGateway](ordergateway.md)_ -_Defined in [OrderGateway.ts:46](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderGateway.ts#L46)_ +_Defined in [OrderGateway.ts:48](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L48)_ Create a new OrderGateway instance. **Parameters:** -| Name | Type | Description | -| --------- | ------------------------------------------- | ------------------------------------------ | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | Instantiation options (see `KosuOptions`). | +| Name | Type | Description | +| --------- | ------------- | ------------------------------------------ | +| `options` | `KosuOptions` | Instantiation options (see `KosuOptions`). | **Returns:** _[OrderGateway](ordergateway.md)_ @@ -54,18 +54,18 @@ Create a new OrderGateway instance. ### amountRemaining -▸ **amountRemaining**(`order`: [Order](../interfaces/order.md)): _`Promise`_ +▸ **amountRemaining**(`order`: `Order`): _`Promise`_ -_Defined in [OrderGateway.ts:150](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderGateway.ts#L150)_ +_Defined in [OrderGateway.ts:152](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L152)_ Checks amount of partial exchange tokens remaining, depending on the implementation of the SubContract specified in the supplied order. **Parameters:** -| Name | Type | Description | -| ------- | ------------------------------- | --------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | The Kosu order to check amount remaining for. | +| Name | Type | Description | +| ------- | ------- | --------------------------------------------- | +| `order` | `Order` | The Kosu order to check amount remaining for. | **Returns:** _`Promise`_ @@ -78,7 +78,7 @@ implementation of the `amountRemaining` method. ▸ **arguments**(`subContract`: string): _`Promise`_ -_Defined in [OrderGateway.ts:117](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderGateway.ts#L117)_ +_Defined in [OrderGateway.ts:119](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L119)_ Read the required arguments from a deployed SubContract. @@ -96,17 +96,17 @@ The JSON array that defines the arguments for the SubContract. ### isValid -▸ **isValid**(`order`: [Order](../interfaces/order.md)): _`Promise`_ +▸ **isValid**(`order`: `Order`): _`Promise`_ -_Defined in [OrderGateway.ts:134](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderGateway.ts#L134)_ +_Defined in [OrderGateway.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L136)_ Checks validity of order data according the order's SubContract implementation. **Parameters:** -| Name | Type | Description | -| ------- | ------------------------------- | -------------------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | Kosu order to validate against `isValid` implementation. | +| Name | Type | Description | +| ------- | ------- | -------------------------------------------------------- | +| `order` | `Order` | Kosu order to validate against `isValid` implementation. | **Returns:** _`Promise`_ @@ -114,9 +114,9 @@ Checks validity of order data according the order's SubContract implementation. ### participate -▸ **participate**(`order`: [Order](../interfaces/order.md), `taker`: string): _`Promise`_ +▸ **participate**(`order`: `Order`, `taker`: string): _`Promise`_ -_Defined in [OrderGateway.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderGateway.ts#L96)_ +_Defined in [OrderGateway.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L98)_ Participate in a trade as a taker (or on behalf of one), by submitting the maker order, and the Ethereum address of the taker. The fill transaction @@ -125,10 +125,10 @@ SubContract settlement logic. **Parameters:** -| Name | Type | Description | -| ------- | ------------------------------- | ------------------------------------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | A signed Kosu maker order object with a valid `subContract`. | -| `taker` | string | The Ethereum address of the taker (should be available through provider). | +| Name | Type | Description | +| ------- | ------- | ------------------------------------------------------------------------- | +| `order` | `Order` | A signed Kosu maker order object with a valid `subContract`. | +| `taker` | string | The Ethereum address of the taker (should be available through provider). | **Returns:** _`Promise`_ diff --git a/packages/kosu-docs/docs/kosu-contract-helpers/classes/orderhelper.md b/packages/kosu-docs/docs/kosu-contract-helpers/classes/orderhelper.md new file mode 100644 index 000000000..5e14ffd04 --- /dev/null +++ b/packages/kosu-docs/docs/kosu-contract-helpers/classes/orderhelper.md @@ -0,0 +1,191 @@ +> **[kosu.js](../README.md)** + +[Globals](../globals.md) / [OrderHelper](orderhelper.md) / + +# Class: OrderHelper + +The `OrderHelper` provides methods for interacting with maker orders, such as +participating in trades (as a taker), signing maker order's for execution and +for submission to the Kosu relay network. + +Requires a configured `web3` provider that allows signatures and the execution +of transactions. + +## Hierarchy + +- **OrderHelper** + +## Index + +### Constructors + +- [constructor](orderhelper.md#constructor) + +### Methods + +- [makeOrder](orderhelper.md#makeorder) +- [makerHex](orderhelper.md#makerhex) +- [prepareForPost](orderhelper.md#prepareforpost) +- [recoverMaker](orderhelper.md#recovermaker) +- [recoverPoster](orderhelper.md#recoverposter) +- [serialize](orderhelper.md#serialize) +- [takeOrder](orderhelper.md#takeorder) + +## Constructors + +### constructor + +\+ **new OrderHelper**(`web3`: `Web3`, `orderGateway`: [OrderGateway](ordergateway.md)): _[OrderHelper](orderhelper.md)_ + +_Defined in [OrderHelper.ts:25](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L25)_ + +Create a new `OrderHelper` instance (requires a provider via supplied `web3` +instance). + +**Parameters:** + +| Name | Type | Description | +| -------------- | ------------------------------- | --------------------------------------------------- | +| `web3` | `Web3` | An instance of `Web3` with an active node provider. | +| `orderGateway` | [OrderGateway](ordergateway.md) | An instantiated `OrderGateway` wrapper. | + +**Returns:** _[OrderHelper](orderhelper.md)_ + +## Methods + +### makeOrder + +▸ **makeOrder**(`order`: `Order`): _`Promise`_ + +_Defined in [OrderHelper.ts:45](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L45)_ + +Sign and complete a maker order (requires a pre-configured Order object). + +**Parameters:** + +| Name | Type | Description | +| ------- | ------- | ------------------------- | +| `order` | `Order` | Order to sign as a maker. | + +**Returns:** _`Promise`_ + +The supplied maker order with an appended `makerSignature`. + +--- + +### makerHex + +▸ **makerHex**(`order`: `Order`): _`Promise`_ + +_Defined in [OrderHelper.ts:105](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L105)_ + +Generate the maker hex (serialized `makerValues`). + +**Parameters:** + +| Name | Type | Description | +| ------- | ------- | -------------------------- | +| `order` | `Order` | Order to get maker hex for | + +**Returns:** _`Promise`_ + +--- + +### prepareForPost + +▸ **prepareForPost**(`order`: `Order`, `poster`: string): _`Promise`_ + +_Defined in [OrderHelper.ts:77](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L77)_ + +Sign and order as a poster and append the poster signature to an order +prior to submission to the Kosu relay network. + +**Parameters:** + +| Name | Type | Default | Description | +| -------- | ------- | ----------- | ----------------------------------------------------------------- | +| `order` | `Order` | - | Order to prepare (by appending a poster signature). | +| `poster` | string | order.maker | Poster address to sign order with, defaults to the order's maker. | + +**Returns:** _`Promise`_ + +The maker order now signed and prepared for post with an appended `posterSignature`. + +--- + +### recoverMaker + +▸ **recoverMaker**(`order`: `Order`): _`Promise`_ + +_Defined in [OrderHelper.ts:115](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L115)_ + +Recover the maker address from a signed order. + +**Parameters:** + +| Name | Type | Description | +| ------- | ------- | --------------------------------------------- | +| `order` | `Order` | A signed order to recover maker address from. | + +**Returns:** _`Promise`_ + +--- + +### recoverPoster + +▸ **recoverPoster**(`order`: `PostableOrder`): _`Promise`_ + +_Defined in [OrderHelper.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L126)_ + +Recover the poster address from a maker order that has been signed from a +poster. + +**Parameters:** + +| Name | Type | Description | +| ------- | --------------- | ---------------------------------------------------------- | +| `order` | `PostableOrder` | Order to recover poster from (must be signed by a poster). | + +**Returns:** _`Promise`_ + +--- + +### serialize + +▸ **serialize**(`order`: `Order`): _`Promise`_ + +_Defined in [OrderHelper.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L136)_ + +Generates the contract submission bytes from the arguments of provided order. + +**Parameters:** + +| Name | Type | Description | +| ------- | ------- | ------------------------------------------- | +| `order` | `Order` | Order to generate contract input bytes for. | + +**Returns:** _`Promise`_ + +--- + +### takeOrder + +▸ **takeOrder**(`order`: `TakeableOrder`, `taker`: string): _`Promise`_ + +_Defined in [OrderHelper.ts:65](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderHelper.ts#L65)_ + +Take a signed maker order on the Ethereum blockchain via the order's +specified SubContract, from the supplied taker address (should be available +via configured `web` provider). + +**Parameters:** + +| Name | Type | Description | +| ------- | --------------- | --------------------------------------------------------------------------- | +| `order` | `TakeableOrder` | A signed and fillable maker order object. | +| `taker` | string | The Ethereum address of the taker (must be available to sign via provider). | + +**Returns:** _`Promise`_ + +The value defined by the order's SubContract implementation, usually `true` +for successfully filled orders, and `false` for failed fills. diff --git a/packages/kosu-docs/docs/kosu.js/classes/posterregistry.md b/packages/kosu-docs/docs/kosu-contract-helpers/classes/posterregistry.md similarity index 69% rename from packages/kosu-docs/docs/kosu.js/classes/posterregistry.md rename to packages/kosu-docs/docs/kosu-contract-helpers/classes/posterregistry.md index cabf84940..b8658c2d8 100644 --- a/packages/kosu-docs/docs/kosu.js/classes/posterregistry.md +++ b/packages/kosu-docs/docs/kosu-contract-helpers/classes/posterregistry.md @@ -32,18 +32,18 @@ and to view their balance, as well as the cumulative lockup. ### constructor -\+ **new PosterRegistry**(`options`: [KosuOptions](../interfaces/kosuoptions.md), `treasury`: [Treasury](treasury.md)): _[PosterRegistry](posterregistry.md)_ +\+ **new PosterRegistry**(`options`: `KosuOptions`, `treasury`: [Treasury](treasury.md)): _[PosterRegistry](posterregistry.md)_ -_Defined in [PosterRegistry.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L41)_ +_Defined in [PosterRegistry.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L43)_ Create a new PosterRegistry instance. **Parameters:** -| Name | Type | Description | -| ---------- | ------------------------------------------- | ------------------------------------------ | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | Instantiation options (see `KosuOptions`). | -| `treasury` | [Treasury](treasury.md) | Treasury integration instance. | +| Name | Type | Description | +| ---------- | ----------------------- | ------------------------------------------ | +| `options` | `KosuOptions` | Instantiation options (see `KosuOptions`). | +| `treasury` | [Treasury](treasury.md) | Treasury integration instance. | **Returns:** _[PosterRegistry](posterregistry.md)_ @@ -53,7 +53,7 @@ Create a new PosterRegistry instance. ▸ **pay**(`value`: `BigNumber`): _`Promise`_ -_Defined in [PosterRegistry.ts:149](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L149)_ +_Defined in [PosterRegistry.ts:151](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L151)_ Sends ether to the contract to bond and register tokens for posting. @@ -73,7 +73,7 @@ Logs from the transaction block. ▸ **registerTokens**(`amount`: `BigNumber`): _`Promise`_ -_Defined in [PosterRegistry.ts:107](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L107)_ +_Defined in [PosterRegistry.ts:109](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L109)_ Register tokens into the PosterRegistry contract by bonding KOSU tokens. @@ -93,7 +93,7 @@ A transaction receipt from the mined `register` transaction. ▸ **releaseTokens**(`amount`: `BigNumber`): _`Promise`_ -_Defined in [PosterRegistry.ts:138](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L138)_ +_Defined in [PosterRegistry.ts:140](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L140)_ Release tokens from the PosterRegistry for the `coinbase` address (un-bond). @@ -113,7 +113,7 @@ A transaction receipt from the mined `register` transaction. ▸ **tokensContributed**(): _`Promise`_ -_Defined in [PosterRegistry.ts:85](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L85)_ +_Defined in [PosterRegistry.ts:87](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L87)_ Reads total KOSU tokens contributed to registry. @@ -127,7 +127,7 @@ The total pool of locked KOSU tokens in units of wei. ▸ **tokensRegisteredFor**(`address`: string): _`Promise`_ -_Defined in [PosterRegistry.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/PosterRegistry.ts#L96)_ +_Defined in [PosterRegistry.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/PosterRegistry.ts#L98)_ Reads number of tokens registered for a given address. diff --git a/packages/kosu-docs/docs/kosu.js/classes/treasury.md b/packages/kosu-docs/docs/kosu-contract-helpers/classes/treasury.md similarity index 76% rename from packages/kosu-docs/docs/kosu.js/classes/treasury.md rename to packages/kosu-docs/docs/kosu-contract-helpers/classes/treasury.md index fc2cba9da..c15fb6bba 100644 --- a/packages/kosu-docs/docs/kosu.js/classes/treasury.md +++ b/packages/kosu-docs/docs/kosu-contract-helpers/classes/treasury.md @@ -41,18 +41,18 @@ constructor must include the Treasury's ABI (from the compiled Solidity source). ### constructor -\+ **new Treasury**(`options`: [KosuOptions](../interfaces/kosuoptions.md), `kosuToken`: [KosuToken](kosutoken.md)): _[Treasury](treasury.md)_ +\+ **new Treasury**(`options`: `KosuOptions`, `kosuToken`: [KosuToken](kosutoken.md)): _[Treasury](treasury.md)_ -_Defined in [Treasury.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L49)_ +_Defined in [Treasury.ts:51](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L51)_ Creates a new Treasury instance. **Parameters:** -| Name | Type | Description | -| ----------- | ------------------------------------------- | --------------------------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | Initialization options (see `KosuOptions`). | -| `kosuToken` | [KosuToken](kosutoken.md) | Configured/instantiated `KosuToken` instance. | +| Name | Type | Description | +| ----------- | ------------------------- | --------------------------------------------- | +| `options` | `KosuOptions` | Initialization options (see `KosuOptions`). | +| `kosuToken` | [KosuToken](kosutoken.md) | Configured/instantiated `KosuToken` instance. | **Returns:** _[Treasury](treasury.md)_ @@ -62,7 +62,7 @@ Creates a new Treasury instance. • **kosuToken**: _[KosuToken](kosutoken.md)_ -_Defined in [Treasury.ts:33](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L33)_ +_Defined in [Treasury.ts:35](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L35)_ An instance of the `KosuToken` class to communicate with the KOSU ERC-20 token. @@ -72,7 +72,7 @@ An instance of the `KosuToken` class to communicate with the KOSU ERC-20 token. ▸ **approveTreasury**(`value`: `BigNumber`): _`Promise`_ -_Defined in [Treasury.ts:210](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L210)_ +_Defined in [Treasury.ts:212](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L212)_ Approve the treasury to transfer KOSU on behalf of the user's `coinbase` account. @@ -102,7 +102,7 @@ The decoded transaction receipt, after the TX has been mined. ▸ **currentBalance**(`address`: string): _`Promise`_ -_Defined in [Treasury.ts:172](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L172)_ +_Defined in [Treasury.ts:174](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L174)_ Read the available (current) treasury balance for a provided `address`. @@ -134,7 +134,7 @@ The user's current treasury balance (in wei). ▸ **deposit**(`value`: `BigNumber`): _`Promise`_ -_Defined in [Treasury.ts:99](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L99)_ +_Defined in [Treasury.ts:101](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L101)_ Deposit tokens in the treasury, from the detected `coinbase` account. @@ -163,7 +163,7 @@ The decoded transaction receipt, after the TX has been included in a block. ▸ **pay**(`value`: `BigNumber`): _`Promise`_ -_Defined in [Treasury.ts:221](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L221)_ +_Defined in [Treasury.ts:223](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L223)_ Sends ether to the contract to bond and deposit tokens. @@ -183,7 +183,7 @@ Logs from the transaction block. ▸ **systemBalance**(`address`: string): _`Promise`_ -_Defined in [Treasury.ts:151](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L151)_ +_Defined in [Treasury.ts:153](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L153)_ Read the total system balance of KOSU for a provided `address` string. @@ -215,7 +215,7 @@ The user's total KOSU system balance, in wei. ▸ **treasuryAllowance**(): _`Promise`_ -_Defined in [Treasury.ts:191](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L191)_ +_Defined in [Treasury.ts:193](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L193)_ View the current treasury allowance for the detected `coinbase` account. @@ -240,7 +240,7 @@ The current KOSU approval for the Treasury for the current user, in wei. ▸ **withdraw**(`value`: `BigNumber`): _`Promise`_ -_Defined in [Treasury.ts:130](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Treasury.ts#L130)_ +_Defined in [Treasury.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Treasury.ts#L132)_ Withdraw tokens from treasury to the detected `coinbase` account. diff --git a/packages/kosu-docs/docs/kosu.js/classes/validatorregistry.md b/packages/kosu-docs/docs/kosu-contract-helpers/classes/validatorregistry.md similarity index 66% rename from packages/kosu-docs/docs/kosu.js/classes/validatorregistry.md rename to packages/kosu-docs/docs/kosu-contract-helpers/classes/validatorregistry.md index 2ebffcac5..8e987107d 100644 --- a/packages/kosu-docs/docs/kosu.js/classes/validatorregistry.md +++ b/packages/kosu-docs/docs/kosu-contract-helpers/classes/validatorregistry.md @@ -50,18 +50,18 @@ Integration with ValidatorRegistry contract on an Ethereum blockchain. ### constructor -\+ **new ValidatorRegistry**(`options`: [KosuOptions](../interfaces/kosuoptions.md), `treasury`: [Treasury](treasury.md)): _[ValidatorRegistry](validatorregistry.md)_ +\+ **new ValidatorRegistry**(`options`: `KosuOptions`, `treasury`: [Treasury](treasury.md)): _[ValidatorRegistry](validatorregistry.md)_ -_Defined in [ValidatorRegistry.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L18)_ +_Defined in [ValidatorRegistry.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L20)_ Create a new ValidatorRegistry instance. **Parameters:** -| Name | Type | Description | -| ---------- | ------------------------------------------- | ----------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | instantiation options | -| `treasury` | [Treasury](treasury.md) | treasury integration instance | +| Name | Type | Description | +| ---------- | ----------------------- | ----------------------------- | +| `options` | `KosuOptions` | instantiation options | +| `treasury` | [Treasury](treasury.md) | treasury integration instance | **Returns:** _[ValidatorRegistry](validatorregistry.md)_ @@ -71,7 +71,7 @@ Create a new ValidatorRegistry instance. ▸ **applicationPeriod**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:64](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L64)_ +_Defined in [ValidatorRegistry.ts:66](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L66)_ Reads the application period @@ -83,7 +83,7 @@ Reads the application period ▸ **challengeListing**(`_pubKey`: string, `_details`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:256](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L256)_ +_Defined in [ValidatorRegistry.ts:258](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L258)_ Starts a challenge of a listing @@ -102,7 +102,7 @@ Starts a challenge of a listing ▸ **challengePeriod**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:80](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L80)_ +_Defined in [ValidatorRegistry.ts:82](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L82)_ Reads the challenge period @@ -114,7 +114,7 @@ Reads the challenge period ▸ **claimRewards**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:285](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L285)_ +_Defined in [ValidatorRegistry.ts:287](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L287)_ Claims the rewards of a generating/burning listing @@ -132,7 +132,7 @@ Claims the rewards of a generating/burning listing ▸ **claimWinnings**(`challengeId`: `BigNumber`): _`Promise`_ -_Defined in [ValidatorRegistry.ts:315](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L315)_ +_Defined in [ValidatorRegistry.ts:317](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L317)_ Claims winnings from complete challenge @@ -150,7 +150,7 @@ Claims winnings from complete challenge ▸ **commitPeriod**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:72](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L72)_ +_Defined in [ValidatorRegistry.ts:74](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L74)_ Reads the commit period @@ -162,7 +162,7 @@ Reads the commit period ▸ **confirmListing**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:245](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L245)_ +_Defined in [ValidatorRegistry.ts:247](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L247)_ Confirms listing after application period @@ -180,7 +180,7 @@ Confirms listing after application period ▸ **convertPubKey**(`_pubKey`: string): _string_ -_Defined in [ValidatorRegistry.ts:326](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L326)_ +_Defined in [ValidatorRegistry.ts:328](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L328)_ Converts public key to hex if input is not currently in hex @@ -200,7 +200,7 @@ hex encoded tendermint public key ▸ **exitPeriod**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:88](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L88)_ +_Defined in [ValidatorRegistry.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L90)_ Reads the exit period @@ -212,7 +212,7 @@ Reads the exit period ▸ **finalizeExit**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:305](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L305)_ +_Defined in [ValidatorRegistry.ts:307](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L307)_ Finalizes the exit of a listing @@ -230,7 +230,7 @@ Finalizes the exit of a listing ▸ **getAllChallenges**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:199](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L199)_ +_Defined in [ValidatorRegistry.ts:201](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L201)_ Reads all challenges @@ -242,7 +242,7 @@ Reads all challenges ▸ **getAllListings**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:162](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L162)_ +_Defined in [ValidatorRegistry.ts:164](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L164)_ Reads the registered listings @@ -254,7 +254,7 @@ Reads the registered listings ▸ **getChallenge**(`challengeId`: `BigNumber`): _`Promise`_ -_Defined in [ValidatorRegistry.ts:180](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L180)_ +_Defined in [ValidatorRegistry.ts:182](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L182)_ Reads the challenge by challengeId @@ -272,7 +272,7 @@ Reads the challenge by challengeId ▸ **getChallenges**(`challengeIds`: `BigNumber`[]): _`Promise`_ -_Defined in [ValidatorRegistry.ts:190](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L190)_ +_Defined in [ValidatorRegistry.ts:192](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L192)_ Reads the challenges by challengeIds @@ -290,7 +290,7 @@ Reads the challenges by challengeIds ▸ **getListing**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:146](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L146)_ +_Defined in [ValidatorRegistry.ts:148](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L148)_ Reads the listing for public key @@ -308,7 +308,7 @@ Reads the listing for public key ▸ **getListings**(`_pubKeys`: string[]): _`Promise`_ -_Defined in [ValidatorRegistry.ts:154](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L154)_ +_Defined in [ValidatorRegistry.ts:156](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L156)_ Reads the requested listings @@ -326,7 +326,7 @@ Reads the requested listings ▸ **hexToBase64**(`_pubKey`: string): _string_ -_Defined in [ValidatorRegistry.ts:350](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L350)_ +_Defined in [ValidatorRegistry.ts:352](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L352)_ Converts hex encoded public key back to tendermint base64 @@ -346,7 +346,7 @@ Base64 tendermint public key ▸ **initExit**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:295](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L295)_ +_Defined in [ValidatorRegistry.ts:297](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L297)_ Initializes an exit of a listing from the registry @@ -364,7 +364,7 @@ Initializes an exit of a listing from the registry ▸ **kosuToken**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:128](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L128)_ +_Defined in [ValidatorRegistry.ts:130](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L130)_ Reads the kosuToken address @@ -376,7 +376,7 @@ Reads the kosuToken address ▸ **listingKeys**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L136)_ +_Defined in [ValidatorRegistry.ts:138](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L138)_ Reads the current listing keys @@ -388,7 +388,7 @@ Reads the current listing keys ▸ **maxRewardRate**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:170](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L170)_ +_Defined in [ValidatorRegistry.ts:172](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L172)_ Reads the max reward rate @@ -400,7 +400,7 @@ Reads the max reward rate ▸ **minimumBalance**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L104)_ +_Defined in [ValidatorRegistry.ts:106](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L106)_ Reads the minimum balance @@ -412,7 +412,7 @@ Reads the minimum balance ▸ **registerListing**(`_pubKey`: string, `_tokensToStake`: `BigNumber`, `_rewardRate`: `BigNumber`, `_details`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:212](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L212)_ +_Defined in [ValidatorRegistry.ts:214](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L214)_ Register a new listing @@ -433,7 +433,7 @@ Register a new listing ▸ **resolveChallenge**(`_pubKey`: string): _`Promise`_ -_Defined in [ValidatorRegistry.ts:275](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L275)_ +_Defined in [ValidatorRegistry.ts:277](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L277)_ Resolves challenge of a listing @@ -451,7 +451,7 @@ Resolves challenge of a listing ▸ **rewardPeriod**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L96)_ +_Defined in [ValidatorRegistry.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L98)_ Reads the reward period @@ -463,7 +463,7 @@ Reads the reward period ▸ **stakeholderCut**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:112](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L112)_ +_Defined in [ValidatorRegistry.ts:114](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L114)_ Reads the stakeholder cut @@ -475,7 +475,7 @@ Reads the stakeholder cut ▸ **voting**(): _`Promise`_ -_Defined in [ValidatorRegistry.ts:120](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/ValidatorRegistry.ts#L120)_ +_Defined in [ValidatorRegistry.ts:122](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/ValidatorRegistry.ts#L122)_ Reads the Voting contract address diff --git a/packages/kosu-docs/docs/kosu.js/classes/voting.md b/packages/kosu-docs/docs/kosu-contract-helpers/classes/voting.md similarity index 72% rename from packages/kosu-docs/docs/kosu.js/classes/voting.md rename to packages/kosu-docs/docs/kosu-contract-helpers/classes/voting.md index ddcf3fe6a..6a69d7312 100644 --- a/packages/kosu-docs/docs/kosu.js/classes/voting.md +++ b/packages/kosu-docs/docs/kosu-contract-helpers/classes/voting.md @@ -30,18 +30,18 @@ Integration with Voting contract on an Ethereum blockchain. ### constructor -\+ **new Voting**(`options`: [KosuOptions](../interfaces/kosuoptions.md), `treasury`: [Treasury](treasury.md)): _[Voting](voting.md)_ +\+ **new Voting**(`options`: `KosuOptions`, `treasury`: [Treasury](treasury.md)): _[Voting](voting.md)_ -_Defined in [Voting.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L18)_ +_Defined in [Voting.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L20)_ Create a new Voting instance. **Parameters:** -| Name | Type | Description | -| ---------- | ------------------------------------------- | ----------------------------- | -| `options` | [KosuOptions](../interfaces/kosuoptions.md) | instantiation options | -| `treasury` | [Treasury](treasury.md) | treasury integration instance | +| Name | Type | Description | +| ---------- | ----------------------- | ----------------------------- | +| `options` | `KosuOptions` | instantiation options | +| `treasury` | [Treasury](treasury.md) | treasury integration instance | **Returns:** _[Voting](voting.md)_ @@ -51,7 +51,7 @@ Create a new Voting instance. ▸ **commitVote**(`_pollId`: `BigNumber`, `_vote`: string, `_tokensToCommit`: `BigNumber`): _`Promise`_ -_Defined in [Voting.ts:67](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L67)_ +_Defined in [Voting.ts:69](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L69)_ Commits vote to voting contract @@ -71,7 +71,7 @@ Commits vote to voting contract ▸ **encodeVote**(`_voteOption`: string, `_voteSalt`: string): _string_ -_Defined in [Voting.ts:165](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L165)_ +_Defined in [Voting.ts:167](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L167)_ Encodes a vote by hashing the option and salt @@ -92,7 +92,7 @@ Encoded vote ▸ **revealVote**(`_pollId`: `BigNumber`, `_voteOption`: `BigNumber`, `_voteSalt`: `BigNumber`): _`Promise`_ -_Defined in [Voting.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L96)_ +_Defined in [Voting.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L98)_ Reveals vote on voting contract @@ -112,7 +112,7 @@ Reveals vote on voting contract ▸ **totalRevealedTokens**(`_pollId`: `BigNumber`): _`Promise`_ -_Defined in [Voting.ts:134](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L134)_ +_Defined in [Voting.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L136)_ Reads the total winning tokens for poll @@ -130,7 +130,7 @@ Reads the total winning tokens for poll ▸ **totalWinningTokens**(`_pollId`: `BigNumber`): _`Promise`_ -_Defined in [Voting.ts:124](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L124)_ +_Defined in [Voting.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L126)_ Reads the total winning tokens for poll @@ -148,7 +148,7 @@ Reads the total winning tokens for poll ▸ **userWinningTokens**(`_pollId`: `BigNumber`, `_userAddress`: string): _`Promise`_ -_Defined in [Voting.ts:145](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L145)_ +_Defined in [Voting.ts:147](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L147)_ Reads users winning tokens committed for poll @@ -167,7 +167,7 @@ Reads users winning tokens committed for poll ▸ **winningOption**(`_pollId`: `BigNumber`): _`Promise`_ -_Defined in [Voting.ts:114](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Voting.ts#L114)_ +_Defined in [Voting.ts:116](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Voting.ts#L116)_ Reads the winning option for poll diff --git a/packages/kosu-docs/docs/kosu-contract-helpers/globals.md b/packages/kosu-docs/docs/kosu-contract-helpers/globals.md new file mode 100644 index 000000000..d6e6a8adf --- /dev/null +++ b/packages/kosu-docs/docs/kosu-contract-helpers/globals.md @@ -0,0 +1,277 @@ +> **[kosu.js](README.md)** + +[Globals](globals.md) / + +# kosu.js + +## Index + +### Classes + +- [EventEmitter](classes/eventemitter.md) +- [Kosu](classes/kosu.md) +- [KosuToken](classes/kosutoken.md) +- [NodeClient](classes/nodeclient.md) +- [OrderGateway](classes/ordergateway.md) +- [OrderHelper](classes/orderhelper.md) +- [PosterRegistry](classes/posterregistry.md) +- [Treasury](classes/treasury.md) +- [ValidatorRegistry](classes/validatorregistry.md) +- [Voting](classes/voting.md) + +### Variables + +- [version](globals.md#const-version) + +### Functions + +- [\_serialize](globals.md#_serialize) + +### Object literals + +- [KosuEndpoints](globals.md#const-kosuendpoints) +- [OrderSerializer](globals.md#const-orderserializer) +- [Signature](globals.md#const-signature) + +## Variables + +### `Const` version + +• **version**: _any_ = process.env.npm_package_version || require("../package.json").version + +_Defined in [Kosu.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L19)_ + +## Functions + +### \_serialize + +▸ **\_serialize**(`_arguments`: any, `values`: any): _string_ + +_Defined in [OrderSerializer.ts:9](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L9)_ + +**Parameters:** + +| Name | Type | +| ------------ | ---- | +| `_arguments` | any | +| `values` | any | + +**Returns:** _string_ + +## Object literals + +### `Const` KosuEndpoints + +### ▪ **KosuEndpoints**: _object_ + +_Defined in [EventEmitter.ts:9](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L9)_ + +▪ **1**: _object_ + +_Defined in [EventEmitter.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L10)_ + +- **http**: _string_ = `https://ethnet.zaidan.io/mainnet` + +- **ws**: _string_ = `wss://ethnet.zaidan.io/ws/mainnet` + +▪ **3**: _object_ + +_Defined in [EventEmitter.ts:14](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L14)_ + +- **http**: _string_ = `https://ethnet.zaidan.io/ropsten` + +- **ws**: _string_ = `wss://ethnet.zaidan.io/ws/ropsten` + +▪ **42**: _object_ + +_Defined in [EventEmitter.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L18)_ + +- **http**: _string_ = `https://ethnet.zaidan.io/kovan` + +- **ws**: _string_ = `wss://ethnet.zaidan.io/ws/kovan` + +▪ **6174**: _object_ + +_Defined in [EventEmitter.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L22)_ + +- **http**: _string_ = `https://ethnet.zaidan.io/kosu` + +- **ws**: _string_ = `wss://ethnet.zaidan.io/ws/kosu` + +--- + +### `Const` OrderSerializer + +### ▪ **OrderSerializer**: _object_ + +_Defined in [OrderSerializer.ts:52](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L52)_ + +could add to utils (or create order-utils pacakge) + +### makerHex + +▸ **makerHex**(`order`: `Order`, `_arguments`: any): _string_ + +_Defined in [OrderSerializer.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L98)_ + +Generate the maker hex from order + +**Parameters:** + +| Name | Type | Description | +| ------------ | ------- | ---------------------------------------- | +| `order` | `Order` | to generate hex from | +| `_arguments` | any | Argument json defined in the subContract | + +**Returns:** _string_ + +### posterSignatureHex + +▸ **posterSignatureHex**(`order`: `Order`, `_arguments`: any): _string_ + +_Defined in [OrderSerializer.ts:74](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L74)_ + +Generates hex to be used for the poster signing process + +**Parameters:** + +| Name | Type | Description | +| ------------ | ------- | ---------------------------------------- | +| `order` | `Order` | Order to get data for | +| `_arguments` | any | Argument json defined in the subContract | + +**Returns:** _string_ + +### recoverMaker + +▸ **recoverMaker**(`order`: `Order`, `_arguments`: any[]): _string_ + +_Defined in [OrderSerializer.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L126)_ + +Recovers the maker from the signed information + +**Parameters:** + +| Name | Type | Description | +| ------------ | ------- | ---------------------------------------- | +| `order` | `Order` | to recover address from | +| `_arguments` | any[] | Argument json defined in the subContract | + +**Returns:** _string_ + +### recoverPoster + +▸ **recoverPoster**(`order`: `PostableOrder`, `_arguments`: any[]): _string_ + +_Defined in [OrderSerializer.ts:88](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L88)_ + +Recovers the poster from the poster signature + +**Parameters:** + +| Name | Type | Description | +| ------------ | --------------- | ---------------------------------------- | +| `order` | `PostableOrder` | Order to recover address that signed | +| `_arguments` | any[] | Argument json defined in the subContract | + +**Returns:** _string_ + +### serialize + +▸ **serialize**(`_arguments`: any, `order`: `Order`): _string_ + +_Defined in [OrderSerializer.ts:59](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderSerializer.ts#L59)_ + +Serializes the data into bytes + +**Parameters:** + +| Name | Type | Description | +| ------------ | ------- | ---------------------------------------- | +| `_arguments` | any | Argument json defined in the subContract | +| `order` | `Order` | Order to serialize | + +**Returns:** _string_ + +--- + +### `Const` Signature + +### ▪ **Signature**: _object_ + +_Defined in [Signature.ts:6](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Signature.ts#L6)_ + +### generate + +▸ **generate**(`web3`: `Web3`, `messageHex`: string, `signer`: string): _`Promise`_ + +_Defined in [Signature.ts:15](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Signature.ts#L15)_ + +Generates a signature for a message hex using calls to a provider though web3 + +**Parameters:** + +| Name | Type | Description | +| ------------ | ------ | ----------------------------------- | +| `web3` | `Web3` | Web3 configured to desired provider | +| `messageHex` | string | Hex representation of the message | +| `signer` | string | Address to sign the message | + +**Returns:** _`Promise`_ + +A vrs signature + +### recoverAddress + +▸ **recoverAddress**(`messageHex`: any, `signature`: string): _string_ + +_Defined in [Signature.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Signature.ts#L37)_ + +Recovers address from a message hex and signature + +**Parameters:** + +| Name | Type | Description | +| ------------ | ------ | ---------------------------------------- | +| `messageHex` | any | Hex representation of the signed message | +| `signature` | string | VRS signature | + +**Returns:** _string_ + +### sign + +▸ **sign**(`web3`: `Web3`, `messageHex`: string, `signer`: string): _`Promise`_ + +_Defined in [Signature.ts:55](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Signature.ts#L55)_ + +Sign hex with provided address + +**Parameters:** + +| Name | Type | Description | +| ------------ | ------ | -------------------------------------- | +| `web3` | `Web3` | Provider which executes the signature. | +| `messageHex` | string | Hex to be singed | +| `signer` | string | Address to sign with. | + +**Returns:** _`Promise`_ + +### validate + +▸ **validate**(`messageHex`: string, `signature`: string, `signer`: string): _boolean_ + +_Defined in [Signature.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Signature.ts#L27)_ + +Validates the signature of a messageHex is from the provided signer + +**Parameters:** + +| Name | Type | Description | +| ------------ | ------ | -------------------------------------- | +| `messageHex` | string | signed message hex | +| `signature` | string | signature from message hex | +| `signer` | string | signer who may have signed the message | + +**Returns:** _boolean_ + +boolean representing if the signer in fact generated the signature with this message diff --git a/packages/kosu-docs/docs/kosu-genesis-cli/README.md b/packages/kosu-docs/docs/kosu-genesis-cli/README.md index 3f2e3672c..4025fb08a 100644 --- a/packages/kosu-docs/docs/kosu-genesis-cli/README.md +++ b/packages/kosu-docs/docs/kosu-genesis-cli/README.md @@ -64,6 +64,7 @@ Options: -L, --period-length The length of each rebalance period (in Ethereum blocks) (default: "5") -m, --max-order-bytes The maximum size of a single order transaction (default: "4096") -B, --blocks-before-pruning Maximum age of attestations before pruning (default: "50") + -o, --orders-limit The maximum number of orders to keep in state at time (default: "100") -h, --help output usage information ``` diff --git a/packages/kosu-docs/docs/kosu-genesis-cli/globals.md b/packages/kosu-docs/docs/kosu-genesis-cli/globals.md index e6c9f9791..6b0c77de8 100644 --- a/packages/kosu-docs/docs/kosu-genesis-cli/globals.md +++ b/packages/kosu-docs/docs/kosu-genesis-cli/globals.md @@ -40,7 +40,7 @@ • **cli**: _`Command`_ = new commander.Command() -_Defined in [cli/cli.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/cli/cli.ts#L3)_ +_Defined in [cli/cli.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/cli/cli.ts#L3)_ ## Functions @@ -48,7 +48,7 @@ _Defined in [cli/cli.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/b ▸ **dateFromTimestamp**(`timestamp`: number): _`Date`_ -_Defined in [functions.ts:332](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/functions.ts#L332)_ +_Defined in [functions.ts:335](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L335)_ Return a `Date` object generated from a Unix timestamp in seconds. @@ -68,7 +68,7 @@ The JavaScript Date object corresponding to that Unix time. ▸ **generateGenesisFromBlock**(`kosu`: `Kosu`, `chainId`: string, `snapshotBlock`: number, `startTime`: number, `consensusParams`: [ConsensusParams](interfaces/consensusparams.md)): _`Promise`_ -_Defined in [functions.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/functions.ts#L27)_ +_Defined in [functions.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L27)_ Generate a Tendermint genesis file for a Kosu network, where the initial validators are set based on the current state of a deployed Kosu contract system's @@ -94,7 +94,7 @@ Promise resolving to object that can be JSON-serialized to a Kosu/Tendermint gen ▸ **getAppState**(`validators`: [SnapshotValidator](interfaces/snapshotvalidator.md)[], `posters`: [SnapshotPoster](interfaces/snapshotposter.md)[], `snapshotBlock`: number, `consensusParameters`: [ConsensusParams](interfaces/consensusparams.md)): _[AppState](interfaces/appstate.md)_ -_Defined in [functions.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/functions.ts#L90)_ +_Defined in [functions.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L90)_ Constructs the `app_state` genesis field, where the following initial states are gathered or set, from re-processed Ethereum blockchain event logs, or from @@ -127,7 +127,7 @@ CLI input. ▸ **getInitialValidatorInfo**(`validators`: [SnapshotValidator](interfaces/snapshotvalidator.md)[]): _[InitialValidatorInfo](interfaces/initialvalidatorinfo.md)[]_ -_Defined in [functions.ts:304](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/functions.ts#L304)_ +_Defined in [functions.ts:307](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L307)_ Convert the validator snapshot data to the JSON format expected by the Kosu client. @@ -148,7 +148,7 @@ The array of initial validators as expected by `initial_validator_info`. ▸ **getTendermintValidators**(`validators`: [SnapshotValidator](interfaces/snapshotvalidator.md)[]): _[GenesisValidator](interfaces/genesisvalidator.md)[]_ -_Defined in [functions.ts:239](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/functions.ts#L239)_ +_Defined in [functions.ts:241](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L241)_ Convert the validator snapshot data to the JSON format expected by Tendermint. @@ -168,7 +168,7 @@ Tendermint-style genesis validator JSON. ▸ **hexKeyToBase64**(`publicKey`: string): _string_ -_Defined in [functions.ts:322](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/functions.ts#L322)_ +_Defined in [functions.ts:325](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L325)_ Convert a 0x-prefixed hex-encoded public key string to a base64-encoded string. @@ -188,7 +188,7 @@ The base64-encoded string representation of the public key. ▸ **parseMonikerFromDetails**(`details`: string, `itemSeparator`: string, `valueSeparator`: string): _string_ -_Defined in [functions.ts:274](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/functions.ts#L274)_ +_Defined in [functions.ts:277](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L277)_ Allows parsing a moniker from a string that uses two types of separators to store key-value pairs in a plain string. @@ -224,7 +224,7 @@ The value corresponding to the `moniker` key if found, otherwise the input strin ▸ **publicKeyToAddress**(`publicKey`: `Buffer`): _string_ -_Defined in [functions.ts:223](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/functions.ts#L223)_ +_Defined in [functions.ts:225](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L225)_ Convert a Tendermint public key to a Tendermint address (also called node ID). @@ -244,7 +244,7 @@ The corresponding Tendermint address string. ▸ **snapshotPostersAtBlock**(`kosu`: `Kosu`, `snapshotBlock`: number): _`Promise`_ -_Defined in [functions.ts:179](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/functions.ts#L179)_ +_Defined in [functions.ts:179](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L179)_ Generate a "snapshot" of the PosterRegistry contract state (all posters) by re-playing `PosterRegistryUpdate` events from the Kosu EventEmitter contract. @@ -269,7 +269,7 @@ Promise resolving to snapshot poster info (see type definition). ▸ **snapshotValidatorsAtBlock**(`kosu`: `Kosu`, `snapshotBlock`: number): _`Promise`_ -_Defined in [functions.ts:117](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/functions.ts#L117)_ +_Defined in [functions.ts:117](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L117)_ Generate a "snapshot" of the ValidatorRegistry TCR contract state (specifically, only the listings designated validators at the snapshot block) by re-playing diff --git a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/appstate.md b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/appstate.md index 49249e860..f7f62392d 100644 --- a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/appstate.md +++ b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/appstate.md @@ -23,7 +23,7 @@ • **consensus_params**: _[ConsensusParams](consensusparams.md)_ -_Defined in [types.d.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L18)_ +_Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L19)_ --- @@ -31,7 +31,7 @@ _Defined in [types.d.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/ • **initial_poster_info**: _[SnapshotPoster](snapshotposter.md)[]_ -_Defined in [types.d.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L20)_ +_Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L21)_ --- @@ -39,7 +39,7 @@ _Defined in [types.d.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/ • **initial_validator_info**: _[InitialValidatorInfo](initialvalidatorinfo.md)[]_ -_Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L19)_ +_Defined in [types.d.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L20)_ --- @@ -47,4 +47,4 @@ _Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/ • **snapshot_block**: _number_ -_Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L21)_ +_Defined in [types.d.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L22)_ diff --git a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/consensusparams.md b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/consensusparams.md index 451bf3793..a2c55005c 100644 --- a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/consensusparams.md +++ b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/consensusparams.md @@ -15,6 +15,7 @@ - [blocks_before_pruning](consensusparams.md#blocks_before_pruning) - [finality_threshold](consensusparams.md#finality_threshold) - [max_order_bytes](consensusparams.md#max_order_bytes) +- [orders_limit](consensusparams.md#orders_limit) - [period_length](consensusparams.md#period_length) - [period_limit](consensusparams.md#period_limit) @@ -24,7 +25,7 @@ • **blocks_before_pruning**: _number_ -_Defined in [types.d.ts:14](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L14)_ +_Defined in [types.d.ts:14](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L14)_ --- @@ -32,7 +33,7 @@ _Defined in [types.d.ts:14](https://github.com/ParadigmFoundation/kosu-monorepo/ • **finality_threshold**: _number_ -_Defined in [types.d.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L10)_ +_Defined in [types.d.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L10)_ --- @@ -40,7 +41,15 @@ _Defined in [types.d.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/ • **max_order_bytes**: _number_ -_Defined in [types.d.ts:13](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L13)_ +_Defined in [types.d.ts:13](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L13)_ + +--- + +### orders_limit + +• **orders_limit**: _number_ + +_Defined in [types.d.ts:15](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L15)_ --- @@ -48,7 +57,7 @@ _Defined in [types.d.ts:13](https://github.com/ParadigmFoundation/kosu-monorepo/ • **period_length**: _number_ -_Defined in [types.d.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L12)_ +_Defined in [types.d.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L12)_ --- @@ -56,4 +65,4 @@ _Defined in [types.d.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/ • **period_limit**: _number_ -_Defined in [types.d.ts:11](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L11)_ +_Defined in [types.d.ts:11](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L11)_ diff --git a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/genesisblock.md b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/genesisblock.md index 3aa6d624b..4f361f594 100644 --- a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/genesisblock.md +++ b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/genesisblock.md @@ -24,7 +24,7 @@ • **app_hash**: _string_ -_Defined in [types.d.ts:5](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L5)_ +_Defined in [types.d.ts:5](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L5)_ --- @@ -32,7 +32,7 @@ _Defined in [types.d.ts:5](https://github.com/ParadigmFoundation/kosu-monorepo/b • **app_state**: _[AppState](appstate.md)_ -_Defined in [types.d.ts:6](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L6)_ +_Defined in [types.d.ts:6](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L6)_ --- @@ -40,7 +40,7 @@ _Defined in [types.d.ts:6](https://github.com/ParadigmFoundation/kosu-monorepo/b • **chain_id**: _string_ -_Defined in [types.d.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L3)_ +_Defined in [types.d.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L3)_ --- @@ -48,7 +48,7 @@ _Defined in [types.d.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/b • **genesis_time**: _string_ -_Defined in [types.d.ts:2](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L2)_ +_Defined in [types.d.ts:2](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L2)_ --- @@ -56,4 +56,4 @@ _Defined in [types.d.ts:2](https://github.com/ParadigmFoundation/kosu-monorepo/b • **validators**: _[GenesisValidator](genesisvalidator.md)[]_ -_Defined in [types.d.ts:4](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L4)_ +_Defined in [types.d.ts:4](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L4)_ diff --git a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/genesisvalidator.md b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/genesisvalidator.md index e265fe449..894caf185 100644 --- a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/genesisvalidator.md +++ b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/genesisvalidator.md @@ -14,7 +14,7 @@ - [address](genesisvalidator.md#address) - [name](genesisvalidator.md#name) -- [power](genesisvalidator.md#optional-power) +- [power](genesisvalidator.md#power) - [pub_key](genesisvalidator.md#pub_key) ## Properties @@ -23,7 +23,7 @@ • **address**: _string_ -_Defined in [types.d.ts:31](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L31)_ +_Defined in [types.d.ts:32](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L32)_ --- @@ -31,15 +31,15 @@ _Defined in [types.d.ts:31](https://github.com/ParadigmFoundation/kosu-monorepo/ • **name**: _string_ -_Defined in [types.d.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L37)_ +_Defined in [types.d.ts:38](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L38)_ --- -### `Optional` power +### power -• **power**? : _undefined | string_ +• **power**: _string_ -_Defined in [types.d.ts:36](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L36)_ +_Defined in [types.d.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L37)_ --- @@ -47,6 +47,6 @@ _Defined in [types.d.ts:36](https://github.com/ParadigmFoundation/kosu-monorepo/ • **pub_key**: _object_ -_Defined in [types.d.ts:32](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L32)_ +_Defined in [types.d.ts:33](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L33)_ #### Type declaration: diff --git a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/initialvalidatorinfo.md b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/initialvalidatorinfo.md index d6600d2a1..ff12e635c 100644 --- a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/initialvalidatorinfo.md +++ b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/initialvalidatorinfo.md @@ -22,7 +22,7 @@ • **ethereum_address**: _string_ -_Defined in [types.d.ts:26](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L26)_ +_Defined in [types.d.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L27)_ --- @@ -30,7 +30,7 @@ _Defined in [types.d.ts:26](https://github.com/ParadigmFoundation/kosu-monorepo/ • **initial_stake**: _string_ -_Defined in [types.d.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L27)_ +_Defined in [types.d.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L28)_ --- @@ -38,4 +38,4 @@ _Defined in [types.d.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/ • **tendermint_address**: _string_ -_Defined in [types.d.ts:25](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L25)_ +_Defined in [types.d.ts:26](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L26)_ diff --git a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotlisting.md b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotlisting.md index 6f0886b0f..77f3510d8 100644 --- a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotlisting.md +++ b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotlisting.md @@ -26,7 +26,7 @@ • **details**: _string_ -_Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L43)_ +_Defined in [types.d.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L44)_ --- @@ -34,7 +34,7 @@ _Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/ • **ethAddress**: _string_ -_Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L42)_ +_Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L43)_ --- @@ -42,15 +42,15 @@ _Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/ • **publicKey**: _`Buffer`_ -_Defined in [types.d.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L41)_ +_Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L42)_ --- ### `Optional` stakeAmount -• **stakeAmount**? : _undefined | string_ +• **stakeAmount**? : _string_ -_Defined in [types.d.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L44)_ +_Defined in [types.d.ts:45](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L45)_ --- @@ -58,4 +58,4 @@ _Defined in [types.d.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/ • **status**: _"proposal" | "validator"_ -_Defined in [types.d.ts:45](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L45)_ +_Defined in [types.d.ts:46](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L46)_ diff --git a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotposter.md b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotposter.md index 798758019..066909c17 100644 --- a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotposter.md +++ b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotposter.md @@ -12,21 +12,21 @@ ### Properties -- [address](snapshotposter.md#address) - [balance](snapshotposter.md#balance) +- [ethereum_address](snapshotposter.md#ethereum_address) ## Properties -### address +### balance -• **address**: _string_ +• **balance**: _string_ -_Defined in [types.d.ts:54](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L54)_ +_Defined in [types.d.ts:56](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L56)_ --- -### balance +### ethereum_address -• **balance**: _string_ +• **ethereum_address**: _string_ -_Defined in [types.d.ts:55](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L55)_ +_Defined in [types.d.ts:55](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L55)_ diff --git a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotvalidator.md b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotvalidator.md index 021cddd09..8d9d1e30e 100644 --- a/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotvalidator.md +++ b/packages/kosu-docs/docs/kosu-genesis-cli/interfaces/snapshotvalidator.md @@ -28,7 +28,7 @@ _Inherited from [SnapshotListing](snapshotlisting.md).[details](snapshotlisting.md#details)_ -_Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L43)_ +_Defined in [types.d.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L44)_ --- @@ -38,7 +38,7 @@ _Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/ _Inherited from [SnapshotListing](snapshotlisting.md).[ethAddress](snapshotlisting.md#ethaddress)_ -_Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L42)_ +_Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L43)_ --- @@ -48,7 +48,7 @@ _Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/ _Inherited from [SnapshotListing](snapshotlisting.md).[publicKey](snapshotlisting.md#publickey)_ -_Defined in [types.d.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L41)_ +_Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L42)_ --- @@ -58,7 +58,7 @@ _Defined in [types.d.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/ _Overrides [SnapshotListing](snapshotlisting.md).[stakeAmount](snapshotlisting.md#optional-stakeamount)_ -_Defined in [types.d.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L49)_ +_Defined in [types.d.ts:50](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L50)_ --- @@ -68,4 +68,4 @@ _Defined in [types.d.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/ _Overrides [SnapshotListing](snapshotlisting.md).[status](snapshotlisting.md#status)_ -_Defined in [types.d.ts:50](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu-genesis-cli/src/types.d.ts#L50)_ +_Defined in [types.d.ts:51](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L51)_ diff --git a/packages/kosu-docs/docs/kosu-system-contracts/PosterRegistryProxy.md b/packages/kosu-docs/docs/kosu-system-contracts/PosterRegistryProxy.md deleted file mode 100644 index dd129d606..000000000 --- a/packages/kosu-docs/docs/kosu-system-contracts/PosterRegistryProxy.md +++ /dev/null @@ -1,99 +0,0 @@ -# PosterRegistryProxy - -Proxy contract for interacting with the PosterRegisty implementation contract. - -## Contents - -- [Methods](undefined) - - [constructor](#constructor) - - [registerTokens](#registertokens) - - [releaseTokens](#releasetokens) - - [setImplementation](#setimplementation) - - [tokensRegisteredFor](#tokensregisteredfor) - -## Methods - -### constructor - -Creates a Proxy for a PosterRegistry. Accepts an initial implementation that can be overwritten if a replacement is deployed. - -#### Signature - -```solidity -constructor(implementation address, auth address) public -``` - -#### Parameters: - -| Parameter | Type | Description | -| ---------------- | --------- | ------------------------------------------ | -| `implementation` | `address` | deployed implementation of PosterRegistry. | -| `auth` | `address` | AuthorizedAddresses deployed address. | - -### registerTokens - -Calls registerTokens on the current registry. - -#### Signature - -```solidity -function registerTokens(amount uint256) public -``` - -#### Parameters: - -| Parameter | Type | Description | -| --------- | --------- | ------------------------------------- | -| `amount` | `uint256` | Desired amount of tokens to register. | - -### releaseTokens - -Calls releaseTokens for the current registry. - -#### Signature - -```solidity -function releaseTokens(amount uint256) public -``` - -#### Parameters: - -| Parameter | Type | Description | -| --------- | --------- | ------------------------------------ | -| `amount` | `uint256` | Desired amount of tokens to release. | - -### setImplementation - -Set a new PosterRegistry implementation if a replacement is deployed. - -#### Signature - -```solidity -function setImplementation(implementation address) public -``` - -#### Parameters: - -| Parameter | Type | Description | -| ---------------- | --------- | --------------------------------------------------------------- | -| `implementation` | `address` | Deployed address for replacement PosterRegistry implementation. | - -### tokensRegisteredFor - -Reads the current registries tokens registered for the supplied address. - -#### Signature - -```solidity -function tokensRegisteredFor(a address) public view (uint256) -``` - -#### Parameters: - -| Parameter | Type | Description | -| --------- | --------- | --------------- | -| `a` | `address` | Address of user | - -#### Returns: - -The current number of tokens contributed by the address. diff --git a/packages/kosu-docs/docs/kosu-system-contracts/README.md b/packages/kosu-docs/docs/kosu-system-contracts/README.md deleted file mode 100644 index 2b37e0c22..000000000 --- a/packages/kosu-docs/docs/kosu-system-contracts/README.md +++ /dev/null @@ -1,41 +0,0 @@ -# Kosu System Contracts - -This repository contains the contract system that implements the Kosu protocol, in conjunction with `go-kosu`. - -These contracts support the inner workings of the Kosu network, including validator governance, poster access control, and general economic coordination. - -These contracts are **under active development and may change extensively at any time**. - -## 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://ethnet.zaidan.io/ropsten` - -| Contract Name | Last Deploy Date | Deployed Address | -| ------------------------------------------------------------------- | ---------------- | ------------------------------------------------------------------------------------------------------------------------------- | -| [OrderGateway](./contracts/external/OrderGateway.sol) | 17 Jun 19 | [`0x10772c057491d2f11f6ed3b116d7dc3cc8135e24`](https://ropsten.etherscan.io/address/0x10772c057491d2f11f6ed3b116d7dc3cc8135e24) | -| [Treasury](./contracts/treasury/Treasury.sol) | 17 Jun 19 | [`0xf7377157c181ca45944924444cc8ec48322602dc`](https://ropsten.etherscan.io/address/0xf7377157c181ca45944924444cc8ec48322602dc) | -| [PosterRegistryProxy](./contracts/external/PosterRegistryProxy.sol) | 17 Jun 19 | [`0x8c581ed507a7c843026cf04ca213542b77a4a397`](https://ropsten.etherscan.io/address/0x8c581ed507a7c843026cf04ca213542b77a4a397) | -| [ValidatorRegistry](./contracts/external/ValidatorRegistry.sol) | 17 Jun 19 | [`0xff74dda760854c3639c6f728aa4179b8b000f322`](https://ropsten.etherscan.io/address/0xff74dda760854c3639c6f728aa4179b8b000f322) | -| [EventEmitter](./contracts/event/EventEmitter.sol) | 17 Jun 19 | [`0x90acff67b832afdfd7938a0bc1192dc08f6c742e`](https://ropsten.etherscan.io/address/0x90acff67b832afdfd7938a0bc1192dc08f6c742e) | -| [Voting](./contracts/voting/Voting.sol) | 17 Jun 19 | [`0xc0ba1ab8781c234c4b04061bb6411680412cc2ad`](https://ropsten.etherscan.io/address/0xc0ba1ab8781c234c4b04061bb6411680412cc2ad) | -| [KosuToken](contracts/lib/KosuToken.sol) | 17 Jun 19 | [`0x800f612a35f5c2ee8de26ff9983cb74ba6c929a4`](https://ropsten.etherscan.io/address/0x800f612a35f5c2ee8de26ff9983cb74ba6c929a4) | - -### Kosu Dev PoA - -- **Network ID:** 6174 -- **ETHNET URL:** `https://ethnet.zaidan.io/kosu` - -| Contract Name | Last Deploy Date | Deployed Address | -| ------------------------------------------------------------------------- | ---------------- | -------------------------------------------- | -| [OrderGateway](./contracts/external/OrderGateway.sol) | 17 Jun 19 | `0x07a24e06d4279c0d8224957CDa6A349Aeb326963` | -| [Treasury](./contracts/treasury/Treasury.sol) | 17 Jun 19 | `0x39Fa4aF991C0642744E0F05042Bcf38A96ab345f` | -| [PosterRegistryProxy](./contracts/external/PosterRegistryProxy.sol) | 17 Jun 19 | `0xBdd34B13Aff942b32C2660a11dA19Ff6E964724e` | -| [ValidatorRegistryProxy](./contracts/external/ValidatorRegistryProxy.sol) | 17 Jun 19 | `0xf277f6009869B701AdaD8D29Cbc7D029Bbe5391d` | -| [EventEmitter](./contracts/event/EventEmitter.sol) | 17 Jun 19 | `0xf2098FB608098A562d24CCde594A304d739cc4B7` | -| [Voting](./contracts/voting/Voting.sol) | 17 Jun 19 | `0xd73B3E6B4b7702569720B93e1C27D33cB91f8407` | -| [KosuToken](contracts/lib/KosuToken.sol) | 17 Jun 19 | `0x1513EFDA5170c8B1eC168bFB238278EeaA3B114e` | diff --git a/packages/kosu-docs/docs/kosu.js/classes/orderhelper.md b/packages/kosu-docs/docs/kosu.js/classes/orderhelper.md deleted file mode 100644 index 8271d5235..000000000 --- a/packages/kosu-docs/docs/kosu.js/classes/orderhelper.md +++ /dev/null @@ -1,191 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [OrderHelper](orderhelper.md) / - -# Class: OrderHelper - -The `OrderHelper` provides methods for interacting with maker orders, such as -participating in trades (as a taker), signing maker order's for execution and -for submission to the Kosu relay network. - -Requires a configured `web3` provider that allows signatures and the execution -of transactions. - -## Hierarchy - -- **OrderHelper** - -## Index - -### Constructors - -- [constructor](orderhelper.md#constructor) - -### Methods - -- [makeOrder](orderhelper.md#makeorder) -- [makerHex](orderhelper.md#makerhex) -- [prepareForPost](orderhelper.md#prepareforpost) -- [recoverMaker](orderhelper.md#recovermaker) -- [recoverPoster](orderhelper.md#recoverposter) -- [serialize](orderhelper.md#serialize) -- [takeOrder](orderhelper.md#takeorder) - -## Constructors - -### constructor - -\+ **new OrderHelper**(`web3`: `Web3`, `orderGateway`: [OrderGateway](ordergateway.md)): _[OrderHelper](orderhelper.md)_ - -_Defined in [OrderHelper.ts:24](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L24)_ - -Create a new `OrderHelper` instance (requires a provider via supplied `web3` -instance). - -**Parameters:** - -| Name | Type | Description | -| -------------- | ------------------------------- | --------------------------------------------------- | -| `web3` | `Web3` | An instance of `Web3` with an active node provider. | -| `orderGateway` | [OrderGateway](ordergateway.md) | An instantiated `OrderGateway` wrapper. | - -**Returns:** _[OrderHelper](orderhelper.md)_ - -## Methods - -### makeOrder - -▸ **makeOrder**(`order`: [Order](../interfaces/order.md)): _`Promise`_ - -_Defined in [OrderHelper.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L44)_ - -Sign and complete a maker order (requires a pre-configured Order object). - -**Parameters:** - -| Name | Type | Description | -| ------- | ------------------------------- | ------------------------- | -| `order` | [Order](../interfaces/order.md) | Order to sign as a maker. | - -**Returns:** _`Promise`_ - -The supplied maker order with an appended `makerSignature`. - ---- - -### makerHex - -▸ **makerHex**(`order`: [Order](../interfaces/order.md)): _`Promise`_ - -_Defined in [OrderHelper.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L104)_ - -Generate the maker hex (serialized `makerValues`). - -**Parameters:** - -| Name | Type | Description | -| ------- | ------------------------------- | -------------------------- | -| `order` | [Order](../interfaces/order.md) | Order to get maker hex for | - -**Returns:** _`Promise`_ - ---- - -### prepareForPost - -▸ **prepareForPost**(`order`: [Order](../interfaces/order.md), `poster`: string): _`Promise`_ - -_Defined in [OrderHelper.ts:76](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L76)_ - -Sign and order as a poster and append the poster signature to an order -prior to submission to the Kosu relay network. - -**Parameters:** - -| Name | Type | Default | Description | -| -------- | ------------------------------- | ----------- | ----------------------------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | - | Order to prepare (by appending a poster signature). | -| `poster` | string | order.maker | Poster address to sign order with, defaults to the order's maker. | - -**Returns:** _`Promise`_ - -The maker order now signed and prepared for post with an appended `posterSignature`. - ---- - -### recoverMaker - -▸ **recoverMaker**(`order`: [Order](../interfaces/order.md)): _`Promise`_ - -_Defined in [OrderHelper.ts:114](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L114)_ - -Recover the maker address from a signed order. - -**Parameters:** - -| Name | Type | Description | -| ------- | ------------------------------- | --------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | A signed order to recover maker address from. | - -**Returns:** _`Promise`_ - ---- - -### recoverPoster - -▸ **recoverPoster**(`order`: [PostableOrder](../interfaces/postableorder.md)): _`Promise`_ - -_Defined in [OrderHelper.ts:125](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L125)_ - -Recover the poster address from a maker order that has been signed from a -poster. - -**Parameters:** - -| Name | Type | Description | -| ------- | ----------------------------------------------- | ---------------------------------------------------------- | -| `order` | [PostableOrder](../interfaces/postableorder.md) | Order to recover poster from (must be signed by a poster). | - -**Returns:** _`Promise`_ - ---- - -### serialize - -▸ **serialize**(`order`: [Order](../interfaces/order.md)): _`Promise`_ - -_Defined in [OrderHelper.ts:135](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L135)_ - -Generates the contract submission bytes from the arguments of provided order. - -**Parameters:** - -| Name | Type | Description | -| ------- | ------------------------------- | ------------------------------------------- | -| `order` | [Order](../interfaces/order.md) | Order to generate contract input bytes for. | - -**Returns:** _`Promise`_ - ---- - -### takeOrder - -▸ **takeOrder**(`order`: [TakeableOrder](../interfaces/takeableorder.md), `taker`: string): _`Promise`_ - -_Defined in [OrderHelper.ts:64](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderHelper.ts#L64)_ - -Take a signed maker order on the Ethereum blockchain via the order's -specified SubContract, from the supplied taker address (should be available -via configured `web` provider). - -**Parameters:** - -| Name | Type | Description | -| ------- | ----------------------------------------------- | --------------------------------------------------------------------------- | -| `order` | [TakeableOrder](../interfaces/takeableorder.md) | A signed and fillable maker order object. | -| `taker` | string | The Ethereum address of the taker (must be available to sign via provider). | - -**Returns:** _`Promise`_ - -The value defined by the order's SubContract implementation, usually `true` -for successfully filled orders, and `false` for failed fills. diff --git a/packages/kosu-docs/docs/kosu.js/globals.md b/packages/kosu-docs/docs/kosu.js/globals.md deleted file mode 100644 index 8f746fc53..000000000 --- a/packages/kosu-docs/docs/kosu.js/globals.md +++ /dev/null @@ -1,378 +0,0 @@ -> **[kosu.js](README.md)** - -[Globals](globals.md) / - -# kosu.js - -## Index - -### Classes - -- [EventEmitter](classes/eventemitter.md) -- [Kosu](classes/kosu.md) -- [KosuToken](classes/kosutoken.md) -- [NodeClient](classes/nodeclient.md) -- [OrderGateway](classes/ordergateway.md) -- [OrderHelper](classes/orderhelper.md) -- [PosterRegistry](classes/posterregistry.md) -- [Treasury](classes/treasury.md) -- [ValidatorRegistry](classes/validatorregistry.md) -- [Voting](classes/voting.md) - -### Interfaces - -- [DecodedKosuLogArgs](interfaces/decodedkosulogargs.md) -- [KosuOptions](interfaces/kosuoptions.md) -- [KosuUtils](interfaces/kosuutils.md) -- [LogWithDecodedKosuArgs](interfaces/logwithdecodedkosuargs.md) -- [Order](interfaces/order.md) -- [OrderArgument](interfaces/orderargument.md) -- [OrderRejectionInfo](interfaces/orderrejectioninfo.md) -- [OrderValidationResult](interfaces/ordervalidationresult.md) -- [PostableOrder](interfaces/postableorder.md) -- [Poster](interfaces/poster.md) -- [RoundInfo](interfaces/roundinfo.md) -- [TakeableOrder](interfaces/takeableorder.md) -- [Validator](interfaces/validator.md) - -### Variables - -- [NULL_ADDRESS](globals.md#const-null_address) -- [version](globals.md#const-version) - -### Functions - -- [\_serialize](globals.md#_serialize) -- [toBytes32](globals.md#tobytes32) - -### Object literals - -- [KosuEndpoints](globals.md#const-kosuendpoints) -- [OrderSerializer](globals.md#const-orderserializer) -- [Signature](globals.md#const-signature) - -## Variables - -### `Const` NULL_ADDRESS - -• **NULL_ADDRESS**: _string_ = "0x0000000000000000000000000000000000000000" - -_Defined in [utils.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/utils.ts#L12)_ - ---- - -### `Const` version - -• **version**: _any_ = process.env.npm_package_version || require("../package.json").version - -_Defined in [Kosu.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Kosu.ts#L18)_ - -## Functions - -### \_serialize - -▸ **\_serialize**(`_arguments`: any, `values`: any): _string_ - -_Defined in [OrderSerializer.ts:8](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L8)_ - -**Parameters:** - -| Name | Type | -| ------------ | ---- | -| `_arguments` | any | -| `values` | any | - -**Returns:** _string_ - ---- - -### toBytes32 - -▸ **toBytes32**(`value`: string): _string_ - -_Defined in [utils.ts:8](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/utils.ts#L8)_ - -Convert an arbitrary string to a `bytes32` version. - -**Parameters:** - -| Name | Type | Description | -| ------- | ------ | --------------------------------------------------------- | -| `value` | string | String value to be converted into bytes32 representation. | - -**Returns:** _string_ - -## Object literals - -### `Const` KosuEndpoints - -### ▪ **KosuEndpoints**: _object_ - -_Defined in [EventEmitter.ts:7](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L7)_ - -▪ **1**: _object_ - -_Defined in [EventEmitter.ts:8](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L8)_ - -- **http**: _string_ = `https://ethnet.zaidan.io/mainnet` - -- **ws**: _string_ = `wss://ethnet.zaidan.io/ws/mainnet` - -▪ **3**: _object_ - -_Defined in [EventEmitter.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L12)_ - -- **http**: _string_ = `https://ethnet.zaidan.io/ropsten` - -- **ws**: _string_ = `wss://ethnet.zaidan.io/ws/ropsten` - -▪ **42**: _object_ - -_Defined in [EventEmitter.ts:16](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L16)_ - -- **http**: _string_ = `https://ethnet.zaidan.io/kovan` - -- **ws**: _string_ = `wss://ethnet.zaidan.io/ws/kovan` - -▪ **6174**: _object_ - -_Defined in [EventEmitter.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/EventEmitter.ts#L20)_ - -- **http**: _string_ = `https://ethnet.zaidan.io/kosu` - -- **ws**: _string_ = `wss://ethnet.zaidan.io/ws/kosu` - ---- - -### `Const` OrderSerializer - -### ▪ **OrderSerializer**: _object_ - -_Defined in [OrderSerializer.ts:51](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L51)_ - -could add to utils (or create order-utils pacakge) - -### makerHex - -▸ **makerHex**(`order`: [Order](interfaces/order.md), `_arguments`: any): _string_ - -_Defined in [OrderSerializer.ts:97](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L97)_ - -Generate the maker hex from order - -**Parameters:** - -| Name | Type | Description | -| ------------ | ---------------------------- | ---------------------------------------- | -| `order` | [Order](interfaces/order.md) | to generate hex from | -| `_arguments` | any | Argument json defined in the subContract | - -**Returns:** _string_ - -### posterSignatureHex - -▸ **posterSignatureHex**(`order`: [Order](interfaces/order.md), `_arguments`: any): _string_ - -_Defined in [OrderSerializer.ts:73](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L73)_ - -Generates hex to be used for the poster signing process - -**Parameters:** - -| Name | Type | Description | -| ------------ | ---------------------------- | ---------------------------------------- | -| `order` | [Order](interfaces/order.md) | Order to get data for | -| `_arguments` | any | Argument json defined in the subContract | - -**Returns:** _string_ - -### recoverMaker - -▸ **recoverMaker**(`order`: [Order](interfaces/order.md), `_arguments`: any[]): _string_ - -_Defined in [OrderSerializer.ts:125](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L125)_ - -Recovers the maker from the signed information - -**Parameters:** - -| Name | Type | Description | -| ------------ | ---------------------------- | ---------------------------------------- | -| `order` | [Order](interfaces/order.md) | to recover address from | -| `_arguments` | any[] | Argument json defined in the subContract | - -**Returns:** _string_ - -### recoverPoster - -▸ **recoverPoster**(`order`: [PostableOrder](interfaces/postableorder.md), `_arguments`: any[]): _string_ - -_Defined in [OrderSerializer.ts:87](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L87)_ - -Recovers the poster from the poster signature - -**Parameters:** - -| Name | Type | Description | -| ------------ | -------------------------------------------- | ---------------------------------------- | -| `order` | [PostableOrder](interfaces/postableorder.md) | Order to recover address that signed | -| `_arguments` | any[] | Argument json defined in the subContract | - -**Returns:** _string_ - -### serialize - -▸ **serialize**(`_arguments`: any, `order`: [Order](interfaces/order.md)): _string_ - -_Defined in [OrderSerializer.ts:58](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/OrderSerializer.ts#L58)_ - -Serializes the data into bytes - -**Parameters:** - -| Name | Type | Description | -| ------------ | ---------------------------- | ---------------------------------------- | -| `_arguments` | any | Argument json defined in the subContract | -| `order` | [Order](interfaces/order.md) | Order to serialize | - -**Returns:** _string_ - ---- - -### `Const` Signature - -### ▪ **Signature**: _object_ - -_Defined in [Signature.ts:7](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Signature.ts#L7)_ - -_Defined in [types.d.ts:45](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L45)_ - -### generate - -▸ **generate**(`web3`: `Web3`, `messageHex`: string, `signer`: string): _`Promise`_ - -_Defined in [Signature.ts:16](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Signature.ts#L16)_ - -Generates a signature for a message hex using calls to a provider though web3 - -**Parameters:** - -| Name | Type | Description | -| ------------ | ------ | ----------------------------------- | -| `web3` | `Web3` | Web3 configured to desired provider | -| `messageHex` | string | Hex representation of the message | -| `signer` | string | Address to sign the message | - -**Returns:** _`Promise`_ - -A vrs signature - -▸ **generate**(`web3`: `Web3`, `messageHex`: string, `signer`: string): _`Promise`_ - -_Defined in [types.d.ts:46](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L46)_ - -**Parameters:** - -| Name | Type | -| ------------ | ------ | -| `web3` | `Web3` | -| `messageHex` | string | -| `signer` | string | - -**Returns:** _`Promise`_ - -### recoverAddress - -▸ **recoverAddress**(`messageHex`: any, `signature`: string): _string_ - -_Defined in [Signature.ts:38](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Signature.ts#L38)_ - -Recovers address from a message hex and signature - -**Parameters:** - -| Name | Type | Description | -| ------------ | ------ | ---------------------------------------- | -| `messageHex` | any | Hex representation of the signed message | -| `signature` | string | VRS signature | - -**Returns:** _string_ - -▸ **recoverAddress**(`messageHex`: any, `signature`: string): _string_ - -_Defined in [types.d.ts:48](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L48)_ - -**Parameters:** - -| Name | Type | -| ------------ | ------ | -| `messageHex` | any | -| `signature` | string | - -**Returns:** _string_ - -### sign - -▸ **sign**(`web3`: `Web3`, `messageHex`: string, `signer`: string): _`Promise`_ - -_Defined in [Signature.ts:56](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Signature.ts#L56)_ - -Sign hex with provided address - -**Parameters:** - -| Name | Type | Description | -| ------------ | ------ | -------------------------------------- | -| `web3` | `Web3` | Provider which executes the signature. | -| `messageHex` | string | Hex to be singed | -| `signer` | string | Address to sign with. | - -**Returns:** _`Promise`_ - -▸ **sign**(`web3`: `Web3`, `messageHex`: string, `signer`: string): _`Promise`_ - -_Defined in [types.d.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L49)_ - -**Parameters:** - -| Name | Type | -| ------------ | ------ | -| `web3` | `Web3` | -| `messageHex` | string | -| `signer` | string | - -**Returns:** _`Promise`_ - -### validate - -▸ **validate**(`messageHex`: string, `signature`: string, `signer`: string): _boolean_ - -_Defined in [Signature.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/Signature.ts#L28)_ - -Validates the signature of a messageHex is from the provided signer - -**Parameters:** - -| Name | Type | Description | -| ------------ | ------ | -------------------------------------- | -| `messageHex` | string | signed message hex | -| `signature` | string | signature from message hex | -| `signer` | string | signer who may have signed the message | - -**Returns:** _boolean_ - -boolean representing if the signer in fact generated the signature with this message - -▸ **validate**(`messageHex`: string, `signature`: string, `signer`: string): _boolean_ - -_Defined in [types.d.ts:47](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L47)_ - -**Parameters:** - -| Name | Type | -| ------------ | ------ | -| `messageHex` | string | -| `signature` | string | -| `signer` | string | - -**Returns:** _boolean_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/decodedkosulogargs.md b/packages/kosu-docs/docs/kosu.js/interfaces/decodedkosulogargs.md deleted file mode 100644 index 75e5d3a0c..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/decodedkosulogargs.md +++ /dev/null @@ -1,9 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [DecodedKosuLogArgs](decodedkosulogargs.md) / - -# Interface: DecodedKosuLogArgs - -## Hierarchy - -- **DecodedKosuLogArgs** diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/kosuoptions.md b/packages/kosu-docs/docs/kosu.js/interfaces/kosuoptions.md deleted file mode 100644 index e9a333c15..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/kosuoptions.md +++ /dev/null @@ -1,122 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [KosuOptions](kosuoptions.md) / - -# Interface: KosuOptions - -## Hierarchy - -- **KosuOptions** - -## Index - -### Properties - -- [eventEmitterAddress](kosuoptions.md#optional-eventemitteraddress) -- [kosuNodeUrl](kosuoptions.md#optional-kosunodeurl) -- [kosuTokenAddress](kosuoptions.md#optional-kosutokenaddress) -- [networkId](kosuoptions.md#optional-networkid) -- [orderGatewayAddress](kosuoptions.md#optional-ordergatewayaddress) -- [posterRegistryAddress](kosuoptions.md#optional-posterregistryaddress) -- [provider](kosuoptions.md#optional-provider) -- [treasuryAddress](kosuoptions.md#optional-treasuryaddress) -- [validatorRegistryAddress](kosuoptions.md#optional-validatorregistryaddress) -- [votingAddress](kosuoptions.md#optional-votingaddress) -- [web3](kosuoptions.md#optional-web3) -- [web3Wrapper](kosuoptions.md#optional-web3wrapper) - -## Properties - -### `Optional` eventEmitterAddress - -• **eventEmitterAddress**? : _string_ - -_Defined in [types.d.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L10)_ - ---- - -### `Optional` kosuNodeUrl - -• **kosuNodeUrl**? : _string_ - -_Defined in [types.d.ts:6](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L6)_ - ---- - -### `Optional` kosuTokenAddress - -• **kosuTokenAddress**? : _string_ - -_Defined in [types.d.ts:9](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L9)_ - ---- - -### `Optional` networkId - -• **networkId**? : _number | string_ - -_Defined in [types.d.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L3)_ - ---- - -### `Optional` orderGatewayAddress - -• **orderGatewayAddress**? : _string_ - -_Defined in [types.d.ts:11](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L11)_ - ---- - -### `Optional` posterRegistryAddress - -• **posterRegistryAddress**? : _string_ - -_Defined in [types.d.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L12)_ - ---- - -### `Optional` provider - -• **provider**? : _[provider](kosuoptions.md#optional-provider)_ - -_Defined in [types.d.ts:2](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L2)_ - ---- - -### `Optional` treasuryAddress - -• **treasuryAddress**? : _string_ - -_Defined in [types.d.ts:8](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L8)_ - ---- - -### `Optional` validatorRegistryAddress - -• **validatorRegistryAddress**? : _string_ - -_Defined in [types.d.ts:13](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L13)_ - ---- - -### `Optional` votingAddress - -• **votingAddress**? : _string_ - -_Defined in [types.d.ts:7](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L7)_ - ---- - -### `Optional` web3 - -• **web3**? : _`Web3`_ - -_Defined in [types.d.ts:4](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L4)_ - ---- - -### `Optional` web3Wrapper - -• **web3Wrapper**? : _`Web3Wrapper`_ - -_Defined in [types.d.ts:5](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L5)_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/kosuutils.md b/packages/kosu-docs/docs/kosu.js/interfaces/kosuutils.md deleted file mode 100644 index f47269703..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/kosuutils.md +++ /dev/null @@ -1,43 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [KosuUtils](kosuutils.md) / - -# Interface: KosuUtils - -## Hierarchy - -- **KosuUtils** - -## Index - -### Properties - -- [NULL_ADDRESS](kosuutils.md#null_address) - -### Methods - -- [toBytes32](kosuutils.md#tobytes32) - -## Properties - -### NULL_ADDRESS - -• **NULL_ADDRESS**: _string_ - -_Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L42)_ - -## Methods - -### toBytes32 - -▸ **toBytes32**(`value`: string): _number | string | `BN`_ - -_Defined in [types.d.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L41)_ - -**Parameters:** - -| Name | Type | -| ------- | ------ | -| `value` | string | - -**Returns:** _number | string | `BN`_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/logwithdecodedkosuargs.md b/packages/kosu-docs/docs/kosu.js/interfaces/logwithdecodedkosuargs.md deleted file mode 100644 index 6ee97677b..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/logwithdecodedkosuargs.md +++ /dev/null @@ -1,49 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [LogWithDecodedKosuArgs](logwithdecodedkosuargs.md) / - -# Interface: LogWithDecodedKosuArgs <**A, B**> - -## Type parameters - -▪ **A** - -▪ **B** - -## Hierarchy - -- any - - - **LogWithDecodedKosuArgs** - -## Index - -### Properties - -- [args](logwithdecodedkosuargs.md#args) -- [decodedArgs](logwithdecodedkosuargs.md#decodedargs) -- [event](logwithdecodedkosuargs.md#event) - -## Properties - -### args - -• **args**: _`A`_ - -_Defined in [types.d.ts:56](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L56)_ - ---- - -### decodedArgs - -• **decodedArgs**: _`B`_ - -_Defined in [types.d.ts:57](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L57)_ - ---- - -### event - -• **event**: _string_ - -_Defined in [types.d.ts:55](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L55)_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/order.md b/packages/kosu-docs/docs/kosu.js/interfaces/order.md deleted file mode 100644 index 306fe31e6..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/order.md +++ /dev/null @@ -1,90 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [Order](order.md) / - -# Interface: Order - -## Hierarchy - -- **Order** - - - [PostableOrder](postableorder.md) - - - [TakeableOrder](takeableorder.md) - -## Index - -### Properties - -- [arguments](order.md#optional-arguments) -- [id](order.md#id) -- [maker](order.md#maker) -- [makerSignature](order.md#optional-makersignature) -- [makerValues](order.md#makervalues) -- [poster](order.md#poster) -- [subContract](order.md#subcontract) -- [takerValues](order.md#optional-takervalues) - -## Properties - -### `Optional` arguments - -• **arguments**? : _any_ - -_Defined in [types.d.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L22)_ - ---- - -### id - -• **id**: _any_ - -_Defined in [types.d.ts:23](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L23)_ - ---- - -### maker - -• **maker**: _string_ - -_Defined in [types.d.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L18)_ - ---- - -### `Optional` makerSignature - -• **makerSignature**? : _any_ - -_Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L21)_ - ---- - -### makerValues - -• **makerValues**: _any_ - -_Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L19)_ - ---- - -### poster - -• **poster**: _string_ - -_Defined in [types.d.ts:24](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L24)_ - ---- - -### subContract - -• **subContract**: _string_ - -_Defined in [types.d.ts:17](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L17)_ - ---- - -### `Optional` takerValues - -• **takerValues**? : _any_ - -_Defined in [types.d.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L20)_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/orderargument.md b/packages/kosu-docs/docs/kosu.js/interfaces/orderargument.md deleted file mode 100644 index 2bb833d7c..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/orderargument.md +++ /dev/null @@ -1,32 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [OrderArgument](orderargument.md) / - -# Interface: OrderArgument - -## Hierarchy - -- **OrderArgument** - -## Index - -### Properties - -- [datatype](orderargument.md#datatype) -- [name](orderargument.md#name) - -## Properties - -### datatype - -• **datatype**: _string_ - -_Defined in [types.d.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L37)_ - ---- - -### name - -• **name**: _string_ - -_Defined in [types.d.ts:36](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L36)_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/orderrejectioninfo.md b/packages/kosu-docs/docs/kosu.js/interfaces/orderrejectioninfo.md deleted file mode 100644 index e07a22465..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/orderrejectioninfo.md +++ /dev/null @@ -1,32 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [OrderRejectionInfo](orderrejectioninfo.md) / - -# Interface: OrderRejectionInfo - -## Hierarchy - -- **OrderRejectionInfo** - -## Index - -### Properties - -- [order](orderrejectioninfo.md#order) -- [reason](orderrejectioninfo.md#reason) - -## Properties - -### order - -• **order**: _string_ - -_Defined in [types.d.ts:66](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L66)_ - ---- - -### reason - -• **reason**: _string_ - -_Defined in [types.d.ts:67](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L67)_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/ordervalidationresult.md b/packages/kosu-docs/docs/kosu.js/interfaces/ordervalidationresult.md deleted file mode 100644 index 7f4128d05..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/ordervalidationresult.md +++ /dev/null @@ -1,32 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [OrderValidationResult](ordervalidationresult.md) / - -# Interface: OrderValidationResult - -## Hierarchy - -- **OrderValidationResult** - -## Index - -### Properties - -- [accepted](ordervalidationresult.md#accepted) -- [rejected](ordervalidationresult.md#rejected) - -## Properties - -### accepted - -• **accepted**: _string[]_ - -_Defined in [types.d.ts:61](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L61)_ - ---- - -### rejected - -• **rejected**: _[OrderRejectionInfo](orderrejectioninfo.md)[]_ - -_Defined in [types.d.ts:62](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L62)_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/postableorder.md b/packages/kosu-docs/docs/kosu.js/interfaces/postableorder.md deleted file mode 100644 index 2356799ee..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/postableorder.md +++ /dev/null @@ -1,113 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [PostableOrder](postableorder.md) / - -# Interface: PostableOrder - -## Hierarchy - -- [Order](order.md) - - - **PostableOrder** - -## Index - -### Properties - -- [arguments](postableorder.md#optional-arguments) -- [id](postableorder.md#id) -- [maker](postableorder.md#maker) -- [makerSignature](postableorder.md#optional-makersignature) -- [makerValues](postableorder.md#makervalues) -- [poster](postableorder.md#poster) -- [posterSignature](postableorder.md#postersignature) -- [subContract](postableorder.md#subcontract) -- [takerValues](postableorder.md#optional-takervalues) - -## Properties - -### `Optional` arguments - -• **arguments**? : _any_ - -_Inherited from [Order](order.md).[arguments](order.md#optional-arguments)_ - -_Defined in [types.d.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L22)_ - ---- - -### id - -• **id**: _any_ - -_Inherited from [Order](order.md).[id](order.md#id)_ - -_Defined in [types.d.ts:23](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L23)_ - ---- - -### maker - -• **maker**: _string_ - -_Inherited from [Order](order.md).[maker](order.md#maker)_ - -_Defined in [types.d.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L18)_ - ---- - -### `Optional` makerSignature - -• **makerSignature**? : _any_ - -_Inherited from [Order](order.md).[makerSignature](order.md#optional-makersignature)_ - -_Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L21)_ - ---- - -### makerValues - -• **makerValues**: _any_ - -_Inherited from [Order](order.md).[makerValues](order.md#makervalues)_ - -_Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L19)_ - ---- - -### poster - -• **poster**: _string_ - -_Inherited from [Order](order.md).[poster](order.md#poster)_ - -_Defined in [types.d.ts:24](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L24)_ - ---- - -### posterSignature - -• **posterSignature**: _string_ - -_Defined in [types.d.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L28)_ - ---- - -### subContract - -• **subContract**: _string_ - -_Inherited from [Order](order.md).[subContract](order.md#subcontract)_ - -_Defined in [types.d.ts:17](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L17)_ - ---- - -### `Optional` takerValues - -• **takerValues**? : _any_ - -_Inherited from [Order](order.md).[takerValues](order.md#optional-takervalues)_ - -_Defined in [types.d.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L20)_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/poster.md b/packages/kosu-docs/docs/kosu.js/interfaces/poster.md deleted file mode 100644 index 33db7afad..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/poster.md +++ /dev/null @@ -1,32 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [Poster](poster.md) / - -# Interface: Poster - -## Hierarchy - -- **Poster** - -## Index - -### Properties - -- [balance](poster.md#balance) -- [limit](poster.md#limit) - -## Properties - -### balance - -• **balance**: _`BigNumber`_ - -_Defined in [types.d.ts:71](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L71)_ - ---- - -### limit - -• **limit**: _number_ - -_Defined in [types.d.ts:72](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L72)_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/roundinfo.md b/packages/kosu-docs/docs/kosu.js/interfaces/roundinfo.md deleted file mode 100644 index b52cfc203..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/roundinfo.md +++ /dev/null @@ -1,50 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [RoundInfo](roundinfo.md) / - -# Interface: RoundInfo - -## Hierarchy - -- **RoundInfo** - -## Index - -### Properties - -- [endsAt](roundinfo.md#endsat) -- [limit](roundinfo.md#limit) -- [number](roundinfo.md#number) -- [startsAt](roundinfo.md#startsat) - -## Properties - -### endsAt - -• **endsAt**: _number_ - -_Defined in [types.d.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L90)_ - ---- - -### limit - -• **limit**: _number_ - -_Defined in [types.d.ts:91](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L91)_ - ---- - -### number - -• **number**: _number_ - -_Defined in [types.d.ts:88](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L88)_ - ---- - -### startsAt - -• **startsAt**: _number_ - -_Defined in [types.d.ts:89](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L89)_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/takeableorder.md b/packages/kosu-docs/docs/kosu.js/interfaces/takeableorder.md deleted file mode 100644 index b924024e0..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/takeableorder.md +++ /dev/null @@ -1,104 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [TakeableOrder](takeableorder.md) / - -# Interface: TakeableOrder - -## Hierarchy - -- [Order](order.md) - - - **TakeableOrder** - -## Index - -### Properties - -- [arguments](takeableorder.md#optional-arguments) -- [id](takeableorder.md#id) -- [maker](takeableorder.md#maker) -- [makerSignature](takeableorder.md#optional-makersignature) -- [makerValues](takeableorder.md#makervalues) -- [poster](takeableorder.md#poster) -- [subContract](takeableorder.md#subcontract) -- [takerValues](takeableorder.md#takervalues) - -## Properties - -### `Optional` arguments - -• **arguments**? : _any_ - -_Inherited from [Order](order.md).[arguments](order.md#optional-arguments)_ - -_Defined in [types.d.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L22)_ - ---- - -### id - -• **id**: _any_ - -_Inherited from [Order](order.md).[id](order.md#id)_ - -_Defined in [types.d.ts:23](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L23)_ - ---- - -### maker - -• **maker**: _string_ - -_Inherited from [Order](order.md).[maker](order.md#maker)_ - -_Defined in [types.d.ts:18](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L18)_ - ---- - -### `Optional` makerSignature - -• **makerSignature**? : _any_ - -_Inherited from [Order](order.md).[makerSignature](order.md#optional-makersignature)_ - -_Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L21)_ - ---- - -### makerValues - -• **makerValues**: _any_ - -_Inherited from [Order](order.md).[makerValues](order.md#makervalues)_ - -_Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L19)_ - ---- - -### poster - -• **poster**: _string_ - -_Inherited from [Order](order.md).[poster](order.md#poster)_ - -_Defined in [types.d.ts:24](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L24)_ - ---- - -### subContract - -• **subContract**: _string_ - -_Inherited from [Order](order.md).[subContract](order.md#subcontract)_ - -_Defined in [types.d.ts:17](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L17)_ - ---- - -### takerValues - -• **takerValues**: _any_ - -_Overrides [Order](order.md).[takerValues](order.md#optional-takervalues)_ - -_Defined in [types.d.ts:32](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L32)_ diff --git a/packages/kosu-docs/docs/kosu.js/interfaces/validator.md b/packages/kosu-docs/docs/kosu.js/interfaces/validator.md deleted file mode 100644 index d99843db4..000000000 --- a/packages/kosu-docs/docs/kosu.js/interfaces/validator.md +++ /dev/null @@ -1,95 +0,0 @@ -> **[kosu.js](../README.md)** - -[Globals](../globals.md) / [Validator](validator.md) / - -# Interface: Validator - -## Hierarchy - -- **Validator** - -## Index - -### Properties - -- [active](validator.md#active) -- [applied](validator.md#applied) -- [balance](validator.md#balance) -- [firstVote](validator.md#firstvote) -- [lastProposed](validator.md#lastproposed) -- [lastVoted](validator.md#lastvoted) -- [power](validator.md#power) -- [publicKey](validator.md#publickey) -- [totalVotes](validator.md#totalvotes) - -## Properties - -### active - -• **active**: _number_ - -_Defined in [types.d.ts:83](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L83)_ - ---- - -### applied - -• **applied**: _number_ - -_Defined in [types.d.ts:84](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L84)_ - ---- - -### balance - -• **balance**: _`BigNumber`_ - -_Defined in [types.d.ts:76](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L76)_ - ---- - -### firstVote - -• **firstVote**: _number_ - -_Defined in [types.d.ts:79](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L79)_ - ---- - -### lastProposed - -• **lastProposed**: _number_ - -_Defined in [types.d.ts:81](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L81)_ - ---- - -### lastVoted - -• **lastVoted**: _number_ - -_Defined in [types.d.ts:80](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L80)_ - ---- - -### power - -• **power**: _number_ - -_Defined in [types.d.ts:77](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L77)_ - ---- - -### publicKey - -• **publicKey**: _string_ - -_Defined in [types.d.ts:78](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L78)_ - ---- - -### totalVotes - -• **totalVotes**: _number_ - -_Defined in [types.d.ts:82](https://github.com/ParadigmFoundation/kosu-monorepo/blob/2f37cabf/packages/kosu.js/src/types.d.ts#L82)_ diff --git a/packages/kosu-genesis-cli/docs/globals.md b/packages/kosu-genesis-cli/docs/globals.md index 5df78be5e..6b0c77de8 100644 --- a/packages/kosu-genesis-cli/docs/globals.md +++ b/packages/kosu-genesis-cli/docs/globals.md @@ -40,7 +40,7 @@ • **cli**: _`Command`_ = new commander.Command() -_Defined in [cli/cli.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/cli/cli.ts#L3)_ +_Defined in [cli/cli.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/cli/cli.ts#L3)_ ## Functions @@ -48,7 +48,7 @@ _Defined in [cli/cli.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/b ▸ **dateFromTimestamp**(`timestamp`: number): _`Date`_ -_Defined in [functions.ts:335](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/functions.ts#L335)_ +_Defined in [functions.ts:335](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L335)_ Return a `Date` object generated from a Unix timestamp in seconds. @@ -68,7 +68,7 @@ The JavaScript Date object corresponding to that Unix time. ▸ **generateGenesisFromBlock**(`kosu`: `Kosu`, `chainId`: string, `snapshotBlock`: number, `startTime`: number, `consensusParams`: [ConsensusParams](interfaces/consensusparams.md)): _`Promise`_ -_Defined in [functions.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/functions.ts#L27)_ +_Defined in [functions.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L27)_ Generate a Tendermint genesis file for a Kosu network, where the initial validators are set based on the current state of a deployed Kosu contract system's @@ -94,7 +94,7 @@ Promise resolving to object that can be JSON-serialized to a Kosu/Tendermint gen ▸ **getAppState**(`validators`: [SnapshotValidator](interfaces/snapshotvalidator.md)[], `posters`: [SnapshotPoster](interfaces/snapshotposter.md)[], `snapshotBlock`: number, `consensusParameters`: [ConsensusParams](interfaces/consensusparams.md)): _[AppState](interfaces/appstate.md)_ -_Defined in [functions.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/functions.ts#L90)_ +_Defined in [functions.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L90)_ Constructs the `app_state` genesis field, where the following initial states are gathered or set, from re-processed Ethereum blockchain event logs, or from @@ -127,7 +127,7 @@ CLI input. ▸ **getInitialValidatorInfo**(`validators`: [SnapshotValidator](interfaces/snapshotvalidator.md)[]): _[InitialValidatorInfo](interfaces/initialvalidatorinfo.md)[]_ -_Defined in [functions.ts:307](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/functions.ts#L307)_ +_Defined in [functions.ts:307](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L307)_ Convert the validator snapshot data to the JSON format expected by the Kosu client. @@ -148,7 +148,7 @@ The array of initial validators as expected by `initial_validator_info`. ▸ **getTendermintValidators**(`validators`: [SnapshotValidator](interfaces/snapshotvalidator.md)[]): _[GenesisValidator](interfaces/genesisvalidator.md)[]_ -_Defined in [functions.ts:241](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/functions.ts#L241)_ +_Defined in [functions.ts:241](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L241)_ Convert the validator snapshot data to the JSON format expected by Tendermint. @@ -168,7 +168,7 @@ Tendermint-style genesis validator JSON. ▸ **hexKeyToBase64**(`publicKey`: string): _string_ -_Defined in [functions.ts:325](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/functions.ts#L325)_ +_Defined in [functions.ts:325](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L325)_ Convert a 0x-prefixed hex-encoded public key string to a base64-encoded string. @@ -188,7 +188,7 @@ The base64-encoded string representation of the public key. ▸ **parseMonikerFromDetails**(`details`: string, `itemSeparator`: string, `valueSeparator`: string): _string_ -_Defined in [functions.ts:277](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/functions.ts#L277)_ +_Defined in [functions.ts:277](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L277)_ Allows parsing a moniker from a string that uses two types of separators to store key-value pairs in a plain string. @@ -224,7 +224,7 @@ The value corresponding to the `moniker` key if found, otherwise the input strin ▸ **publicKeyToAddress**(`publicKey`: `Buffer`): _string_ -_Defined in [functions.ts:225](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/functions.ts#L225)_ +_Defined in [functions.ts:225](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L225)_ Convert a Tendermint public key to a Tendermint address (also called node ID). @@ -244,7 +244,7 @@ The corresponding Tendermint address string. ▸ **snapshotPostersAtBlock**(`kosu`: `Kosu`, `snapshotBlock`: number): _`Promise`_ -_Defined in [functions.ts:179](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/functions.ts#L179)_ +_Defined in [functions.ts:179](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L179)_ Generate a "snapshot" of the PosterRegistry contract state (all posters) by re-playing `PosterRegistryUpdate` events from the Kosu EventEmitter contract. @@ -269,7 +269,7 @@ Promise resolving to snapshot poster info (see type definition). ▸ **snapshotValidatorsAtBlock**(`kosu`: `Kosu`, `snapshotBlock`: number): _`Promise`_ -_Defined in [functions.ts:117](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/functions.ts#L117)_ +_Defined in [functions.ts:117](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/functions.ts#L117)_ Generate a "snapshot" of the ValidatorRegistry TCR contract state (specifically, only the listings designated validators at the snapshot block) by re-playing diff --git a/packages/kosu-genesis-cli/docs/interfaces/appstate.md b/packages/kosu-genesis-cli/docs/interfaces/appstate.md index e63c71f24..f7f62392d 100644 --- a/packages/kosu-genesis-cli/docs/interfaces/appstate.md +++ b/packages/kosu-genesis-cli/docs/interfaces/appstate.md @@ -23,7 +23,7 @@ • **consensus_params**: _[ConsensusParams](consensusparams.md)_ -_Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L19)_ +_Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L19)_ --- @@ -31,7 +31,7 @@ _Defined in [types.d.ts:19](https://github.com/ParadigmFoundation/kosu-monorepo/ • **initial_poster_info**: _[SnapshotPoster](snapshotposter.md)[]_ -_Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L21)_ +_Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L21)_ --- @@ -39,7 +39,7 @@ _Defined in [types.d.ts:21](https://github.com/ParadigmFoundation/kosu-monorepo/ • **initial_validator_info**: _[InitialValidatorInfo](initialvalidatorinfo.md)[]_ -_Defined in [types.d.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L20)_ +_Defined in [types.d.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L20)_ --- @@ -47,4 +47,4 @@ _Defined in [types.d.ts:20](https://github.com/ParadigmFoundation/kosu-monorepo/ • **snapshot_block**: _number_ -_Defined in [types.d.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L22)_ +_Defined in [types.d.ts:22](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L22)_ diff --git a/packages/kosu-genesis-cli/docs/interfaces/consensusparams.md b/packages/kosu-genesis-cli/docs/interfaces/consensusparams.md index 6606e97a2..a2c55005c 100644 --- a/packages/kosu-genesis-cli/docs/interfaces/consensusparams.md +++ b/packages/kosu-genesis-cli/docs/interfaces/consensusparams.md @@ -25,7 +25,7 @@ • **blocks_before_pruning**: _number_ -_Defined in [types.d.ts:14](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L14)_ +_Defined in [types.d.ts:14](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L14)_ --- @@ -33,7 +33,7 @@ _Defined in [types.d.ts:14](https://github.com/ParadigmFoundation/kosu-monorepo/ • **finality_threshold**: _number_ -_Defined in [types.d.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L10)_ +_Defined in [types.d.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L10)_ --- @@ -41,7 +41,7 @@ _Defined in [types.d.ts:10](https://github.com/ParadigmFoundation/kosu-monorepo/ • **max_order_bytes**: _number_ -_Defined in [types.d.ts:13](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L13)_ +_Defined in [types.d.ts:13](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L13)_ --- @@ -49,7 +49,7 @@ _Defined in [types.d.ts:13](https://github.com/ParadigmFoundation/kosu-monorepo/ • **orders_limit**: _number_ -_Defined in [types.d.ts:15](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L15)_ +_Defined in [types.d.ts:15](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L15)_ --- @@ -57,7 +57,7 @@ _Defined in [types.d.ts:15](https://github.com/ParadigmFoundation/kosu-monorepo/ • **period_length**: _number_ -_Defined in [types.d.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L12)_ +_Defined in [types.d.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L12)_ --- @@ -65,4 +65,4 @@ _Defined in [types.d.ts:12](https://github.com/ParadigmFoundation/kosu-monorepo/ • **period_limit**: _number_ -_Defined in [types.d.ts:11](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L11)_ +_Defined in [types.d.ts:11](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L11)_ diff --git a/packages/kosu-genesis-cli/docs/interfaces/genesisblock.md b/packages/kosu-genesis-cli/docs/interfaces/genesisblock.md index 6364c85d2..4f361f594 100644 --- a/packages/kosu-genesis-cli/docs/interfaces/genesisblock.md +++ b/packages/kosu-genesis-cli/docs/interfaces/genesisblock.md @@ -24,7 +24,7 @@ • **app_hash**: _string_ -_Defined in [types.d.ts:5](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L5)_ +_Defined in [types.d.ts:5](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L5)_ --- @@ -32,7 +32,7 @@ _Defined in [types.d.ts:5](https://github.com/ParadigmFoundation/kosu-monorepo/b • **app_state**: _[AppState](appstate.md)_ -_Defined in [types.d.ts:6](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L6)_ +_Defined in [types.d.ts:6](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L6)_ --- @@ -40,7 +40,7 @@ _Defined in [types.d.ts:6](https://github.com/ParadigmFoundation/kosu-monorepo/b • **chain_id**: _string_ -_Defined in [types.d.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L3)_ +_Defined in [types.d.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L3)_ --- @@ -48,7 +48,7 @@ _Defined in [types.d.ts:3](https://github.com/ParadigmFoundation/kosu-monorepo/b • **genesis_time**: _string_ -_Defined in [types.d.ts:2](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L2)_ +_Defined in [types.d.ts:2](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L2)_ --- @@ -56,4 +56,4 @@ _Defined in [types.d.ts:2](https://github.com/ParadigmFoundation/kosu-monorepo/b • **validators**: _[GenesisValidator](genesisvalidator.md)[]_ -_Defined in [types.d.ts:4](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L4)_ +_Defined in [types.d.ts:4](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L4)_ diff --git a/packages/kosu-genesis-cli/docs/interfaces/genesisvalidator.md b/packages/kosu-genesis-cli/docs/interfaces/genesisvalidator.md index 276ad883e..894caf185 100644 --- a/packages/kosu-genesis-cli/docs/interfaces/genesisvalidator.md +++ b/packages/kosu-genesis-cli/docs/interfaces/genesisvalidator.md @@ -23,7 +23,7 @@ • **address**: _string_ -_Defined in [types.d.ts:32](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L32)_ +_Defined in [types.d.ts:32](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L32)_ --- @@ -31,7 +31,7 @@ _Defined in [types.d.ts:32](https://github.com/ParadigmFoundation/kosu-monorepo/ • **name**: _string_ -_Defined in [types.d.ts:38](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L38)_ +_Defined in [types.d.ts:38](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L38)_ --- @@ -39,7 +39,7 @@ _Defined in [types.d.ts:38](https://github.com/ParadigmFoundation/kosu-monorepo/ • **power**: _string_ -_Defined in [types.d.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L37)_ +_Defined in [types.d.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L37)_ --- @@ -47,6 +47,6 @@ _Defined in [types.d.ts:37](https://github.com/ParadigmFoundation/kosu-monorepo/ • **pub_key**: _object_ -_Defined in [types.d.ts:33](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L33)_ +_Defined in [types.d.ts:33](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L33)_ #### Type declaration: diff --git a/packages/kosu-genesis-cli/docs/interfaces/initialvalidatorinfo.md b/packages/kosu-genesis-cli/docs/interfaces/initialvalidatorinfo.md index 2793f3de8..ff12e635c 100644 --- a/packages/kosu-genesis-cli/docs/interfaces/initialvalidatorinfo.md +++ b/packages/kosu-genesis-cli/docs/interfaces/initialvalidatorinfo.md @@ -22,7 +22,7 @@ • **ethereum_address**: _string_ -_Defined in [types.d.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L27)_ +_Defined in [types.d.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L27)_ --- @@ -30,7 +30,7 @@ _Defined in [types.d.ts:27](https://github.com/ParadigmFoundation/kosu-monorepo/ • **initial_stake**: _string_ -_Defined in [types.d.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L28)_ +_Defined in [types.d.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L28)_ --- @@ -38,4 +38,4 @@ _Defined in [types.d.ts:28](https://github.com/ParadigmFoundation/kosu-monorepo/ • **tendermint_address**: _string_ -_Defined in [types.d.ts:26](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L26)_ +_Defined in [types.d.ts:26](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L26)_ diff --git a/packages/kosu-genesis-cli/docs/interfaces/snapshotlisting.md b/packages/kosu-genesis-cli/docs/interfaces/snapshotlisting.md index 7ca4309b3..77f3510d8 100644 --- a/packages/kosu-genesis-cli/docs/interfaces/snapshotlisting.md +++ b/packages/kosu-genesis-cli/docs/interfaces/snapshotlisting.md @@ -26,7 +26,7 @@ • **details**: _string_ -_Defined in [types.d.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L44)_ +_Defined in [types.d.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L44)_ --- @@ -34,7 +34,7 @@ _Defined in [types.d.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/ • **ethAddress**: _string_ -_Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L43)_ +_Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L43)_ --- @@ -42,7 +42,7 @@ _Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/ • **publicKey**: _`Buffer`_ -_Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L42)_ +_Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L42)_ --- @@ -50,7 +50,7 @@ _Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/ • **stakeAmount**? : _string_ -_Defined in [types.d.ts:45](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L45)_ +_Defined in [types.d.ts:45](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L45)_ --- @@ -58,4 +58,4 @@ _Defined in [types.d.ts:45](https://github.com/ParadigmFoundation/kosu-monorepo/ • **status**: _"proposal" | "validator"_ -_Defined in [types.d.ts:46](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L46)_ +_Defined in [types.d.ts:46](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L46)_ diff --git a/packages/kosu-genesis-cli/docs/interfaces/snapshotposter.md b/packages/kosu-genesis-cli/docs/interfaces/snapshotposter.md index de2bf4bda..066909c17 100644 --- a/packages/kosu-genesis-cli/docs/interfaces/snapshotposter.md +++ b/packages/kosu-genesis-cli/docs/interfaces/snapshotposter.md @@ -21,7 +21,7 @@ • **balance**: _string_ -_Defined in [types.d.ts:56](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L56)_ +_Defined in [types.d.ts:56](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L56)_ --- @@ -29,4 +29,4 @@ _Defined in [types.d.ts:56](https://github.com/ParadigmFoundation/kosu-monorepo/ • **ethereum_address**: _string_ -_Defined in [types.d.ts:55](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L55)_ +_Defined in [types.d.ts:55](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L55)_ diff --git a/packages/kosu-genesis-cli/docs/interfaces/snapshotvalidator.md b/packages/kosu-genesis-cli/docs/interfaces/snapshotvalidator.md index b52a0dc8d..8d9d1e30e 100644 --- a/packages/kosu-genesis-cli/docs/interfaces/snapshotvalidator.md +++ b/packages/kosu-genesis-cli/docs/interfaces/snapshotvalidator.md @@ -28,7 +28,7 @@ _Inherited from [SnapshotListing](snapshotlisting.md).[details](snapshotlisting.md#details)_ -_Defined in [types.d.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L44)_ +_Defined in [types.d.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L44)_ --- @@ -38,7 +38,7 @@ _Defined in [types.d.ts:44](https://github.com/ParadigmFoundation/kosu-monorepo/ _Inherited from [SnapshotListing](snapshotlisting.md).[ethAddress](snapshotlisting.md#ethaddress)_ -_Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L43)_ +_Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L43)_ --- @@ -48,7 +48,7 @@ _Defined in [types.d.ts:43](https://github.com/ParadigmFoundation/kosu-monorepo/ _Inherited from [SnapshotListing](snapshotlisting.md).[publicKey](snapshotlisting.md#publickey)_ -_Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L42)_ +_Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L42)_ --- @@ -58,7 +58,7 @@ _Defined in [types.d.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/ _Overrides [SnapshotListing](snapshotlisting.md).[stakeAmount](snapshotlisting.md#optional-stakeamount)_ -_Defined in [types.d.ts:50](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L50)_ +_Defined in [types.d.ts:50](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L50)_ --- @@ -68,4 +68,4 @@ _Defined in [types.d.ts:50](https://github.com/ParadigmFoundation/kosu-monorepo/ _Overrides [SnapshotListing](snapshotlisting.md).[status](snapshotlisting.md#status)_ -_Defined in [types.d.ts:51](https://github.com/ParadigmFoundation/kosu-monorepo/blob/9b95ef82/packages/kosu-genesis-cli/src/types.d.ts#L51)_ +_Defined in [types.d.ts:51](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-genesis-cli/src/types.d.ts#L51)_ diff --git a/packages/kosu-system-contracts/docs/KosuToken.md b/packages/kosu-system-contracts/docs/KosuToken.md index 2a3340849..6b4f42f4f 100644 --- a/packages/kosu-system-contracts/docs/KosuToken.md +++ b/packages/kosu-system-contracts/docs/KosuToken.md @@ -10,7 +10,6 @@ KosuToken (KOSU) is an implementation of the ERC-20 interface and supporting bon - [balanceOf](#balanceof) - [bondTokens](#bondtokens) - [burn](#burn) - - [constructor](#constructor) - [decreaseAllowance](#decreaseallowance) - [estimateEtherToToken](#estimateethertotoken) - [estimateTokenToEther](#estimatetokentoether) @@ -112,22 +111,6 @@ function burn(amount uint256) public | --------- | --------- | ------------------------- | | `amount` | `uint256` | Number of tokens to burn. | -### constructor - -Initializes KosuToken with the authorizedAddresses shared permission contract to protect functions. - -#### Signature - -```solidity -constructor(_auth address) public -``` - -#### Parameters: - -| Parameter | Type | Description | -| --------- | --------- | -------------------------------------- | -| `_auth` | `address` | Deployed AuthorizedAddresses contract. | - ### decreaseAllowance Decrease the amount of tokens that an owner allowed to a spender. approve should be called when allowed\_[_spender] == 0. To decrement allowed value is better to use this function to avoid 2 calls (and wait until the first transaction is mined) From MonolithDAO Token.sol Emits an Approval event. diff --git a/packages/kosu-system-contracts/docs/Treasury.md b/packages/kosu-system-contracts/docs/Treasury.md index 99598bc08..0e4a5e284 100644 --- a/packages/kosu-system-contracts/docs/Treasury.md +++ b/packages/kosu-system-contracts/docs/Treasury.md @@ -17,7 +17,6 @@ The Kosu Treasury manages KosuToken balances to allow tokens in use within the c - [deposit](#deposit) - [registerVote](#registervote) - [releaseTokens](#releasetokens) - - [setVoting](#setvoting) - [systemBalance](#systembalance) - [tokenLocksExpire](#tokenlocksexpire) - [validatorLock](#validatorlock) @@ -208,13 +207,13 @@ function registerVote(account address, pollId uint256, amount uint256, endBlock #### Parameters: -| Parameter | Type | Description | -| ---------------- | --------- | ------------------------------------------------------------------------------------- | -| `account` | `address` | The account voting. | -| `pollId` | `uint256` | The poll the account is voting on. | -| `amount` | `uint256` | Number of tokens contributed. | -| `endBlock` | `uint256` | Block number vote token lock should expire. | -| `losingEndBlock` | `uint256` | Block number vote token lock should expire if vote was in support of a losing option. | +| Parameter | Type | Description | +| ---------------- | --------- | ---------------------------------- | +| `account` | `address` | The account voting. | +| `pollId` | `uint256` | The poll the account is voting on. | +| `amount` | `uint256` | Number of tokens contributed. | +| `endBlock` | `uint256` | +| `losingEndBlock` | `uint256` | ### releaseTokens @@ -233,22 +232,6 @@ function releaseTokens(account address, amount uint256) public | `account` | `address` | Account to release tokens to. | | `amount` | `uint256` | Number of tokens to release. | -### setVoting - -Set the voting contract after post deployment of the Treasury contract. - -#### Signature - -```solidity -function setVoting(votingAddress address) public -``` - -#### Parameters: - -| Parameter | Type | Description | -| --------------- | --------- | ---------------------------------------- | -| `votingAddress` | `address` | address of the deployed Voting contract. | - ### systemBalance Reports the total balance within the entire contract system for an account. diff --git a/packages/kosu-system-contracts/docs/ValidatorRegistry.md b/packages/kosu-system-contracts/docs/ValidatorRegistry.md index 3ec10eddc..b865dc6c8 100644 --- a/packages/kosu-system-contracts/docs/ValidatorRegistry.md +++ b/packages/kosu-system-contracts/docs/ValidatorRegistry.md @@ -101,19 +101,19 @@ constructor(_treasuryAddress address, _votingAddress address, _events address, _ #### Parameters: -| Parameter | Type | Description | -| ------------------------ | --------- | -------------------------------------------------------------------------------------------- | -| `_treasuryAddress` | `address` | Deployed Treasury address. | -| `_votingAddress` | `address` | Deployed Voting address. | -| `_events` | `address` | Deployed EventEmitter address. | -| `_applicationPeriod` | `uint256` | Initial application period (in blocks) for pending listings. | -| `_commitPeriod` | `uint256` | Number of blocks after challenge initiated in which votes can be committed. | -| `_challengePeriod` | `uint256` | Number of blocks a challenge lasts before being finalized. | -| `_exitPeriod` | `uint256` | Number of blocks exiting listings must wait before claiming stake. | -| `_rewardPeriod` | `uint256` | The frequency (in blocks) with which validator rewards may be issued. | -| `_exitLockPeriod` | `uint256` | Number of blocks tokens will be locked after a successful exit. | -| `_winningVoteLockPeriod` | `uint256` | Number of blocks winning voters will have tokens locked after a challenge has been resolved. | -| `_losingVoteLockPeriod` | `uint256` | Number of blocks losing voters will have tokens locked after a challenge has been resolved. | +| Parameter | Type | Description | +| ------------------------ | --------- | --------------------------------------------------------------------------- | +| `_treasuryAddress` | `address` | Deployed Treasury address. | +| `_votingAddress` | `address` | Deployed Voting address. | +| `_events` | `address` | Deployed EventEmitter address. | +| `_applicationPeriod` | `uint256` | Initial application period (in blocks) for pending listings. | +| `_commitPeriod` | `uint256` | Number of blocks after challenge initiated in which votes can be committed. | +| `_challengePeriod` | `uint256` | Number of blocks a challenge lasts before being finalized. | +| `_exitPeriod` | `uint256` | Number of blocks exiting listings must wait before claiming stake. | +| `_rewardPeriod` | `uint256` | The frequency (in blocks) with which validator rewards may be issued. | +| `_exitLockPeriod` | `uint256` | +| `_winningVoteLockPeriod` | `uint256` | +| `_losingVoteLockPeriod` | `uint256` | ### finalizeExit