Protocol testnet #16

motechFR · 2024-11-01T20:00:36Z

No description provided.

…assigned

motechFR · 2024-11-11T18:12:56Z

__test__/contracts/Protocol/MemoryUtils/read.spec.ts

+describe('returns', function () {
+  let testMemoryUtils: Awaited<ReturnType<typeof deployTestMemoryUtils>>['testMemoryUtilsContract'];
+
+  beforeAll(async () => {
+    testMemoryUtils = (await deployTestMemoryUtils()).testMemoryUtilsContract;
+  });


This test suite is critical to ensure future updates do not change memory locations.

It ensures we don't lock ourselves out of an admin slot for example

motechFR · 2024-11-11T18:21:10Z

__test__/deployBuilderNft.ts

@@ -7,17 +7,21 @@ import { generateWallets } from './generateWallets';
 export async function deployBuilderNftContract({ USDCContractAddress }: { USDCContractAddress?: Address } = {}) {
  const { adminAccount: admin, thirdUserAccount: proceedsReceiverAccount } = await generateWallets();

-  const implementation = await viem.deployContract('BuilderNFTSeasonOneImplementation01');
+  const implementation = await viem.deployContract('BuilderNFTSeasonOneImplementation01', [], {
+    client: { wallet: admin }


Fixed deploys to use a specific wallet as the client, and not use default viem data

motechFR · 2024-11-11T18:21:40Z

__test__/deployEAS.ts

+import type { GeneratedWallet } from './generateWallets';
+import { generateWallets } from './generateWallets';
+
+export async function deployEASContracts() {


Generates EAS Resolver, and deploys both our schemas

motechFR · 2024-11-11T18:22:26Z

__test__/deployScoutTokenERC20.ts

+
+  const decimalMultiplier = 10n ** decimals;
+
+  async function mintTo({ account, amount }: { account: string; amount: number }) {


Utility methods for using the ERC20 more easily

motechFR · 2024-11-11T18:32:12Z

__test__/generateWallets.ts

+  initialEthBalance?: number;
+};
+
+export async function generateWallets({ initialEthBalance = 1 }: GeneratedWalletConfig = { initialEthBalance: 1 }) {


I discovered we weren't initialising contracts with wallets, but the default wallet with viem, which is why it automagically worked.

this fixes generate wallets so we for sure always get different wallets

motechFR · 2024-11-11T18:34:44Z

contracts/FiatTokenV2_2/contracts/util/SignatureCheckerFiatProxy.sol

@@ -25,9 +25,9 @@ import { IERC1271 } from "../interface/IERC1271.sol";
 * @dev Signature verification helper that can be used instead of `ECRecover.recover` to seamlessly support both ECDSA
 * signatures from externally owned accounts (EOAs) as well as ERC1271 signatures from smart contract wallets.
 *
- * Adapted from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/21bb89ef5bfc789b9333eb05e3ba2b7b284ac77c/contracts/utils/cryptography/SignatureChecker.sol
+ * Adapted from https://github.com/OpenZeppelin/openzeppelin-contracts/blob/21bb89ef5bfc789b9333eb05e3ba2b7b284ac77c/contracts/utils/cryptography/SignatureCheckerFiatProxy.sol


There was a conflict with another SignatureChecker from EAS libs, so renamed this to avoid issues (This one compiles with 0.6.x whereas EAS compiles with 0.8.27)

motechFR · 2024-11-11T18:35:25Z

contracts/protocol/libs/MemoryUtils.sol

+
+import "@openzeppelin/contracts/utils/StorageSlot.sol";
+
+library MemoryUtils {


Using a single core memory library with namespacing. This makes it easier to reason about every storage slot used across our contracts

motechFR · 2024-11-11T18:35:53Z

contracts/protocol/test/TestMemory.sol

+import "../libs/ProtocolAccessControl.sol";
+import "../libs/MemoryUtils.sol";
+
+contract TestMemoryUtils {


Memory Utils has everything internal

This allows us to access those internals and make them testable

motechFR · 2024-11-11T18:45:26Z

contracts/protocol/libs/ProtocolAccessControl.sol

+    function _setRole(bytes32 role, address account) internal {
+      require(account != address(0), "Invalid account. Cannot be empty");
+
+      address _currentHolder = _roleHolder(role);
+
+      // Update the role only if it's different
+      if (_currentHolder != account) {
+          MemoryUtils._setAddress(role, account);
+          emit RoleTransferred(MemoryUtils._getRoleName(role), _currentHolder, account);
+      }
+    }


Standard behaviour for granting roles.

RoleTransferred provides inbuilt auditability for all our role changes

motechFR · 2024-11-11T18:46:13Z

lib/connectors.ts

+  scoutgameEASResolver?: Address | null;
+  scoutgameErc20TokenDev?: Address | null;
+  scoutgameScoutProtocolProxyDev?: Address | null;


These are the 3 main keys

I've been considering refactoring these under a dev | prod key with same type to avoid duplication of keys

motechFR · 2024-11-11T18:46:51Z

scripts/deploy/deployBuilderNft.ts

@@ -1,41 +1,48 @@
-import dotenv from 'dotenv';
+import { execSync } from 'node:child_process';


ESLint across this file

motechFR · 2024-11-11T18:49:06Z

scripts/deploy/deployEASSchemas.ts

+  const easRegistryContract = await viem.getContractAt('ISchemaRegistry', easSchemaRegistryAddress);
+
+  console.log('Deploying the resolver contract...');
+  const deployedResolver = await viem.deployContract(


Cleaned up deploy script, viem has inbuilt encoding of deploy data and resolution of the ABI

No more need to path.resolve the ABI

motechFR · 2024-11-11T18:49:48Z

scripts/deploy/deployScoutGameErc20.ts

+  process.env.PRIVATE_KEY?.startsWith('0x') ? process.env.PRIVATE_KEY : `0x${process.env.PRIVATE_KEY}`
+) as `0x${string}`;
+
+task('deployScoutGameERC20', 'Deploys or updates the BuilderNFTSeasonOne contracts').setAction(


TODO: We should add an initialise() method or something similar in the ERC20 so that we don't have ability to mint new tokens from thin air

motechFR · 2024-11-11T18:50:25Z

scripts/deploy/deployScoutProtocol.ts

+  process.env.PRIVATE_KEY?.startsWith('0x') ? process.env.PRIVATE_KEY : `0x${process.env.PRIVATE_KEY}`
+) as `0x${string}`;
+
+task('deployScoutProtocol', 'Deploys or updates the ScoutProtocol contracts').setAction(async (taskArgs, hre) => {


Same as buildernft

Deploy a new implementation

Point a proxy to it, or also deploy a new proxy

motechFR · 2024-11-11T18:50:41Z

scripts/interact/builderNftApp.ts

 import fs from 'fs';
+import path from 'path';


motechFR · 2024-11-11T18:51:32Z

contracts/protocol/ProtocolEASResolver.sol

+        return true;
+    }
+
+    function setAttesterWallet(address _attesterWallet) external onlyAdmin {


Role slots defined in Memory utils

Setters for roles other than admin or pauser defined in Contract that uses this role

motechFR · 2024-11-11T18:52:28Z

contracts/protocol/ProtocolEASResolver.sol

+    }
+
+    function setAttesterWallet(address _attesterWallet) external onlyAdmin {
+      _setRole(MemoryUtils.EAS_ATTESTER_SLOT, _attesterWallet);


This is all we need to do.

EASResolver simply asserts access controls on the role assignment

We can then benefit from the standard method which has inbuilt event emissions

motechFR · 2024-11-11T18:53:10Z

contracts/protocol/ProtocolImplementation.sol

+
+    // Allow the sender to claim their balance as ERC20 tokens
+    function claim(
+        string memory week,


Keep the protocol simple by only giving it the notion of weeks

Seasons are managed by the caller

motechFR · 2024-11-11T18:54:52Z

contracts/protocol/ProtocolImplementation.sol

+    }
+
+    // Function to set the Merkle root for a given week
+    function setMerkleRoot(string memory week, bytes32 merkleRoot) external onlyAdminOrClaimManager onlyWhenNotPaused {


TODO: We'll want to implement the claiming mechanism towards the vesting contract

We could do that here, but it then attaches this method and prevents us re-running manually

I suggest a claimScoutAllocation method defined separately

motechFR · 2024-11-11T18:56:30Z

contracts/protocol/ProtocolImplementation.sol

+
+    // Function to get the Merkle root hash for a given week
+    function getMerkleRoot(string memory week) public view returns (bytes32) {
+        bytes32 slot = keccak256(abi.encodePacked(week, MemoryUtils.MERKLE_ROOTS_SLOT));


We should probably refactor this to a getWeekSlot() method

Also, need to double check how many slots are available in Solidity so we don't hit that max a few years down the line

motechFR · 2024-11-11T18:57:20Z

contracts/protocol/ScoutProtocolProxy.sol

+import "./libs/ProtocolAccessControl.sol";
+import "./libs/MemoryUtils.sol";
+
+contract ScoutProtocolProxy is Context, ProtocolAccessControl {


Super lightweight proxy

motechFR · 2024-11-11T19:02:38Z

contracts/protocol/ProtocolEASResolver.sol

+        Attestation calldata attestation,
+        uint256 /*value*/
+    ) internal override returns (bool) {
+        require(attestation.attester == attester() || attestation.attester == secondaryAttester(), "Invalid attester");


Super lightweight validation on the attester only.

Since we control the attester, we can handle validation before it attest

motechFR · 2024-11-11T19:04:16Z

contracts/protocol/ProtocolImplementation.sol

+        ScoutTokenERC20 token = _getToken();
+
+        // Transfer tokens to the user
+        token.transfer(msg.sender, amount * (10 ** token.decimals()));


For easier reasoning, we pass the amount as integers across systems

We only need to wei-ify amounts in the contract

motechFR added 30 commits November 1, 2024 12:28

Add erc20 deploy code

70a46f6

Added ERC20 deployment

aea2187

Rename to protocol

4a1c43e

Setup test utils and deploy scripting for the ERC20

979f600

Add test for deploying protocol contract

fce57d3

Setup the claiming test suite

5acf349

Setting up the test suite

16bff5f

Successfully test failed merkle validation

5e4878a

Make the tests for the claiming mechanism pass

4f6675c

Update generators to add some balance

b72e76a

Add permissions test

f75c52a

Refactor access control into its own contract

ee9196a

Make sure tests work

15bd811

Add protocol scripts

7184a75

Setup dev contract

e7526c2

Cleanup script and switch tokens

fb95167

Update implementation so that getting a merkle root fails if not yet …

5f8322a

…assigned

Refactor code for access control

75bcc05

Setup EAS test deployments

7b192d3

Cleanup generators

8213a1f

Further cleanup

3ff3963

Bump core

9dd6ed6

Fix write method for EAS Resolver

cc3dcc8

Integrate claiming with merkle tree proofs from core

a233002

Finish up refactoring

6f1aef9

Finish scripting schema deployments

6b396ad

Rename schema

f24e44c

Bump core

d36284c

Fix test timeout fail

653aaf4

Update deployments

d32759b

motechFR added 5 commits November 8, 2024 19:06

Add pausing mechanism

feb2b83

Add pauser role test

3baf543

Add test coverage for memory util storage slots

a6961c9

Deploy ERC20 and mint 200 million tokens to dev and prod protocols

82f7bc3

Add EAS Resolver to the contract connectors

3f90d1c

motechFR commented Nov 11, 2024

View reviewed changes

scripts/interact/builderNftApp.ts

import fs from 'fs';

import path from 'path';

Copy link

Contributor Author

motechFR Nov 11, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ESLint

motechFR commented Nov 11, 2024

View reviewed changes

Cleanup

55fff48

motechFR merged commit 6e9c7e8 into main Nov 12, 2024
1 check passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Protocol testnet #16

Protocol testnet #16

motechFR commented Nov 1, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024 •

edited

Loading

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024

motechFR Nov 11, 2024 •

edited

Loading

motechFR Nov 11, 2024


		const decimalMultiplier = 10n ** decimals;

		async function mintTo({ account, amount }: { account: string; amount: number }) {


		import "@openzeppelin/contracts/utils/StorageSlot.sol";

		library MemoryUtils {

		@@ -1,41 +1,48 @@
		import dotenv from 'dotenv';
		import { execSync } from 'node:child_process';

Protocol testnet #16

Protocol testnet #16

Conversation

motechFR commented Nov 1, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

motechFR Nov 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

motechFR Nov 11, 2024 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

motechFR Nov 11, 2024 •

edited

Loading

motechFR Nov 11, 2024 •

edited

Loading