03: preparing SDK generation

README.md

@@ -8,7 +8,7 @@ It is built using the _MetaStack_ consisting of the following tools:
 - [shank](https://github.com/metaplex-foundation/shank) which extracts IDL data from the Rust
   program
 - [solita](https://github.com/metaplex-foundation/solita) which generates a TypeScript SDK from
-  the extrated IDL
+  the extracted IDL
 - [amman](https://github.com/metaplex-foundation/amman) which allows debugging and testing the
   program on a local validator
 
@@ -32,6 +32,11 @@ functions against that program after it is deployed on a local validator via _am
 ```sh
 cd program && cargo build-bpf
 ```
+### Generating SDK
+
+```sh
+cd ts && yarn api:gen
+```
 
 ### Running SDK Tests
 
@@ -51,11 +56,11 @@ For example to checkout step **2** you'd do: `git switch 2 -c pr/2`.
 
 1. [adding solana rust program with processor method stubs](https://github.com/thlorenz/tictactoe/pull/1)
 2. [setup SDK package](https://github.com/thlorenz/tictactoe/pull/2)
+3. [preparing SDK generation](https://github.com/thlorenz/tictactoe/pull/3)
 
 ## Resources
 
-- [Figma
-  Board](https://www.figma.com/file/mjzOnSoQ6cOlmRhCLFYgxn/Shank%2FSolita%2FAmman-Solana-Development-Toolbelt)
+- [Figma Board](https://www.figma.com/file/mjzOnSoQ6cOlmRhCLFYgxn/Shank%2FSolita%2FAmman-Solana-Development-Toolbelt)
   used to explain the _MetaStack_.
 
 ## LICENSE

program/Cargo.toml

@@ -17,5 +17,6 @@ test-bpf = []
 borsh = "0.9.3"
 num-derive = "0.3.3"
 num-traits = "0.2.15"
+shank = "0.0.10"
 solana-program = "1.14.5"
 thiserror = "1.0.37"

program/src/instructions.rs

@@ -1,10 +1,15 @@
 use borsh::BorshDeserialize;
+use shank::ShankInstruction;
 
 // -----------------
 // Instruction
 // -----------------
-#[derive(BorshDeserialize)]
+#[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),

ts/.prettierrc

@@ -0,0 +1,9 @@
+{
+  "semi": false,
+  "singleQuote": true,
+  "trailingComma": "es5",
+  "useTabs": false,
+  "tabWidth": 2,
+  "arrowParens": "always",
+  "printWidth": 80
+}

ts/.solitarc.js

@@ -0,0 +1,14 @@
+const path = require('path')
+const programDir = path.join(__dirname, '..', 'program')
+const idlDir = path.join(__dirname, 'idl')
+const sdkDir = path.join(__dirname, 'src', 'generated')
+const binaryInstallDir = path.join(__dirname, '.crates')
+
+module.exports = {
+  idlGenerator: 'shank',
+  programName: 'tictactoe',
+  idlDir,
+  sdkDir,
+  binaryInstallDir,
+  programDir,
+}

ts/package.json

@@ -11,7 +11,8 @@
     "build": "rimraf dist && tsc -p tsconfig.json",
     "pretest": "yarn build",
     "test": "tape dist/test/*.js",
-    "t": "esr ./test/tictactoe.ts | tap-spec"
+    "t": "esr ./test/tictactoe.ts | tap-spec",
+    "api:gen": "solita"
   },
   "dependencies": {
     "@metaplex-foundation/beet": "^0.7.1",