hello world example

Author: ceyonur

.devcontainer/Dockerfile

@@ -6,8 +6,3 @@ FROM mcr.microsoft.com/devcontainers/base
 
 COPY --from=avalanchego /avalanchego/build /go/src/github.com/ava-labs/avalanchego/build
 COPY --from=avalanche-cli /avalanche /usr/local/bin/avalanche
-
-COPY --from=foundry /usr/local/bin/forge /usr/local/bin/forge
-COPY --from=foundry /usr/local/bin/cast /usr/local/bin/cast
-COPY --from=foundry /usr/local/bin/anvil /usr/local/bin/anvil
-COPY --from=foundry /usr/local/bin/chisel /usr/local/bin/chisel

README.md

@@ -33,8 +33,6 @@ To get a comprehensive introduction to Precompile-EVM, take the Avalanche Academ
 
 ## How to use
 
-There is an example branch [hello-world-example](https://github.com/ava-labs/precompile-evm/tree/hello-world-example) in this repository. You can check the example branch to see how to register precompiles and test them.
-
 ### 1. Generate Precompile Files
 
 First, you need to create your precompile contract interface in the `contracts` directory and build the ABI. Then you can generate your precompile as such:
@@ -63,6 +61,8 @@ First, create the configuration for your subnet.
 avalanche blockchain create myblockchain --custom --vm $AVALANCHEGO_PLUGIN_PATH/srEXiWaHuhNyGwPUi444Tu47ZEDwxTWrbQiuD7FmgSAQ6X7Dy --genesis ./.devcontainer/genesis-example.json
 ```
 
+Confirm that the new `holamundo/` directory has the appropriate files.
+
 Next, launch the Subnet with your custom VM:
 
 ```bash

contracts/README.md

@@ -111,15 +111,6 @@ Subnet-EVM must activate any precompiles used in the test in the genesis:
 {
   "config": {
     "chainId": 43214,
-    "homesteadBlock": 0,
-    "eip150Block": 0,
-    "eip155Block": 0,
-    "eip158Block": 0,
-    "byzantiumBlock": 0,
-    "constantinopleBlock": 0,
-    "petersburgBlock": 0,
-    "istanbulBlock": 0,
-    "muirGlacierBlock": 0,
     "feeConfig": {
       "gasLimit": 8000000,
       "minBaseFee": 25000000000,

contracts/contracts/.gitkeep

@@ -0,0 +1,19 @@
+//SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "./interfaces/IHelloWorld.sol";
+
+address constant HELLO_WORLD_ADDRESS = 0x0300000000000000000000000000000000000000;
+
+// ExampleHelloWorld shows how the HelloWorld precompile can be used in a smart contract.
+contract ExampleHelloWorld {
+  IHelloWorld helloWorld = IHelloWorld(HELLO_WORLD_ADDRESS);
+
+  function sayHello() public view returns (string memory) {
+    return helloWorld.sayHello();
+  }
+
+  function setGreeting(string calldata greeting) public {
+    helloWorld.setGreeting(greeting);
+  }
+}

contracts/contracts/ExampleHelloWorld.sol

@@ -0,0 +1,13 @@
+// SPDX-License-Identifier: MIT
+
+pragma solidity >=0.8.0;
+import "@avalabs/subnet-evm-contracts/contracts/interfaces/IAllowList.sol";
+
+interface IHelloWorld is IAllowList {
+  event GreetingChanged(address indexed sender, string oldGreeting, string newGreeting);
+  // sayHello returns the stored greeting string
+  function sayHello() external view returns (string calldata result);
+
+  // setGreeting  stores the greeting string
+  function setGreeting(string calldata response) external;
+}

contracts/contracts/interfaces/.gitkeep

@@ -0,0 +1,42 @@
+//SPDX-License-Identifier: MIT
+pragma solidity ^0.8.0;
+
+import "../ExampleHelloWorld.sol";
+import "../interfaces/IHelloWorld.sol";
+import "@avalabs/subnet-evm-contracts/contracts/test/AllowListTest.sol";
+
+contract ExampleHelloWorldTest is AllowListTest {
+  IHelloWorld helloWorld = IHelloWorld(HELLO_WORLD_ADDRESS);
+
+  function step_getDefaultHelloWorld() public {
+    ExampleHelloWorld example = new ExampleHelloWorld();
+    address exampleAddress = address(example);
+
+    assertRole(helloWorld.readAllowList(exampleAddress), AllowList.Role.None);
+    assertEq(example.sayHello(), "Hello World!");
+  }
+
+  function step_doesNotSetGreetingBeforeEnabled() public {
+    ExampleHelloWorld example = new ExampleHelloWorld();
+    address exampleAddress = address(example);
+
+    assertRole(helloWorld.readAllowList(exampleAddress), AllowList.Role.None);
+
+    try example.setGreeting("testing") {
+      assertTrue(false, "setGreeting should fail");
+    } catch {} // TODO should match on an error to make sure that this is failing in the way that's expected
+  }
+
+  function step_setAndGetGreeting() public {
+    ExampleHelloWorld example = new ExampleHelloWorld();
+    address exampleAddress = address(example);
+
+    assertRole(helloWorld.readAllowList(exampleAddress), AllowList.Role.None);
+    helloWorld.setEnabled(exampleAddress);
+    assertRole(helloWorld.readAllowList(exampleAddress), AllowList.Role.Enabled);
+
+    string memory greeting = "testgreeting";
+    example.setGreeting(greeting);
+    assertEq(example.sayHello(), greeting);
+  }
+}