WIP - New contracts and contracts-sdk packages

package.json

@@ -85,6 +85,7 @@
     "@glazed/devtools": "^0.2.0",
     "@google-cloud/storage": "^6.7.0",
     "@jest/types": "^29.0.3",
+    "@layerzerolabs/lz-evm-oapp-v2": "^2.3.33",
     "@nomicfoundation/hardhat-chai-matchers": "^2.0.0",
     "@nomicfoundation/hardhat-ethers": "^3.0.0",
     "@nomicfoundation/hardhat-network-helpers": "^1.0.0",

packages/contracts-old/.env-sample

@@ -0,0 +1 @@
+MNEMONIC = 

packages/contracts-old/.gitignore

@@ -0,0 +1,14 @@
+node_modules
+.env
+
+# Hardhat files
+/cache
+/artifacts
+
+# TypeChain files
+/typechain
+/typechain-types
+
+# solidity-coverage files
+/coverage
+/coverage.json

packages/contracts-old/DEPLOYMENTS.md

@@ -0,0 +1,23 @@
+# Contract Deployment Addresses
+
+You can check for any contract associated w/ snickerdoodle.com at [erc7529.snickerdoodle.com](https://erc7529.snickerdoodle.com/).
+
+## `snickerdoodlelabs/devchain:0.1.2`
+
+Local blockchain created by running the `snickerdoodlelabs/devchain` docker image with the `dev` flag enabled.
+
+- Protocol Token:  `0x9fE46736679d2D9a65F0992F2272dE9f3c7fa6e0`
+- Consent Contract Implementation: `0x5FbDB2315678afecb367f032d93F642f64180aa3`
+- Consent Factory: `0xDc64a140Aa3E981100a9becA4E685f962f0cF6C9`
+- Questionnaires Contract: `0x0165878A594ca255338adfa4d48449f69242Eb8F`
+
+## Fuji Network
+
+Official Avalanche Testnet:
+
+- Protocol Token: `0x73F4391c2669f79F15480d3e2Bb22e0792c682bE`
+- Consent Contract Implementation: `0xF6E4d9fA6d35bf45AF9DaDb4931B7499B9De04fC`
+- Consent Factory: `0x5b6c961538E65b6EaCaf09Ec8E93D5f5f1d1afcC`
+- Questionnaires Contract: `0x692F3657c24B91Cb8516b9622b1F271E03cBcEC9`
+- Timelock Controller: `TBD`
+- Governor Contract: `TBD`

packages/contracts-old/Dockerfile

@@ -0,0 +1,16 @@
+FROM node:18-slim
+
+# we need tmux for background sessions and curl for fetching avalanche tools
+RUN apt update -y \
+  && apt install -y vim tmux curl git
+
+WORKDIR /root
+
+# copy the contracts package into the working directory
+COPY . .
+
+# install contracts package dependencies
+RUN npm install
+RUN npm install -D @nomicfoundation/hardhat-toolbox solidity-coverage dotenv
+
+ENTRYPOINT [ "/bin/bash", "entrypoint.sh" ]

packages/contracts-old/README.md

@@ -0,0 +1,75 @@
+![Contracts](https://github.com/SnickerdoodleLabs/Snickerdoodle-Theme-Light/blob/main/snickerdoodle_horizontal_notab.png?raw=true)
+
+# Snickerdoodle Protocol Contracts Package
+
+## Package Contents
+
+- [contracts](/packages/contracts/contracts/): Subdirectory containing all Snickerdoodle Protocol smart contracts
+- [docs](/packages/contracts/docs/): Auto-generated API documentation of public and external contract methods
+- [scripts](/packages/contracts/scripts/): Hardhat [scripts](https://hardhat.org/guides/scripts.html) for deploying different configurations of the smart contract stack
+- [subnets](/packages/contracts/subnets/): A subdirectory containing configurations for launching local, testnet, and mainnet [Avalanche Subnets](https://docs.avax.network/subnets)
+- [tasks](/packages/contracts/tasks/): Hardhat [task definitions](https://hardhat.org/guides/create-task.html) for interacting with smart contract deployments
+- [test](/packages/contracts/test/): Hardhat [unit tests](https://hardhat.org/guides/waffle-testing.html) for the Snickerdoodle Protocol smart contract stack
+- [hardhat.config.js](/packages/contracts/hardhat.config.js): [Configuration file](https://hardhat.org/config/) for the Hardhat development framework
+
+## Summary
+
+The Snickerdoodle Contracts stack consists of the following primary components:
+
+### [consent](/packages/contracts/contracts/consent/README.md)
+
+Contains an upgradable EIP721 compatible NFT implementation and an associated contract factory.
+
+### [token](/packages/contracts/contracts/token/README.md)
+
+Contains an EIP20 compatible token, wrapper token (for subnet deployments), and a vesting contract.
+
+### [registry](/packages/contracts/contracts/registry/README.md)
+
+Contains an EIP721 compatible registry contract for storing Snickerdoodle account recovery details.
+
+### [governance](/packages/contracts/contracts/governance/README.md)
+
+Contains the implementation of the Snickerdoodle Protocol governance DAO.
+
+### Install Dependencies
+
+Steps to install and run this project this locally:
+
+```shell
+git clone https://github.com/SnickerdoodleLabs/protocol.git
+cd protocol
+yarn install
+```
+
+### Compiling Contracts
+
+Use Hardhat to compile the protocol contracts like this:
+
+```shell
+cd /packages/contracts
+yarn compile
+yarn test
+```
+
+This command will create a subdirectory called `artifacts` which will contain the contract [ABI](https://docs.soliditylang.org/en/v0.8.13/abi-spec.html) and bytecode for all contracts in the `contracts` subdirectory.
+
+### Docker
+
+A pre-built docker image for local development against the contract stack is available at
+[`snickerdoodlelabs/devchain`](https://hub.docker.com/repository/docker/snickerdoodlelabs/devchain).
+Run a local subnet like this:
+
+```shell
+docker run -d -p 8545:8545 --rm snickerdoodlelabs/devchain
+```
+
+Run a [Hardhat node](https://hardhat.org/hardhat-network/docs/overview) like this:
+
+```shell
+docker run -d -p 8569:8569 --name devchain --rm --env NETWORK=dev snickerdoodlelabs/devchain
+```
+
+## Deployment Addresses
+
+A list of Snickerdoodle Protocol contract addresses can be found [here](/packages/contracts/DEPLOYMENTS.md).

packages/contracts-old/contracts/governance/SnickerdoodleGovernor.sol

@@ -0,0 +1,127 @@
+// SPDX-License-Identifier: MIT
+// Compatible with OpenZeppelin Contracts ^5.0.0
+pragma solidity ^0.8.20;
+
+import "@openzeppelin/contracts-upgradeable/governance/GovernorUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/governance/extensions/GovernorSettingsUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/governance/extensions/GovernorCountingSimpleUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/governance/extensions/GovernorStorageUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/governance/extensions/GovernorVotesUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/governance/extensions/GovernorVotesQuorumFractionUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/governance/extensions/GovernorTimelockControlUpgradeable.sol";
+import "@openzeppelin/contracts-upgradeable/proxy/utils/Initializable.sol";
+
+contract SnickerdoodleGovernor is Initializable, GovernorUpgradeable, GovernorSettingsUpgradeable, GovernorCountingSimpleUpgradeable, GovernorStorageUpgradeable, GovernorVotesUpgradeable, GovernorVotesQuorumFractionUpgradeable, GovernorTimelockControlUpgradeable {
+    /// @custom:oz-upgrades-unsafe-allow constructor
+    constructor() {
+        _disableInitializers();
+    }
+
+    function initialize(IVotes _token, TimelockControllerUpgradeable _timelock)
+        initializer public
+    {
+        __Governor_init("SnickerdoodleGovernor");
+        __GovernorSettings_init(7200 /* 1 day */, 50400 /* 1 week */, 0);
+        __GovernorCountingSimple_init();
+        __GovernorStorage_init();
+        __GovernorVotes_init(_token);
+        __GovernorVotesQuorumFraction_init(4);
+        __GovernorTimelockControl_init(_timelock);
+    }
+
+    // The following functions are overrides required by Solidity.
+
+    function votingDelay()
+        public
+        view
+        override(GovernorUpgradeable, GovernorSettingsUpgradeable)
+        returns (uint256)
+    {
+        return super.votingDelay();
+    }
+
+    function votingPeriod()
+        public
+        view
+        override(GovernorUpgradeable, GovernorSettingsUpgradeable)
+        returns (uint256)
+    {
+        return super.votingPeriod();
+    }
+
+    function quorum(uint256 blockNumber)
+        public
+        view
+        override(GovernorUpgradeable, GovernorVotesQuorumFractionUpgradeable)
+        returns (uint256)
+    {
+        return super.quorum(blockNumber);
+    }
+
+    function state(uint256 proposalId)
+        public
+        view
+        override(GovernorUpgradeable, GovernorTimelockControlUpgradeable)
+        returns (ProposalState)
+    {
+        return super.state(proposalId);
+    }
+
+    function proposalNeedsQueuing(uint256 proposalId)
+        public
+        view
+        override(GovernorUpgradeable, GovernorTimelockControlUpgradeable)
+        returns (bool)
+    {
+        return super.proposalNeedsQueuing(proposalId);
+    }
+
+    function proposalThreshold()
+        public
+        view
+        override(GovernorUpgradeable, GovernorSettingsUpgradeable)
+        returns (uint256)
+    {
+        return super.proposalThreshold();
+    }
+
+    function _propose(address[] memory targets, uint256[] memory values, bytes[] memory calldatas, string memory description, address proposer)
+        internal
+        override(GovernorUpgradeable, GovernorStorageUpgradeable)
+        returns (uint256)
+    {
+        return super._propose(targets, values, calldatas, description, proposer);
+    }
+
+    function _queueOperations(uint256 proposalId, address[] memory targets, uint256[] memory values, bytes[] memory calldatas, bytes32 descriptionHash)
+        internal
+        override(GovernorUpgradeable, GovernorTimelockControlUpgradeable)
+        returns (uint48)
+    {
+        return super._queueOperations(proposalId, targets, values, calldatas, descriptionHash);
+    }
+
+    function _executeOperations(uint256 proposalId, address[] memory targets, uint256[] memory values, bytes[] memory calldatas, bytes32 descriptionHash)
+        internal
+        override(GovernorUpgradeable, GovernorTimelockControlUpgradeable)
+    {
+        super._executeOperations(proposalId, targets, values, calldatas, descriptionHash);
+    }
+
+    function _cancel(address[] memory targets, uint256[] memory values, bytes[] memory calldatas, bytes32 descriptionHash)
+        internal
+        override(GovernorUpgradeable, GovernorTimelockControlUpgradeable)
+        returns (uint256)
+    {
+        return super._cancel(targets, values, calldatas, descriptionHash);
+    }
+
+    function _executor()
+        internal
+        view
+        override(GovernorUpgradeable, GovernorTimelockControlUpgradeable)
+        returns (address)
+    {
+        return super._executor();
+    }
+}

packages/contracts-old/entrypoint.sh

@@ -0,0 +1,9 @@
+#!/bin/bash
+
+tmux new -d -s hardhat npx hardhat node
+
+# deploy the scripts to the running instance
+npx hardhat run scripts/deploy-factory-and-consent.cts --network localhost
+
+# keeps main thread of execution from exiting
+tail -f /dev/null

packages/contracts-old/package.json

@@ -0,0 +1,46 @@
+{
+  "name": "@snickerdoodlelabs/contracts",
+  "version": "1.0.1",
+  "description": "Smart contracts for the Snickerdoodle Protocol",
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/SnickerdoodleLabs/SDL-Contracts"
+  },
+  "files": [
+    "contracts/",
+    "artifacts/"
+  ],
+  "scripts": {
+    "compile": "npx hardhat compile",
+    "test": "npx hardhat test",
+    "script": "npx hardhat run",
+    "dockerize": "docker build -t snickerdoodlelabs/devchain:0.1.3 -f Dockerfile --progress=plain .",
+    "docker-push": "docker push snickerdoodlelabs/devchain:0.1.2",
+    "redocgen": "npx hardhat clean && npx hardhat compile && npx hardhat docgen && node scripts/docgenTitleFix.js"
+  },
+  "type": "commonjs",
+  "dependencies": {
+    "@openzeppelin/contracts": "^5.0.2",
+    "@openzeppelin/contracts-upgradeable": "^5.0.2",
+    "@prb/math": "^4.0.2",
+    "@snickerdoodlelabs/erc7529": "workspace:^",
+    "dotenv": "^16.0.1",
+    "fs": "^0.0.1-security",
+    "it-all": "^1.0.6",
+    "solidity-coverage": "^0.7.21",
+    "solidity-docgen": "^0.6.0-beta.16"
+  },
+  "devDependencies": {
+    "@nomicfoundation/hardhat-chai-matchers": "^2.0.0",
+    "@nomicfoundation/hardhat-ethers": "^3.0.0",
+    "@nomicfoundation/hardhat-network-helpers": "^1.0.0",
+    "@nomicfoundation/hardhat-verify": "^2.0.0",
+    "@openzeppelin/hardhat-upgrades": "^3.0.4",
+    "hardhat": "^2.21.0",
+    "hardhat-contract-sizer": "^2.10.0",
+    "hardhat-gas-reporter": "^1.0.10",
+    "ts-node": "^10.8.0",
+    "typescript": "^5.2.2"
+  }
+}

packages/contracts-old/tsconfig.json

@@ -0,0 +1,5 @@
+{
+    "compilerOptions": {
+        "module": "CommonJS"
+    }
+}

packages/contracts-sdk/src-new/debug/constants.ts

@@ -0,0 +1,26 @@
+import {
+  ChainId,
+  EVMPrivateKey,
+  URLString,
+} from "@snickerdoodlelabs/objects";
+import { ethers } from "ethers";
+
+// #region export constants
+export const chainId = ChainId(31337);
+export const providerUrl = URLString("http://localhost:8545");
+
+// This is the private key of the account that A. deployed the contracts and B. has all the token
+// #0xf39Fd6e51aad88F6F4ce6aB8827279cffFb92266
+export const privateKey = EVMPrivateKey(
+  "ac0974bec39a17e36ba4a6b4d238ff944bacb478cbed5efcae784d7bf4f2ff80",
+);
+
+// #0xfE3eEB4ba0FA4BD3b398711AF18908136f5bf430
+export const privateKey1 = EVMPrivateKey(
+  "87f0ccf57f9778b5b2e7b62ceddd9530dd6daa6efef6cd03c986d4cc48e2d62b",
+);
+
+// #0xF0CE81C1832B8eb87179Ee578c360b528BcFB3E8
+export const privateKey2 = EVMPrivateKey(
+  "360389bcb918034edc934cc7896a59b365a2c1769513e55e17974896e0b3a888",
+);

packages/contracts-sdk/src-new/debug/contracts.ts

@@ -0,0 +1,12 @@
+import { ICryptoUtils } from "@snickerdoodlelabs/node-utils";
+import { ethers } from "ethers";
+
+import {} from "@contracts-sdk/debug/constants.js";
+
+export class Contracts {
+  public constructor(
+    protected signer: ethers.Wallet,
+    protected signer1: ethers.Wallet,
+    protected cryptoUtils: ICryptoUtils,
+  ) {}
+}