This page explains how to install and use the Chainlink Library in your projects.
If you're new to smart contract development and want a step-by-step guide, try out our Example Walkthrough
If you already have a project, you can add Chainlink to it by using the following package managers.
Install using NPM
npm install @chainlink/contracts --save
Install using Yarn
yarn add @chainlink/contracts
If you're creating a new project from scratch, these commands will help you set up your project to interact with Chainlink.
If you are using OpenZeppelin Starter Kits, you can create a new project by running:
oz unpack smartcontractkit/box
Install Truffle with NPM:
npm install truffle -g
With Truffle installed, run the commands below to unbox a Chainlinked contract into a new directory.
mkdir MyChainlinkedProject cd MyChainlinkedProject/ truffle unbox smartcontractkit/box
For more details on how to use the Truffle, see this blog post.
Once you have the Chainlink library installed, you can leverage the Chainlink ecosystem.
If you're interested in retrieving up to date crypto prices in your contracts, learn more about our Price Feeds.
If you need to consume randomness in your contracts, learn about Chainlink VRF.
And if you want your contracts to retrieve data from off-chain APIs, learn about Using Any API.
Updated 12 days ago