Skip to content

Latest commit

 

History

History
103 lines (72 loc) · 2.68 KB

README.md

File metadata and controls

103 lines (72 loc) · 2.68 KB
Raw

Table of Contents

sbpf

A simple scaffold to bootstrap sBPF Assembly programs.

Dependencies

Please make sure you have the latest version of Solana Command Line Tools installed.

Installation

cargo install --git https://github.com/deanmlittle/sbpf.git

Usage

To view all the commands you can run, type sbpf help. Here are the available commands:

  • init: Create a new project scaffold.
  • build: Compile into a Solana program executable.
  • deploy: Build and deploy the program.
  • test: Test the deployed program.
  • e2e: Build, deploy, and test a program.
  • clean: Clean up build and deploy artifacts.
  • help: Print this message or the help of the given subcommand(s).
Usage: sbpf <COMMAND>

Commands:
  init    Create a new project scaffold
  build   Compile into a Solana program executable
  deploy  Build and deploy the program
  test    Test deployed program
  e2e     Build, deploy and test a program
  clean   Clean up build and deploy artifacts
  help    Print this message or the help of the given subcommand(s)

Options:
  -h, --help     Print help
  -V, --version  Print version

Command Details

Initialize a Project

To create a new project, use the sbpf init command. By default, it initializes a project with Rust tests using Mollusk. You can also initialize a project with TypeScript tests using the --ts-tests option.

sbpf init --help
Create a new project scaffold

Usage: sbpf init [OPTIONS] [NAME]

Arguments:
  [NAME]  The name of the project to create

Options:
  -t, --ts-tests  Initialize with TypeScript tests instead of Mollusk Rust tests
  -h, --help      Print help information
  -V, --version   Print version information
Examples
Create a new project with Rust tests (default)
sbpf init my-project
Create a new project with TypeScript tests
sbpf init my-project --ts-tests

After initializing the project, you can navigate into the project directory and use other commands to build, deploy, and test your program.

Advanced Usage

You can override the default linker with a custom linker file by including it in the src directory with the same name as your program. For example:

src/example/example.s
src/example/example.ld

Contributing

PRs welcome!