Add agent contract & deployment scripts

shadmau · shadmau · commit fa2deb171565 · 2025-09-15T15:54:55.000+02:00
diff --git a/.env.example b/.env.example
@@ -0,0 +1,5 @@
+PRIVATE_KEY=
+RPC_URL=https://eth-sepolia.g.alchemy.com/v2/your-api-key
+AGENT_ADDRESS=
+TOKEN_ID=0
+RECIPIENT=0x..
diff --git a/.gitignore b/.gitignore
@@ -3,9 +3,7 @@ cache/
 out/
 
 # Ignores development broadcast logs
-!/broadcast
-/broadcast/*/31337/
-/broadcast/**/dry-run/
+broadcast/
 
 # Docs
 docs/
diff --git a/.gitmodules b/.gitmodules
@@ -1,3 +1,6 @@
 [submodule "lib/forge-std"]
 	path = lib/forge-std
 	url = https://github.com/foundry-rs/forge-std
+[submodule "lib/openzeppelin-contracts"]
+	path = lib/openzeppelin-contracts
+	url = https://github.com/OpenZeppelin/openzeppelin-contracts
diff --git a/SCRIPTS.md b/SCRIPTS.md
@@ -0,0 +1,47 @@
+# Deployment and Interaction Scripts
+
+## Environment Setup
+
+Create a `.env` file with:
+
+```bash
+PRIVATE_KEY=your_private_key_here
+RPC_URL=your_rpc_url_here
+```
+
+## Usage
+
+### 1. Deploy Contract
+
+```bash
+forge script script/Deploy.s.sol --rpc-url $RPC_URL --broadcast --verify --etherscan-api-key $ETHERSCAN_API_KEY
+
+```
+
+### 2. Mint Token (Admin Only)
+
+Set environment variables
+
+Run mint script:
+
+```bash
+forge script script/Mint.s.sol --rpc-url $RPC_URL --broadcast
+```
+
+### 3. Claim Token (Admin Only)
+
+Set environment variables
+
+Run claim script:
+
+```bash
+forge script script/Claim.s.sol --rpc-url $RPC_URL --broadcast
+```
+
+## Example Flow
+
+1. Deploy: `forge script script/Deploy.s.sol --rpc-url $RPC_URL --broadcast`
+2. Set AGENT_ADDRESS from deploy output
+3. Mint: `forge script script/Mint.s.sol --rpc-url $RPC_URL --broadcast`
+4. Set TOKEN_ID=0 and RECIPIENT address
+5. Claim: `forge script script/Claim.s.sol --rpc-url $RPC_URL --broadcast`
diff --git a/foundry.lock b/foundry.lock
@@ -4,5 +4,11 @@
       "name": "v1.10.0",
       "rev": "8bbcf6e3f8f62f419e5429a0bd89331c85c37824"
     }
+  },
+  "lib/openzeppelin-contracts": {
+    "tag": {
+      "name": "v5.4.0",
+      "rev": "c64a1edb67b6e3f4a15cca8909c9482ad33a02b0"
+    }
   }
 }
diff --git a/lib/openzeppelin-contracts b/lib/openzeppelin-contracts
@@ -0,0 +1 @@
+Subproject commit c64a1edb67b6e3f4a15cca8909c9482ad33a02b0
diff --git a/remappings.txt b/remappings.txt
@@ -0,0 +1 @@
+@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/
diff --git a/script/Claim.s.sol b/script/Claim.s.sol
@@ -0,0 +1,28 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.28;
+
+import {Script, console} from "forge-std/Script.sol";
+import {Agent} from "../src/Agent.sol";
+
+contract ClaimScript is Script {
+    function run() external {
+        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+        address agentAddress = vm.envAddress("AGENT_ADDRESS");
+        uint256 tokenId = vm.envUint("TOKEN_ID");
+        address recipient = vm.envAddress("RECIPIENT");
+
+        vm.startBroadcast(deployerPrivateKey);
+
+        Agent agent = Agent(agentAddress);
+
+        console.log("Token owner before claim:", agent.ownerOf(tokenId));
+        console.log("Claiming token", tokenId, "to:", recipient);
+
+        agent.claim(recipient, tokenId);
+
+        console.log("Token owner after claim:", agent.ownerOf(tokenId));
+        console.log("Claim successful!");
+
+        vm.stopBroadcast();
+    }
+}
diff --git a/script/Counter.s.sol b/script/Counter.s.sol
diff --git a/script/Deploy.s.sol b/script/Deploy.s.sol
@@ -0,0 +1,20 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.28;
+
+import {Script, console} from "forge-std/Script.sol";
+import {Agent} from "../src/Agent.sol";
+
+contract DeployScript is Script {
+    function run() external {
+        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+
+        vm.startBroadcast(deployerPrivateKey);
+
+        Agent agent = new Agent();
+
+        console.log("Agent deployed to:", address(agent));
+        console.log("Owner:", agent.owner());
+
+        vm.stopBroadcast();
+    }
+}
diff --git a/script/Mint.s.sol b/script/Mint.s.sol
@@ -0,0 +1,35 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.28;
+
+import {Script, console} from "forge-std/Script.sol";
+import {Agent} from "../src/Agent.sol";
+import {AgentData} from "../src/structs.sol";
+
+contract MintScript is Script {
+    function run() external {
+        uint256 deployerPrivateKey = vm.envUint("PRIVATE_KEY");
+        address agentAddress = vm.envAddress("AGENT_ADDRESS");
+
+        vm.startBroadcast(deployerPrivateKey);
+
+        Agent agent = Agent(agentAddress);
+
+        AgentData memory sampleAgent = AgentData({
+            name: "Sample Agent",
+            slug: "sample-agent",
+            description: "A sample agent",
+            githubRepoUri: "https://github.com/example/sample-agent",
+            commitHash: "abc123def456",
+            version: "1.0.0"
+        });
+
+        agent.mint(sampleAgent);
+
+        uint256 tokenId = agent.nextTokenId() - 1;
+        console.log("Minted token ID:", tokenId);
+        console.log("Token owner:", agent.ownerOf(tokenId));
+        console.log("Agent name:", sampleAgent.name);
+
+        vm.stopBroadcast();
+    }
+}
diff --git a/src/Agent.sol b/src/Agent.sol
@@ -0,0 +1,74 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.28;
+
+import {Ownable} from "@openzeppelin/contracts/access/Ownable.sol";
+import {ERC721} from "@openzeppelin/contracts/token/ERC721/ERC721.sol";
+import {AgentData} from "./structs.sol";
+import {IAgentNFT} from "./interfaces/IAgentNFT.sol";
+
+contract Agent is Ownable, ERC721, IAgentNFT {
+    uint256 public nextTokenId;
+    string public baseTokenUri;
+
+    mapping(uint256 => AgentData) public agentData;
+
+    constructor() ERC721("Sentic Agent", "AGNT") Ownable(msg.sender) {}
+
+    /**
+     * @notice Admin minting function - mints to contract.
+     * @param _agentData User-defined agent data.
+     */
+    function mint(AgentData memory _agentData) external onlyOwner {
+        uint256 tokenId = nextTokenId++;
+        _mint(address(this), tokenId);
+        agentData[tokenId] = _agentData;
+        emit AgentCreated(tokenId);
+    }
+
+    /**
+     * @notice Admin assigns token to recipient.
+     * @param recipient The address to receive the Agent NFT.
+     * @param tokenId The token ID to assign.
+     */
+    function claim(address recipient, uint256 tokenId) external onlyOwner {
+        require(ownerOf(tokenId) == address(this), "Token not held by contract");
+        _transfer(address(this), recipient, tokenId);
+    }
+
+    // /**
+    //  * @notice Update the agent data for a specific token ID.
+    //  * @param tokenId The token ID to update.
+    //  * @param _agentData The new agent data to set.
+    //  */
+    // function updateAgentData(uint256 tokenId, AgentData memory _agentData) external {
+    //     require(ownerOf(tokenId) == msg.sender, "Only agent owner can update agent data");
+    //     agentData[tokenId] = _agentData;
+    //     emit AgentUpdated(tokenId);
+    // }
+
+    /**
+     * @notice Set the base URI for tokenURI.
+     * @param baseUri The base URI to set.
+     */
+    function setBaseUri(string memory baseUri) public onlyOwner {
+        baseTokenUri = baseUri;
+    }
+
+    /**
+     * @notice Standard getter for user-controlled agent data.
+     * @param tokenId The token ID to retrieve agent data for.
+     */
+    function getAgentData(uint256 tokenId) external view override returns (AgentData memory) {
+        require(ownerOf(tokenId) != address(0), "Token does not exist");
+        AgentData memory data = agentData[tokenId];
+        return data;
+    }
+
+    /**
+     * @notice Internal override returning the base URI for tokenURI.
+     *         tokenURI = baseURI + tokenId
+     */
+    function _baseURI() internal view virtual override returns (string memory) {
+        return baseTokenUri;
+    }
+}
diff --git a/src/Counter.sol b/src/Counter.sol
diff --git a/src/interfaces/IAgentNFT.sol b/src/interfaces/IAgentNFT.sol
@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import {IERC721} from "@openzeppelin/contracts/token/ERC721/IERC721.sol";
+import {AgentData} from "../structs.sol";
+
+interface IAgentNFT is IERC721 {
+    function getAgentData(uint256 tokenId) external view returns (AgentData memory);
+
+    event AgentCreated(uint256 indexed tokenId);
+}
diff --git a/src/structs.sol b/src/structs.sol
@@ -0,0 +1,11 @@
+// SPDX-License-Identifier: MIT
+pragma solidity ^0.8.28;
+
+struct AgentData {
+    string name;
+    string slug;
+    string description;
+    string githubRepoUri;
+    string commitHash;
+    string version;
+}
diff --git a/test/Agent.t.sol b/test/Agent.t.sol
diff --git a/test/Counter.t.sol b/test/Counter.t.sol

Original file line number	Diff line number	Diff line change
`@@ -4,5 +4,11 @@`
`4`	`4`	`"name": "v1.10.0",`
`5`	`5`	`"rev": "8bbcf6e3f8f62f419e5429a0bd89331c85c37824"`
`6`	`6`	`}`
	`7`	`+ },`
	`8`	`+ "lib/openzeppelin-contracts": {`
	`9`	`+ "tag": {`
	`10`	`+ "name": "v5.4.0",`
	`11`	`+ "rev": "c64a1edb67b6e3f4a15cca8909c9482ad33a02b0"`
	`12`	`+ }`
`7`	`13`	`}`
`8`	`14`	`}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+@openzeppelin/contracts/=lib/openzeppelin-contracts/contracts/`