Skip to content

Commit e9403d0

Browse files
committed
Updated documentation and deleted pages to point to zodiac.wiki.
1 parent 3938584 commit e9403d0

37 files changed

+31
-1071
lines changed

docs/intro.md

Lines changed: 3 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -2,36 +2,8 @@
22
sidebar_position: 1
33
---
44

5-
# Zodiac Introduction
5+
# Documentation
66

7-
Let's discover **Zodiac in less than 5 minutes**.
7+
The tutorials for the Zodiac protocol have moved.
88

9-
Anyone can contribute to the Zodiac compliant collection of tools by submitting a pull request on the repository: https://github.com/gnosis/zodiac.
10-
11-
## What Is Zodiac?
12-
13-
The expansion pack for DAOs, Zodiac is a collection of tools built according to an open standard.
14-
15-
The Zodiac open standard enables DAOs to act more like constellations, connecting protocols, platforms, and chains, no longer confined to monolithic designs.
16-
17-
To learn more about the ideas behind Zodiac, visit the [blog](http://gnosisguild.mirror.xyz/). If you have any questions about Zodiac, join the [Gnosis Guild Discord](https://discord.gg/wwmBWTgyEq).
18-
19-
The Zodiac open standard enables:
20-
21-
- Flexible, module-based control of programmable accounts
22-
- Un-opinionated standards for programmable account interaction
23-
- Reusable implementations of core and factory logic
24-
25-
26-
## Build a Zodiac Module
27-
28-
Import Module.sol into your module.
29-
30-
```solidity
31-
import "@gnosis/zodiac/contracts/core/Module.sol";
32-
33-
contract YourModule is Module {
34-
/// insert your code here
35-
}
36-
37-
```
9+
Please visit: https://zodiac.wiki/index.php/Category:Documentation.

docs/tutorial-build-a-module/01_setup.md

Lines changed: 3 additions & 58 deletions
Original file line numberDiff line numberDiff line change
@@ -2,63 +2,8 @@
22
sidebar_position: 1
33
---
44

5-
# Setup
5+
# Documentation
66

7-
## Welcome
7+
The tutorial to build your own Zodiac Module has moved.
88

9-
In this tutorial, you'll learn the the fundamental concepts of Zodiac modules while you build a super-simple example module. Deploying it first on a local test environment to control a mock [Gnosis Safe](http://gnosis-safe.io/), and later using it to control a real Gnosis Safe on a public test network.
10-
11-
## Setup IDE
12-
13-
For this tutorial, we'll make use of [Remix](https://remix.ethereum.org/), a powerful web-based IDE for building Ethereum applications. However, if you would prefer to use some other developer environment, the instructions should port easily to wherever you like to work.
14-
15-
Start by importing [this gist](https://gist.github.com/auryn-macmillan/105ae8f09c34406997d217ee4dc0f63a).
16-
17-
![Remix: insert from gist](/img/tutorial/build_module_01.png)
18-
19-
This will add three files to your working directory: `Button.sol`, `MockSafe.sol`, and `MyModule.sol`.
20-
21-
![Remix: files](/img/tutorial/build_module_02.png)
22-
23-
Alternatively, you can create each of the files manually and copy the code from [the gist](https://gist.github.com/auryn-macmillan/105ae8f09c34406997d217ee4dc0f63a).
24-
25-
`Button.sol` is a silly little contract with one function, `pushButton()`, which increments a counter, `pushes`. The `pushButton()` function is only callable by the contracts "owner", which will be our Gnosis Safe.
26-
27-
`MockSafe.sol` is a mock of the Gnosis Safe that we'll use for simplicity as we build and test in our local environment. Later we'll replace it with a real Gnosis Safe on a public test network to make sure our module really works.
28-
29-
`MyModule.sol` is where you'll be adding your own code to control our Gnosis Safes and make it push the button in our `Button.sol` contract.
30-
31-
## Deploy Button and MockSafe
32-
33-
Before we write any of our own code, we should deploy our Button and MockSafe contracts to our local environment.
34-
35-
Navigate to the "Solidity Compiler" tab and check "Auto compile". This will re-compile your contract each time you make a change.
36-
37-
![Remix: autocompile](/img/tutorial/build_module_03.png)
38-
39-
With `Button.sol` open, navigate to the "Deploy & Run Transactions" tab, select "Button" from the contracts dropdown, and hit "deploy". Do the same for `MockSafe.sol`.
40-
41-
![Remix: deploy](/img/tutorial/build_module_04.png)
42-
43-
You should now see two items have appeared in the "deployed contracts" section slightly below the deploy button, one each for `Button.sol` and `MockSafe.sol`. You can expand the view of either by clicking the carat to the left of the name, exposing the variables and functions for the contract.
44-
45-
You can test that your button works by pushing the "pushes" button on your deployed Button. It should return `0`. Now push the "pushButton" button and then then "pushes" button again, this time it should return `1`.
46-
47-
![Remix: deploy](/img/tutorial/build_module_23.png)
48-
49-
Copy the address of your `MockSafe`, expand your deployed `Button`, and call the `transferOwnership()` function, pasting in your MockSafe's address for the parameter.
50-
51-
![Remix: transfer ownership](/img/tutorial/build_module_05.png)
52-
53-
Now that you've transferred ownership, pushing the "pushButton" button on your Button will now fail. Rather, you'll need make your MockSafe execute the transaction.
54-
55-
Expand your MockSafe and call the `exec` function with the following parameters:
56-
57-
- **to:** `{address of your deployed Button contract}`
58-
- **value:** `0`
59-
- **data:** `"0x0a007972"` _(the ABI encoded function signature for the `pushButton()` function)_
60-
61-
Clicking the "pushes" button on your Button should now show that `pushes` has been incremented again.
62-
63-
Your set up, huzzah! 🎉
64-
Let's start building!
9+
Please visit: https://zodiac.wiki/index.php/Category:Custom_Module.

docs/tutorial-build-a-module/02_create_module.md

Lines changed: 0 additions & 93 deletions
This file was deleted.

docs/tutorial-build-a-module/03_deploy_module.md

Lines changed: 0 additions & 27 deletions
This file was deleted.

docs/tutorial-build-a-module/04_deploy_on_rinkeby.md

Lines changed: 0 additions & 87 deletions
This file was deleted.

docs/tutorial-modifier-delay/add-modifier.md

Lines changed: 0 additions & 28 deletions
This file was deleted.

docs/tutorial-modifier-delay/get-started.md

Lines changed: 3 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -2,28 +2,8 @@
22
sidebar_position: 1
33
---
44

5-
# Get started
5+
# Documentation
66

7-
## About the Zodiac Delay Modifier
7+
The tutorial for the Zodiac Delay Modifier has moved.
88

9-
This modifier allows avatars (accounts) to enforce a time delay between when a module initiates a transaction and when it can be executed by an avatar.
10-
11-
[Read more here](https://github.com/gnosis/zodiac-modifier-delay). For a more technical guide on how to use the Delay Modifier beyond the Zodiac App interface, see the Github repo [Setup Guide](https://github.com/gnosis/zodiac-modifier-delay/blob/main/docs/setup_guide.md).
12-
13-
## Setup a Gnosis Safe
14-
15-
If you've already set up a Gnosis Safe you'd like to use for this tutorial, skip to the next step below.
16-
17-
If not, check out the Gnosis Safe Help Center. The [Create a Safe](https://help.gnosis-safe.io/en/articles/3876461-create-a-safe) tutorial will walk you through the full process of creating a new Gnosis Safe account in just 60 seconds.
18-
19-
Note that for the purposes of this tutorial, we'll be using a Gnosis Safe deployed on the Rinkeby testnetwork. You can create a Gnosis Safe on Rinkeby at [http://rinkeby.gnosis-safe.io](http://rinkeby.gnosis-safe.io/).
20-
21-
## Navigate to the Zodiac App
22-
23-
On your Gnosis Safe's left menu, click the `APPS` option. Here you'll find apps available through Gnosis Safe. Scroll to the end of this list, and you'll find the Zodiac App.
24-
25-
![Zodiac App in Safe Apps](/img/tutorial/zodiac_app.png)
26-
27-
Once entering the Zodiac App, you'll see the current Zodiac compliant collection of tools that have a Zodiac App interface.
28-
29-
![Zodiac App](/img/tutorial/zodiac_app_2.png)
9+
Please visit: https://zodiac.wiki/index.php/Category:Delay_Modifier.

docs/tutorial-modifier-delay/review-modifier.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)