Skip to content

Commit 72a71b1

Browse files
authored
chore: formatting and comments (#39)
* build: use immutables * chore: add spech * chore: readme updates * fix: test amounts
1 parent 880ce7e commit 72a71b1

5 files changed

Lines changed: 260 additions & 45 deletions

File tree

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11

22
# Yearn Tokenized Strategy
33

4-
This repository contains the base code for the Yearn V3 tokenized strategy implementation. The V3 strategy implementation utilizes an immutable proxy pattern to allow anyome to easily create their own single strategy vaults that will all use the same logic held within the `TokenizedStrategy` for their redundant and high risk code. The implementation holds all ERC-20, ERC-4626, profit locking and reporting functionility to make any strategy that uses it a fully permisionless vault without holding any of this logic itself.
4+
This repository contains the base code for the Yearn V3 "Tokenized Strategy" implementation. The V3 strategy implementation utilizes an immutable proxy pattern to allow anyone to easily create their own single strategy 4626 vaults that will all use the same logic held within the `TokenizedStrategy` for their redundant and high risk code. The implementation holds all ERC-20, ERC-4626, profit locking and reporting functionality to make any strategy that uses it a fully permissionless vault without holding any of this logic itself.
55

66
NOTE: The implementation address that calls are delegated to is pre-set to a constant and can never be changed post deployment. The implementation contract itself is ownerless and can never be updated in any way.
77

@@ -11,7 +11,7 @@ A `Strategy` contract can become a fully ERC-4626 compliant vault by inheriting
1111

1212
[BaseTokenizedStrategy](https://github.com/yearn/tokenized-strategy/blob/master/src/BaseTokenizedStrategy.sol) - Abstract contract to inherit that communicates with the `TokenizedStrategy`.
1313

14-
Full tech spech can be found [here](https://hackmd.io/@D4Z1faeARKedWmEygMxDBA/H1WtpMTCs)
14+
Full tech spech can be found [here](https://github.com/yearn/tokenized-strategy/blob/master/SPECIFICATION.md)
1515

1616
## Installation and Setup
1717

@@ -28,7 +28,7 @@ git clone --recursive https://github.com/myuser/tokenized-strategy
2828
cd tokenized-strategy
2929
```
3030

31-
NOTE: if you create from template you may need to run the following command to fetch the git submodules (.gitmodules for exact releases) `git submodule init && git submodule update`
31+
NOTE: if you create from template you may need to run the following command to fetch the git sub modules (.gitmodules for exact releases) `git submodule init && git submodule update`
3232

3333
4. Build the project.
3434

0 commit comments

Comments
 (0)