PRBProxy is a proxy contract that allows for the composition of Ethereum transactions on behalf of the contract owner, acting as a smart wallet that enables multiple contract calls within a single transaction. Externally owned accounts (EOAs) do not have this functionality; they are limited to interacting with only one contract per transaction.
Some key features of PRBProxy include:
- Forwarding calls with
DELEGATECALL
- Use of CREATE2 to deploy the proxies at deterministic addresses.
- A unique registry system ensures that each user has a distinct proxy.
- An access control system that permits third-party accounts (called "envoys") to call target contracts on behalf of the owner.
- A plugin system that enables the proxy to respond to callbacks
- Reversion with custom errors rather than reason strings for improved error handling.
- Comprehensive documentation via NatSpec comments.
- Development and testing using Foundry.
Overall, PRBProxy is a powerful tool for transaction composition, providing numerous features and benefits not available through EOAs.
Background
The concept of a proxy contract has gained popularity thanks to DappHub, the team responsible for creating the decentralized stablecoin DAI. DappHub created DSProxy, a widely used tool that allows for the execution of multiple contract calls in a single transaction. Major DeFi players like Maker, Balancer, and DeFi Saver all rely on DSProxy.
However, as the Ethereum ecosystem has evolved since DSProxy's launch in 2017, the tool has become outdated. With significant improvements to the Solidity compiler and new EVM OPCODES, as well as the introduction of more user-friendly development environments like Foundry, it was time for an update.
Enter PRBProxy, the modern successor to DSProxy; a "DSProxy 2.0", if you will. It improves upon DSProxy in several ways:
- PRBProxy is deployed with CREATE2, which allows clients to know the proxy contract's address in advance.
CREATE2
seeds are generated in a way that eliminates the risk of front-running.- The proxy owner cannot be changed during the
DELEGATECALL
operation. - PRBProxy uses high-level Solidity code that is easier to comprehend and less prone to errors.
- A minimum gas reserve is stored in the proxy to prevent it from becoming unusable if future EVM opcode gas costs change.
- PRBProxy offers more features than DSProxy.
Using CREATE2 eliminates the risk of a chain reorg overriding the proxy contract owner, making PRBProxy a more secure alternative to DSProxy. With DSProxy, users must wait for several blocks to be mined before assuming the contract is secure. However, PRBProxy eliminates this risk entirely, allowing users to even safely send funds to the proxy before it is deployed.
Install
Foundry
First, run the install step:
forge install --no-commit PaulRBerg/prb-proxy@v4
Your .gitmodules
file should now contain the following entry:
[submodule "lib/prb-proxy"]
branch = "v4"
path = "lib/prb-proxy"
url = "https://github.com/PaulRBerg/prb-proxy"
Finally, add this to your remappings.txt
file:
prb-proxy/=lib/prb-proxy/src/
Hardhat
PRBProxy is available as an npm package:
yarn add @prb/proxy
Usage
To deploy a proxy, you have two options: you can either call the deploy
or the deployFor
function in the
PRBProxyRegistry
contract.
Once the proxy is deployed, you can start interacting with target contracts. PRBProxy ships with one "enshrined" target
contract called PRBProxyHelpers
. This contract provides several useful functions, including:
installPlugin
setMinGasReserve
setPermission
uninstallPlugin
You call the functions above by ABI-encoding their calldata and calling execute
on the proxy. The logic in
PRBProxyHelpers
is kept separate from the proxy itself to reduce deployment costs.
Addresses
The registry and the enshrined target are deployed at the same address on the following chains:
Contract | Chain | Chain ID | Address |
---|---|---|---|
Registry | Ethereum Goerli Testnet | 5 | 0x7aE53f08B444D481d207e5F335Df017CE6E9d248 |
Helpers | Ethereum Goerli Testnet | 5 | 0xDc608dFCc62E0e7756439270D09881EEDf7885EF |
Targets
To make use of PRBProxy, you'll need a "target" contract. Targets consist of stateless scripts and are the key to leveraging PRBProxy for transaction composition.
As an example, here's a target contract that wraps ETH into WETH (the ERC-20 version of ETH) and deposits the resulting WETH into a DeFi protocol called Acme:
// SPDX-License-Identifier: UNLICENSED
pragma solidity >=0.8.18 <=0.9.0;
interface AcmeLike {
function depositCollateral(address token, uint256 collateralAmount);
}
interface WethLike {
function deposit() external payable;
}
function wrapEthAndDepositCollateral(AcmeLike acme) external payable override {
uint256 depositAmount = msg.value;
// Convert the received ETH to WETH.
WethLike weth = WethLike(0xC02aaA39b223FE8D0A0e5C4F27eAD9083C756Cc2);
weth.deposit{ value: depositAmount }();
// Deposit the WETH as collateral into the Acme DeFi protocol.
acme.depositCollateral(address(weth), depositAmount);
}
For more examples of target contracts, see the Targets wiki.
Frontends
Integrating PRBProxy into a frontend app is a straightforward process:
- Begin by calling the
getCurrentProxy
function on the registry to determine if the user already has a proxy. - If the user does not have a proxy, ask them to deploy one by calling either the
deploy
ordeployFor
function. - Interact with your desired target contract using the
execute
function. - Going forward, treat the proxy address as the user of your system.
However, this is just scratching the surface. For more examples of how to use PRBProxy in a frontend environment, check out the Frontends wiki. Additionally, Maker's developer guide, Working with DSProxy, provides an in-depth exploration of the proxy concept that can also help you understand how to use PRBProxy. Just be sure to keep in mind the differences outlined throughout this document.
Gas Efficiency
It costs 528,529 gas to deploy a PRBProxy, whereas a DSProxy costs 596,198 gas - a reduction in deployment costs of roughly 12%.
The execute
function in PRBProxy is slightly more expensive than in its counterpart, due to the safety checks in our
implementation. However, the majority of gas costs when calling execute are instead related to the logic being executed
in the target contract.
Contributing
Feel free to dive in! Open an issue, start a discussion, or submit a PR.
Pre Requisites
You will need the following software on your machine:
In addition, familiarity with Solidity is requisite.
Set Up
Clone this repository including submodules:
$ git clone --recurse-submodules -j8 git@github.com:PaulRBerg/prb-proxy.git
Then, inside the project's directory, run this to install the Node.js dependencies:
$ yarn install
Now you can start making changes.
Syntax Highlighting
You will need the following VSCode extensions:
Security
While I have strict standards for code quality and test coverage, it's important to note that this project may not be entirely risk-free. Although I have taken measures to ensure the security of PRBProxy, it has not yet been audited by a third-party security researcher.
Caveat Emptor
Please be aware that this software is experimental and is provided on an "as is" and "as available" basis. I do not offer any warranties, and I cannot be held responsible for any direct or indirect loss resulting from the continued use of this codebase.
Contact
If you discover any bugs or security issues, please report them via Telegram.
Acknowledgments
- ds-proxy - DappHub's proxy, which powers the Maker protocol.
- wand - attempt to build DSProxy 2.0, started by one of the original authors of DSProxy.
- dsa-contracts - InstaDapp's DeFi Smart Accounts.
License
MIT © Paul Razvan Berg