Skip to content

Commit

Permalink
rename: CVC -> EVC
Browse files Browse the repository at this point in the history
  • Loading branch information
kasperpawlowski committed Nov 8, 2023
1 parent b352d65 commit 2f47e9f
Show file tree
Hide file tree
Showing 39 changed files with 2,043 additions and 2,032 deletions.
4 changes: 2 additions & 2 deletions .fuzz.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,10 +9,10 @@ fuzz:
quick_check: False
build_directory: out
sources_directory: src
project: "CVC"
project: "EVC"
rpc_url: http://127.0.0.1:8545
deployed_contract_address: "0x5fbdb2315678afecb367f032d93f642f64180aa3"
number_of_cores: 32
time_limit: 1hour
targets:
- "test/cvc/CreditVaultConnectorScribble.sol"
- "test/evc/EthereumVaultConnectorScribble.sol"
30 changes: 15 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Credit Vault Connector
# Ethereum Vault Connector

The Credit Vault Connector (CVC) is an attempt to distill the core functionality required for a lending market into a foundational layer that can be used as a base building block for many diverse protocols. The CVC is primarily a mediator between Credit Vaults, which are contracts that implement the ERC-4626 interface and contain a small amount of additional logic for interfacing with other vaults.
The Ethereum Vault Connector (EVC) is an attempt to distill the core functionality required for a lending market into a foundational layer that can be used as a base building block for many diverse protocols. The EVC is primarily a mediator between Vaults, which are contracts that implement the ERC-4626 interface and contain a small amount of additional logic for interfacing with other vaults.

For more information refer to the [WHITEPAPER](docs/whitepaper.md) and the [SPECS](docs/specs.md).

Expand All @@ -11,28 +11,28 @@ For more information refer to the [WHITEPAPER](docs/whitepaper.md) and the [SPEC
```
.
├── interfaces
│ ├── ICreditVault.sol
│ ├── ICreditVaultConnector.sol
│ ├── IVault.sol
│ ├── IEthereumVaultConnector.sol
│ └── IERC1271.sol
├── CreditVaultConnector.sol
├── EthereumVaultConnector.sol
├── ExecutionContext.sol
├── Set.sol
└── TransientStorage.sol
```

## Install

To install Credit Vault Connector in a [**Foundry**](https://github.com/foundry-rs/foundry) project:
To install Ethereum Vault Connector in a [**Foundry**](https://github.com/foundry-rs/foundry) project:

```sh
forge install euler-xyz/euler-cvc
forge install euler-xyz/euler-evc
```

## Usage

The Credit Vault Connector comes with a comprehensive set of tests written in Solidity, which can be executed using Foundry.
The Ethereum Vault Connector comes with a comprehensive set of tests written in Solidity, which can be executed using Foundry.

For a detailed understanding of the Credit Vault Connector and considerations for its integration, please refer to the [WHITEPAPER](docs/whitepaper.md) and the [SPECS](docs/specs.md). You can find examples of vaults utilizing the Credit Vault Connector in the [CVC Playground](https://github.com/euler-xyz/euler-cvc-playground/tree/master/src) repository. However, these example vaults are not meant for production use as they have not been audited and are intended solely for testing and experimentation purposes.
For a detailed understanding of the Ethereum Vault Connector and considerations for its integration, please refer to the [WHITEPAPER](docs/whitepaper.md) and the [SPECS](docs/specs.md). You can find examples of vaults utilizing the Ethereum Vault Connector in the [EVC Playground](https://github.com/euler-xyz/euler-evc-playground/tree/master/src) repository. However, these example vaults are not meant for production use as they have not been audited and are intended solely for testing and experimentation purposes.

To install Foundry:

Expand All @@ -49,7 +49,7 @@ foundryup
To clone the repo and install dependencies:

```sh
git clone https://github.com/euler-xyz/euler-cvc.git && cd euler-cvc && yarn
git clone https://github.com/euler-xyz/euler-evc.git && cd euler-evc && yarn
```

## Testing
Expand All @@ -73,13 +73,13 @@ npm install -g eth-scribble
To instrument the contracts and run the tests:

```sh
scribble test/cvc/CreditVaultConnectorScribble.sol --output-mode files --arm && forge test
scribble test/evc/EthereumVaultConnectorScribble.sol --output-mode files --arm && forge test
```

To remove instrumentation:

```sh
scribble test/cvc/CreditVaultConnectorScribble.sol --disarm
scribble test/evc/EthereumVaultConnectorScribble.sol --disarm
```

### in `coverage` mode
Expand All @@ -94,17 +94,17 @@ This software is **experimental** and is provided "as is" and "as available".

**No warranties are provided** and **no liability will be accepted for any loss** incurred through the use of this codebase.

Always include thorough tests when using the Credit Vault Connector to ensure it interacts correctly with your code.
Always include thorough tests when using the Ethereum Vault Connector to ensure it interacts correctly with your code.

The Credit Vault Connector **has not yet undergone an audit** and should not be used in production.
The Ethereum Vault Connector **has not yet undergone an audit** and should not be used in production.

## Known limitations

Refer to the [WHITEPAPER](docs/whitepaper.md#security-considerations) for a list of known limitations and security considerations.

## Contributing

The code is currently in an experimental phase leading up to the first audit. Feedback or ideas for improving the Credit Vault Connector are appreciated. Contributions are welcome from anyone interested in conducting security research, writing more tests including formal verification, improving readability and documentation, optimizing, simplifying, or developing integrations.
The code is currently in an experimental phase leading up to the first audit. Feedback or ideas for improving the Ethereum Vault Connector are appreciated. Contributions are welcome from anyone interested in conducting security research, writing more tests including formal verification, improving readability and documentation, optimizing, simplifying, or developing integrations.

## License

Expand Down
Loading

0 comments on commit 2f47e9f

Please sign in to comment.