@coral-xyz/anchor

What is @coral-xyz/anchor?

@coral-xyz/anchor is a framework for Solana's Sealevel runtime providing several developer tools to build, deploy, and interact with smart contracts on the Solana blockchain. It simplifies the process of writing Solana programs by offering a set of Rust macros and a TypeScript client for interacting with these programs.

What are @coral-xyz/anchor's main functionalities?

Smart Contract Development

This code demonstrates how to set up a client to interact with a Solana smart contract using the @coral-xyz/anchor framework. It shows how to load the program's IDL, set up a provider, and call a function on the smart contract.

const anchor = require('@coral-xyz/anchor');

// Define the provider
const provider = anchor.AnchorProvider.env();
anchor.setProvider(provider);

// Load the IDL
const idl = JSON.parse(require('fs').readFileSync('./target/idl/my_program.json', 'utf8'));

// Address of the deployed program
const programId = new anchor.web3.PublicKey('YourProgramPublicKey');

// Generate the program client from IDL
const program = new anchor.Program(idl, programId);

// Interact with the program
async function main() {
  // Call a function from the smart contract
  await program.rpc.initialize();
}

main().catch(err => console.error(err));

Testing Smart Contracts

This code provides a basic test setup for a Solana smart contract using the @coral-xyz/anchor framework. It uses Mocha for testing and demonstrates how to initialize a program and assert the state of an account.

const anchor = require('@coral-xyz/anchor');
const assert = require('assert');

describe('my-program', () => {
  // Configure the client to use the local cluster.
  const provider = anchor.AnchorProvider.local();
  anchor.setProvider(provider);

  const program = anchor.workspace.MyProgram;

  it('Initializes the account', async () => {
    // Add your test here.
    const tx = await program.rpc.initialize();
    console.log('Transaction signature', tx);

    // Fetch the account and assert its state
    const account = await program.account.myAccount.fetch(provider.wallet.publicKey);
    assert.ok(account.data.eq(new anchor.BN(0)));
  });
});

Other packages similar to @coral-xyz/anchor

@solana/web3.js

@solana/web3.js is a JavaScript API for interacting with the Solana blockchain. While it provides lower-level access to Solana's features, it lacks the higher-level abstractions and developer tools that @coral-xyz/anchor offers, such as IDL generation and client-side program interaction.

README

@coral-xyz/anchor

TypeScript client for Anchor programs.

Note

• @coral-xyz/anchor depends on node.js native modules. Therefore, webpack 5 will not work with current version. You will either need to rollback to webpack 4, or use a polyfill for each missing dependency.

Changelog

[0.30.1] - 2024-06-20

Features

• idl: Allow overriding the idl build toolchain with the RUSTUP_TOOLCHAIN environment variable (#2941).
• avm: Support customizing the installation location using AVM_HOME environment variable (#2917).
• avm: Optimize avm list when GitHub API rate limits are reached (#2962)
• idl, ts: Add accounts resolution for associated token accounts (#2927).
• cli: Add --no-install option to the init command (#2945).
• lang: Implement TryFromIntError for Error to be able to propagate integer conversion errors (#2950).
• idl: Add ability to convert legacy IDLs (#2986).
• ts: Extract Anchor error codes into their own package (#2983).
• cli: Add additional solana arguments to the upgrade command (#2998).
• spl: Export spl-associated-token-account crate (#2999).
• lang: Support legacy IDLs with declare_program! (#2997).
• cli: Add idl convert command (#3009).
• cli: Add idl type command (#3017).
• lang: Add anchor_lang::pubkey macro for declaring Pubkey const values (#3021).
• cli: Sync program ids on the initial build (#3023).
• idl: Remove anchor-syn dependency (#3030).
• lang: Add const of program ID to declare_id! and declare_program! (#3019).
• idl: Add separate spec crate (#3036).

Fixes

• lang: Eliminate variable allocations that build up stack space for token extension code generation (#2913).
• ts: Fix incorrect maxSupportedTransactionVersion in AnchorProvider.send*() methods (#2922).
• cli: Use npm's configured default license for new projects made with anchor init (#2929).
• cli: add filename to 'Unable to read keypair file' errors (#2932).
• idl: Fix path resolution of the Cargo.lock of the project when generating idls for external types (#2946).
• idl: Fix potential panic on external type resolution (#2954).
• lang: Fix using defined types in instruction parameters with declare_program! (#2959).
• lang: Fix using const generics with declare_program! (#2965).
• lang: Fix using Vec<u8> type with declare_program! (#2966).
• lang: Fix ProgramError::ArithmeticOverflow not found error (#2975).
• lang: Fix using optional accounts with declare_program! (#2967).
• lang: Fix instruction return type generation with declare_program! (#2977).
• cli: Fix IDL write getting corrupted from retries (#2964).
• idl: Fix unexpected_cfgs build warning (#2992).
• lang: Make tuple struct fields public in declare_program! (#2994).
• Remove rust-version from crate manifests (#3000).
• cli: Fix upgradeable program clones (#3010).
• ts: Fix using IDLs that have defined types as generic arguments (#3016).
• idl: Fix generation with unsupported expressions (#3033).
• idl: Fix using address constraint with field expressions (#3034).
• lang: Fix using bytemuckunsafe account serialization with declare_program! (#3037).

Breaking