solana/sdk/bpf
jackcmay 188904c318
Fix Docker paths after move (#1986)
2018-12-02 13:47:05 -08:00
..
inc Move bpf-sdk to sdk/bpf 2018-12-01 10:47:59 -08:00
llvm-docker Fix Docker paths after move (#1986) 2018-12-02 13:47:05 -08:00
scripts Write versions in .. 2018-12-02 12:17:44 -08:00
.gitignore Avoid unnecessary llvm/ subdirectory 2018-12-01 12:37:57 -08:00
README.md Remove upstream LLVM install instructions as we now (temporarily) bundle a forked LLVM 2018-12-01 10:47:59 -08:00
bpf.mk Fix Docker paths after move (#1986) 2018-12-02 13:47:05 -08:00

README.md

Development

Quick start

To get started create a makefile containing:

include path/to/bpf.mk

and src/program.c containing:

#include <solana_sdk.h>

bool entrypoint(const uint8_t *input) {
  SolKeyedAccount ka[1];
  uint8_t *data;
  uint64_t data_len;

  if (!sol_deserialize(buf, ka, SOL_ARRAY_SIZE(ka), NULL, &data, &data_len)) {
    return false;
  }
  print_params(1, ka, data, data_len);
  return true;
}

Then run make to build out/program.o. Run make help for more details.

Unit tests

Built-in support for unit testing is provided by the Criterion test framework. To get started create the file test/example.c containing:

#include <criterion/criterion.h>
#include "../src/program.c"

Test(test_suite_name, test_case_name) {
  cr_assert(true);
}

Then run make test.

Limitations

  • Programs must be fully contained within a single .c file
  • No libc is available but solana_sdk.h provides a minimal set of primitives