Skip to content

Commit

Permalink
docs: wow
Browse files Browse the repository at this point in the history
  • Loading branch information
boolafish committed Oct 1, 2019
1 parent 095647f commit 213273d
Show file tree
Hide file tree
Showing 113 changed files with 22,165 additions and 0 deletions.
147 changes: 147 additions & 0 deletions plasma_framework/docs/Address.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,147 @@
# Address.sol

View Source: [openzeppelin-solidity/contracts/utils/Address.sol](../openzeppelin-solidity/contracts/utils/Address.sol)

**Address**

Collection of functions related to the address type,

## Functions

- [isContract(address account)](#iscontract)

### isContract

Returns true if `account` is a contract.
* This test is non-exhaustive, and there may be false-negatives: during the
execution of a contract's constructor, its address will be reported as
not containing a contract.
* > It is unsafe to assume that an address for which this function returns
false is an externally-owned account (EOA) and not a contract.

```js
function isContract(address account) internal view
returns(bool)
```

**Arguments**

| Name | Type | Description |
| ------------- |------------- | -----|
| account | address | |

## Contracts

* [Address](Address.md)
* [AddressPayable](AddressPayable.md)
* [AddressPayableWrapper](AddressPayableWrapper.md)
* [Bits](Bits.md)
* [BitsWrapper](BitsWrapper.md)
* [BlockController](BlockController.md)
* [BlockModel](BlockModel.md)
* [BondSize](BondSize.md)
* [BondSizeMock](BondSizeMock.md)
* [DummyExitGame](DummyExitGame.md)
* [DummyVault](DummyVault.md)
* [ECDSA](ECDSA.md)
* [ERC20](ERC20.md)
* [Erc20DepositVerifier](Erc20DepositVerifier.md)
* [ERC20Mintable](ERC20Mintable.md)
* [Erc20Vault](Erc20Vault.md)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitableTimestampWrapper](ExitableTimestampWrapper.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitGameRegistryMock](ExitGameRegistryMock.md)
* [ExitId](ExitId.md)
* [ExitIdWrapper](ExitIdWrapper.md)
* [ExitPriority](ExitPriority.md)
* [ExitPriorityWrapper](ExitPriorityWrapper.md)
* [ExpectedOutputGuardHandler](ExpectedOutputGuardHandler.md)
* [IERC20](IERC20.md)
* [IErc20DepositVerifier](IErc20DepositVerifier.md)
* [IEthDepositVerifier](IEthDepositVerifier.md)
* [IExitProcessor](IExitProcessor.md)
* [Import](Import.md)
* [IOutputGuardHandler](IOutputGuardHandler.md)
* [IsDeposit](IsDeposit.md)
* [IsDepositWrapper](IsDepositWrapper.md)
* [ISpendingCondition](ISpendingCondition.md)
* [IStateTransitionVerifier](IStateTransitionVerifier.md)
* [Math](Math.md)
* [Merkle](Merkle.md)
* [MerkleWrapper](MerkleWrapper.md)
* [Migrations](Migrations.md)
* [MinterRole](MinterRole.md)
* [NonCompliantERC20](NonCompliantERC20.md)
* [OnlyFromAddress](OnlyFromAddress.md)
* [OnlyWithValue](OnlyWithValue.md)
* [OnlyWithValueMock](OnlyWithValueMock.md)
* [Operated](Operated.md)
* [OperatedMock](OperatedMock.md)
* [OutputGuard](OutputGuard.md)
* [OutputGuardHandlerRegistry](OutputGuardHandlerRegistry.md)
* [OutputGuardModel](OutputGuardModel.md)
* [OutputGuardWrapper](OutputGuardWrapper.md)
* [OutputId](OutputId.md)
* [OutputIdWrapper](OutputIdWrapper.md)
* [Ownable](Ownable.md)
* [PaymentChallengeIFEInputSpent](PaymentChallengeIFEInputSpent.md)
* [PaymentChallengeIFENotCanonical](PaymentChallengeIFENotCanonical.md)
* [PaymentChallengeIFEOutputSpent](PaymentChallengeIFEOutputSpent.md)
* [PaymentChallengeStandardExit](PaymentChallengeStandardExit.md)
* [PaymentEip712Lib](PaymentEip712Lib.md)
* [PaymentEip712LibMock](PaymentEip712LibMock.md)
* [PaymentExitDataModel](PaymentExitDataModel.md)
* [PaymentExitGame](PaymentExitGame.md)
* [PaymentInFlightExitModelUtils](PaymentInFlightExitModelUtils.md)
* [PaymentInFlightExitRouter](PaymentInFlightExitRouter.md)
* [PaymentInFlightExitRouterArgs](PaymentInFlightExitRouterArgs.md)
* [PaymentInFlightExitRouterMock](PaymentInFlightExitRouterMock.md)
* [PaymentOutputGuardHandler](PaymentOutputGuardHandler.md)
* [PaymentOutputModel](PaymentOutputModel.md)
* [PaymentOutputModelMock](PaymentOutputModelMock.md)
* [PaymentOutputToPaymentTxCondition](PaymentOutputToPaymentTxCondition.md)
* [PaymentPiggybackInFlightExit](PaymentPiggybackInFlightExit.md)
* [PaymentProcessInFlightExit](PaymentProcessInFlightExit.md)
* [PaymentProcessStandardExit](PaymentProcessStandardExit.md)
* [PaymentStandardExitRouter](PaymentStandardExitRouter.md)
* [PaymentStandardExitRouterArgs](PaymentStandardExitRouterArgs.md)
* [PaymentStandardExitRouterMock](PaymentStandardExitRouterMock.md)
* [PaymentStartInFlightExit](PaymentStartInFlightExit.md)
* [PaymentStartStandardExit](PaymentStartStandardExit.md)
* [PaymentTransactionModel](PaymentTransactionModel.md)
* [PaymentTransactionModelMock](PaymentTransactionModelMock.md)
* [PaymentTransactionStateTransitionVerifier](PaymentTransactionStateTransitionVerifier.md)
* [PlasmaFramework](PlasmaFramework.md)
* [PriorityQueue](PriorityQueue.md)
* [Protocol](Protocol.md)
* [ProtocolWrapper](ProtocolWrapper.md)
* [Quarantine](Quarantine.md)
* [QuarantineMock](QuarantineMock.md)
* [ReentrancyExitGame](ReentrancyExitGame.md)
* [RLP](RLP.md)
* [RLPMock](RLPMock.md)
* [Roles](Roles.md)
* [SafeERC20](SafeERC20.md)
* [SafeMath](SafeMath.md)
* [SpendingConditionMock](SpendingConditionMock.md)
* [SpendingConditionRegistry](SpendingConditionRegistry.md)
* [SpyErc20VaultForExitGame](SpyErc20VaultForExitGame.md)
* [SpyEthVaultForExitGame](SpyEthVaultForExitGame.md)
* [SpyPlasmaFrameworkForExitGame](SpyPlasmaFrameworkForExitGame.md)
* [StateTransitionVerifierMock](StateTransitionVerifierMock.md)
* [TxFinalization](TxFinalization.md)
* [TxFinalizationWrapper](TxFinalizationWrapper.md)
* [TxPosLib](TxPosLib.md)
* [TxPosLibWrapper](TxPosLibWrapper.md)
* [UtxoPosLib](UtxoPosLib.md)
* [UtxoPosLibWrapper](UtxoPosLibWrapper.md)
* [Vault](Vault.md)
* [VaultRegistry](VaultRegistry.md)
* [VaultRegistryMock](VaultRegistryMock.md)
* [WireTransaction](WireTransaction.md)
* [WireTransactionWrapper](WireTransactionWrapper.md)
* [ZeroHashesProvider](ZeroHashesProvider.md)
140 changes: 140 additions & 0 deletions plasma_framework/docs/AddressPayable.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,140 @@
# AddressPayable.sol

View Source: [contracts/src/utils/AddressPayable.sol](../contracts/src/utils/AddressPayable.sol)

**AddressPayable**

## Functions

- [convert(address account)](#convert)

### convert

Converts an `address` into `address payable`.

```js
function convert(address account) internal pure
returns(address payable)
```

**Arguments**

| Name | Type | Description |
| ------------- |------------- | -----|
| account | address | |

## Contracts

* [Address](Address.md)
* [AddressPayable](AddressPayable.md)
* [AddressPayableWrapper](AddressPayableWrapper.md)
* [Bits](Bits.md)
* [BitsWrapper](BitsWrapper.md)
* [BlockController](BlockController.md)
* [BlockModel](BlockModel.md)
* [BondSize](BondSize.md)
* [BondSizeMock](BondSizeMock.md)
* [DummyExitGame](DummyExitGame.md)
* [DummyVault](DummyVault.md)
* [ECDSA](ECDSA.md)
* [ERC20](ERC20.md)
* [Erc20DepositVerifier](Erc20DepositVerifier.md)
* [ERC20Mintable](ERC20Mintable.md)
* [Erc20Vault](Erc20Vault.md)
* [EthDepositVerifier](EthDepositVerifier.md)
* [EthVault](EthVault.md)
* [ExitableTimestamp](ExitableTimestamp.md)
* [ExitableTimestampWrapper](ExitableTimestampWrapper.md)
* [ExitGameController](ExitGameController.md)
* [ExitGameRegistry](ExitGameRegistry.md)
* [ExitGameRegistryMock](ExitGameRegistryMock.md)
* [ExitId](ExitId.md)
* [ExitIdWrapper](ExitIdWrapper.md)
* [ExitPriority](ExitPriority.md)
* [ExitPriorityWrapper](ExitPriorityWrapper.md)
* [ExpectedOutputGuardHandler](ExpectedOutputGuardHandler.md)
* [IERC20](IERC20.md)
* [IErc20DepositVerifier](IErc20DepositVerifier.md)
* [IEthDepositVerifier](IEthDepositVerifier.md)
* [IExitProcessor](IExitProcessor.md)
* [Import](Import.md)
* [IOutputGuardHandler](IOutputGuardHandler.md)
* [IsDeposit](IsDeposit.md)
* [IsDepositWrapper](IsDepositWrapper.md)
* [ISpendingCondition](ISpendingCondition.md)
* [IStateTransitionVerifier](IStateTransitionVerifier.md)
* [Math](Math.md)
* [Merkle](Merkle.md)
* [MerkleWrapper](MerkleWrapper.md)
* [Migrations](Migrations.md)
* [MinterRole](MinterRole.md)
* [NonCompliantERC20](NonCompliantERC20.md)
* [OnlyFromAddress](OnlyFromAddress.md)
* [OnlyWithValue](OnlyWithValue.md)
* [OnlyWithValueMock](OnlyWithValueMock.md)
* [Operated](Operated.md)
* [OperatedMock](OperatedMock.md)
* [OutputGuard](OutputGuard.md)
* [OutputGuardHandlerRegistry](OutputGuardHandlerRegistry.md)
* [OutputGuardModel](OutputGuardModel.md)
* [OutputGuardWrapper](OutputGuardWrapper.md)
* [OutputId](OutputId.md)
* [OutputIdWrapper](OutputIdWrapper.md)
* [Ownable](Ownable.md)
* [PaymentChallengeIFEInputSpent](PaymentChallengeIFEInputSpent.md)
* [PaymentChallengeIFENotCanonical](PaymentChallengeIFENotCanonical.md)
* [PaymentChallengeIFEOutputSpent](PaymentChallengeIFEOutputSpent.md)
* [PaymentChallengeStandardExit](PaymentChallengeStandardExit.md)
* [PaymentEip712Lib](PaymentEip712Lib.md)
* [PaymentEip712LibMock](PaymentEip712LibMock.md)
* [PaymentExitDataModel](PaymentExitDataModel.md)
* [PaymentExitGame](PaymentExitGame.md)
* [PaymentInFlightExitModelUtils](PaymentInFlightExitModelUtils.md)
* [PaymentInFlightExitRouter](PaymentInFlightExitRouter.md)
* [PaymentInFlightExitRouterArgs](PaymentInFlightExitRouterArgs.md)
* [PaymentInFlightExitRouterMock](PaymentInFlightExitRouterMock.md)
* [PaymentOutputGuardHandler](PaymentOutputGuardHandler.md)
* [PaymentOutputModel](PaymentOutputModel.md)
* [PaymentOutputModelMock](PaymentOutputModelMock.md)
* [PaymentOutputToPaymentTxCondition](PaymentOutputToPaymentTxCondition.md)
* [PaymentPiggybackInFlightExit](PaymentPiggybackInFlightExit.md)
* [PaymentProcessInFlightExit](PaymentProcessInFlightExit.md)
* [PaymentProcessStandardExit](PaymentProcessStandardExit.md)
* [PaymentStandardExitRouter](PaymentStandardExitRouter.md)
* [PaymentStandardExitRouterArgs](PaymentStandardExitRouterArgs.md)
* [PaymentStandardExitRouterMock](PaymentStandardExitRouterMock.md)
* [PaymentStartInFlightExit](PaymentStartInFlightExit.md)
* [PaymentStartStandardExit](PaymentStartStandardExit.md)
* [PaymentTransactionModel](PaymentTransactionModel.md)
* [PaymentTransactionModelMock](PaymentTransactionModelMock.md)
* [PaymentTransactionStateTransitionVerifier](PaymentTransactionStateTransitionVerifier.md)
* [PlasmaFramework](PlasmaFramework.md)
* [PriorityQueue](PriorityQueue.md)
* [Protocol](Protocol.md)
* [ProtocolWrapper](ProtocolWrapper.md)
* [Quarantine](Quarantine.md)
* [QuarantineMock](QuarantineMock.md)
* [ReentrancyExitGame](ReentrancyExitGame.md)
* [RLP](RLP.md)
* [RLPMock](RLPMock.md)
* [Roles](Roles.md)
* [SafeERC20](SafeERC20.md)
* [SafeMath](SafeMath.md)
* [SpendingConditionMock](SpendingConditionMock.md)
* [SpendingConditionRegistry](SpendingConditionRegistry.md)
* [SpyErc20VaultForExitGame](SpyErc20VaultForExitGame.md)
* [SpyEthVaultForExitGame](SpyEthVaultForExitGame.md)
* [SpyPlasmaFrameworkForExitGame](SpyPlasmaFrameworkForExitGame.md)
* [StateTransitionVerifierMock](StateTransitionVerifierMock.md)
* [TxFinalization](TxFinalization.md)
* [TxFinalizationWrapper](TxFinalizationWrapper.md)
* [TxPosLib](TxPosLib.md)
* [TxPosLibWrapper](TxPosLibWrapper.md)
* [UtxoPosLib](UtxoPosLib.md)
* [UtxoPosLibWrapper](UtxoPosLibWrapper.md)
* [Vault](Vault.md)
* [VaultRegistry](VaultRegistry.md)
* [VaultRegistryMock](VaultRegistryMock.md)
* [WireTransaction](WireTransaction.md)
* [WireTransactionWrapper](WireTransactionWrapper.md)
* [ZeroHashesProvider](ZeroHashesProvider.md)

0 comments on commit 213273d

Please sign in to comment.