Skip to content

Readme #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
signature18632 merged 2 commits into from
Jul 31, 2025
Merged

Readme #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc2ba05
v1.0.6
signature18632 Jul 29, 2025
ac0ac0a
update readme
signature18632 Jul 31, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -51,14 +51,14 @@ packages
├── block-sync-monitor
├── deposit-analyzer
├── indexer
├── indexer-cache-validator
├── indexer-event-watcher
├── indexer-monitor
├── messenger-relayer
├── mint-executor
├── mock-l1-to-l2-relayer
├── mock-l2-to-l1-relayer
├── predicate
├── referral
├── shared
├── token
├── token-map-register
Expand Down Expand Up @@ -86,6 +86,22 @@ docker build -f docker/Dockerfile -t intmax2-function .
docker run --rm -p 3000:3000 --env-file .env intmax2-function workspace token start
```


## Testing

The project uses Vitest for testing. Run tests with the following commands:

```sh
# Run all tests
yarn test

# Run tests in watch mode
yarn test --watch

# Run tests with coverage report
yarn coverage
```

## Redis

```sh
Expand Down
6 changes: 3 additions & 3 deletions package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "intmax2-function",
"version": "1.0.5",
"version": "1.0.6",
"license": "MIT",
"description": "A collection of function for INTMAX",
"description": "A collection of function for INTMAX2 blockchain",
"repository": {
"type": "git",
"url": "https://github.com/InternetMaximalism/intmax2-function.git"
Expand All @@ -18,7 +18,7 @@
"api"
],
"engines": {
"node": ">=18.0.0",
"node": ">=20.0.0",
"yarn": ">=4.0.0"
},
"workspaces": [
Expand Down