Router

​

Variables

​

conditionalTokens

contract IConditionalTokens conditionalTokens

​

wrapped1155Factory

contract IWrapped1155Factory wrapped1155Factory

​

Functions

​

constructor

constructor(contract IConditionalTokens _conditionalTokens, contract IWrapped1155Factory _wrapped1155Factory) public

​

splitPosition

function splitPosition(contract IERC20 collateralToken, contract Market market, uint256 amount) public

1. The ERC20 associated to each outcome must be previously created on the wrapped1155Factory.
2. The caller must have <amount> collateral tokens or ERC20 parent outcome tokens (in the case market.parentCollectionId is not null).

1. Transfer <amount> collateral from the user to Router.
2. Call conditionalTokens.splitPosition to transfer <amount> collateral from Router to ConditionalTokens, while minting corresponding ERC1155 outcome tokens to Router.

1. Unwrap ERC20 parent outcome tokens back to ERC1155 tokens.
2. Call conditionalTokens.splitPosition to transfer ERC1155 parent outcome tokens from Router to ConditionalTokens, burning them while minting corresponding conditional outcome tokens to Router.

3. Transfer ERC1155 outcome tokens from Router to Wrapped1155Factory contract. There is a callback function in Wrapped1155Factory that will wrap the tokens into ERC20 tokens, then transfer the wrapped tokens back to the original user.

​

_splitPosition

function _splitPosition(contract IERC20 collateralToken, contract Market market, uint256 amount) internal

​

mergePositions

function mergePositions(contract IERC20 collateralToken, contract Market market, uint256 amount) public

1. The ERC20 associated to each outcome must be previously created on the wrapped1155Factory.
2. The caller must have <amount> ERC20 tokens of all the outcomes of a market. For example, to call mergePositions of a market with 3 outcomes: Yes, No, Invalid, the caller must have <amount> tokens for each outcome.

1. Unwraps ERC20 outcome tokens (which will burn these tokens and transfer corresponding ERC1155 outcome tokens back to the Router contract).
2. Call conditionalTokens.mergePositions to burn ERC1155 outcome tokens. Then:

3. Return collateral to Router , which will then be sent to the user.

3. conditionalTokens will mint ERC1155 parent outcome tokens and send to Router. Router will wrap these tokens to ERC20 and send to the user.

​

_mergePositions

function _mergePositions(contract IERC20 collateralToken, contract Market market, uint256 amount) internal

​

redeemPositions

function redeemPositions(contract IERC20 collateralToken, contract Market market, uint256[] outcomeIndexes, uint256[] amounts) public

1. The ERC20 associated to each outcome must be previously created on the wrapped1155Factory.
2. The caller must have ERC20 tokens of the outcomes they want to redeem. For example, to call redeemPositions for outcome Yes of a market with 3 outcomes: Yes, No, Invalid, the caller must have Yes tokens. (The call will still be processed even if the caller does not have tokens, but it will have no effect).
3. conditionalTokens.reportPayouts has been called by an oracle.

1. Unwraps ERC20 outcome tokens (which will burn these tokens and transfer corresponding ERC1155 outcome tokens back to the Router contract).
2. Call conditionalTokens.redeemPositions to burn ERC1155 outcome tokens. Then:

3. Return collateral to Router . The return amount is in proportion to the ConditionalTokens payouts. Router will calculate the collateral difference before and after redeeming and transfer the difference to the user.

3. conditionalTokens will mint ERC1155 parent outcome tokens and send to Router. The amount is in proportion to the ConditionalTokens payouts. Router will calculate the ERC1155 outcome tokens difference before and after redeeming, wrap the difference to ERC20 and send to the user.

​

_redeemPositions

function _redeemPositions(contract IERC20 collateralToken, contract Market market, uint256[] outcomeIndexes, uint256[] amounts) internal

​

getPartition

function getPartition(uint256 size) internal pure returns (uint256[])

​

getTokenId

function getTokenId(contract IERC20 collateralToken, bytes32 parentCollectionId, bytes32 conditionId, uint256 indexSet) public view returns (uint256)

​

getWinningOutcomes

function getWinningOutcomes(bytes32 conditionId) external view returns (bool[])