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

Update docs to break out per file #134

Merged
merged 1 commit into from
Dec 8, 2022
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Update docs to break out per file
venables committed Dec 7, 2022

Unverified

This user has not yet uploaded their public signing key.
commit 475a4f6e61abc839b66b5dce208b2c781cce4dbe
6 changes: 5 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -20,6 +20,10 @@ npx hardhat run scripts/deploy.ts
Documentation is generated by [solidity-docgen](https://github.com/OpenZeppelin/solidity-docgen)

```sh
npm run docs

# or

npx hardhat docgen
```

@@ -73,5 +77,5 @@ npx hardhat setPaused --help
Here is an example command to pause a hypothetical contract:

```sh
npx hardhat setPaused --address 0x5FbDB2315678afecb367f032d93F642f64180aa3 --paused true
npx hardhat setPaused --address 0x5FbDB2315678afecb367f032d93F642f64180aa3 --paused true
```
36 changes: 36 additions & 0 deletions docs/CollateralVault.md
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
```

30 changes: 30 additions & 0 deletions docs/FeeVault.md
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._

55 changes: 55 additions & 0 deletions docs/FirstLossVault.md
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._

47 changes: 47 additions & 0 deletions docs/FundingVault.md
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._

Loading