Migrate eth-json-rpc-provider into core monorepo (1/2) (#1737)

## Explanation This is the first of two PRs that will migrate [`eth-json-rpc-provider`](https://github.com/MetaMask/eth-json-rpc-provider) into the core monorepo by following these steps: #1079 (comment). - This PR focuses on migrating the git history of the original package. - `eth-json-rpc-provider` is moved into a temporary directory in core (`merged-packages/`) with git history fully intact. - The second PR will remove the `merged-packages/` directory and integrate `eth-json-rpc-provider` into the `packages/` directory, resolving any issues arising from applying core monorepo linter/compiler/build settings to the newly added package. ## Blocked by - [x] MetaMask/eth-json-rpc-provider#29 ## References - Partially implements #1551 - See MetaMask/eth-json-rpc-provider#28 for preparatory steps taken in original repo. ## Changelog N/A since `@metamask/eth-json-rpc-provider` isn't usable from the monorepo as of this PR. ## Checklist - [x] I've updated the test suite for new or updated code as appropriate - [x] I've updated documentation (JSDoc, Markdown, etc.) for new or updated code as appropriate - [x] I've highlighted breaking changes using the "BREAKING" category above as appropriate --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: Mark Stacey <markjstacey@gmail.com> Co-authored-by: Alex Donesky <alex.donesky@consensys.net> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com> Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: legobeat <109787230+legobeat@users.noreply.github.com> Co-authored-by: legobt <6wbvkn0j@anonaddy.me> Co-authored-by: Maarten Zuidhoorn <maarten@zuidhoorn.com>
MetaMask · Oct 2, 2023 · 10b8f26 · 10b8f26
1 parent 93ac28e
commit 10b8f26
Show file tree

Hide file tree

Showing 39 changed files with 9,264 additions and 0 deletions.
diff --git a/merged-packages/eth-json-rpc-provider/.depcheckrc.json b/merged-packages/eth-json-rpc-provider/.depcheckrc.json
@@ -0,0 +1,10 @@
+{
+  "ignores": [
+    "@lavamoat/allow-scripts",
+    "@metamask/auto-changelog",
+    "@types/*",
+    "prettier-plugin-packagejson",
+    "ts-node",
+    "typedoc"
+  ]
+}
diff --git a/merged-packages/eth-json-rpc-provider/.editorconfig b/merged-packages/eth-json-rpc-provider/.editorconfig
@@ -0,0 +1,9 @@
+root = true
+
+[*]
+indent_style = space
+indent_size = 2
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
diff --git a/merged-packages/eth-json-rpc-provider/.eslintrc.js b/merged-packages/eth-json-rpc-provider/.eslintrc.js
@@ -0,0 +1,135 @@
+module.exports = {
+  root: true,
+  extends: ['@metamask/eslint-config', '@metamask/eslint-config-nodejs'],
+  ignorePatterns: [
+    '!.eslintrc.js',
+    '!jest.config.js',
+    'node_modules',
+    'dist',
+    'docs',
+    'coverage',
+    // 'merged-packages',
+  ],
+  overrides: [
+    {
+      files: ['*.test.{ts,js}', '**/tests/**/*.{ts,js}'],
+      extends: ['@metamask/eslint-config-jest'],
+      rules: {
+        // TODO: Re-enable
+        'import/no-named-as-default-member': 'off',
+        'jest/no-conditional-expect': 'off',
+      },
+    },
+    {
+      // These files are test helpers, not tests. We still use the Jest ESLint
+      // config here to ensure that ESLint expects a test-like environment, but
+      // various rules meant just to apply to tests have been disabled.
+      files: ['**/tests/**/*.{ts,js}', '!*.test.{ts,js}'],
+      rules: {
+        'jest/no-export': 'off',
+        'jest/require-top-level-describe': 'off',
+        'jest/no-if': 'off',
+        'jest/no-test-return-statement': 'off',
+        // TODO: Re-enable this rule; we can accomodate this even in our test helpers
+        'jest/expect-expect': 'off',
+      },
+    },
+    {
+      files: ['*.js'],
+      parserOptions: {
+        sourceType: 'script',
+        ecmaVersion: '2018',
+      },
+    },
+    {
+      files: ['*.ts'],
+      extends: ['@metamask/eslint-config-typescript'],
+      parserOptions: {
+        tsconfigRootDir: __dirname,
+        project: ['./tsconfig.json'],
+      },
+      rules: {
+        // disabled due to incompatibility with Record<string, unknown>
+        // See https://github.com/Microsoft/TypeScript/issues/15300#issuecomment-702872440
+        '@typescript-eslint/consistent-type-definitions': 'off',
+
+        // TODO: auto-fix breaks stuff
+        '@typescript-eslint/promise-function-async': 'off',
+
+        // TODO: re-enble most of these rules
+        '@typescript-eslint/await-thenable': 'warn',
+        '@typescript-eslint/naming-convention': 'off',
+        '@typescript-eslint/no-floating-promises': 'warn',
+        '@typescript-eslint/no-for-in-array': 'warn',
+        '@typescript-eslint/no-loss-of-precision': 'warn',
+        '@typescript-eslint/no-misused-promises': 'warn',
+        '@typescript-eslint/no-unnecessary-type-assertion': 'off',
+        '@typescript-eslint/unbound-method': 'off',
+        '@typescript-eslint/prefer-enum-initializers': 'off',
+        '@typescript-eslint/prefer-nullish-coalescing': 'off',
+        '@typescript-eslint/prefer-optional-chain': 'off',
+        '@typescript-eslint/prefer-reduce-type-parameter': 'off',
+        '@typescript-eslint/restrict-plus-operands': 'warn',
+        '@typescript-eslint/restrict-template-expressions': 'warn',
+        'no-restricted-syntax': 'off',
+        'no-restricted-globals': 'off',
+      },
+    },
+    {
+      files: ['tests/setupAfterEnv/matchers.ts'],
+      parserOptions: {
+        sourceType: 'script',
+      },
+    },
+    {
+      files: ['*.d.ts'],
+      rules: {
+        '@typescript-eslint/naming-convention': 'warn',
+        'import/unambiguous': 'off',
+      },
+    },
+    {
+      files: ['scripts/*.ts'],
+      rules: {
+        // All scripts will have shebangs.
+        'n/shebang': 'off',
+      },
+    },
+  ],
+  rules: {
+    // Left disabled because various properties throughough this repo are snake_case because the
+    // names come from external sources or must comply with standards
+    // e.g. `txreceipt_status`, `signTypedData_v4`, `token_id`
+    camelcase: 'off',
+    'id-length': 'off',
+
+    // TODO: re-enble most of these rules
+    '@typescript-eslint/naming-convention': 'off',
+    'function-paren-newline': 'off',
+    'guard-for-in': 'off',
+    'id-denylist': 'off',
+    'implicit-arrow-linebreak': 'off',
+    'import/no-anonymous-default-export': 'off',
+    'import/no-unassigned-import': 'off',
+    'lines-around-comment': 'off',
+    'n/no-sync': 'off',
+    'no-async-promise-executor': 'off',
+    'no-case-declarations': 'off',
+    'no-invalid-this': 'off',
+    'no-negated-condition': 'off',
+    'no-new': 'off',
+    'no-param-reassign': 'off',
+    'no-restricted-syntax': 'off',
+    radix: 'off',
+    'require-atomic-updates': 'off',
+    'jsdoc/match-description': [
+      'off',
+      { matchDescription: '^[A-Z`\\d_][\\s\\S]*[.?!`>)}]$' },
+    ],
+  },
+  settings: {
+    'import/resolver': {
+      typescript: {},
+    },
+  },
+};
diff --git a/merged-packages/eth-json-rpc-provider/.gitattributes b/merged-packages/eth-json-rpc-provider/.gitattributes
@@ -0,0 +1,8 @@
+* text=auto
+
+yarn.lock linguist-generated=false
+
+# yarn v3
+# See: https://yarnpkg.com/getting-started/qa#which-files-should-be-gitignored
+/.yarn/releases/** binary
+/.yarn/plugins/** binary
diff --git a/merged-packages/eth-json-rpc-provider/.github/CODEOWNERS b/merged-packages/eth-json-rpc-provider/.github/CODEOWNERS
@@ -0,0 +1,4 @@
+# Lines starting with '#' are comments.
+# Each line is a file pattern followed by one or more owners.
+
+*                                    @MetaMask/devs
diff --git a/merged-packages/eth-json-rpc-provider/.github/dependabot.yml b/merged-packages/eth-json-rpc-provider/.github/dependabot.yml
@@ -0,0 +1,15 @@
+# Please see the documentation for all configuration options:
+# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: 'npm'
+    directory: '/'
+    schedule:
+      interval: 'daily'
+      time: '06:00'
+    allow:
+      - dependency-name: '@metamask/*'
+    target-branch: 'main'
+    versioning-strategy: 'increase-if-necessary'
+    open-pull-requests-limit: 10
diff --git a/merged-packages/eth-json-rpc-provider/.github/pull_request_template.md b/merged-packages/eth-json-rpc-provider/.github/pull_request_template.md
@@ -0,0 +1,11 @@
+<!--
+Thanks for your contribution! Take a moment to answer these questions so that reviewers have the information they need to properly understand your changes:
+
+* What is the current state of things and why does it need to change?
+* What is the solution your changes offer and how does it work?
+
+Are there any issues or other links reviewers should consult to understand this pull request better? For instance:
+
+* Fixes #12345
+* See: #67890
+-->
diff --git a/merged-packages/eth-json-rpc-provider/.github/workflows/build-lint-test.yml b/merged-packages/eth-json-rpc-provider/.github/workflows/build-lint-test.yml
@@ -0,0 +1,99 @@
+name: Build, Lint, and Test
+
+on:
+  workflow_call:
+
+jobs:
+  prepare:
+    name: Prepare
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+          cache: 'yarn'
+      - name: Install Yarn dependencies
+        run: yarn --immutable
+
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    needs:
+      - prepare
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+      - run: yarn --immutable --immutable-cache
+      - run: yarn build
+      - name: Require clean working directory
+        shell: bash
+        run: |
+          if ! git diff --exit-code; then
+            echo "Working tree dirty at end of job"
+            exit 1
+          fi
+
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    needs:
+      - prepare
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+      - run: yarn --immutable --immutable-cache
+      - run: yarn lint
+      - name: Validate RC changelog
+        if: ${{ startsWith(github.head_ref, 'release/') }}
+        run: yarn auto-changelog validate --rc
+      - name: Validate changelog
+        if: ${{ !startsWith(github.head_ref, 'release/') }}
+        run: yarn auto-changelog validate
+      - name: Require clean working directory
+        shell: bash
+        run: |
+          if ! git diff --exit-code; then
+            echo "Working tree dirty at end of job"
+            exit 1
+          fi
+
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    needs:
+      - prepare
+    strategy:
+      matrix:
+        node-version: [16.x, 18.x, 20.x]
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: ${{ matrix.node-version }}
+          cache: 'yarn'
+      - run: yarn --immutable --immutable-cache
+      - run: yarn test
+      - name: Require clean working directory
+        shell: bash
+        run: |
+          if ! git diff --exit-code; then
+            echo "Working tree dirty at end of job"
+            exit 1
+          fi
diff --git a/merged-packages/eth-json-rpc-provider/.github/workflows/create-release-pr.yml b/merged-packages/eth-json-rpc-provider/.github/workflows/create-release-pr.yml
@@ -0,0 +1,41 @@
+name: Create Release Pull Request
+
+on:
+  workflow_dispatch:
+    inputs:
+      base-branch:
+        description: 'The base branch for git operations and the pull request.'
+        default: 'main'
+        required: true
+      release-type:
+        description: 'A SemVer version diff, i.e. major, minor, patch, prerelease etc. Mutually exclusive with "release-version".'
+        required: false
+      release-version:
+        description: 'A specific version to bump to. Mutually exclusive with "release-type".'
+        required: false
+
+jobs:
+  create-release-pr:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v3
+        with:
+          # This is to guarantee that the most recent tag is fetched.
+          # This can be configured to a more reasonable value by consumers.
+          fetch-depth: 0
+          # We check out the specified branch, which will be used as the base
+          # branch for all git operations and the release PR.
+          ref: ${{ github.event.inputs.base-branch }}
+      - name: Setup Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+      - uses: MetaMask/action-create-release-pr@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          release-type: ${{ github.event.inputs.release-type }}
+          release-version: ${{ github.event.inputs.release-version }}