Go to file
acheron 6716c13b38
client: Add documentation for `RequestBuilder.accounts` method (#2822)
2024-02-20 22:38:31 +01:00
.github lang: Fix `use of unstable library feature 'build_hasher_simple_hash_one'` (#2756) 2023-12-31 18:05:33 +01:00
avm v0.29.0 (#2672) 2023-10-16 18:35:17 +02:00
bench cli: Require explicit `overflow-checks` flag (#2716) 2023-11-30 00:55:12 +01:00
cli cli: Accept package name as program name (#2816) 2024-02-16 16:51:56 +01:00
client client: Add documentation for `RequestBuilder.accounts` method (#2822) 2024-02-20 22:38:31 +01:00
docker v0.29.0 (#2672) 2023-10-16 18:35:17 +02:00
docs docs: Fix typos (#2815) 2024-02-10 22:39:00 +01:00
examples cli: Require explicit `overflow-checks` flag (#2716) 2023-11-30 00:55:12 +01:00
lang Specify `solana-program` version range to not include 1.18.0 (#2798) 2024-01-29 23:18:57 +01:00
spl spl: Pin version of `toml_edit` crate to 0.21.0 (#2807) 2024-02-04 12:46:25 +01:00
tests tests: Fix non-path `anchor-lang` dep in tests (#2811) 2024-02-07 23:59:54 +01:00
ts ts: Correctly construct field layout for type aliases (#2821) 2024-02-19 20:59:48 +01:00
.gitignore Relax the mpl metadata package constraint (#2366) 2023-01-22 08:48:57 -06:00
.gitmodules tests: Remove `auction-house` submodule and host it natively (#2654) 2023-10-09 13:50:40 +02:00
CHANGELOG.md ts: Correctly construct field layout for type aliases (#2821) 2024-02-19 20:59:48 +01:00
CODE_OF_CONDUCT.md Fix broken link to Rust's code of conduct (#2810) 2024-02-06 23:41:53 +01:00
CONTRIBUTING.md update discord links (#2424) 2023-03-06 11:19:08 +00:00
Cargo.lock spl: Pin version of `toml_edit` crate to 0.21.0 (#2807) 2024-02-04 12:46:25 +01:00
Cargo.toml Fix workspace `resolver` warning (#2676) 2023-10-30 22:39:07 +01:00
LICENSE v0.28.0 (#2527) 2023-06-09 18:00:35 +02:00
Makefile v0.27.0 (#2428) 2023-03-08 13:28:23 +00:00
README.md Make `anchor-spl` and `anchor-client` badges links to creates.io (#2684) 2023-10-26 23:58:36 +02:00
VERSION v0.29.0 (#2672) 2023-10-16 18:35:17 +02:00
setup-tests.sh Upgrade Solana to `1.17.0` (#2645) 2023-10-07 23:53:37 +02:00
version-bump.sh bench: Add lock files and store Solana version (#2537) 2023-06-20 20:20:22 +02:00

README.md

Anchor

Solana Sealevel Framework

Build Status Tutorials Discord Chat License

Anchor is a framework for Solana's Sealevel runtime providing several convenient developer tools for writing smart contracts.

  • Rust eDSL for writing Solana programs
  • IDL specification
  • TypeScript package for generating clients from IDL
  • CLI and workspace management for developing complete applications

If you're familiar with developing in Ethereum's Solidity, Truffle, web3.js, then the experience will be familiar. Although the DSL syntax and semantics are targeted at Solana, the high level flow of writing RPC request handlers, emitting an IDL, and generating clients from IDL is the same.

Getting Started

For a quickstart guide and in depth tutorials, see the anchor book and the older documentation that is being phased out. To jump straight to examples, go here. For the latest Rust and TypeScript API documentation, see docs.rs and the typedoc.

Packages

Package Description Version Docs
anchor-lang Rust primitives for writing programs on Solana Crates.io Docs.rs
anchor-spl CPI clients for SPL programs on Solana crates Docs.rs
anchor-client Rust client for Anchor programs crates Docs.rs
@coral-xyz/anchor TypeScript client for Anchor programs npm Docs
@coral-xyz/anchor-cli CLI to support building and managing an Anchor workspace npm Docs

Note

  • Anchor is in active development, so all APIs are subject to change.
  • This code is unaudited. Use at your own risk.

Examples

Here's a counter program, where only the designated authority can increment the count.

use anchor_lang::prelude::*;

declare_id!("Fg6PaFpoGXkYsidMpWTK6W2BeZ7FEfcYkg476zPFsLnS");

#[program]
mod counter {
    use super::*;

    pub fn initialize(ctx: Context<Initialize>, start: u64) -> Result<()> {
        let counter = &mut ctx.accounts.counter;
        counter.authority = *ctx.accounts.authority.key;
        counter.count = start;
        Ok(())
    }

    pub fn increment(ctx: Context<Increment>) -> Result<()> {
        let counter = &mut ctx.accounts.counter;
        counter.count += 1;
        Ok(())
    }
}

#[derive(Accounts)]
pub struct Initialize<'info> {
    #[account(init, payer = authority, space = 48)]
    pub counter: Account<'info, Counter>,
    pub authority: Signer<'info>,
    pub system_program: Program<'info, System>,
}

#[derive(Accounts)]
pub struct Increment<'info> {
    #[account(mut, has_one = authority)]
    pub counter: Account<'info, Counter>,
    pub authority: Signer<'info>,
}

#[account]
pub struct Counter {
    pub authority: Pubkey,
    pub count: u64,
}

For more, see the examples and tests directories.

License

Anchor is licensed under Apache 2.0.

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in Anchor by you, as defined in the Apache-2.0 license, shall be licensed as above, without any additional terms or conditions.

Contribution

Thank you for your interest in contributing to Anchor! Please see the CONTRIBUTING.md to learn how.

Thanks ❤️