Skip to content
This repository has been archived by the owner on Oct 3, 2023. It is now read-only.

Commit

Permalink
feat: add tests and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@amusingaxl
amusingaxl committed Oct 24, 2022
1 parent 6f72854 commit d851ef7
Show file tree
Hide file tree
Showing 4 changed files with 345 additions and 26 deletions.
3 changes: 3 additions & 0 deletions .gitmodules
View file
Original file line number Diff line number Diff line change
@@ -1,3 +1,6 @@
[submodule "lib/forge-std"]
path = lib/forge-std
url = https://github.com/foundry-rs/forge-std
[submodule "lib/solmate"]
path = lib/solmate
url = https://github.com/transmissions11/solmate
1 change: 1 addition & 0 deletions lib/solmate
Submodule solmate added at c2594b
158 changes: 132 additions & 26 deletions src/Safebox.sol
View file
Original file line number Diff line number Diff line change
@@ -1,54 +1,100 @@
// SPDX-FileCopyrightText: © 2022 Dai Foundation <www.daifoundation.org>
// SPDX-License-Identifier: AGPL-3.0-or-later
//
// This program is free software: you can redistribute it and/or modify
// it under the terms of the GNU Affero General Public License as published by
// the Free Software Foundation, either version 3 of the License, or
// (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
// GNU Affero General Public License for more details.
//
// You should have received a copy of the GNU Affero General Public License
// along with this program. If not, see <https://www.gnu.org/licenses/>.
pragma solidity ^0.8.16;

interface WardsLike {
function rely(address usr) external;

function deny(address usr) external;

function wards(address usr) external view returns (uint256);
}

interface CanLike {
function hope(address usr) external;

function nope(address usr) external;

function can(address usr) external view returns (uint256);
}

interface FileLike {
function file(bytes32 what, address data) external;
}

contract Safebox is WardsLike, CanLike, FileLike {
/**
* @author amusingaxl
* @title A safebox for digital assets.
* The `owner` is in full control of how much and when it can send assets to `recipient`.
* The `custodian` cooperation is required whenever the `owner` wants to update the `recipient`.
*/
contract Safebox {
/// @notice Addresses with owner access on this contract. `wards[usr]`
mapping(address => uint256) public wards;

/// @notice Addresses with custodian access on this contract. `can[usr]`
mapping(address => uint256) public can;

/// @notice The recipient for the assets held in this contract.
address public recipient;

/// @notice Reference to the new recipient when the it is to be changed.
address public pendingRecipient;

/**
* @notice `usr` was granted owner access.
* @param usr The user address.
*/
event Rely(address indexed usr);
/**
* @notice `usr` owner access was revoked.
* @param usr The user address.
*/
event Deny(address indexed usr);

/**
* @notice `usr` was granted custodian access.
* @param usr The user address.
*/
event Hope(address indexed usr);
/**
* @notice `usr` custodian address was revoked.
* @param usr The user address.
*/
event Nope(address indexed usr);

/**
* @notice A contract parameter was updated.
* @param what The changed parameter name. Currently the supported values are: "outputConduit" and "jug".
* @param data The new value of the parameter.
*/
event File(bytes32 indexed what, address data);

/**
* @notice The recipient has been sucessfully changed.
* @param recipient The new recipient address.
*/
event RecipientChange(address indexed recipient);
/**
* @notice A deposit was made into the safebox.
* @param token The token deposited.
* @param amount The amount deposited.
*/
event Deposit(address indexed token, uint256 amount);

/**
* @notice A withdrawal was made by the owner.
* @param token The token deposited.
* @param amount The amount deposited.
*/
event Withdraw(address indexed token, uint256 amount);

modifier auth() {
require(wards[msg.sender] == 1, "Safebox/not-authorized");
_;
}

/**
* @param _owner The safebox owner.
* @param _custodian The safebox custodian.
* @param _recipient The recipient for assets in the safebox.
*/
constructor(
address _owner,
address _custodian,
address _recipient
) {
require(_recipient != address(0), "Safebox/invalid-recipient");

wards[_owner] = 1;
emit Rely(_owner);

Expand All @@ -59,35 +105,70 @@ contract Safebox is WardsLike, CanLike, FileLike {
emit RecipientChange(_recipient);
}

/*//////////////////////////////////
Authorization
//////////////////////////////////*/

/**
* @notice Grants `usr` owner access to this contract.
* @param usr The user address.
*/
function rely(address usr) external auth {
wards[usr] = 1;
emit Rely(usr);
}

/**
* @notice Revokes `usr` owner access from this contract.
* @param usr The user address.
*/
function deny(address usr) external auth {
wards[usr] = 0;
emit Deny(usr);
}

/**
* @notice Grants `usr` custodian access to this contract.
* @param usr The user address.
*/
function hope(address usr) external auth {
can[usr] = 1;
emit Hope(usr);
}

/**
* @notice Revokes `usr` custodian access from this contract.
* @param usr The user address.
*/
function nope(address usr) external auth {
can[usr] = 0;
emit Nope(usr);
}

/*//////////////////////////////////
Safebox Operation
//////////////////////////////////*/

/**
* @notice Updates a contract parameter.
* @param what The changed parameter name. `"recipient"`
* @param data The new value of the parameter.
*/
function file(bytes32 what, address data) external auth {
if (what == "recipient") {
require(data != address(0), "Safebox/invalid-recipient");
pendingRecipient = data;
emit File(what, data);
} else {
revert("Safebox/file-unrecognized-param");
}
}

/**
* @notice Approves the change in the recipient.
* @dev Reverts if `previousRecipient` has not been set or if `_recipient` does not match it.
* @param _recipient The new recipient being approved.
*/
function approveChangeRecipient(address _recipient) external {
require(can[msg.sender] == 1, "Safebox/not-allowed");
require(pendingRecipient != address(0) && pendingRecipient == _recipient, "Safebox/recipient-mismatch");
Expand All @@ -98,14 +179,33 @@ contract Safebox is WardsLike, CanLike, FileLike {
emit RecipientChange(_recipient);
}

function deposit(address token, uint256 amount) external auth {
/**
* @notice Deposits ERC20-like tokens into this contract.
* @param token The token to be deposited.
* @param amount The amount of tokens.
*/
function deposit(address token, uint256 amount) external {
_safeTransferFrom(token, msg.sender, address(this), amount);
emit Deposit(token, amount);
}

/**
* @notice Withdraws ERC20-like tokens from this contract.
* @param token The token to be withdrawn.
* @param amount The amount of tokens.
*/
function withdraw(address token, uint256 amount) external auth {
_safeTransfer(token, recipient, amount);
emit Withdraw(token, amount);
}

/**
* @dev Handles `transferFrom` for tokens with non-standard ERC-20 implementations.
* See https://github.com/d-xo/weird-erc20
* @param from The origin address.
* @param to The destination address.
* @param amount The amount to be transfered.
*/
function _safeTransferFrom(
address token,
address from,
Expand All @@ -118,6 +218,12 @@ contract Safebox is WardsLike, CanLike, FileLike {
require(success && (result.length == 0 || abi.decode(result, (bool))), "Safebox/token-transfer-from-failed");
}

/**
* @dev Handles `transfer` for tokens with non-standard ERC-20 implementations.
* See https://github.com/d-xo/weird-erc20
* @param to The destination address.
* @param amount The amount to be transfered.
*/
function _safeTransfer(
address token,
address to,
Expand Down
Loading

0 comments on commit d851ef7

Please sign in to comment.