Fit to template repo

.eslintignore

@@ -0,0 +1 @@
+lib/

.eslintrc.js

@@ -0,0 +1,91 @@
+module.exports = {
+  env: {
+    commonjs: true,
+    es6: true,
+    node: true,
+  },
+  plugins: ['prettier'],
+  extends: [
+    'eslint:recommended',
+    'plugin:prettier/recommended', // Enables eslint-plugin-prettier and displays prettier errors as ESLint errors. Make sure this is always the last configuration in the extends array.
+  ],
+  parserOptions: {
+    ecmaVersion: 2018, // Allows for the parsing of modern ECMAScript features
+    sourceType: 'module', // Allows for the use of imports
+  },
+  rules: {
+    'prettier/prettier': 'error',
+    'no-unused-vars': 'off',
+    'prefer-const': [2, { destructuring: 'all' }],
+    'object-curly-spacing': ['error', 'always'],
+  },
+  overrides: [
+    {
+      // this config is run against test files (same as the one bellow but not limited to `src` folder)
+      files: ['*.ts', '*.tsx'],
+      parser: '@typescript-eslint/parser',
+      extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:prettier/recommended',
+      ],
+      plugins: ['@typescript-eslint', 'prettier'],
+      rules: {
+        'no-empty-pattern': 'warn',
+        'prettier/prettier': ['error', { singleQuote: true }],
+        '@typescript-eslint/member-delimiter-style': ['off'],
+        '@typescript-eslint/no-explicit-any': ['off'],
+        '@typescript-eslint/no-use-before-define': ['off'],
+        '@typescript-eslint/no-non-null-assertion': ['off'],
+        '@typescript-eslint/ban-ts-comment': ['warn'],
+        '@typescript-eslint/no-unused-vars': [
+          'warn',
+          {
+            argsIgnorePattern: '^_',
+            varsIgnorePattern: '^_',
+            caughtErrorsIgnorePattern: '^_',
+          },
+        ],
+        'no-implicit-coercion': 'error',
+      },
+    },
+    {
+      files: ['src/**/*.ts', 'src/**/*.tsx'],
+      parser: '@typescript-eslint/parser',
+      parserOptions: {
+        project: 'tsconfig.json',
+      },
+      extends: [
+        'eslint:recommended',
+        'plugin:@typescript-eslint/recommended',
+        'plugin:prettier/recommended',
+      ],
+      plugins: ['@typescript-eslint', 'prettier', '@typescript-eslint/tslint'],
+      rules: {
+        'no-empty-pattern': 'warn',
+        'prettier/prettier': ['error', { singleQuote: true }],
+        '@typescript-eslint/member-delimiter-style': ['off'],
+        '@typescript-eslint/no-explicit-any': ['off'],
+        '@typescript-eslint/no-use-before-define': ['off'],
+        '@typescript-eslint/no-non-null-assertion': ['off'],
+        '@typescript-eslint/ban-ts-comment': ['warn'],
+        '@typescript-eslint/no-unused-vars': [
+          'warn',
+          {
+            argsIgnorePattern: '^_',
+            varsIgnorePattern: '^_',
+            caughtErrorsIgnorePattern: '^_',
+          },
+        ],
+        '@typescript-eslint/tslint/config': [
+          'error',
+          {
+            rules: { 'strict-comparisons': true },
+          },
+        ],
+        'no-implicit-coercion': 'error',
+        '@typescript-eslint/no-shadow': ['error'],
+      },
+    },
+  ],
+}

.gas-snapshot

@@ -1,18 +1,36 @@
-RewardDistributorTest:testBlockGasLimit() (gas: 22830786)
-RewardDistributorTest:testConstructor() (gas: 533016)
-RewardDistributorTest:testConstructorDoesNotAcceptEmpty() (gas: 69042)
-RewardDistributorTest:testConstructorDoesNotAcceptPastLimit() (gas: 1636148)
-RewardDistributorTest:testDistributeAndUpdateRecipients() (gas: 4276467)
-RewardDistributorTest:testDistributeAndUpdateRecipientsBadPrevious() (gas: 2096822)
-RewardDistributorTest:testDistributeAndUpdateRecipientsNotOwner() (gas: 2099732)
-RewardDistributorTest:testDistributeRewards() (gas: 653269)
-RewardDistributorTest:testDistributeRewardsDoesNotDistributeToEmpty() (gas: 532370)
-RewardDistributorTest:testDistributeRewardsDoesNotDistributeToWrongCount() (gas: 537165)
-RewardDistributorTest:testDistributeRewardsDoesNotDistributeWrongRecipients() (gas: 535861)
-RewardDistributorTest:testDistributeRewardsDoesRefundsOwner() (gas: 937648)
-RewardDistributorTest:testDistributeRewardsFailsForEmptyRD() (gas: 533039)
-RewardDistributorTest:testDistributeRewardsFailsToRefundsOwner() (gas: 662631)
-RewardDistributorTest:testHashAddresses() (gas: 87649)
-RewardDistributorTest:testLowSend() (gas: 658025)
-RewardDistributorTest:testUncheckedInc() (gas: 651)
-RewardDistributorTest:testUpdateDoesNotAcceptInvalidValues() (gas: 1018294)
+ArbChildToParentRewardRouterTest:testSanityCheck() (gas: 257342)
+ArbChildToParentRewardRouterTest:testSendNative(uint64) (runs: 256, μ: 44649, ~: 44780)
+ArbChildToParentRewardRouterTest:testSendToken(uint256) (runs: 256, μ: 99537, ~: 99238)
+ChildToParentRewardRouterTest:testCantRouteTokenTooSoon() (gas: 107176)
+ChildToParentRewardRouterTest:testCantRouteTokensWhenSetToNativeOnly() (gas: 8624)
+ChildToParentRewardRouterTest:testCantrouteNativeFundsTooSoon() (gas: 100623)
+ChildToParentRewardRouterTest:testDistributionUpdate() (gas: 206068)
+ChildToParentRewardRouterTest:testRouteNativeFunds() (gas: 78065)
+ChildToParentRewardRouterTest:testRouteToken() (gas: 79806)
+ChildToParentRewardRouterTest:testZeroAddressConstructorCheck() (gas: 111253)
+OpChildToParentRewardRouterTest:testSanityCheck() (gas: 46295)
+OpChildToParentRewardRouterTest:testSendNative(uint64) (runs: 256, μ: 23548, ~: 23679)
+OpChildToParentRewardRouterTest:testSendToken(uint256) (runs: 256, μ: 93099, ~: 92788)
+ParentToChildRewardRouterTest:testCantRouteTooSoon() (gas: 93093)
+ParentToChildRewardRouterTest:testRevertsWithInsufficientValue() (gas: 37185)
+ParentToChildRewardRouterTest:testrouteNativeFunds() (gas: 89285)
+RewardDistributorTest:testBlockGasLimit() (gas: 69524218)
+RewardDistributorTest:testConstructor() (gas: 1023688)
+RewardDistributorTest:testConstructorDoesNotAcceptEmpty() (gas: 72612)
+RewardDistributorTest:testConstructorDoesNotAcceptPastLimit() (gas: 3124911)
+RewardDistributorTest:testConstructorInputLengthMismatch() (gas: 252338)
+RewardDistributorTest:testDistributeAndUpdateRecipients() (gas: 6231656)
+RewardDistributorTest:testDistributeAndUpdateRecipientsBadPrevious() (gas: 4007775)
+RewardDistributorTest:testDistributeAndUpdateRecipientsNotOwner() (gas: 4018821)
+RewardDistributorTest:testDistributeRewards(uint256) (runs: 256, μ: 1130540, ~: 1130540)
+RewardDistributorTest:testDistributeRewardsDoesNotDistributeToEmpty() (gas: 1011249)
+RewardDistributorTest:testDistributeRewardsDoesNotDistributeToWrongCount() (gas: 1017358)
+RewardDistributorTest:testDistributeRewardsDoesNotDistributeWrongRecipients() (gas: 1015863)
+RewardDistributorTest:testDistributeRewardsDoesNotDistributeWrongWeights() (gas: 1015179)
+RewardDistributorTest:testDistributeRewardsDoesRefundsOwner(uint256) (runs: 256, μ: 2133067, ~: 2133067)
+RewardDistributorTest:testDistributeRewardsFailsToRefundsOwner() (gas: 1144021)
+RewardDistributorTest:testDistributeRewardsInputLengthMismatch() (gas: 1012801)
+RewardDistributorTest:testHashAddresses() (gas: 84052)
+RewardDistributorTest:testLowSend(uint256) (runs: 256, μ: 1252855, ~: 1252855)
+RewardDistributorTest:testUncheckedInc() (gas: 5127)
+RewardDistributorTest:testUpdateDoesNotAcceptInvalidValues() (gas: 2110869)

.github/workflows/audit.yml

@@ -0,0 +1,26 @@
+name: Audit
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  audit:
+    name: Audit
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: stable
+
+      - run: yarn
+      - run: yarn audit:ci

.github/workflows/lint.yml

@@ -0,0 +1,26 @@
+name: Lint
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: stable
+
+      - run: yarn && yarn build
+      - run: yarn lint

.github/workflows/test-e2e.yml

@@ -5,8 +5,9 @@ on:
   workflow_dispatch:
 
 jobs:
-  test-e2e:
-    name: Test E2E with ETH fee L3
+  # Run e2e tests against a local L1 and L2 node
+  l1-l2:
+    name: L1 + L2
     runs-on: ubuntu-latest
     steps:
       - name: Checkout
@@ -15,24 +16,24 @@ jobs:
       - name: Set up Node.js
         uses: actions/setup-node@v4
         with:
-          node-version: 18
+          node-version: 22
 
       - name: Set up the local node
         uses: OffchainLabs/actions/run-nitro-test-node@main
         with:
           nitro-testnode-ref: release
-          l3-node: true
 
       - name: Install Foundry
         uses: foundry-rs/foundry-toolchain@v1
         with:
-          version: nightly
+          version: stable
 
       - run: yarn
       - run: cp .env.example .env && yarn test:e2e
 
-  # test-e2e-custom-fee:
-  #   name: Test E2E with Custom Fee L3
+  # # Run e2e tests against a local L1, L2, and L3 node with ETH fees
+  # l1-l2-l3:
+  #   name: L1 + L2 + L3
   #   runs-on: ubuntu-latest
   #   steps:
   #     - name: Checkout
@@ -41,7 +42,34 @@ jobs:
   #     - name: Set up Node.js
   #       uses: actions/setup-node@v4
   #       with:
-  #         node-version: 18
+  #         node-version: 22
+
+  #     - name: Set up the local node
+  #       uses: OffchainLabs/actions/run-nitro-test-node@main
+  #       with:
+  #         nitro-testnode-ref: release
+  #         l3-node: true
+
+  #     - name: Install Foundry
+  #       uses: foundry-rs/foundry-toolchain@v1
+  #       with:
+  #         version: stable
+
+  #     - run: yarn
+  #     - run: cp .env.example .env && yarn test:e2e
+
+  # # Run e2e tests against a local L1, L2, and L3 node with ERC20 fees
+  # l1-l2-l3-erc20:
+  #   name: L1 + L2 + L3 with ERC20 fees
+  #   runs-on: ubuntu-latest
+  #   steps:
+  #     - name: Checkout
+  #       uses: actions/checkout@v4
+
+  #     - name: Set up Node.js
+  #       uses: actions/setup-node@v4
+  #       with:
+  #         node-version: 22
 
   #     - name: Set up the local node
   #       uses: OffchainLabs/actions/run-nitro-test-node@main
@@ -53,7 +81,7 @@ jobs:
   #     - name: Install Foundry
   #       uses: foundry-rs/foundry-toolchain@v1
   #       with:
-  #         version: nightly
+  #         version: stable
 
   #     - run: yarn
   #     - run: cp .env.example .env && yarn test:e2e

.github/workflows/test-fork.yml

@@ -0,0 +1,26 @@
+name: Test Fork
+
+on:
+  pull_request:
+  workflow_dispatch:
+
+jobs:
+  test-fork:
+    name: Test Fork
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 22
+
+      - name: Install Foundry
+        uses: foundry-rs/foundry-toolchain@v1
+        with:
+          version: stable
+
+      - run: yarn
+      - run: ETH_FORK_URL=${{ secrets.ETH_FORK_URL }} ARB_FORK_URL=${{ secrets.ARB_FORK_URL }} yarn test:fork