Solana Cookbook

Install Web3.js

There are a few libraries that you can use to get started with javascript or typescript on Solana.

Web3.js

@solana/web3.jsopen in new window is a library that has a lot of the basic Solana tools to interact, send transactions, and read from the blockchain.

You can install with the following:

yarn add @solana/web3.js

npm install --save @solana/web3.js

<!-- Development (un-minified) -->
<script src="https://unpkg.com/@solana/web3.js@latest/lib/index.iife.js"></script>

<!-- Production (minified) -->
<script src="https://unpkg.com/@solana/web3.js@latest/lib/index.iife.min.js"></script>

SPL-Token

@solana/spl-token is a library that contains many of the javascript/typescript bindings needed to interact with SPL tokens. You can use this library to mint new SPL tokens, transfer tokens, and more.

You can install this library with the following:

yarn add @solana/spl-token

npm install --save @solana/spl-token

<!-- Development (un-minified) -->
<script src="https://unpkg.com/@solana/spl-token@latest/lib/index.iife.js"></script>

<!-- Production (minified) -->
<script src="https://unpkg.com/@solana/spl-token@latest/lib/index.iife.min.js"></script>

Wallet-Adapter

There is a collection of libraries that can help bootstrap wallet connections within Solana called wallet-adapter. Currently the package supports use within Svelte, Angular, Vue.js, and React. Wallet-adapter can quickstart your dApp integration with wallets like Phantomopen in new window, Solflareopen in new window, and more.

You can install this library with the following:

yarn add @solana/wallet-adapter-wallets \
    @solana/wallet-adapter-base

npm install --save @solana/wallet-adapter-wallets \
    @solana/wallet-adapter-base

Install Rust

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

For Windows, please visit the Rust installation siteopen in new window.

Install CLI

macOS & Linux

Open your favorite Terminal application.

Replace LATEST_RELEASE with your desired version and install the latest Solana releaseopen in new window on your machine by running:

sh -c "$(curl -sSfL https://release.solana.com/LATEST_RELEASE/install)"

You can replace LATEST_RELEASE with the release tag matching the software version of your desired release, or use one of the three symbolic channel names: stable, beta, or edge. To find the latest release, check versions available hereopen in new window.

The following output indicates a successful update:

downloading LATEST_RELEASE installer
Configuration: /home/solana/.config/solana/install/config.yml
Active release directory: /home/solana/.local/share/solana/install/active_release
* Release version: LATEST_RELEASE
* Release URL: https://github.com/solana-labs/solana/releases/download/LATEST_RELEASE/solana-release-x86_64-unknown-linux-gnu.tar.bz2
Update successful

Depending on your system, the end of the installer messaging may prompt you to

Please update your PATH environment variable to include the solana programs:

If you get the above message, copy and paste the recommended command below it to update PATH.

Confirm you have the desired version of solana installed by running:

solana --version

After a successful install, solana-install update may be used to easily update the Solana software to a newer version at any time.

Downloading Binaries (Linux)

Alternatively, you can install from binaries instead of using solana-install.

Download the binaries by navigating to https://github.com/solana-labs/solana/releases/latestopen in new window, download solana-release-x86_64-unknown-linux-gnu.tar.bz2. Open a new terminal, move the binaries from your download folder to the root folder, then extract the archive:

mv Downloads/solana-release-x86_64-unknown-linux-gnu.tar.bz2 .
tar jxf solana-release-x86_64-unknown-linux-gnu.tar.bz2

Next, You need to make the solana-cli accessible in all terminal.To do that, you need to add it to the PATH. Open the terminal configuration file with the command below

sudo nano /etc/profile

At the bottom of the nano editor shown, you will add the following line of code

export PATH=/home/coderina/solana-release/bin:$PATH

Save the file by pressing CTRL + X, then Y and then Enter.

Restart your Machine to make this change take effect. Voila you can now access the solana-cli in any terminal on your machine.

Downloading Binaries (macOS)

Alternatively, you can install from binaries instead of using solana-install.

Download the binaries by navigating to https://github.com/solana-labs/solana/releases/latestopen in new window, download solana-release-x86_64-apple-darwin.tar.bz2, then extract the archive:

tar jxf solana-release-x86_64-apple-darwin.tar.bz2
cd solana-release/
export PATH=$PWD/bin:$PATH

Windows

Open a Command Prompt (cmd.exe) as an Administrator.

Search for Command Prompt in the Windows search bar. When the Command Prompt app appears, right-click and select “Open as Administrator”. If you are prompted by a pop-up window asking “Do you want to allow this app to make changes to your device?”, click 'Yes'.

Copy and paste the following command, then press Enter to download the Solana installer into a temporary directory:

curl https://release.solana.com/v1.9.16/solana-install-init-x86_64-pc-windows-msvc.exe --output C:\solana-install-tmp\solana-install-init.exe --create-dirs

If v1.9.16 is not your desired version, find the latest release hereopen in new window.

Copy and paste the following command, then press Enter to install the latest version of Solana. If you see a security pop-up by your system, please select to allow the program to run.

C:\solana-install-tmp\solana-install-init.exe v1.9.16

To find the latest release, check versions available hereopen in new window.

When the installer is finished, press Enter.

Close the command prompt window and re-open a new command prompt window as a normal user.

Search for "Command Prompt" in the search bar, then left-click on the Command Prompt app icon (no need to run as Administrator).

Confirm you have the desired version of solana installed by entering:

solana --version

After a successful install, solana-install update may be used to easily update the Solana software to a newer version at any time.

Downloading Binaries

Alternatively, you can install from binaries instead of using solana-install.

Download the binaries by navigating to https://github.com/solana-labs/solana/releases/latestopen in new window, download solana-release-x86_64-pc-windows-msvc.tar.bz2, then extract the archive using WinZip or similar.

Open a Command Prompt and navigate to the directory into which you extracted the binaries and run:

cd solana-release/
set PATH=%cd%/bin;%PATH%

Build From Source

If you are unable to use the prebuilt binaries or prefer to build it yourself from source, navigate to https://github.com/solana-labs/solana/releases/latestopen in new window, and download the Source Code archive. Extract the code and build the binaries with:

./scripts/cargo-install-all.sh .
export PATH=$PWD/bin:$PATH

You can then run the following command to obtain the same result as with prebuilt binaries:

solana-install init
Last Updated:
Contributors: mayben, Brian Friel, Hipo, Jacob CG, Jacob Creech, Ayush, Lukmon Abdulsalam, Silvestre Vivo, Thomas H, dtlehrer, Jonas Hahn