chore: run build steps before npm test

[piyushbag]

Summary

• Add pretest script to run build-typechain and build before jest
• Document automatic build behavior in README

Test plan

• Removed dist/ and src/typechain/, then npm test regenerated artifacts via pretest

Summary by CodeRabbit

• Tests
  • npm test now automatically builds required artifacts before running Jest tests.
  • Development documentation now clarifies that integration tests use live contracts through an RPC endpoint and are not run in CI.

[coderabbitai]

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 7e8175c1-22d0-41bf-a624-bf0e8411f2a2

📥 Commits

Reviewing files that changed from the base of the PR and between bae40ad and 0c28511.

📒 Files selected for processing (2)

• README.md
• package.json

---

📝 Walkthrough

Walkthrough

The test workflow now runs typechain generation and project compilation automatically before npm test. The README documents this behavior and clarifies that yarn test runs live-contract integration tests outside CI.

Changes

Test workflow

Layer / File(s)	Summary
Test preparation and documentation package.json, README.md	Adds a pretest script that runs build-typechain and build before Jest, and documents the differing npm test and yarn test behaviors.

Estimated code review effort: 1 (Trivial) | ~3 minutes

Suggested reviewers: michaelsmueller

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name	Status	Explanation	Resolution
Description check	⚠️ Warning	The description includes a summary and test plan, but it omits the required ticket, problem, solution, other notes, and screenshots sections.	Add the template sections, including Type/Ticket, Problem, Solution, and Screenshots, or explain why any optional section is omitted.

✅ Passed checks (4 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title clearly states the main change: adding build steps before npm test.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check	✅ Passed	Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check	✅ Passed	Check skipped because no linked issues were found for this pull request.

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests

Warning

There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands.}