Docs x warden contract (#1165)

ijonele · web-flow · commit 80776f48229a · 2025-01-15T14:04:42.000+01:00
* added a sample contract for calling x/warden

* finalized the smart contract guide + small fixes

* coderabbit

* consolidated improvements in precompile docs
diff --git a/docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md b/docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-a-cross-chain-app.md
@@ -38,10 +38,10 @@ Here are the key features of this contract:
 
 Before you start, complete the following prerequisites:
 
-1. Install `node.js` and `npm`.
-2. Install `truffle`  globally: `npm install -g truffle`.
-3. Create a wallet and get Sepolia ETH – for example, from the [PoW Sepolia Faucet](https://sepolia-faucet.pk910.de).
-4. Create an [Infura](https://www.infura.io) account for accessing the Sepolia network.
+- Install `node.js` and `npm`.
+- Install `truffle`  globally: `npm install -g truffle`.
+- Create a wallet and get Sepolia ETH – for example, from the [PoW Sepolia Faucet](https://sepolia-faucet.pk910.de).
+- Create an [Infura](https://www.infura.io) account for accessing the Sepolia network.
 
 ### 1.1. Set up the project
 
diff --git a/docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md b/docs/developer-docs/docs/build-an-app/deploy-smart-contracts-on-warden/deploy-an-evm-contract.md
@@ -72,16 +72,6 @@ To deploy an EVM contract locally, you need to run a local chain and make sure i
    </TabItem>
    </Tabs>
 
-5. You'll also need your chain ID. Run the following and note down the value from the `network` field:
-
-   ```bash
-   wardend status
-   ```
-
-   :::tip
-   If you used our `just` script to run the node with default settings, the chain ID is `warden_1337-1`.
-   :::
-
 ### Option 2. Connect to Chiado
 
 To deploy an EVM contract on [Chiado testnet](/operate-a-node/chiado-testnet/chiado-overview), you need to install its binary and fund your key, as shown in the following steps:
@@ -134,22 +124,16 @@ To deploy an EVM contract on [Chiado testnet](/operate-a-node/chiado-testnet/chi
 
 ## 2. Create an EVM project
 
-1. Create a new directory `/warden-smart-contract` for your project and navigate there:
-
-    ```bash
-    mkdir warden-smart-contract
-    cd warden-smart-contract
-    ```
-
-2. Initialize a new Foundry project:
+Initialize a new Foundry project and navigate to its directory:
 
-    ```bash
-    forge init --no-commit
-    ```
+```bash
+forge init warden-smart-contract --no-commit
+cd warden-smart-contract
+```
 
 ## 3. Create a smart contract
 
-After you initialize a Foundry project, the script will automatically create a sample contract named `Counter` in the `/src` directory:
+After you initialize a Foundry project, the script will automatically create a sample contract named `Counter.sol` in the `/src` directory:
 
 ```sol title="/warden-smart-contract/src/Counter.sol"
 // SPDX-License-Identifier: UNLICENSED
@@ -352,5 +336,5 @@ After deploying a basic EVM smart contract, start using Warden precompiles to ca
 See the following sections:
 
 - [Call Warden modules in your contract](/category/interact-with-warden-modules)
-- [Solidity precompiles](/category/precompiles)
+- [Precompiles](/category/precompiles)
 
diff --git a/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/get-started.md b/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/get-started.md
@@ -1,5 +1,5 @@
 ﻿---
-sidebar_position: 1
+sidebar_position: 2
 ---
 
 import Tabs from '@theme/Tabs';
@@ -9,37 +9,91 @@ import TabItem from '@theme/TabItem';
 
 ## Overview
 
-This guide shows how to prepare an EVM smart contract for interacting with [Warden Protocol modules](/category/warden-protocol-modules).
+You can interact with [Warden Protocol modules](/category/warden-protocol-modules) in your EVM smart contract by calling [Warden precompiles](/category/precompiles).
 
-You're going to call modules from your contract by using functions from the available [Warden precompiles](/category/precompiles).
+This guide shows how to deploy a simple EVM contract calling the [`spaceById()`](../precompiles/x-warden#query-a-space-by-id) function of the [`x/warden`](../precompiles/x-warden) module. After that, you'll be able to expand your contract code with other functions, which are documented in the subsections below.
+
+To learn the basics of deploying contracts on Warden, refer to [Deploy an EVM contract](../deploy-smart-contracts-on-warden/deploy-an-evm-contract).
 
 ## Prerequisites
 
 Before you start, complete the following prerequisites:
 
-1. [Install Foundry](https://book.getfoundry.sh/getting-started/installation) by running this command:
+- [Install Foundry](https://book.getfoundry.sh/getting-started/installation) by running this command:
 
    ```bash
    curl -L https://foundry.paradigm.xyz | bash \ 
    foundryup
    ```
 
-2. [Prepare the chain](../deploy-smart-contracts-on-warden/deploy-an-evm-contract#1-prepare-the-chain), setting up your private key.
+- Prepare the chain, setting up your private key. You can either run a local chain or join the Chiado testnet, as shown in [Deploy an EVM smart contract](../deploy-smart-contracts-on-warden/deploy-an-evm-contract#1-prepare-the-chain).
 
-## 1. Create a project and contract
+## 1. Create your project and contract
 
 1. Initialize a new Foundry project and navigate to its directory:
-     
+
    ```bash
    forge init warden-smart-contract --no-commit
    cd warden-smart-contract
    ```
+   
+   Alternatively, you can use an existing project – for example, the one you created when following the [Deploy an EVM contract](../deploy-smart-contracts-on-warden/deploy-an-evm-contract) guide.
 
 2. In the `/src` directory, create a new contract named `Warden.sol`.
 
-3. Finally, prepare the contract code. You can use code samples from the following sections:
+   To call a precompile in your contract, do this::
 
-   - [Interact with x/warden](/category/interact-with-xwarden)
+   - Define an `interface` for interacting with a [Warden precompile](/category/precompiles).
+   - Add a `contract` with functions calling the precompile.
+   - In the `contract` section, you should also reference the precompile address.
+
+   You can use the example contract below. It calls the [`spaceById()`](../precompiles/x-warden#query-a-space-by-id) function of [`x/warden`](../precompiles/x-warden) to return a Space and its creator by Space ID:
+
+   ```solidity title="/warden-smart-contract/src/Warden.sol"
+   // SPDX-License-Identifier: UNLICENSED
+   pragma solidity ^0.8.13;
+   
+   // An interface for interacting with the IWarden precompile
+   interface IWarden {
+   
+       // A function for getting a Space by its ID
+       function spaceById(uint64) external view returns (Space memory);
+   
+       // Data structure representing a Warden Space
+       struct Space {
+           uint64 id; // The Space ID
+           address creator; // The Space creator address
+           address[] owners;
+           uint64 nonce;
+           uint64 approveAdminTemplateId;
+           uint64 rejectAdminTemplateId;
+           uint64 approveSignTemplateId;
+           uint64 rejectSignTemplateId;
+       }
+   }
+   
+   // A contract for interacting with the IWarden precompile
+   contract querySpace {
+   
+       // The IWarden precompile address
+       address constant WARDEN_ADDRESS = 0x0000000000000000000000000000000000000900;
+       IWarden public warden;
+   
+       constructor() {
+           warden = IWarden(WARDEN_ADDRESS);
+       }
+   
+       // A function for getting a Space by Space ID
+       function getSpace(uint64 id) external view returns (IWarden.Space memory) {
+           return warden.spaceById(id);
+       }
+   
+       // A function for getting the Space creator address by Space ID
+       function getSpaceCreator(uint64 id) external view returns (address) {
+           return warden.spaceById(id).creator;
+       }
+   }
+   ```
 
 ## 2. Compile and deploy the contract
 
@@ -73,7 +127,7 @@ Before you start, complete the following prerequisites:
 3. Deploy the contract:
 
    ```bash
-   forge create --rpc-url $RPC_URL --private-key $PRIVATE_KEY src/Warden.sol:WardenContract
+   forge create --rpc-url $RPC_URL --private-key $PRIVATE_KEY src/Warden.sol:querySpace
    ```
 
 4. Export your contract address returned in `Deployed to`:
@@ -88,9 +142,47 @@ Before you start, complete the following prerequisites:
    cast code $CONTRACT_ADDRESS --rpc-url $RPC_URL
    ```
 
+## 3. Interact with the contract
+
+Now you can interact with the contract.
+
+1. If you're using a local chain, make sure it's running and there is at least one Space:
+   
+   ```
+   wardend query warden spaces
+   ```
+
+   If nothing is returned, [create a Space](/operate-a-node/run-a-local-chain#create-a-space). 
+
+2. Get a Space by its ID – for example, `1`:
+   
+   ```
+   cast call $CONTRACT_ADDRESS "getSpace(uint64)" 1 --rpc-url $RPC_URL
+   ```
+
+   The result will look like this:
+
+   ```
+   0x000000000000000000000000000000000000000000000000000000000000002000000000000000000000000000000000000000000000000000000000000000010000000000000000000000006ea8ac1673402989e7b653ae4e83b54173719c3000000000000000000000000000000000000000000000000000000000000001000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000000010000000000000000000000006ea8ac1673402989e7b653ae4e83b54173719c30
+   ```
+
+3. Get the Space creator by Space ID – for example, `1`:
+   
+   ```
+   cast call $CONTRACT_ADDRESS "getSpaceCreator(uint64)" 1 --rpc-url $RPC_URL
+   ```
+
+   The result will look like this:
+
+   ```
+   0x0000000000000000000000006ea8ac1673402989e7b653ae4e83b54173719c30
+   ```
+
 ## Next steps
 
-- To dive deeper and find code samples for each function from Warden precompiles, see the following guides:
+Now you can dive deeper and expand your contract with other functions from Warden precompiles:
+
+- To find code samples for each function, see the following guides:
   - [Interact with x/warden](/category/interact-with-xwarden)
-  - *Other modules: coming soon.*
-- For an overview of the functions, refer to the [Precompiles](/category/precompiles) section.
+  - *Other modules: coming soon*
+- For an overview of the available functions, refer to the [Precompiles](/category/precompiles) section.
diff --git a/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/_category_.json b/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/_category_.json
@@ -1,5 +1,5 @@
 {
-    "position": 2,
+    "position": 3,
     "label": "Interact with x/warden",
     "collapsible": true,
     "collapsed": true,
diff --git a/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/manage-key-requests.md b/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/manage-key-requests.md
@@ -13,7 +13,8 @@ This article explains how to use `x/warden` to manage [key requests](/learn/glos
 To understand how to set up and deploy your project, see [Get started](../get-started.md).
 
 :::tip
-For an overview of `x/warden` functions, refer to [Precompiles: x/warden](../../precompiles/x-warden#key-requests)
+- For an overview of `x/warden` functions, refer to [Precompiles: x/warden](../../precompiles/x-warden#key-requests).
+- The precompile address is `0x0000000000000000000000000000000000000900`.
 :::
 
 ## Create a new key request
diff --git a/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/manage-keychains.md b/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/manage-keychains.md
@@ -13,7 +13,8 @@ This article explains how to use `x/warden` to manage [Keychains](/learn/glossar
 To understand how to set up and deploy your project, see [Get started](../get-started.md).
 
 :::tip
-For an overview of `x/warden` functions, refer to [Precompiles: x/warden](../../precompiles/x-warden#keychains)
+- For an overview of `x/warden` functions, refer to [Precompiles: x/warden](../../precompiles/x-warden#keychains).
+- The precompile address is `0x0000000000000000000000000000000000000900`.
 :::
 
 ## Create a new Keychain
diff --git a/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/manage-keys.md b/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/manage-keys.md
@@ -13,7 +13,8 @@ This article explains how to use `x/warden` to manage [keys](/learn/glossary#key
 To understand how to set up and deploy your project, see [Get started](../get-started.md).
 
 :::tip
-For an overview of `x/warden` functions, refer to [Precompiles: x/warden](../../precompiles/x-warden#keys)
+- For an overview of `x/warden` functions, refer to [Precompiles: x/warden](../../precompiles/x-warden#keys).
+- The precompile address is `0x0000000000000000000000000000000000000900`.
 :::
 
 ## Update a key
diff --git a/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/manage-signature-requests.md b/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/manage-signature-requests.md
@@ -13,7 +13,8 @@ This article explains how to use `x/warden` to manage [signature requests](/lear
 To understand how to set up and deploy your project, see [Get started](../get-started.md).
 
 :::tip
-For an overview of `x/warden` functions, refer to [Precompiles: x/warden](../../precompiles/x-warden#signature-requests)
+- For an overview of `x/warden` functions, refer to [Precompiles: x/warden](../../precompiles/x-warden#signature-requests).
+- The precompile address is `0x0000000000000000000000000000000000000900`.
 :::
 
 ## Create a new signature request
diff --git a/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/manage-spaces.md b/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/interact-with-x-warden/manage-spaces.md
@@ -13,7 +13,8 @@ This article explains how to use `x/warden` to manage [Spaces](/learn/glossary#s
 To understand how to set up and deploy your project, see [Get started](../get-started.md).
 
 :::tip
-For an overview of `x/warden` functions, refer to [Precompiles: x/warden](../../precompiles/x-warden#spaces)
+- For an overview of `x/warden` functions, refer to [Precompiles: x/warden](../../precompiles/x-warden#spaces).
+- The precompile address is `0x0000000000000000000000000000000000000900`.
 :::
 
 ## Create a new Space
@@ -22,11 +23,11 @@ To create a new Space, use the following code in your contract. It calls the [`n
 
 ```solidity
 function newSpace(
-        uint64 approveAdminTemplateId,
-        uint64 rejectAdminTemplateId,
-        uint64 approveSignTemplateId,
-        uint64 rejectSignTemplateId,
-        address[] calldata additionalOwners
+    uint64 approveAdminTemplateId,
+    uint64 rejectAdminTemplateId,
+    uint64 approveSignTemplateId,
+    uint64 rejectSignTemplateId,
+    address[] calldata additionalOwners
 ) external returns (uint64 id);
 
 contract wardenSpace {
@@ -311,13 +312,13 @@ contract SpaceQuery {
         warden = IWarden(WARDEN_ADDRESS);
     }
 
-    function getSpaceById(uint64 spaceId) external view returns (IWarden.Space memory) {
-        return warden.spaceById(spaceId);
+    function getSpaceById(uint64 id) external view returns (IWarden.Space memory) {
+        return warden.spaceById(id);
     }
 }
 ```
 
-After deploying your contract, you can interact with it by calling the `spaceById()` function:
+After deploying your contract, you can interact with it by calling the `getSpaceById()` function:
 
 ```bash
 cast call $CONTRACT_ADDRESS "getSpaceById(uint64)" 1 --rpc-url $RPC_URL
diff --git a/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/introduction.md b/docs/developer-docs/docs/build-an-app/interact-with-warden-modules/introduction.md
@@ -0,0 +1,22 @@
+﻿---
+sidebar_position: 1
+---
+
+# Introduction
+
+You can interact with [Warden Protocol modules](/category/warden-protocol-modules) in your EVM smart contract by calling [Warden precompiles](/category/precompiles).
+
+To familiarize yourself with precompiles, take the following steps:
+
+1. Deploy a simple EVM contract by following the [Get started](get-started) guide.
+3. After that, you can expand your contract code as shown in these subsections:
+   - [Interact with x/warden](/category/interact-with-xwarden)
+   - *Other modules: coming soon*
+4. For an overview of available functions, refer to the [Precompiles](/category/precompiles) section.
+
+In this table, you can find all the resources you'll need to interact with each precompile:
+
+|  Functions                                    | Code samples                                              | Precompile address                           |
+| --------------------------------------------- | --------------------------------------------------------- |--------------------------------------------- |
+| [x/warden functions](../precompiles/x-warden) | [Interact with x/warden](/category/interact-with-xwarden) | `0x0000000000000000000000000000000000000900` |
+| [x/act functions](../precompiles/x-act)       | *Coming soon*                                             | `0x0000000000000000000000000000000000000901` |
diff --git a/docs/developer-docs/docs/build-an-app/precompiles/x-act.md b/docs/developer-docs/docs/build-an-app/precompiles/x-act.md
diff --git a/docs/developer-docs/docs/learn/glossary.md b/docs/developer-docs/docs/learn/glossary.md
diff --git a/docs/developer-docs/docs/learn/oracle-services.md b/docs/developer-docs/docs/learn/oracle-services.md
diff --git a/docs/developer-docs/docs/learn/warden-protocol-modules/x-warden.md b/docs/developer-docs/docs/learn/warden-protocol-modules/x-warden.md
diff --git a/docs/developer-docs/docs/operate-a-node/run-a-local-chain.md b/docs/developer-docs/docs/operate-a-node/run-a-local-chain.md

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,5 @@`
`1`	`1`	`{`
`2`		`- "position": 2,`
	`2`	`+ "position": 3,`
`3`	`3`	`"label": "Interact with x/warden",`
`4`	`4`	`"collapsible": true,`
`5`	`5`	`"collapsed": true,`