Skip to content

2 - document that rebasing token share quantities must be equivalent to their wrapped quantities #47

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.

Sign up for GitHub

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

Open
mcclurejt wants to merge 2 commits into
base: main
Choose a base branch
from
Open

2 - document that rebasing token share quantities must be equivalent to their wrapped quantities #47

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
6c6e6a6
document that rebasing token share quantities must be equivalent to t…
mcclurejt Dec 19, 2024
040eb76
fix alignment
mcclurejt Dec 19, 2024
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
49 changes: 49 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,55 @@ source .env && \
forge script script/DeployEverlongStrategy.s.sol --rpc-url 0.0.0.0:8545 --broadcast
```

#### Options

##### `AS_BASE=<true>`

Specifies whether to use hyperdrive's base token or vault shares token when
transacting with hyperdrive.

| :warning: WARNING |
| :----------------------------------------------------------------- |
| When `IS_WRAPPED` is set, `AS_BASE` must be false (or left empty). |

##### `IS_WRAPPED=<true>`

Wrap the token used to transact with hyperdrive. If the hyperdrive vault shares
token is a rebasing token, `IS_WRAPPED` must be set to true since Yearn vaults
explicitly do not support rebasing tokens.

| :exclamation: IMPORTANT |
| :---------------------------------------------------------------------- |
| The address for the wrapped asset must be set via the `ASSET` parameter |

| :exclamation: IMPORTANT |
| :------------------------------------------------------------------------------------------------------------- |
| Only rebasing tokens whos "share" token quantities equal the wrapped token quantities can be used (EX: StETH). |
Copy link

@MrToph MrToph Dec 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

whose


##### `ASSET=<address>`

Set the address for the strategy asset. This should only be set when
`IS_WRAPPED=true`.

When `IS_WRAPPED=false`, the strategy asset is the hyperdrive's base token or
vault shares token depending on the value of `AS_BASE`.

##### `PROFIT_MAX_UNLOCK=<seconds>`

Period in seconds to unlock profit over for the strategy.

If deposits/redemptions to the strategy are limited to approved vaults, this
can be set to zero for faster yield accrual by the vaults.

If deposits/redemptions to the strategy are not permissioned, this should be set
to at least the yield accrual interval of hyperdrive (typically 1 day).
Comment on lines +125 to +126
Copy link

@MrToph MrToph Dec 21, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I thought in practice you'll always use a vault? Because, otherwise your assumptions that the strategy's idle is close to 0 does not hold, for example.


##### `KEEPER_CONTRACT_NAME=<string>`

Name of the keeper contract to use for tending and reporting.

By default, this is the most recently deployed keeper contract on the chain.

### Deploy a `Vault`

```sh
Expand Down
Loading