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

Commit 8bbb8aa

Browse files
authored
Merge pull request #49 from smartcontractkit/deprecation-notice
Depreciate SDK packages. Add redirect notices to each of the 3 READMEs.
2 parents 61e0951 + 059f8c2 commit 8bbb8aa

File tree

5 files changed

+24
-12
lines changed

5 files changed

+24
-12
lines changed

README.md

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,12 +10,16 @@
1010

1111
# CCIP JavaScript SDK
1212

13+
<div role="note" align="center" style="background:#fff4e5;border-left:4px solid #ff8c00;padding:12px;border-radius:6px;margin-bottom:16px;">
14+
<strong>Deprecation notice:</strong> This repository is deprecated and no longer maintained. Instead please use the <a href="https://www.npmjs.com/package/@chainlink/ccip-sdk"> latest CCIP SDK here</a>.
15+
</div>
16+
1317
### Start here
1418

1519
The CCIP JavaScript SDK is a monorepo for two packages:
1620

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`.
21+
- [`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.
22+
- [`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`.
1923

2024
Using both packages, you can add a fully featured CCIP bridge to your app that can be styled to match your app design.
2125

@@ -100,10 +104,10 @@ Contributions to either repos are welcome! Please open an issue or submit a pull
100104

101105
## Resources
102106

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)
106-
- [Chainlink CCIP Javascript SDK Documentation](https://docs.chain.link/ccip/ccip-javascript-sdk/)
107-
- [Chainlink CCIP Documentation](https://docs.chain.link/ccip)
108-
- [Chainlink CCIP Directory](https://docs.chain.link/ccip/directory)
109-
- [Chainlink Documentation](https://docs.chain.link/)
107+
- [ccip-js README](./packages/ccip-js/README.md)
108+
- [ccip-react-components README](./packages/ccip-react-components/README.md)
109+
- [examples/nextjs README](./examples/nextjs/README.md)
110+
- [Chainlink CCIP Javascript SDK Documentation](https://docs.chain.link/ccip/ccip-javascript-sdk/)
111+
- [Chainlink CCIP Documentation](https://docs.chain.link/ccip)
112+
- [Chainlink CCIP Directory](https://docs.chain.link/ccip/directory)
113+
- [Chainlink Documentation](https://docs.chain.link/)

packages/ccip-js/README.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,8 @@
1-
# CCIP-JS
1+
# CCIP-JS Package
2+
3+
<div role="note" align="center" style="background:#fff4e5;border-left:4px solid #ff8c00;padding:12px;border-radius:6px;margin-bottom:16px;">
4+
<strong>Deprecation notice:</strong> This package is deprecated and no longer maintained. Instead please use the <a href="https://www.npmjs.com/package/@chainlink/ccip-sdk"> latest CCIP SDK here</a>.
5+
</div>
26

37
CCIP-JS is 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. The library utilizes types and helper functions from [Viem](https://viem.sh/).
48

packages/ccip-js/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@chainlink/ccip-js",
3-
"version": "0.2.6",
3+
"version": "0.2.7",
44
"private": false,
55
"main": "dist/api.js",
66
"types": "dist/api.d.ts",

packages/ccip-react-components/README.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# CCIP-REACT-COMPONENTS
22

3+
<div role="note" align="center" style="background:#fff4e5;border-left:4px solid #ff8c00;padding:12px;border-radius:6px;margin-bottom:16px;">
4+
<strong>Deprecation notice:</strong> This package for React UI components on top of the <a href="../ccip-js/README.md">CCIP-JS package</a> is deprecated and no longer maintained. You can access the <a href="https://www.npmjs.com/package/@chainlink/ccip-sdk"> latest CCIP SDK here</a>. However note also that there is currently no React Components package that is compatible with the new CCIP SDK.
5+
</div>
6+
37
The CCIP-REACT-COMPONENTS package is a set of prebuilt ready-to-use UI components built on top of [CCIP-JS](../ccip-js/README.md). Using both packages, you can add a fully featured CCIP bridge to your app that can be styled to match your app design.
48

59
## Table of contents

packages/ccip-react-components/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "@chainlink/ccip-react-components",
33
"private": false,
4-
"version": "0.3.1",
4+
"version": "0.3.2",
55
"type": "module",
66
"main": "./dist/index.umd.js",
77
"module": "./dist/index.es.js",

0 commit comments

Comments
 (0)