Skip to content

Latest commit

 

History

History
92 lines (61 loc) · 3.26 KB

readme.md

File metadata and controls

92 lines (61 loc) · 3.26 KB
Raw

Kaptn

Transfer-Hook Program Framework

Kaptn is a framework for Solana's Sealevel runtime that makes creating Transfer-Hook programs even easier.

  • Convenience macros for abstracting the complexity of native Rust Solana programs
  • Similar flow to writing Anchor programs
  • CLI tool for deploying, managing, and monitoring Transfer-Hook programs (TBA)

This framework is in early development and any contributions or suggestions are very welcome.

NOTE: At this time, there have been no audits on the code. Use at your own risk.

Getting Started

Prerequisites

  • Rust 1.70+
  • Solana CLI

Installation

To install the Kaptn CLI, run the following command:

cargo install kaptn-cli

Creating a new project

To create a new project, run the following command:

kaptn new my-project

This will create a new directory called my-project with a basic structure for a Kaptn project.

This will produce a lib.rs file that looks like this:

use kaptn_lang::prelude::*;

declare_id!("5H4LbTCzkudomL3ocLttgLFtHWvpbiadS1DhPGvo2XYh");
declare_mint!("FQf33CHwMZY4TYo6RP5CuTXUCVs8YFJH1MreMYtHiPhi");

#[transfer_hook]
pub fn hello_world(ctx: TransferContext<MyExtraMetas>) -> ProgramResult {
    msg!("Ahoy from transfer-hook program: {:?}", ctx.program_id);
    Ok(())
}

#[derive(ExtraMetas)]
pub struct MyExtraMetas {}

Here we can see a few things:

  • declare_id! and declare_mint! are macros that generate the ID and mint for your program. These refer to keypairs that were generated when the project was created.
  • #[transfer_hook] is a macro that generates the transfer hook for your program. This is the main function that will be called when a transfer hook is executed. Inside this function you are provided a TransferContext which contains the necessary information to process the transfer and any other bussiness logic you want to add.
  • #[derive(ExtraMetas)] is a macro that generates the extra metas for your program. This is where you can add your own extra metas if needed. These can be static pubkeys or generated seeds or even other extra metas from your struct.

Building and deploying

To build and deploy your project, run the following command:

cargo build-bpf
solana program deploy target/deploy/my_project.so

This will build your project and deploy it to the Solana network.

Initializing and Updating ExtraMetas

When you first deploy your program you will need to initialize and fill the PDA that will be use to update your extra metas. You can do this by running the following command:

kaptn create-extra-metas

When ever your change your extra metas struct in the program, you will also need to build, deploy your program, and update your on chain extra metas account. This is done by running the following command:

kaptn update-extra-metas

With this you should be all set up and ready to start using your Transfer-Hook program. I plan on wrapping the rest of the command such and building and deploying into the kaptn cli.