Skip to content
This repository was archived by the owner on Mar 17, 2026. It is now read-only.

Commit 2a6f337

Browse files
committed
Update viem versions in both packages.
Update Contributing guidelines in README.
1 parent a4a4e6a commit 2a6f337

6 files changed

Lines changed: 122 additions & 1952 deletions

File tree

README.md

Lines changed: 38 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -5,17 +5,23 @@
55

66
[![License](https://img.shields.io/badge/license-MIT-blue)](https://github.com/smartcontractkit/ccip-javascript-sdk/blob/main/LICENSE)
77
[![SDK Documentation](https://img.shields.io/static/v1?label=sdk-docs&message=latest&color=blue)](https://docs.chain.link/ccip/ccip-javascript-sdk/)
8+
89
</div>
910

1011
# CCIP JavaScript SDK
1112

12-
The CCIP JavaScript SDK includes two packages:
13-
- [`ccip-js`](/packages/ccip-js/README.md): A TypeScript library that provides a client for managing cross-chain token transfers that use Chainlink's [Cross-Chain Interoperability Protocol (CCIP)](https://docs.chain.link/ccip) routers.
14-
- [`ccip-react-components`](/packages/ccip-react-components/README.md): A set of prebuilt ready-to-use UI components built on top of `ccip-js`.
13+
### Start here
14+
15+
The CCIP JavaScript SDK is a monorepo for two packages:
16+
17+
- [`ccip-js`](/packages/ccip-js/README.md): A TypeScript library that provides a client for managing cross-chain token transfers that use Chainlink's [Cross-Chain Interoperability Protocol (CCIP)](https://docs.chain.link/ccip) routers.
18+
- [`ccip-react-components`](/packages/ccip-react-components/README.md): A set of prebuilt ready-to-use React UI components. This package depends on `ccip-js`.
1519

16-
Using both packages, you can add a fully featured CCIP bridge to your app that can be styled to match your app design.
17-
18-
To view more detailed documentation and more examples, visit the [Chainlink Javascript SDK Documentation](https://docs.chain.link/ccip/ccip-javascript-sdk/).
20+
Using both packages, you can add a fully featured CCIP bridge to your app that can be styled to match your app design.
21+
22+
To view more detailed documentation and more examples, visit the [Chainlink Javascript SDK Documentation](https://docs.chain.link/ccip/ccip-javascript-sdk/). Development specific information is also found in individual READMEs inside the `./packages/<<PACKAGE_NAME>>` directory.
23+
24+
There is also an example implementation of a front end NextJS app that uses these packages in `./examples/nextjs`. That has its own README as well.
1925

2026
### Prerequisites
2127

@@ -29,7 +35,6 @@ git clone https://github.com/smartcontractkit/ccip-javascript-sdk.git
2935

3036
3. Run `pnpm install`
3137

32-
3338
### Run the example app
3439

3540
```sh
@@ -42,9 +47,12 @@ pnpm dev-example
4247

4348
### Build packages
4449

45-
If you want to make changes to the package code, you need to rebuild the packages and make sure package.json file to point to the updated local versions.
50+
If you want to make changes to the package code, you need to rebuild the packages.
51+
Then:
4652

47-
Make sure to build the `ccip-js` package before you build the `ccip-react-components` package. The React components depend on the JS package.
53+
1. Make sure to build the `ccip-js` package before you build the `ccip-react-components` package. The React components depend on the JS package.
54+
55+
2. Make sure your client's package.json file to points to the updated local versions or use npm link or equivalent in your downstream client code. You can see examples of this in the steps below.
4856

4957
Follow these steps:
5058

@@ -73,9 +81,29 @@ pnpm build-components
7381
"@chainlink/ccip-react-components": "link:../../packages/ccip-react-components",
7482
```
7583

84+
## Contributing
85+
86+
Contributions to either repos are welcome! Please open an issue or submit a pull request using the process below.
87+
88+
1. Fork the repository.
89+
2. Clone your fork: `git clone https://github.com/YOUR_USERNAME/ccip-javascript-sdk.git`
90+
3. Navigate to directory: `cd ccip-javascript-sdk`
91+
4. Fetch all branches: `git fetch origin`
92+
5. Switch to develop branch: `git checkout develop`
93+
6. Install dependencies: `pnpm install`
94+
7. Create a feature branch: `git checkout -b feature/my-feature`
95+
8. Commit your changes
96+
9. Push to the branch (git push origin feature/my-feature).
97+
10. Open a pull request from your fork to the `develop` branch of this repo.
98+
99+
🚨 Always branch off from `develop` when creating your feature branch.
100+
76101
## Resources
77102

103+
- [ccip-js README](./packages/ccip-js/README.md)
104+
- [ccip-react-components README](./packages/ccip-react-components/README.md)
105+
- [examples/nextjs README](./examples/nextjs/README.md)
78106
- [Chainlink CCIP Javascript SDK Documentation](https://docs.chain.link/ccip/ccip-javascript-sdk/)
79107
- [Chainlink CCIP Documentation](https://docs.chain.link/ccip)
80108
- [Chainlink CCIP Directory](https://docs.chain.link/ccip/directory)
81-
- [Chainlink Documentation](https://docs.chain.link/)
109+
- [Chainlink Documentation](https://docs.chain.link/)

packages/ccip-js/README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -615,13 +615,7 @@ Note further that we have set a 180000ms (3 mins) timeout on the jest config. Th
615615

616616
### Contributing
617617

618-
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
619-
620-
1. Fork the repository.
621-
1. Create your feature branch (git checkout -b feature/my-feature).
622-
1. Commit your changes (git commit -m 'Add some feature').
623-
1. Push to the branch (git push origin feature/my-feature).
624-
1. Open a pull request.
618+
Please see the main README.
625619

626620
## License
627621

packages/ccip-js/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,6 @@
5050
"mocha": "^11.1.0",
5151
"ts-jest": "^29.2.5",
5252
"typescript": "^5.8.2",
53-
"viem": "2.21.25"
53+
"viem": "^2.31.3"
5454
}
5555
}

packages/ccip-react-components/README.md

Lines changed: 1 addition & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -373,13 +373,7 @@ export const Page = () = {
373373

374374
## Contributing
375375

376-
Contributions are welcome! Please open an issue or submit a pull request on GitHub.
377-
378-
1. Fork the repository.
379-
1. Create your feature branch (git checkout -b feature/my-feature).
380-
1. Commit your changes (git commit -m 'Add some feature').
381-
1. Push to the branch (git push origin feature/my-feature).
382-
1. Open a pull request.
376+
Please see the main README.
383377

384378
## License
385379

packages/ccip-react-components/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@
2828
"coverage": "vitest --environment jsdom run --coverage"
2929
},
3030
"dependencies": {
31-
"@chainlink/ccip-js": "^0.2.4",
31+
"@chainlink/ccip-js": "workspace:*",
3232
"@hookform/resolvers": "^3.9.0",
3333
"@radix-ui/react-dialog": "^1.1.1",
3434
"@radix-ui/react-label": "^2.1.0",
@@ -48,8 +48,8 @@
4848
"tailwind-merge": "^2.3.0",
4949
"tailwindcss-animate": "^1.0.7",
5050
"typescript": "^5.2.2",
51-
"viem": "2.21.25",
52-
"wagmi": "2.12.7",
51+
"viem": "^2.31.3",
52+
"wagmi": "^2.12.7",
5353
"zod": "^3.23.8"
5454
},
5555
"devDependencies": {

0 commit comments

Comments
 (0)