This page explains how to install and use the Chainlink Library in your projects.

📘

If you prefer a step-by-step guide to get started, use the Example Walkthrough

Install into Existing Projects

If you already have a project, you can add Chainlink to it by using the following package managers.

NPM

Install using NPM

npm install @chainlink/contracts --save

Yarn

Install using Yarn

yarn add @chainlink/contracts

Create a New Project

If you're creating a new project from scratch, these commands will help you set up your project to interact with Chainlink.

OpenZeppelin Starter Kit

If you are using OpenZeppelin Starter Kits, you can create a new project by running:

oz unpack smartcontractkit/box

Truffle 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.

Using Chainlink Contracts

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.