chore: documentation, and deploy

Author: 0xJepsen

README.md

@@ -1,66 +1,6 @@
-## Foundry
+## Pluto Onchain Verifier
 
-**Foundry is a blazing fast, portable and modular toolkit for Ethereum application development written in Rust.**
+This is a simple contract that verifies signatures from a given notary.
 
-Foundry consists of:
+The contract is deployed on Base Sepolia at
 
--   **Forge**: Ethereum testing framework (like Truffle, Hardhat and DappTools).
--   **Cast**: Swiss army knife for interacting with EVM smart contracts, sending transactions and getting chain data.
--   **Anvil**: Local Ethereum node, akin to Ganache, Hardhat Network.
--   **Chisel**: Fast, utilitarian, and verbose solidity REPL.
-
-## Documentation
-
-https://book.getfoundry.sh/
-
-## Usage
-
-### Build
-
-```shell
-$ forge build
-```
-
-### Test
-
-```shell
-$ forge test
-```
-
-### Format
-
-```shell
-$ forge fmt
-```
-
-### Gas Snapshots
-
-```shell
-$ forge snapshot
-```
-
-### Anvil
-
-```shell
-$ anvil
-```
-
-### Deploy
-
-```shell
-$ forge script script/Counter.s.sol:CounterScript --rpc-url <your_rpc_url> --private-key <your_private_key>
-```
-
-### Cast
-
-```shell
-$ cast <subcommand>
-```
-
-### Help
-
-```shell
-$ forge --help
-$ anvil --help
-$ cast --help
-```

script/SignatureChecker.s.sol

@@ -2,17 +2,17 @@
 pragma solidity ^0.8.13;
 
 import {Script, console} from "forge-std/Script.sol";
-import {SignatureChecker} from "../src/SignatureChecker.sol";
+import {Verifier} from "../src/Verifier.sol";
 
-contract SignatureCheckerScript is Script {
-    SignatureChecker public signatureChecker;
+contract VerifierScript is Script {
+    Verifier public verifier;
 
     function setUp() public {}
 
     function run() public {
         vm.startBroadcast();
 
-        signatureChecker = new SignatureChecker(0xfdf07A5dCfa7b74f4c28DAb23eaD8B1c43Be801F);
+        verifier = new Verifier(0xfdf07A5dCfa7b74f4c28DAb23eaD8B1c43Be801F);
 
         vm.stopBroadcast();
     }

src/SignatureChecker.sol src/Verifier.solsrc/SignatureChecker.sol renamed to src/Verifier.sol

@@ -3,9 +3,9 @@ pragma solidity ^0.8.20;
 
 import "@openzeppelin/contracts/access/Ownable.sol";
 
-/// @title SignatureChecker
+/// @title Verifier
 /// @notice A contract that verifies signatures
-contract SignatureChecker is Ownable {
+contract Verifier is Ownable {
     /// @notice Mapping of notary addresses to their validity
     mapping(address => bool) public isNotary;
 

test/SignatureChecker.t.sol test/Verifier.t.soltest/SignatureChecker.t.sol renamed to test/Verifier.t.sol

@@ -2,13 +2,13 @@
 pragma solidity ^0.8.13;
 
 import {Test, console} from "forge-std/Test.sol";
-import {SignatureChecker} from "../src/SignatureChecker.sol";
+import {Verifier} from "../src/Verifier.sol";
 
-contract SignatureCheckerTest is Test {
-    SignatureChecker public signatureChecker;
+contract VerifierTest is Test {
+    Verifier public verifier;
 
     function setUp() public {
-        signatureChecker = new SignatureChecker(0xfdf07A5dCfa7b74f4c28DAb23eaD8B1c43Be801F);
+        verifier = new Verifier(0xfdf07A5dCfa7b74f4c28DAb23eaD8B1c43Be801F);
     }
 
     function test_isValidSignature() public {
@@ -22,6 +22,6 @@ contract SignatureCheckerTest is Test {
         bytes32 value = 0x8452c9b9140222b08593a26daa782707297be9f7b3e8281d7b4974769f19afd0;
         bytes32 manifest = 0x7df909980a1642d0370a4a510422201ce525da6b319a7b9e9656771fa7336d5a;
 
-        assertEq(signatureChecker.verifyNotarySignature(digest, v, r, s, signer, manifest, value), true);
+        assertEq(verifier.verifyNotarySignature(digest, v, r, s, signer, manifest, value), true);
     }
 }