chore(build): add artifacts, remove ts conditions

.github/workflows/on-push-to-main.yml

@@ -57,32 +57,33 @@ jobs:
           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
           NODE_AUTH_TOKEN: ${{secrets.NPM_TOKEN }}
 
-  docs:
-    needs: check
-    name: Deploy Docs
-    runs-on: ubuntu-latest
+  # TODO: do we want this?
+  # docs:
+  #   needs: check
+  #   name: Deploy Docs
+  #   runs-on: ubuntu-latest
 
-    permissions:
-      contents: write
-      pages: write
-      id-token: write
+  #   permissions:
+  #     contents: write
+  #     pages: write
+  #     id-token: write
 
-    steps:
-      - uses: actions/checkout@v4
-        with:
-          submodules: recursive
+  #   steps:
+  #     - uses: actions/checkout@v4
+  #       with:
+  #         submodules: recursive
 
-      - name: Install Foundry
-        uses: foundry-rs/foundry-toolchain@v1
-        with:
-          version: nightly
+  #     - name: Install Foundry
+  #       uses: foundry-rs/foundry-toolchain@v1
+  #       with:
+  #         version: nightly
 
-      - name: Build Documentation (mdBook)
-        working-directory: ./packages/evm
-        run: forge doc --build
+  #     - name: Build Documentation (mdBook)
+  #       working-directory: ./packages/evm
+  #       run: forge doc --build
 
-      - name: Publish Documentation
-        uses: JamesIves/github-pages-deploy-action@v4
-        with:
-          folder: ./packages/evm/docs/book
-          token: ${{ secrets.GITHUB_TOKEN }}
+  #     - name: Publish Documentation
+  #       uses: JamesIves/github-pages-deploy-action@v4
+  #       with:
+  #         folder: ./packages/evm/docs/book
+  #         token: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -4,3 +4,4 @@ dist
 coverage
 .cache
 tsconfig.tsbuildinfo
+.DS_Store

README.md

@@ -1,5 +1,14 @@
 # Boost Protocol
 
+- [Boost Protocol](#boost-protocol)
+  - [Overview](#overview)
+  - [How It Works](#how-it-works)
+    - [Boost Creation](#boost-creation)
+    - [Boost Participation](#boost-participation)
+  - [Development](#development)
+    - [Prerequisites](#prerequisites)
+    - [Getting Started](#getting-started)
+
 [![Documentation](https://img.shields.io/badge/documentation-gh--pages-blue)](https://rabbitholegg.github.io/boost-protocol/index.html)
 [![Test Status](https://github.com/rabbitholegg/boost-protocol/actions/workflows/test.yml/badge.svg?branch=main)](https://github.com/rabbitholegg/boost-protocol/actions/workflows/test.yml)
 
@@ -66,3 +75,19 @@ The Boost Protocol is designed to be flexible and customizable, allowing develop
 3. **Submit Proof of Completion**: If the Boost's Action can't be immediately validated on-chain from the Validator contract, the user must submit proof of completion to the Validator. The proof can take many forms, including signatures, merkle proofs, and ZK proofs. The Validator will verify the proof and attest to the user's completion of the Boost.
 
 4. **Claim Incentives**: Once the Validator has confirmed the user has completed the Boost's Action, the user can claim the Incentives. The Incentives can be claimed immediately or over time, depending on the rules defined by the Boost creator. Once claimed, the Incentives are transferred to the user's wallet.
+
+## Development
+
+### Prerequisites
+
+- [Node ~20](https://github.com/nvm-sh/nvm)
+- [PNPM](https://pnpm.io/installation)
+- [Foundry](https://book.getfoundry.sh/getting-started/installation)
+
+### Getting Started
+
+Clone the repository - `git clone https://github.com/rabbitholegg/boost-protocol`
+
+Install dependencies - `pnpm install`. This command will also initialize all submodules required for `evm` package development.
+
+Build packages - `turbo build` or `pnpm build`

packages/evm/.gitignore

@@ -17,4 +17,4 @@ docs/
 # Dotenv file
 .env
 
-sdk/
+sdk/

packages/evm/artifacts/@openzeppelin/contracts/interfaces/IERC1271.sol/IERC1271.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/IERC1155Errors.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/IERC20Errors.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/interfaces/draft-IERC6093.sol/IERC721Errors.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/token/ERC1155/ERC1155.sol/ERC1155.d.ts

@@ -434,12 +434,25 @@ export interface ERC1155$Type {
 }
 
 declare module "@nomicfoundation/hardhat-viem/types" {
+  export function deployContract(
+    contractName: "ERC1155",
+    constructorArgs?: [],
+    config?: DeployContractConfig
+  ): Promise<GetContractReturnType<ERC1155$Type["abi"]>>;
   export function deployContract(
     contractName: "@openzeppelin/contracts/token/ERC1155/ERC1155.sol:ERC1155",
     constructorArgs?: [],
     config?: DeployContractConfig
   ): Promise<GetContractReturnType<ERC1155$Type["abi"]>>;
 
+  export function sendDeploymentTransaction(
+    contractName: "ERC1155",
+    constructorArgs?: [],
+    config?: SendDeploymentTransactionConfig
+  ): Promise<{
+    contract: GetContractReturnType<ERC1155$Type["abi"]>;
+    deploymentTransaction: GetTransactionReturnType;
+  }>;
   export function sendDeploymentTransaction(
     contractName: "@openzeppelin/contracts/token/ERC1155/ERC1155.sol:ERC1155",
     constructorArgs?: [],
@@ -449,6 +462,11 @@ declare module "@nomicfoundation/hardhat-viem/types" {
     deploymentTransaction: GetTransactionReturnType;
   }>;
 
+  export function getContractAt(
+    contractName: "ERC1155",
+    address: Address,
+    config?: GetContractAtConfig
+  ): Promise<GetContractReturnType<ERC1155$Type["abi"]>>;
   export function getContractAt(
     contractName: "@openzeppelin/contracts/token/ERC1155/ERC1155.sol:ERC1155",
     address: Address,

packages/evm/artifacts/@openzeppelin/contracts/token/ERC1155/ERC1155.sol/ERC1155.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/token/ERC1155/IERC1155.sol/IERC1155.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/token/ERC1155/IERC1155Receiver.sol/IERC1155Receiver.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/token/ERC1155/extensions/IERC1155MetadataURI.sol/IERC1155MetadataURI.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/token/ERC1155/utils/ERC1155Utils.sol/ERC1155Utils.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/utils/Arrays.sol/Arrays.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/utils/Context.sol/Context.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/utils/Panic.sol/Panic.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/utils/SlotDerivation.sol/SlotDerivation.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/utils/StorageSlot.sol/StorageSlot.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/utils/introspection/ERC165.sol/ERC165.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/utils/introspection/IERC165.sol/IERC165.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/utils/math/Math.sol/Math.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@openzeppelin/contracts/utils/math/SafeCast.sol/SafeCast.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/accounts/Receiver.sol/Receiver.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/auth/Ownable.sol/Ownable.d.ts

@@ -164,12 +164,25 @@ export interface Ownable$Type {
 }
 
 declare module "@nomicfoundation/hardhat-viem/types" {
+  export function deployContract(
+    contractName: "Ownable",
+    constructorArgs?: [],
+    config?: DeployContractConfig
+  ): Promise<GetContractReturnType<Ownable$Type["abi"]>>;
   export function deployContract(
     contractName: "@solady/auth/Ownable.sol:Ownable",
     constructorArgs?: [],
     config?: DeployContractConfig
   ): Promise<GetContractReturnType<Ownable$Type["abi"]>>;
 
+  export function sendDeploymentTransaction(
+    contractName: "Ownable",
+    constructorArgs?: [],
+    config?: SendDeploymentTransactionConfig
+  ): Promise<{
+    contract: GetContractReturnType<Ownable$Type["abi"]>;
+    deploymentTransaction: GetTransactionReturnType;
+  }>;
   export function sendDeploymentTransaction(
     contractName: "@solady/auth/Ownable.sol:Ownable",
     constructorArgs?: [],
@@ -179,6 +192,11 @@ declare module "@nomicfoundation/hardhat-viem/types" {
     deploymentTransaction: GetTransactionReturnType;
   }>;
 
+  export function getContractAt(
+    contractName: "Ownable",
+    address: Address,
+    config?: GetContractAtConfig
+  ): Promise<GetContractReturnType<Ownable$Type["abi"]>>;
   export function getContractAt(
     contractName: "@solady/auth/Ownable.sol:Ownable",
     address: Address,

packages/evm/artifacts/@solady/auth/Ownable.sol/Ownable.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/auth/OwnableRoles.sol/OwnableRoles.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/tokens/ERC20.sol/ERC20.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/tokens/ERC721.sol/ERC721.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/utils/Initializable.sol/Initializable.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/utils/LibClone.sol/LibClone.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/utils/LibPRNG.sol/LibPRNG.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/utils/LibString.sol/LibString.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/utils/LibZip.sol/LibZip.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/utils/ReentrancyGuard.sol/ReentrancyGuard.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/utils/SafeTransferLib.sol/SafeTransferLib.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/@solady/utils/SignatureCheckerLib.sol/SignatureCheckerLib.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/contracts/BoostCore.sol/BoostCore.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/contracts/BoostRegistry.sol/BoostRegistry.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/contracts/actions/Action.sol/Action.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/contracts/actions/ContractAction.sol/ContractAction.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }

packages/evm/artifacts/contracts/actions/ERC721MintAction.sol/ERC721MintAction.dbg.json

@@ -1,4 +1,4 @@
 {
   "_format": "hh-sol-dbg-1",
-  "buildInfo": "../../../build-info/77c946d6b220784dccfddb6cde255b9d.json"
+  "buildInfo": "../../../build-info/0ab469e910ae3035995ca09344e77bdd.json"
 }