Skip to content

[VEN-750] docs: add liquidator reference #12

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
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

[VEN-750] docs: add liquidator reference #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bfadd3c
docs: add liquidator reference
kkirka Nov 10, 2022
44c0035
refactor: update to liquidator docs and add natspec
coreyar Nov 29, 2022
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
23 changes: 23 additions & 0 deletions core-pool/admins.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Admins and ownership

Most of our contracts have a dedicated admin. The admin of most of the contracts is Governance. The admin can be changed with a two-step procedure that guarantees there's no error during transferring the rights.

The interface is similar but for historical reasons some of the contracts do not revert in case of failure. These contracts return 0 if the transaction was successful and an error code otherwise.

## _setPendingAdmin

```
function _setPendingAdmin(
address newPendingAdmin
) external [returns (uint256 error)];
```

Begins transfer of admin rights. The newPendingAdmin must call `_acceptAdmin` to finalize the transfer. The function is only callable by admin.

## _acceptAdmin

```solidity
function _acceptAdmin() external [returns (uint256)];
```

Accepts transfer of admin rights. The function is only callable by pendingAdmin.
Loading