Starter Kits and Frameworks

You can install and use Chainlink in your projects either manually or by using the Chainlink Starter Kits. Once you have the Chainlink library installed, you can more easily access the Chainlink ecosystem.

For a new project, start from the product guide you need:

• Data Feeds
• Data Streams
• VRF v2.5
• CCIP
• CRE

Installing into existing projects

Chainlink is supported by Hardhat, Foundry, and Anchor. Apeworx is available for Vyper.

If you already have a project, install the @chainlink/contracts NPM package.

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 tools and features via the use of our Starter Kits.

Hardhat Starter Kit

For the latest instructions, see the following repositories:

• Hardhat Starter Kit
• Hardhat Starter Kit (TypeScript)

To learn more about Hardhat, read the Hardhat Documentation.

For more details on how to use Chainlink with Hardhat, see the blog post for How to use Hardhat with Chainlink.

Foundry Starter Kit

For the latest instructions, see the following repositories:

• Foundry Starter Kit
• Foundry Starter Kit (Huff)

To learn more about Foundry, read the Foundry Documentation.

Apeworx Starter Kit (Vyper)

For the latest instructions, see the Apeworx Starter Kit repository.

To learn more about Apeworx, read the Apeworx Documentation.

Anchor Starter Kit (Solana)

For the latest instructions, see the Chainlink Solana Starter Kit repository.

To learn more about Anchor, see the Anchor Documentation.

Testing Chainlink contracts

See our blog post on Testing Chainlink Smart Contracts or watch the Chainlink Hackathon Workshop.

Test samples can be found in the Hardhat Starter Kit.