@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.0] - 2024-04-15

See the Anchor 0.30 release notes for a high-level overview of how to update.

Features

• cli: Allow force init and new (#2698).
• cli: Add verifiable option when deploy (#2705).
• cli: Add support for passing arguments to the underlying solana program deploy command with anchor deploy (#2709).
• lang: Add InstructionData::write_to implementation (#2733).
• lang: Add #[interface(..)] attribute for instruction discriminator overrides (#2728).
• ts: Add .interface(..) method for instruction discriminator overrides (#2728).
• cli: Check anchor-lang and CLI version compatibility (#2753).
• ts: Add missing IDL PDA seed types (#2752).
• cli: idl close accepts optional --idl-address parameter (#2760).
• cli: Add support for simple wildcard patterns in Anchor.toml's workspace.members and workspace.exclude. (#2785).
• cli: Add --test-template option for init command (#2805).
• cli: anchor test is able to run multiple commands (#2799).
• cli: Check @coral-xyz/anchor package and CLI version compatibility (#2813).
• cli: Accept package name as program name (#2816).
• cli: Add ability to build and test only a specified program (#2823).
• idl: Add new IDL spec (#2824).
• idl: Add support for reprs (#2824).
• idl: Add support for expression evaluation (#2824).
• idl: Add support for using external types when generating the IDL (#2824).
• idl, ts: Add unit and tuple struct support (#2824).
• idl, ts: Add generics support (#2824).
• ts: Add accountsPartial method to keep the old accounts method behavior (#2824).
• ts: Make opts parameter of AnchorProvider constructor optional (#2843).
• cli: Add --no-idl flag to the build command (#2847).
• cli: Add priority fees to idl commands (#2845).
• ts: Add prepend option to MethodBuilder preInstructions method (#2863).
• lang: Add declare_program! macro (#2857).
• cli: Add deactivate_feature flag to solana-test-validator config in Anchor.toml (#2872).
• idl: Add docs field for constants (#2887).
• idl: Store deployment addresses for other clusters (#2892).
• lang: Add Event utility type to get events from bytes (#2897).
• lang, spl: Add support for token extensions (#2789).
• lang: Return overflow error from Lamports trait operations (#2907).

Fixes

• syn: Add missing new_from_array method to Hash (#2682).
• cli: Switch to Cargo feature resolver(resolver = "2") (#2676).
• cli: Fix using user specific path for provider.wallet in Anchor.toml (#2696).
• syn: Fix IDL constant seeds parsing (#2699).
• cli: Display errors if toolchain override restoration fails (#2700).
• cli: Fix commit based anchor_version override (#2704).
• spl: Fix compilation with shmem feature enabled (#2722).
• cli: Localhost default test validator address changes from localhost to 127.0.0.1, NodeJS 17 IP resolution changes for IPv6 (#2725).
• lang: Eliminate temporary Vec allocations when serializing data with discriminant and set the default capacity to 256 bytes (#2691).
• lang: Allow custom lifetime in Accounts structure (#2741).
• lang: Remove try_to_vec usage while setting the return data in order to reduce heap memory usage (#2744)
• cli: Show installation progress if Solana tools are not installed when using toolchain overrides (#2757).
• ts: Fix formatting enums (#2763).
• cli: Fix migrate command not working without global ts-node installation (#2767).
• client, lang, spl, syn: Enable all features for docs.rs build (#2774).
• ts: Fix construction of field layouts for type aliased instruction arguments (#2821)
• idl: Fix IDL (#2824).
• idl, ts: Make casing consistent (#2824).
• ts: Fix not being able to use numbers in instruction, account, or event names in some cases due to case conversion (#2824).
• cli: Fix excessive test validator requests (#2828).
• client: Fix parse_logs_response to prevent panics when more than 1 outer instruction exists in logs (#2856).
• avm, cli: Fix stdsimd feature compilation error from ahash when installing the CLI using newer Rust versions (#2867).
• spl: Fix not being able to deserialize newer token 2022 extensions (#2876).
• spl: Remove solana-program dependency (#2900).
• spl: Make TokenAccount and Mint Copy (#2904).
• ts: Add missing errors (#2906).

Breaking

• cli: Make cargo build-sbf the default build command (#2694).
• cli: Require explicit overflow-checks flag (#2716).
• ts: Remove anchor-deprecated-state feature (#2717).
• lang: Remove CLOSED_ACCOUNT_DISCRIMINATOR (#2726).
• lang: Make bumps of optional accounts Option<u8> rather than u8 (#2730).
• spl: Remove shared-memory program (#2747).
• ts: Remove associated, account.associated and account.associatedAddress methods (#2749).
• cli: idl upgrade command closes the IDL buffer account (#2760).
• cli: Remove --jest option from the init command (#2805).
• cli: Require idl-build feature in program Cargo.toml (#2824).
• cli: Rename seeds feature to resolution and make it enabled by default (#2824).
• cli: Remove idl parse command (#2824).
• idl: Change IDL spec (#2824).
• syn: Remove idl-parse and seeds features (#2824).
• ts: Change accounts method to no longer accept resolvable accounts (#2824).
• ts: Program instances use camelCase for everything (#2824).
• ts: Remove discriminator functions (#2824).
• ts: Remove programId parameter of the Program constructor (#2864).
• idl, syn: Move IDL types from the anchor-syn crate to the new IDL crate (#2882).
• idl: Add #[non_exhaustive] to IDL enums (#2890).