03: preparing SDK generation

[thlorenz]

previous | next

---

Summary

In this PR we setup code generation via solita and shank.

We added shank as a dependency to the Rust program and annotated the first instruction in
order to describe which accounts should be passed to it and which should be writable and/or
signer.

#[derive(BorshDeserialize, ShankInstruction)]
#[rustfmt::skip]
pub enum TictactoeInstruction {
    #[account(name = "player_x", signer, desc = "The player initializing the game")]
    #[account(name = "game_pda", mut, desc="The game PDA")]
    #[account(name = "system_program", desc="The system program")]
    InitializeGame,
    PlayerJoin,
    PlayerMove(PlayerMove),
}

NOTE that for now we only annotated the first instruction, we will worry about the other two
later.

Inside the TypeScript SDK (./ts) we added the configuration files .solitarc and
.prettierrc that solita will use to generate the SDK code and then format it.

Additionally we added the script api:gen that we can run in order to generate the IDL and
then the code.

What you can do

Read through the changed files in this PR.

Checkout the PR via git switch 03 -c pr/03 and try the following from the ./ts folder:

Run yarn api:gen.

• this will ensure that a shank CLI is installed that matches the one that we're using in the program and then use it to generate the program IDL
• the first time it will install it so it is a bit slow, however due to caching it is a lot faster afterwards
• finally solita generates a TypeScript SDK from that IDL

Even though it isn't necessary, setting the DEBUG env var as follows results in nicer and more readable output:

• we will go into SDK generation in the next step in more detail

---

previous | next