Skip to content
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

[node-client] Seperate node client from contract-helpers #332

Merged
merged 9 commits into from
Oct 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion packages/kosu-contract-helpers/docs/README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> **[kosu.js](README.md)**
> **[contract-helpers](README.md)**

[Globals](globals.md) /

Expand Down
10 changes: 5 additions & 5 deletions packages/kosu-contract-helpers/docs/classes/eventemitter.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> **[kosu.js](../README.md)**
> **[contract-helpers](../README.md)**

[Globals](../globals.md) / [EventEmitter](eventemitter.md) /

Expand Down Expand Up @@ -30,7 +30,7 @@ to subscribe to future events.

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

_Defined in [EventEmitter.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L49)_
_Defined in [EventEmitter.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/EventEmitter.ts#L49)_

Create a new `EventEmitter` instance.

Expand All @@ -48,7 +48,7 @@ Create a new `EventEmitter` instance.

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

_Defined in [EventEmitter.ts:65](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L65)_
_Defined in [EventEmitter.ts:65](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/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).
Expand All @@ -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:111](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L111)_
_Defined in [EventEmitter.ts:111](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/EventEmitter.ts#L111)_

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

Expand Down Expand Up @@ -91,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:84](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/EventEmitter.ts#L84)_
_Defined in [EventEmitter.ts:84](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/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.
Expand Down
42 changes: 14 additions & 28 deletions packages/kosu-contract-helpers/docs/classes/kosu.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> **[kosu.js](../README.md)**
> **[contract-helpers](../README.md)**

[Globals](../globals.md) / [Kosu](kosu.md) /

Expand Down Expand Up @@ -30,7 +30,6 @@ contracts.

- [eventEmitter](kosu.md#eventemitter)
- [kosuToken](kosu.md#kosutoken)
- [node](kosu.md#node)
- [orderGateway](kosu.md#ordergateway)
- [orderHelper](kosu.md#orderhelper)
- [posterRegistry](kosu.md#posterregistry)
Expand All @@ -48,7 +47,7 @@ contracts.

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

_Defined in [Kosu.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L132)_
_Defined in [Kosu.ts:121](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L121)_

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

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

_Defined in [Kosu.ts:119](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L119)_
_Defined in [Kosu.ts:108](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L108)_

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

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

_Defined in [Kosu.ts:84](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L84)_
_Defined in [Kosu.ts:73](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L73)_

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

---

### node

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

_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).

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

---

### orderGateway

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

_Defined in [Kosu.ts:71](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L71)_
_Defined in [Kosu.ts:60](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L60)_

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

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

_Defined in [Kosu.ts:79](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L79)_
_Defined in [Kosu.ts:68](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L68)_

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

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

_Defined in [Kosu.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L104)_
_Defined in [Kosu.ts:93](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L93)_

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

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

_Defined in [Kosu.ts:90](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L90)_
_Defined in [Kosu.ts:79](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L79)_

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

• **utils**: _`KosuUtils`_

_Defined in [Kosu.ts:127](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L127)_
_Defined in [Kosu.ts:116](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L116)_

Common and helpful utility methods and constants for interacting with the
Kosu contract system and Ethereum blockchain.
Expand All @@ -168,7 +154,7 @@ Kosu contract system and Ethereum blockchain.

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

_Defined in [Kosu.ts:113](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L113)_
_Defined in [Kosu.ts:102](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L102)_

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

• **version**: _string_

_Defined in [Kosu.ts:132](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L132)_
_Defined in [Kosu.ts:121](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L121)_

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

Expand All @@ -192,7 +178,7 @@ The current `@kosu/kosu.js` package version.

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

_Defined in [Kosu.ts:97](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L97)_
_Defined in [Kosu.ts:86](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/Kosu.ts#L86)_

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

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

_Defined in [Kosu.ts:42](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L42)_
_Defined in [Kosu.ts:41](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/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
Expand All @@ -216,7 +202,7 @@ wrapper and can be used to directly access the `web3` API.

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

_Defined in [Kosu.ts:49](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/Kosu.ts#L49)_
_Defined in [Kosu.ts:48](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/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
Expand Down
26 changes: 13 additions & 13 deletions packages/kosu-contract-helpers/docs/classes/kosutoken.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> **[kosu.js](../README.md)**
> **[contract-helpers](../README.md)**

[Globals](../globals.md) / [KosuToken](kosutoken.md) /

Expand Down Expand Up @@ -41,7 +41,7 @@ If instantiated outside the `Kosu` class, an instance of `web3` and of the

\+ **new KosuToken**(`options`: `KosuOptions`): _[KosuToken](kosutoken.md)_

_Defined in [KosuToken.ts:39](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L39)_
_Defined in [KosuToken.ts:39](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L39)_

Creates a new KosuToken instance, supplied with an options object.

Expand Down Expand Up @@ -69,7 +69,7 @@ const kosuToken = new KosuToken(options);

▸ **allowance**(`owner`: string, `spender`: string): _`Promise<BigNumber>`_

_Defined in [KosuToken.ts:153](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L153)_
_Defined in [KosuToken.ts:153](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L153)_

Reads approved allowance for a given `owner` and `spender` account.

Expand All @@ -90,7 +90,7 @@ The allowance granted to the `spender` in units of wei.

▸ **approve**(`spender`: string, `value`: `BigNumber`): _`Promise<TransactionReceiptWithDecodedLogs>`_

_Defined in [KosuToken.ts:141](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L141)_
_Defined in [KosuToken.ts:141](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L141)_

Sets approval for user to transfer tokens on `coinbase`'s behalf.

Expand All @@ -111,7 +111,7 @@ The transaction receipt after it has been included in a block.

▸ **balanceOf**(`owner`: string): _`Promise<BigNumber>`_

_Defined in [KosuToken.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L104)_
_Defined in [KosuToken.ts:104](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L104)_

Reads the balance for a user address, returned in wei.

Expand All @@ -131,7 +131,7 @@ The `owner`'s KOSU balance in wei.

▸ **bondTokens**(`value`: `BigNumber`, `minPayout`: `BigNumber`): _`Promise<TransactionReceiptWithDecodedLogs>`_

_Defined in [KosuToken.ts:187](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L187)_
_Defined in [KosuToken.ts:187](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L187)_

Sends ether to the contract to bond tokens.

Expand All @@ -152,7 +152,7 @@ Logs from the transaction block.

▸ **estimateEtherToToken**(`etherInput`: `BigNumber`): _`Promise<BigNumber>`_

_Defined in [KosuToken.ts:164](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L164)_
_Defined in [KosuToken.ts:164](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L164)_

Calculated tokens to be minted from deposited ether.

Expand All @@ -172,7 +172,7 @@ Estimation of tokens to be minted.

▸ **estimateTokenToEther**(`tokensToBurn`: `BigNumber`): _`Promise<BigNumber>`_

_Defined in [KosuToken.ts:175](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L175)_
_Defined in [KosuToken.ts:175](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L175)_

Calculates ether to be returned for burning tokens.

Expand All @@ -192,7 +192,7 @@ Estimation of ether to be returned.

▸ **pay**(`value`: `BigNumber`): _`Promise<TransactionReceiptWithDecodedLogs>`_

_Defined in [KosuToken.ts:211](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L211)_
_Defined in [KosuToken.ts:211](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L211)_

Sends ether to the contract to bond tokens.

Expand All @@ -212,7 +212,7 @@ Logs from the transaction block.

▸ **releaseTokens**(`tokensToBurn`: `BigNumber`): _`Promise<TransactionReceiptWithDecodedLogs>`_

_Defined in [KosuToken.ts:200](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L200)_
_Defined in [KosuToken.ts:200](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L200)_

Releases tokens to be burned and return bonded ether.

Expand All @@ -232,7 +232,7 @@ Logs from the transaction block.

▸ **totalSupply**(): _`Promise<BigNumber>`_

_Defined in [KosuToken.ts:93](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L93)_
_Defined in [KosuToken.ts:93](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/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.
Expand All @@ -247,7 +247,7 @@ The total KOSU supply in wei.

▸ **transfer**(`to`: string, `value`: `BigNumber`): _`Promise<TransactionReceiptWithDecodedLogs>`_

_Defined in [KosuToken.ts:116](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L116)_
_Defined in [KosuToken.ts:116](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L116)_

Transfers tokens to an address, from the current `coinbase` account.

Expand All @@ -268,7 +268,7 @@ The transaction's receipt after inclusion in a block.

▸ **transferFrom**(`from`: string, `to`: string, `value`: `BigNumber`): _`Promise<TransactionReceiptWithDecodedLogs>`_

_Defined in [KosuToken.ts:129](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/KosuToken.ts#L129)_
_Defined in [KosuToken.ts:129](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/KosuToken.ts#L129)_

Transfers token from an address to a destination address.

Expand Down
12 changes: 6 additions & 6 deletions packages/kosu-contract-helpers/docs/classes/ordergateway.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
> **[kosu.js](../README.md)**
> **[contract-helpers](../README.md)**

[Globals](../globals.md) / [OrderGateway](ordergateway.md) /

Expand Down Expand Up @@ -38,7 +38,7 @@ specified SubContract during serialization and signature generation.

\+ **new OrderGateway**(`options`: `KosuOptions`): _[OrderGateway](ordergateway.md)_

_Defined in [OrderGateway.ts:48](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L48)_
_Defined in [OrderGateway.ts:48](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/OrderGateway.ts#L48)_

Create a new OrderGateway instance.

Expand All @@ -56,7 +56,7 @@ Create a new OrderGateway instance.

▸ **amountRemaining**(`order`: `Order`): _`Promise<BigNumber>`_

_Defined in [OrderGateway.ts:152](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L152)_
_Defined in [OrderGateway.ts:152](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/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.
Expand All @@ -78,7 +78,7 @@ implementation of the `amountRemaining` method.

▸ **arguments**(`subContract`: string): _`Promise<any>`_

_Defined in [OrderGateway.ts:119](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L119)_
_Defined in [OrderGateway.ts:119](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/OrderGateway.ts#L119)_

Read the required arguments from a deployed SubContract.

Expand All @@ -98,7 +98,7 @@ The JSON array that defines the arguments for the SubContract.

▸ **isValid**(`order`: `Order`): _`Promise<boolean>`_

_Defined in [OrderGateway.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L136)_
_Defined in [OrderGateway.ts:136](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/packages/kosu-contract-helpers/src/OrderGateway.ts#L136)_

Checks validity of order data according the order's SubContract implementation.

Expand All @@ -116,7 +116,7 @@ Checks validity of order data according the order's SubContract implementation.

▸ **participate**(`order`: `Order`, `taker`: string): _`Promise<any>`_

_Defined in [OrderGateway.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/a7ce3d5b/packages/kosu-contract-helpers/src/OrderGateway.ts#L98)_
_Defined in [OrderGateway.ts:98](https://github.com/ParadigmFoundation/kosu-monorepo/blob/515d6d59/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
Expand Down
Loading