Skip to content

Commit

Permalink
Merge pull request #335 from ParadigmFoundation/fix/docs/after-reorga…
Browse files Browse the repository at this point in the history 
…nization

Fix CD build and docs paths after re-organization
  • Loading branch information
@Freydal
Freydal authored Oct 14, 2019
2 parents a7ce3d5 + dc34daa commit 1111e61
Show file tree
Hide file tree
Showing 80 changed files with 1,013 additions and 3,012 deletions.
4 changes: 2 additions & 2 deletions cloudbuild/main.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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"
Expand Down
16 changes: 8 additions & 8 deletions packages/kosu-contract-helpers/docs/classes/eventemitter.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)_

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

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

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

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: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.
Expand Down
50 changes: 19 additions & 31 deletions packages/kosu-contract-helpers/docs/classes/kosu.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@ contracts.

### Properties

- [Signature](kosu.md#signature)
- [eventEmitter](kosu.md#eventemitter)
- [kosuToken](kosu.md#kosutoken)
- [node](kosu.md#node)
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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.

Expand All @@ -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).
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.
Expand All @@ -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.
Expand All @@ -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
Expand All @@ -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.

Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down
32 changes: 16 additions & 16 deletions packages/kosu-contract-helpers/docs/classes/kosutoken.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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)_

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

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

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

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: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.

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: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.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

_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.
Expand All @@ -247,7 +247,7 @@ The total KOSU supply in wei.

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

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

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: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.

Expand Down
Loading

0 comments on commit 1111e61

Please sign in to comment.