-
Notifications
You must be signed in to change notification settings - Fork 19
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Update docs to break out per file (#134)
- Loading branch information
Showing
44 changed files
with
4,147 additions
and
5,198 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,36 @@ | ||
# Solidity API | ||
|
||
## CollateralVault | ||
|
||
### _loan | ||
|
||
```solidity | ||
address _loan | ||
``` | ||
|
||
### onlyLoan | ||
|
||
```solidity | ||
modifier onlyLoan() | ||
``` | ||
|
||
### constructor | ||
|
||
```solidity | ||
constructor(address loan) public | ||
``` | ||
|
||
### withdraw | ||
|
||
```solidity | ||
function withdraw(address asset, uint256 amount, address receiver) external | ||
``` | ||
|
||
_Allows withdrawal of funds held by vault._ | ||
|
||
### withdrawERC721 | ||
|
||
```solidity | ||
function withdrawERC721(address asset, uint256 tokenId, address receiver) external | ||
``` | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,30 @@ | ||
# Solidity API | ||
|
||
## FeeVault | ||
|
||
### pool | ||
|
||
```solidity | ||
address pool | ||
``` | ||
|
||
### onlyPoolAdmin | ||
|
||
```solidity | ||
modifier onlyPoolAdmin() | ||
``` | ||
|
||
### constructor | ||
|
||
```solidity | ||
constructor(address pool_) public | ||
``` | ||
|
||
### withdraw | ||
|
||
```solidity | ||
function withdraw(address asset, uint256 amount) external | ||
``` | ||
|
||
_Allows withdrawal of fees held by vault._ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,55 @@ | ||
# Solidity API | ||
|
||
## FirstLossVault | ||
|
||
### poolController | ||
|
||
```solidity | ||
address poolController | ||
``` | ||
|
||
### _asset | ||
|
||
```solidity | ||
contract IERC20 _asset | ||
``` | ||
|
||
### onlyPoolController | ||
|
||
```solidity | ||
modifier onlyPoolController() | ||
``` | ||
|
||
_Modifier restricting access to pool_ | ||
|
||
### constructor | ||
|
||
```solidity | ||
constructor(address _poolController, address firstLossAsset) public | ||
``` | ||
|
||
_Constructor for the vault_ | ||
|
||
#### Parameters | ||
|
||
| Name | Type | Description | | ||
| ---- | ---- | ----------- | | ||
| _poolController | address | address of pool controller | | ||
| firstLossAsset | address | asset held by vault | | ||
|
||
### asset | ||
|
||
```solidity | ||
function asset() external view returns (address) | ||
``` | ||
|
||
_Returns the asset held by the vault._ | ||
|
||
### withdraw | ||
|
||
```solidity | ||
function withdraw(uint256 amount, address receiver) external | ||
``` | ||
|
||
_Allows withdrawal of funds held by vault._ | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
# Solidity API | ||
|
||
## FundingVault | ||
|
||
### _loan | ||
|
||
```solidity | ||
address _loan | ||
``` | ||
|
||
### asset | ||
|
||
```solidity | ||
contract IERC20 asset | ||
``` | ||
|
||
### onlyLoan | ||
|
||
```solidity | ||
modifier onlyLoan() | ||
``` | ||
|
||
_Modifier restricting access to pool_ | ||
|
||
### constructor | ||
|
||
```solidity | ||
constructor(address loan, address asset_) public | ||
``` | ||
|
||
_Constructor for the vault_ | ||
|
||
#### Parameters | ||
|
||
| Name | Type | Description | | ||
| ---- | ---- | ----------- | | ||
| loan | address | address of loan | | ||
| asset_ | address | asset held by vault | | ||
|
||
### withdraw | ||
|
||
```solidity | ||
function withdraw(uint256 amount, address receiver) external | ||
``` | ||
|
||
_Allows withdrawal of funds held by vault._ | ||
|
Oops, something went wrong.