Skip to content

/ kosu-monorepo

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

kosu.js: implement a go-kosu JSONRPC client (the NodeClient) #229

Merged
merged 18 commits into from Aug 23, 2019
+1,389 −717
Merged

kosu.js: implement a go-kosu JSONRPC client (the NodeClient) #229

Changes from all commits
Commits
Show all changes
18 commits
Select commit Hold shift + click to select a range
ba893b7
initial node RPC client implementation
hrharder Aug 22, 2019
8a93ad6
missing await on promise
hrharder Aug 22, 2019
f040e2f
fixing validators balance conversion
hrharder Aug 22, 2019
11b9cc0
adding func to convert from public key to node ID
hrharder Aug 22, 2019
6f2e797
kosu.js: implement kosu node jsonrpc client
hrharder Aug 22, 2019
b7f6706
kosu.js: running prettier
hrharder Aug 22, 2019
4048650
kosu.js: regenerating docs
hrharder Aug 22, 2019
884b6c7
kosu.js: don't generate docs for private methods
hrharder Aug 22, 2019
32ee5b8
Merge branch 'master' into feature/kosu.js/node-rpc
hrharder Aug 22, 2019
fc105a5
kosu.js: add lint:fix script
hrharder Aug 22, 2019
d63dab4
kosu.js: fixing linter errors
hrharder Aug 22, 2019
723d4cc
Merge branch 'feature/kosu.js/node-rpc' of github.com:ParadigmFoundat…
hrharder Aug 22, 2019
b6bc830
kosu.js: applying prettier fixes
hrharder Aug 22, 2019
1965401
use BigNumber for validator balance
hrharder Aug 23, 2019
a88cd29
parse number out of poster queries as well
hrharder Aug 23, 2019
67be855
Merge branch 'master' into feature/kosu.js/node-rpc
hrharder Aug 23, 2019
e49427a
update validator and poster types to use BigNumber
hrharder Aug 23, 2019
725d0ba
Merge branch 'feature/kosu.js/node-rpc' of github.com:ParadigmFoundat…
hrharder Aug 23, 2019
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

83 packages/kosu.js/docs/classes/eventemitter.md
View file
Open in desktop
@@ -18,27 +18,19 @@ to subscribe to future events.

- [constructor](eventemitter.md#constructor)

### Properties

- [address](eventemitter.md#private-address)
- [kosuWeb3Wrapper](eventemitter.md#private-kosuweb3wrapper)
- [web3Wrapper](eventemitter.md#private-web3wrapper)

### Methods

- [\_decodeLogs](eventemitter.md#private-_decodelogs)
- [getAddress](eventemitter.md#getaddress)
- [getFutureDecodedLogs](eventemitter.md#getfuturedecodedlogs)
- [getPastDecodedLogs](eventemitter.md#getpastdecodedlogs)
- [getPastLogsFromKosuEndpoint](eventemitter.md#private-getpastlogsfromkosuendpoint)

## Constructors

### constructor

\+ **new EventEmitter**(`options`: [KosuOptions](../interfaces/kosuoptions.md)): _[EventEmitter](eventemitter.md)_

_Defined in [EventEmitter.ts:47](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/EventEmitter.ts#L47)_
_Defined in [EventEmitter.ts:47](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/EventEmitter.ts#L47)_

Create a new `EventEmitter` instance.

@@ -50,61 +42,13 @@ Create a new `EventEmitter` instance.

**Returns:** _[EventEmitter](eventemitter.md)_

## Properties

### `Private` address

• **address**: _string_

_Defined in [EventEmitter.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/EventEmitter.ts#L41)_

The address of the deployed `EventEmitter` contract for the current Ethereum
network.

---

### `Private` kosuWeb3Wrapper

• **kosuWeb3Wrapper**: _`Web3Wrapper`_

_Defined in [EventEmitter.ts:47](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/EventEmitter.ts#L47)_

A separate `web3Wrapper` instance that can be configured with the Kosu
development proof-of-authority network for testing purposes.

---

### `Private` web3Wrapper

• **web3Wrapper**: _`Web3Wrapper`_

_Defined in [EventEmitter.ts:35](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/EventEmitter.ts#L35)_

The `web3Wrapper` instance with the contract's ABI loaded.

## Methods

### `Private` \_decodeLogs

▸ **\_decodeLogs**(`logs`: `LogEntry`[]): _`Array<LogWithDecodedKosuArgs<DecodedLogArgs, DecodedKosuLogArgs>>`_

_Defined in [EventEmitter.ts:143](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/EventEmitter.ts#L143)_

**Parameters:**

| Name | Type |
| ------ | ------------ |
| `logs` | `LogEntry`[] |

**Returns:** _`Array<LogWithDecodedKosuArgs<DecodedLogArgs, DecodedKosuLogArgs>>`_

---

### getAddress

▸ **getAddress**(): _`Promise<string>`_

_Defined in [EventEmitter.ts:63](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/EventEmitter.ts#L63)_
_Defined in [EventEmitter.ts:63](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/EventEmitter.ts#L63)_

Return the address of the configured deployed contract. If not already cached,
will return the deployed address for the detected network ID (if available).
@@ -117,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/c134674/packages/kosu.js/src/EventEmitter.ts#L109)_
_Defined in [EventEmitter.ts:109](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/EventEmitter.ts#L109)_

**`todo`** document better (and confirm)

@@ -147,7 +91,7 @@ A callback function to be called on an array of each new event log.

▸ **getPastDecodedLogs**(`config`: `FilterObject`): _`Promise<Array<LogWithDecodedKosuArgs<DecodedLogArgs, DecodedKosuLogArgs>>>`_

_Defined in [EventEmitter.ts:82](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/EventEmitter.ts#L82)_
_Defined in [EventEmitter.ts:82](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/EventEmitter.ts#L82)_

Get all past decoded logs from the Kosu `EventEmitter` contract, with the
oldest event at position 0.
@@ -161,22 +105,3 @@ oldest event at position 0.
**Returns:** _`Promise<Array<LogWithDecodedKosuArgs<DecodedLogArgs, DecodedKosuLogArgs>>>`_

An array of event logs with decoded arguments from the EventEmitter.

---

### `Private` getPastLogsFromKosuEndpoint

▸ **getPastLogsFromKosuEndpoint**(`config`: `FilterObject`): _`Promise<any[]>`_

_Defined in [EventEmitter.ts:133](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/EventEmitter.ts#L133)_

Load all historical even logs from the Kosu EventEmitter contract that is
deployed on the Kosu private test-network.

**Parameters:**

| Name | Type | Description |
| -------- | -------------- | ---------------------------------------------------------------------- |
| `config` | `FilterObject` | Filter object for querying past logs (see `web3Wrapper.getLogsAsync`). |

**Returns:** _`Promise<any[]>`_
42 packages/kosu.js/docs/classes/kosu.md
View file
Open in desktop
@@ -31,6 +31,7 @@ contracts.
- [Signature](kosu.md#signature)
- [eventEmitter](kosu.md#eventemitter)
- [kosuToken](kosu.md#kosutoken)
- [node](kosu.md#node)
- [orderGateway](kosu.md#ordergateway)
- [orderHelper](kosu.md#orderhelper)
- [posterRegistry](kosu.md#posterregistry)
@@ -48,7 +49,7 @@ contracts.

\+ **new Kosu**(`options`: [KosuOptions](../interfaces/kosuoptions.md)): _[Kosu](kosu.md)_

_Defined in [Kosu.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L126)_
_Defined in [Kosu.ts:137](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L137)_

Create a new `kosu` instance and instantiate wrappers for each Kosu system
contract.
@@ -72,7 +73,7 @@ of transactions and generation of signatures will not be possible.

• **Signature**: _`Signature`_

_Defined in [Kosu.ts:121](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L121)_
_Defined in [Kosu.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L132)_

Utilities for generating and recovering signatures for use within the
Kosu system.
@@ -83,7 +84,7 @@ Kosu system.

• **eventEmitter**: _[EventEmitter](eventemitter.md)_

_Defined in [Kosu.ts:107](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L107)_
_Defined in [Kosu.ts:118](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L118)_

The `eventEmitter` enables the query of and subscription to decoded event
logs from the Kosu `EventEmitter` contract.
@@ -94,17 +95,30 @@ logs from the Kosu `EventEmitter` contract.

• **kosuToken**: _[KosuToken](kosutoken.md)_

_Defined in [Kosu.ts:72](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L72)_
_Defined in [Kosu.ts:83](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L83)_

The `kosuToken` provides methods for interacting with the KOSU ERC-20 token.

---

### node

• **node**: _[NodeClient](nodeclient.md)_

_Defined in [Kosu.ts:58](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L58)_

A JSONRPC client for a Kosu node, enabled if a `kosuNodeUrl` is provided
to the Kosu constructor (as part of the options object).

Enables access to the `go-kosu` JSONRPC-API, including subscriptions.

---

### orderGateway

• **orderGateway**: _[OrderGateway](ordergateway.md)_

_Defined in [Kosu.ts:59](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L59)_
_Defined in [Kosu.ts:70](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L70)_

The `orderGateway` instance provides access to the `OrderGateway` contract
which is used to direct settlement of orders to their corresponding
@@ -119,7 +133,7 @@ type, based on a `SubContract` address.

• **orderHelper**: _[OrderHelper](orderhelper.md)_

_Defined in [Kosu.ts:67](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L67)_
_Defined in [Kosu.ts:78](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L78)_

The `orderHelper` instance provides methods for generating and signing
maker orders, signing orders for submission to the Kosu network, and
@@ -132,7 +146,7 @@ submitting orders for settlement on the Ethereum blockchain via the

• **posterRegistry**: _[PosterRegistry](posterregistry.md)_

_Defined in [Kosu.ts:92](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L92)_
_Defined in [Kosu.ts:103](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L103)_

The `posterRegistry` instance enables users to interact with the Kosu
`PosterRegistry` contract to bond and un-bond KOSU tokens to access the
@@ -144,7 +158,7 @@ order relay feature of the Kosu network.

• **treasury**: _[Treasury](treasury.md)_

_Defined in [Kosu.ts:78](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L78)_
_Defined in [Kosu.ts:89](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L89)_

The `treasury` instance provides access to functionality of the Kosu
`Treasury` contract, such as deposits/withdrawals and allowance management.
@@ -155,7 +169,7 @@ The `treasury` instance provides access to functionality of the Kosu

• **utils**: _[KosuUtils](../interfaces/kosuutils.md)_

_Defined in [Kosu.ts:115](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L115)_
_Defined in [Kosu.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L126)_

Common and helpful utility methods and constants for interacting with the
Kosu contract system and Ethereum blockchain.
@@ -166,7 +180,7 @@ Kosu contract system and Ethereum blockchain.

• **validatorRegistry**: _[ValidatorRegistry](validatorregistry.md)_

_Defined in [Kosu.ts:101](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L101)_
_Defined in [Kosu.ts:112](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L112)_

The `validatorRegistry` instance enables interaction with the `ValidatorRegistry`
token-curated registry system. The system enables users to submit proposals
@@ -180,7 +194,7 @@ It also provides query access to past challenges and the current listings.

• **version**: _string_

_Defined in [Kosu.ts:126](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L126)_
_Defined in [Kosu.ts:137](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L137)_

The current `@kosu/kosu.js` package version.

@@ -190,7 +204,7 @@ The current `@kosu/kosu.js` package version.

• **voting**: _[Voting](voting.md)_

_Defined in [Kosu.ts:85](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L85)_
_Defined in [Kosu.ts:96](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L96)_

The `voting` instance provides access to the Kosu `voting` contract and
allows users to participate in voting on governance measures, and claiming
@@ -202,7 +216,7 @@ rewards for correctly participating in winning polls.

• **web3**: _`Web3`_

_Defined in [Kosu.ts:40](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L40)_
_Defined in [Kosu.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L41)_

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
@@ -214,7 +228,7 @@ wrapper and can be used to directly access the `web3` API.

• **web3Wrapper**: _`Web3Wrapper`_

_Defined in [Kosu.ts:47](https://github.com/ParadigmFoundation/kosu-monorepo/blob/c134674/packages/kosu.js/src/Kosu.ts#L47)_
_Defined in [Kosu.ts:48](https://github.com/ParadigmFoundation/kosu-monorepo/blob/4048650/packages/kosu.js/src/Kosu.ts#L48)_

The `web3Wrapper` is used for some extended features, and provides
a higher-level API to the same underlying `web3` provider. It it used to
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.