Skip to content

Latest commit

 

History

History
126 lines (86 loc) · 7 KB

README.md

File metadata and controls

126 lines (86 loc) · 7 KB
Raw

📯 Legacy Zodiac Roles v1 sources at: gnosis/zodiac-modifier-roles-v1

Zodiac Roles Modifier

Build Status Coverage Status Contributor Covenant

The Roles Modifier belongs to the Zodiac collection of tools, which can be accessed through the Zodiac App available on Safe.

If you have any questions about Zodiac, join the Gnosis Guild Discord. Follow @GnosisGuild on Twitter for updates.

About the Roles Modifier

This modifier allows avatars to enforce granular, role-based, permissions for attached modules.

Modules that have been granted a role are able to unilaterally make calls to any approved addresses, approved functions, and using approved parameters.

The interface mirrors the relevant parts of the Safe's interface, so this contract can be placed between Safe modules and the Safe itself to enforce role-based permissions.

The contracts have been developed with Solidity 0.8.21 targeting evm version shanghai.

Features

  • Create multiple roles
  • Assign roles to addresses
  • Allow roles access to call, delegate call, and/or send to address
  • Scope which functions a role can call on given address
  • Define conditions on function parameters

Flow

  • Define a role by setting targets, functions, and parameters that it can call
  • Assign the role to an address with assignRoles()
  • Address can now trigger the safe to call those targets, functions, and parameters via execTransactionWithRole()

Deployments

Roles

Address: 0x9646fDAD06d3e24444381f44362a3B0eB343D337

MultiSendUnwrapper (transaction unwrapper)

Address: 0x93B7fCbc63ED8a3a24B59e1C3e6649D50B7427c0

AvatarIsOwnerOfERC721 (custom condition)

Address: 0x91B1bd7BCC5E623d5CE76b0152253499a9C819d1

Subgraphs

Development environment setup

  1. For each package were a .env.sample file is present, copy the content of the file into a .env file at the same location and populate it with your keys, etc.
  2. From the repo root run yarn
  3. From the repo root run yarn prepare

After that, you can start working on the different packages.

Packages

This monorepo uses yarn workspaces and is comprised of:

  • evm: Roles mod smart contracts
  • subgraph: a subgraph indexing deployed Roles mod instances
  • sdk: a TypeScript SDK for managing roles
  • app: a webapp for editing roles

Audits

Audits have been performed by the G0 group and Omniscia.

All identified issues have been resolved as of commit a19c0ebda97f7d645335f2c386818546641f832b

All audit reports are available at packages/evm/docs.

Security and Liability

All contracts are WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

License

Created under the LGPL-3.0+ license.