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

Refactor/reviewing contract code and comments #234

Merged
merged 12 commits into from Aug 26, 2019
Prev

Regenerating documentation.

  • Loading branch information
Freydal committed Aug 26, 2019
commit 34c21198170802d5a182f2c6eef29d93cea2fee8
@@ -28,7 +28,7 @@ constructor(auth address) public

### emitEvent

Emits a standard event from the Kosu contract system. The events can be decoded though the javascript library.
Emits a standard event from the Kosu contract system. The events can be decoded though the Kosu.js library.

#### Signature

@@ -140,17 +140,17 @@ function getChallenge(challengeId uint256) public view (tuple)

#### Parameters:

| Parameter | Type | Description |
| ------------- | --------- | ------------------------------------- |
| `challengeId` | `uint256` | The ID to retrieve challenge data for |
| Parameter | Type | Description |
| ------------- | --------- | -------------------------------------- |
| `challengeId` | `uint256` | The ID to retrieve challenge data for. |

#### Returns:

The challenge indicated by the provided ID.

### getChallenges

Expose multiple challenges by is
Expose multiple challenges by ids.

#### Signature

@@ -160,9 +160,9 @@ function getChallenges(challengeIds uint256[]) public view (tuple[])

#### Parameters:

| Parameter | Type | Description |
| -------------- | ----------- | --------------------- |
| `challengeIds` | `uint256[]` | challenge ids to read |
| Parameter | Type | Description |
| -------------- | ----------- | ---------------------- |
| `challengeIds` | `uint256[]` | challenge ids to read. |

#### Returns:

@@ -180,9 +180,9 @@ function getListing(pubKey bytes32) public view (tuple)

#### Parameters:

| Parameter | Type | Description |
| --------- | --------- | --------------------------------- |
| `pubKey` | `bytes32` | Hex encoded tendermint public key |
| Parameter | Type | Description |
| --------- | --------- | ---------------------------------- |
| `pubKey` | `bytes32` | Hex encoded tendermint public key. |

#### Returns:

@@ -200,9 +200,9 @@ function getListings(pubKeys bytes32[]) public view (tuple[])

#### Parameters:

| Parameter | Type | Description |
| --------- | ----------- | ---------------------------------------------- |
| `pubKeys` | `bytes32[]` | Hex encoded Tendermint public keys to retrieve |
| Parameter | Type | Description |
| --------- | ----------- | ----------------------------------------------- |
| `pubKeys` | `bytes32[]` | Hex encoded Tendermint public keys to retrieve. |

#### Returns:

ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.