chore: up

Author: jxom

.github/actions/install-dependencies/action.yml

@@ -0,0 +1,13 @@
+name: "Install dependencies"
+description: "Prepare repository and all dependencies"
+
+runs:
+  using: "composite"
+  steps:
+    - name: Set up foundry
+      uses: foundry-rs/foundry-toolchain@v1
+      with:
+        version: nightly
+
+    - name: Set up Bun
+      uses: oven-sh/setup-bun@v2

.github/workflows/changesets.yml

@@ -0,0 +1,50 @@
+name: Changesets
+on:
+  push:
+    branches: [main]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  verify:
+    name: Verify
+    uses: ./.github/workflows/verify.yml
+    secrets: inherit
+
+  changesets:
+    name: Changesets
+    needs: verify
+    permissions:
+      contents: write
+      id-token: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683
+        with:
+          # This makes Actions fetch all Git history so that Changesets can generate changelogs with the correct commits
+          fetch-depth: 0
+          submodules: 'recursive'
+
+      - name: Install dependencies
+        uses: ./.github/actions/install-dependencies
+
+      - name: PR or publish
+        uses: changesets/action@06245a4e0a36c064a573d4150030f5ec548e4fcc
+        with:
+          title: 'chore: version packages'
+          commit: 'chore: version packages'
+          createGithubReleases: ${{ github.ref == 'refs/heads/main' }}
+          publish: bun changeset:publish
+          version: bun changeset:version
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Publish preview release
+        run: bunx pkg-pr-new publish

.github/workflows/pull-request.yml

@@ -0,0 +1,14 @@
+name: Pull Request
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review]
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+
+jobs:
+  verify:
+    name: Verify
+    uses: ./.github/workflows/verify.yml
+    secrets: inherit

.github/workflows/verify.yml

@@ -0,0 +1,40 @@
+name: Verify
+on:
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  checks:
+    name: Checks
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v4
+        with: 
+          submodules: 'recursive'
+
+      - name: Install dependencies
+        uses: ./.github/actions/install-dependencies
+
+      - name: Check code
+        run: bun check
+
+      - name: Check types
+        run: bun check:types
+
+  test:
+    name: Test Runtime
+    runs-on: ubuntu-latest
+    steps:
+      - name: Clone repository
+        uses: actions/checkout@v4
+        with: 
+          submodules: 'recursive'
+
+      - name: Install dependencies
+        uses: ./.github/actions/install-dependencies
+
+      - name: Run tests
+        run: bun test

README.md

@@ -163,10 +163,9 @@ bun test     # Run tests
 
 ## Community
 
-Check out the following places for more Ox-related content:
+Check out the following places for more content:
 
 - Follow [@wevm_dev](https://x.com/wevm_dev), [@jxom](https://x.com/_jxom), and [@awkweb](https://x.com/awkweb) on Twitter for project updates
-- Join the [discussions on GitHub](https://github.com/wevm/ox/discussions)
 
 ## Support
 

package.json

@@ -6,6 +6,7 @@
 	"scripts": {
 		"build": "zshy --project tsconfig.build.json",
 		"check": "biome check . --write --unsafe",
+		"check:types": "tsc --noEmit",
 		"gen": "forge build --config-path ./contracts/foundry.toml && bun run scripts/generateTypedArtifacts.ts",
 		"test": "bun test src"
 	},

src/Signature.ts

@@ -3,6 +3,17 @@ import * as Constants from './Constants.ts'
 
 const abiCoder = ethers.AbiCoder.defaultAbiCoder()
 
+/**
+ * Verifies a `signature` for a given `address` and `digest`.
+ * 
+ * @deprecated Use `verifyHash` from `viem/actions` instead.
+ * 
+ * @param provider - The ethers.AbstractProvider to use for verification.
+ * @param address - The address of the signer.
+ * @param digest - The digest to verify.
+ * @param signature - The signature to verify.
+ * @returns Whether the signature is valid.
+ */
 export async function verifyHash(
   provider: ethers.AbstractProvider,
   address: string,
@@ -23,6 +34,17 @@ export async function verifyHash(
   return verifyEcdsa(address, digest, signature)
 }
 
+/**
+ * Verifies a `signature` for a given `address` and `message`.
+ * 
+ * @deprecated Use `verifyMessage` from `viem/actions` instead.
+ * 
+ * @param provider - The ethers.AbstractProvider to use for verification.
+ * @param address - The address of the signer.
+ * @param message - The message to verify.
+ * @param signature - The signature to verify.
+ * @returns Whether the signature is valid.
+ */
 export async function verifyMessage(
   provider: ethers.AbstractProvider,
   address: string,
@@ -33,6 +55,19 @@ export async function verifyMessage(
   return verifyHash(provider, address, digest, signature)
 }
 
+/**
+ * Verifies a `signature` for a given `address` and `typedData`.
+ * 
+ * @deprecated Use `verifyTypedData` from `viem/actions` instead.
+ * 
+ * @param provider - The ethers.AbstractProvider to use for verification.
+ * @param address - The address of the signer.
+ * @param domain - The domain of the typed data.
+ * @param types - The types of the typed data.
+ * @param value - The value of the typed data.
+ * @param signature - The signature to verify.
+ * @returns Whether the signature is valid.
+ */
 export async function verifyTypedData(
   provider: ethers.AbstractProvider,
   address: string,

src/VerifyProvider.ts

@@ -26,6 +26,11 @@ export namespace Provider {
   }
 }
 
+/**
+ * Wraps an `ethers.AbstractProvider` with the `VerifyProvider` interface.
+ * 
+ * @deprecated Use `createPublicClient` from `viem` instead.
+ */
 export function wrap<provider extends ethers.AbstractProvider>(
   provider: provider,
 ): Provider<provider> {