120 lines
6.4 KiB
Markdown
120 lines
6.4 KiB
Markdown
<div align="center">
|
|
<img height="170x" src="https://pbs.twimg.com/media/FVUVaO9XEAAulvK?format=png&name=small" />
|
|
|
|
<h1>Anchor</h1>
|
|
|
|
<p>
|
|
<strong>Solana Sealevel Framework</strong>
|
|
</p>
|
|
|
|
<p>
|
|
<a href="https://github.com/coral-xyz/anchor/actions"><img alt="Build Status" src="https://github.com/coral-xyz/anchor/actions/workflows/tests.yaml/badge.svg" /></a>
|
|
<a href="https://anchor-lang.com"><img alt="Tutorials" src="https://img.shields.io/badge/docs-tutorials-blueviolet" /></a>
|
|
<a href="https://discord.gg/NHHGSXAnXk"><img alt="Discord Chat" src="https://img.shields.io/discord/889577356681945098?color=blueviolet" /></a>
|
|
<a href="https://opensource.org/licenses/Apache-2.0"><img alt="License" src="https://img.shields.io/github/license/coral-xyz/anchor?color=blueviolet" /></a>
|
|
</p>
|
|
</div>
|
|
|
|
Anchor is a framework for Solana's [Sealevel](https://medium.com/solana-labs/sealevel-parallel-processing-thousands-of-smart-contracts-d814b378192) runtime providing several convenient developer tools for writing smart contracts.
|
|
|
|
- Rust eDSL for writing Solana programs
|
|
- [IDL](https://en.wikipedia.org/wiki/Interface_description_language) 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](https://docs.soliditylang.org/en/v0.7.4/), [Truffle](https://www.trufflesuite.com/), [web3.js](https://github.com/ethereum/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](https://book.anchor-lang.com) and the older [documentation](https://anchor-lang.com) that is being phased out.
|
|
To jump straight to examples, go [here](https://github.com/coral-xyz/anchor/tree/master/examples). For the latest Rust and TypeScript API documentation, see [docs.rs](https://docs.rs/anchor-lang) and the [typedoc](https://coral-xyz.github.io/anchor/ts/index.html).
|
|
|
|
## Packages
|
|
|
|
| Package | Description | Version | Docs |
|
|
| :---------------------- | :------------------------------------------------------- | :------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------------------------------------------------- |
|
|
| `anchor-lang` | Rust primitives for writing programs on Solana | [](https://crates.io/crates/anchor-lang) | [](https://docs.rs/anchor-lang) |
|
|
| `anchor-spl` | CPI clients for SPL programs on Solana | [](https://crates.io/crates/anchor-spl) | [](https://docs.rs/anchor-spl) |
|
|
| `anchor-client` | Rust client for Anchor programs | [](https://crates.io/crates/anchor-client) | [](https://docs.rs/anchor-client) |
|
|
| `@coral-xyz/anchor` | TypeScript client for Anchor programs | [](https://www.npmjs.com/package/@coral-xyz/anchor) | [](https://coral-xyz.github.io/anchor/ts/index.html) |
|
|
| `@coral-xyz/anchor-cli` | CLI to support building and managing an Anchor workspace | [](https://www.npmjs.com/package/@coral-xyz/anchor-cli) | [](https://coral-xyz.github.io/anchor/cli/commands.html) |
|
|
|
|
## 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.
|
|
|
|
```rust
|
|
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](https://github.com/coral-xyz/anchor/tree/master/examples)
|
|
and [tests](https://github.com/coral-xyz/anchor/tree/master/tests) directories.
|
|
|
|
## License
|
|
|
|
Anchor is licensed under [Apache 2.0](./LICENSE).
|
|
|
|
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](./CONTRIBUTING.md) to learn how.
|
|
|
|
### Thanks ❤️
|
|
|
|
<div align="center">
|
|
<a href="https://github.com/coral-xyz/anchor/graphs/contributors">
|
|
<img src="https://contrib.rocks/image?repo=coral-xyz/anchor" width="100%" />
|
|
</a>
|
|
</div>
|