Skip to content

Commit

Permalink
v1.0.4
Browse files Browse the repository at this point in the history
  • Loading branch information
cag committed May 7, 2018
1 parent 0b56441 commit bd9079a
Show file tree
Hide file tree
Showing 34 changed files with 1,654 additions and 1,637 deletions.
54 changes: 27 additions & 27 deletions docs/source/Campaign.rst
Original file line number Diff line number Diff line change
@@ -1,40 +1,40 @@
Campaign
========

- `Campaign <#campaign>`__

- `Accessors <#accessors>`__
- `Events <#events>`__
- `Accessors <#campaign-accessors>`__
- `Events <#campaign-events>`__

- `CampaignFunding <#campaignfunding-address-indexed-sender-uint256-funding>`__\ (*address*
indexed ``sender``, *uint256* ``funding``)
- `CampaignRefund <#campaignrefund-address-indexed-sender-uint256-refund>`__\ (*address*
indexed ``sender``, *uint256* ``refund``)
- `MarketCreation <#marketcreation-address-indexed-market>`__\ (*address*
indexed ``market``)
- `MarketClosing <#marketclosing>`__\ ()
- `FeeWithdrawal <#feewithdrawal-address-indexed-receiver-uint256-fees>`__\ (*address*
indexed ``receiver``, *uint256* ``fees``)
- `CampaignFunding(\ *address* indexed ``sender``, *uint256*
``funding``) <#campaignfundingaddress-indexed-sender-uint256-funding>`__
- `CampaignRefund(\ *address* indexed ``sender``, *uint256*
``refund``) <#campaignrefundaddress-indexed-sender-uint256-refund>`__
- `MarketCreation(\ *address* indexed
``market``) <#marketcreationaddress-indexed-market>`__
- `MarketClosing() <#marketclosing>`__
- `FeeWithdrawal(\ *address* indexed ``receiver``, *uint256*
``fees``) <#feewithdrawaladdress-indexed-receiver-uint256-fees>`__

- `Functions <#functions>`__
- `Functions <#campaign-functions>`__

- `withdrawFees <#withdrawfees>`__\ ()
- `refund <#refund>`__\ ()
- `createMarket <#createmarket>`__\ ()
- `closeMarket <#closemarket>`__\ ()
- `fund <#fund-uint256-amount>`__\ (*uint256* ``amount``)
- `withdrawFees() <#withdrawfees>`__
- `refund() <#refund>`__
- `createMarket() <#createmarket>`__
- `closeMarket() <#closemarket>`__
- `fund(\ *uint256* ``amount``) <#funduint256-amount>`__

Campaign
========

Campaign contract - Allows to crowdfund a market
------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- **Author**: Stefan George - stefan@gnosis.pm
- **Constructor**: Campaign(\ *address* ``_eventContract``, *address*
``_marketFactory``, *address* ``_marketMaker``, *uint24* ``_fee``,
*uint256* ``_funding``, *uint256* ``_deadline``)
- This contract does **not** have a fallback function.

Accessors
---------
Campaign Accessors
------------------

- *address* marketFactory() ``06ae7095``
- *address* marketMaker() ``1f21f9af``
Expand All @@ -48,8 +48,8 @@ Accessors
- *address* eventContract() ``e274fd24``
- *uint24* FEE_RANGE() ``fbde47f6``

Events
------
Campaign Events
---------------

CampaignFunding(\ *address* indexed ``sender``, *uint256* ``funding``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -81,8 +81,8 @@ FeeWithdrawal(\ *address* indexed ``receiver``, *uint256* ``fees``)
**Signature hash**:
``ee33a3a9cb48e4ff209f8b1c67c4632f1dbbf55aeff8e6f17d957ade7a6fb17c``

Functions
---------
Campaign Functions
------------------

withdrawFees()
~~~~~~~~~~~~~~
Expand Down
38 changes: 19 additions & 19 deletions docs/source/CampaignFactory.rst
Original file line number Diff line number Diff line change
@@ -1,41 +1,41 @@
CampaignFactory
===============

- `CampaignFactory <#campaignfactory>`__

- `Events <#events>`__
- `Events <#campaignfactory-events>`__

- `CampaignCreation <#campaigncreation-address-indexed-creator-address-campaign-address-eventcontract-address-marketfactory-address-marketmaker-uint24-fee-uint256-funding-uint256-deadline>`__\ (*address*
indexed ``creator``, *address* ``campaign``, *address*
``eventContract``, *address* ``marketFactory``, *address*
``marketMaker``, *uint24* ``fee``, *uint256* ``funding``,
*uint256* ``deadline``)
- `CampaignCreation(\ *address* indexed ``creator``, *address*
``campaign``, *address* ``eventContract``, *address*
``marketFactory``, *address* ``marketMaker``, *uint24* ``fee``,
*uint256* ``funding``, *uint256*
``deadline``) <#campaigncreationaddress-indexed-creator-address-campaign-address-eventcontract-address-marketfactory-address-marketmaker-uint24-fee-uint256-funding-uint256-deadline>`__

- `Functions <#functions>`__
- `Functions <#campaignfactory-functions>`__

- `createCampaign <#createcampaign-address-eventcontract-address-marketfactory-address-marketmaker-uint24-fee-uint256-funding-uint256-deadline>`__\ (*address*
``eventContract``, *address* ``marketFactory``, *address*
``marketMaker``, *uint24* ``fee``, *uint256* ``funding``,
*uint256* ``deadline``)
- `createCampaign(\ *address* ``eventContract``, *address*
``marketFactory``, *address* ``marketMaker``, *uint24* ``fee``,
*uint256* ``funding``, *uint256*
``deadline``) <#createcampaignaddress-eventcontract-address-marketfactory-address-marketmaker-uint24-fee-uint256-funding-uint256-deadline>`__

CampaignFactory
===============

Campaign factory contract - Allows to create campaign contracts
---------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- **Author**: Stefan George - stefan@gnosis.pm
- **Constructor**: CampaignFactory()
- This contract does **not** have a fallback function.

Events
------
CampaignFactory Events
----------------------

CampaignCreation(\ *address* indexed ``creator``, *address* ``campaign``, *address* ``eventContract``, *address* ``marketFactory``, *address* ``marketMaker``, *uint24* ``fee``, *uint256* ``funding``, *uint256* ``deadline``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**Signature hash**:
``7a9fd19b658538a67209802dd9011d6e3ce04586fe93c87096d2bc40ed850866``

Functions
---------
CampaignFactory Functions
-------------------------

createCampaign(\ *address* ``eventContract``, *address* ``marketFactory``, *address* ``marketMaker``, *uint24* ``fee``, *uint256* ``funding``, *uint256* ``deadline``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
76 changes: 39 additions & 37 deletions docs/source/CategoricalEvent.rst
Original file line number Diff line number Diff line change
@@ -1,55 +1,57 @@
CategoricalEvent
================

- `CategoricalEvent <#categoricalevent>`__

- `Accessors <#accessors>`__
- `Events <#events>`__

- `OutcomeTokenCreation <#outcometokencreation-address-outcometoken-uint8-index>`__\ (*address*
``outcomeToken``, *uint8* ``index``)
- `OutcomeTokenSetIssuance <#outcometokensetissuance-address-indexed-buyer-uint256-collateraltokencount>`__\ (*address*
indexed ``buyer``, *uint256* ``collateralTokenCount``)
- `OutcomeTokenSetRevocation <#outcometokensetrevocation-address-indexed-seller-uint256-outcometokencount>`__\ (*address*
indexed ``seller``, *uint256* ``outcomeTokenCount``)
- `OutcomeAssignment <#outcomeassignment-int256-outcome>`__\ (*int256*
``outcome``)
- `WinningsRedemption <#winningsredemption-address-indexed-receiver-uint256-winnings>`__\ (*address*
indexed ``receiver``, *uint256* ``winnings``)

- `Functions <#functions>`__

- `setOutcome <#setoutcome>`__\ ()
- `buyAllOutcomes <#buyalloutcomes-uint256-collateraltokencount>`__\ (*uint256*
``collateralTokenCount``)
- `getOutcomeTokenDistribution <#getoutcometokendistribution-address-owner>`__\ (*address*
``owner``)
- `sellAllOutcomes <#sellalloutcomes-uint256-outcometokencount>`__\ (*uint256*
``outcomeTokenCount``)
- `getOutcomeCount <#getoutcomecount>`__\ ()
- `redeemWinnings <#redeemwinnings>`__\ ()
- `getEventHash <#geteventhash>`__\ ()
- `getOutcomeTokens <#getoutcometokens>`__\ ()
- `Accessors <#categoricalevent-accessors>`__
- `Events <#categoricalevent-events>`__

- `OutcomeTokenCreation(\ *address* ``outcomeToken``, *uint8*
``index``) <#outcometokencreationaddress-outcometoken-uint8-index>`__
- `OutcomeTokenSetIssuance(\ *address* indexed ``buyer``,
*uint256*
``collateralTokenCount``) <#outcometokensetissuanceaddress-indexed-buyer-uint256-collateraltokencount>`__
- `OutcomeTokenSetRevocation(\ *address* indexed ``seller``,
*uint256*
``outcomeTokenCount``) <#outcometokensetrevocationaddress-indexed-seller-uint256-outcometokencount>`__
- `OutcomeAssignment(\ *int256*
``outcome``) <#outcomeassignmentint256-outcome>`__
- `WinningsRedemption(\ *address* indexed ``receiver``, *uint256*
``winnings``) <#winningsredemptionaddress-indexed-receiver-uint256-winnings>`__

- `Functions <#categoricalevent-functions>`__

- `setOutcome() <#setoutcome>`__
- `buyAllOutcomes(\ *uint256*
``collateralTokenCount``) <#buyalloutcomesuint256-collateraltokencount>`__
- `getOutcomeTokenDistribution(\ *address*
``owner``) <#getoutcometokendistributionaddress-owner>`__
- `sellAllOutcomes(\ *uint256*
``outcomeTokenCount``) <#sellalloutcomesuint256-outcometokencount>`__
- `getOutcomeCount() <#getoutcomecount>`__
- `redeemWinnings() <#redeemwinnings>`__
- `getEventHash() <#geteventhash>`__
- `getOutcomeTokens() <#getoutcometokens>`__

CategoricalEvent
================

Categorical event contract - Categorical events resolve to an outcome from a set of outcomes
--------------------------------------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- **Author**: Stefan George - stefan@gnosis.pm
- **Constructor**: CategoricalEvent(\ *address* ``_collateralToken``,
*address* ``_oracle``, *uint8* ``outcomeCount``)
- This contract does **not** have a fallback function.

Accessors
---------
CategoricalEvent Accessors
--------------------------

- *int256* outcome() ``27793f87``
- *address* oracle() ``7dc0d1d0``
- *address* outcomeTokens(\ *uint256*) ``8abe59ea``
- *address* collateralToken() ``b2016bd4``
- *bool* isOutcomeSet() ``ccdf68f3``

Events
------
CategoricalEvent Events
-----------------------

OutcomeTokenCreation(\ *address* ``outcomeToken``, *uint8* ``index``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -81,8 +83,8 @@ WinningsRedemption(\ *address* indexed ``receiver``, *uint256* ``winnings``)
**Signature hash**:
``2fe921bb50a459800ae7eae7c0124e9e875094a539eb7dc5b3f728017347e0fb``

Functions
---------
CategoricalEvent Functions
--------------------------

setOutcome()
~~~~~~~~~~~~
Expand Down
46 changes: 23 additions & 23 deletions docs/source/CentralizedOracle.rst
Original file line number Diff line number Diff line change
@@ -1,43 +1,43 @@
CentralizedOracle
=================

- `CentralizedOracle <#centralizedoracle>`__

- `Accessors <#accessors>`__
- `Events <#events>`__
- `Accessors <#centralizedoracle-accessors>`__
- `Events <#centralizedoracle-events>`__

- `OwnerReplacement <#ownerreplacement-address-indexed-newowner>`__\ (*address*
indexed ``newOwner``)
- `OutcomeAssignment <#outcomeassignment-int256-outcome>`__\ (*int256*
``outcome``)
- `OwnerReplacement(\ *address* indexed
``newOwner``) <#ownerreplacementaddress-indexed-newowner>`__
- `OutcomeAssignment(\ *int256*
``outcome``) <#outcomeassignmentint256-outcome>`__

- `Functions <#functions>`__
- `Functions <#centralizedoracle-functions>`__

- `setOutcome <#setoutcome-int256-_outcome>`__\ (*int256*
``_outcome``)
- `getOutcome <#getoutcome>`__\ ()
- `replaceOwner <#replaceowner-address-newowner>`__\ (*address*
``newOwner``)
- `isOutcomeSet <#isoutcomeset>`__\ ()
- `setOutcome(\ *int256*
``_outcome``) <#setoutcomeint256-_outcome>`__
- `getOutcome() <#getoutcome>`__
- `replaceOwner(\ *address*
``newOwner``) <#replaceowneraddress-newowner>`__
- `isOutcomeSet() <#isoutcomeset>`__

CentralizedOracle
=================

Centralized oracle contract - Allows the contract owner to set an outcome
-------------------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- **Author**: Stefan George - stefan@gnosis.pm
- **Constructor**: CentralizedOracle(\ *address* ``_owner``, *bytes*
``_ipfsHash``)
- This contract does **not** have a fallback function.

Accessors
---------
CentralizedOracle Accessors
---------------------------

- *int256* outcome() ``27793f87``
- *address* owner() ``8da5cb5b``
- *bytes* ipfsHash() ``c623674f``
- *bool* isSet() ``c65fb380``

Events
------
CentralizedOracle Events
------------------------

OwnerReplacement(\ *address* indexed ``newOwner``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand All @@ -51,8 +51,8 @@ OutcomeAssignment(\ *int256* ``outcome``)
**Signature hash**:
``b1aaa9f4484acc283375c8e495a44766e4026170797dc9280b4ae2ab5632fb71``

Functions
---------
CentralizedOracle Functions
---------------------------

setOutcome(\ *int256* ``_outcome``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
30 changes: 15 additions & 15 deletions docs/source/CentralizedOracleFactory.rst
Original file line number Diff line number Diff line change
@@ -1,37 +1,37 @@
CentralizedOracleFactory
========================

- `CentralizedOracleFactory <#centralizedoraclefactory>`__

- `Events <#events>`__
- `Events <#centralizedoraclefactory-events>`__

- `CentralizedOracleCreation <#centralizedoraclecreation-address-indexed-creator-address-centralizedoracle-bytes-ipfshash>`__\ (*address*
indexed ``creator``, *address* ``centralizedOracle``, *bytes*
``ipfsHash``)
- `CentralizedOracleCreation(\ *address* indexed ``creator``,
*address* ``centralizedOracle``, *bytes*
``ipfsHash``) <#centralizedoraclecreationaddress-indexed-creator-address-centralizedoracle-bytes-ipfshash>`__

- `Functions <#functions>`__
- `Functions <#centralizedoraclefactory-functions>`__

- `createCentralizedOracle <#createcentralizedoracle-bytes-ipfshash>`__\ (*bytes*
``ipfsHash``)
- `createCentralizedOracle(\ *bytes*
``ipfsHash``) <#createcentralizedoraclebytes-ipfshash>`__

CentralizedOracleFactory
========================

Centralized oracle factory contract - Allows to create centralized oracle contracts
-----------------------------------------------------------------------------------
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

- **Author**: Stefan George - stefan@gnosis.pm
- **Constructor**: CentralizedOracleFactory()
- This contract does **not** have a fallback function.

Events
------
CentralizedOracleFactory Events
-------------------------------

CentralizedOracleCreation(\ *address* indexed ``creator``, *address* ``centralizedOracle``, *bytes* ``ipfsHash``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

**Signature hash**:
``33a1926cf5c2f7306ac1685bf19260d678fea874f5f59c00b69fa5e2643ecfd2``

Functions
---------
CentralizedOracleFactory Functions
----------------------------------

createCentralizedOracle(\ *bytes* ``ipfsHash``)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down
Loading

0 comments on commit bd9079a

Please sign in to comment.