diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..215f844 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,26 @@ +# Changelog + +All notable changes to this project will be documented in this file. + +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). + +## [0.1.0] - 03 June 2024 + +### Dependencies + +| Package | Version | +| ------------------------- | ------- | +| @chainlink/contracts-ccip | 1.4.0 | +| @chainlink/contracts | - | + +### Services + +- [x] Chainlink CCIP +- [ ] Chainlink Data Feeds + +### Added + +- Initial release of the project + +[0.1.0]: https://github.com/smartcontractkit/chainlink-local/releases/tag/v0.1.0 diff --git a/README.md b/README.md index 5da70c9..713d7d1 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,12 @@ ## Chainlink Local -Chainlink Local is an installable dependency. It provides a tool (the Chainlink Local Simulator) that developers import into their Foundry and Hardhat scripts. This tool runs [Chainlink CCIP](https://docs.chain.link/ccip) locally which means developers can rapidly explore, prototype and iterate CCIP dApps off-chain, and move to testnet only when they're ready to test in a live environment. +Chainlink Local is an installable dependency. It provides a tool (the Chainlink Local Simulator) that developers import into their Foundry or Hardhat or Remix projects. This tool runs [Chainlink CCIP](https://docs.chain.link/ccip) locally which means developers can rapidly explore, prototype and iterate CCIP dApps off-chain in a local environment, and move to testnet only when they're ready to test in a live environment. -The package exposes a set of smart contracts and scripts with which you build, deploy and execute CCIP token transfers and arbitrary messages on a local Hardhat or Anvil (Foundry) development node. Chainlink Local also supports forked nodes. +The package exposes a set of smart contracts and scripts with which you build, deploy and execute CCIP token transfers and arbitrary messages on a local Remix, Hardhat or Anvil (Foundry) development node. Chainlink Local also supports forked nodes. -User Contracts tested with Chainlink Local can be deployed to test networks without any modifications. +User Contracts tested with Chainlink Local can be deployed to test networks without any modifications (assuming network specific contract addresses such as Router contracts and LINK token addresses are passed in via a constructor). + +To view more detailed documentation and more examples, visit the [Chainlink Local Documentation](https://cll-devrel.gitbook.io/chainlink-local-documentation).

@@ -27,7 +29,7 @@ and then set remappings to: `@chainlink/local/=lib/chainlink-local/` in either ` #### Hardhat (npm) ``` -npm install git+https://github.com/smartcontractkit/chainlink-local.git +npm install @chainlink/local ``` #### Remix IDE @@ -36,6 +38,8 @@ npm install git+https://github.com/smartcontractkit/chainlink-local.git import "https://github.com/smartcontractkit/chainlink-local/blob/main/src/ccip/CCIPLocalSimulator.sol"; ``` +Once you have installed CCIP Local, you are now ready to start using it with your project. + ### Usage Import `CCIPLocalSimulator.sol` inside your tests or scripts, for example: diff --git a/package.json b/package.json index 9fbaa92..968ccb2 100644 --- a/package.json +++ b/package.json @@ -1,7 +1,8 @@ { "name": "@chainlink/local", "description": "Chainlink Local Simulator", - "version": "0.0.1", + "license": "MIT", + "version": "0.1.0", "files": [ "src/**/*.sol", "!src/test/**/*",