紹介

Shank

Shankは、Shank属性マクロで注釈されたSolanaプログラムコードからインターフェース定義言語(IDL)を抽出するために設計されたRustクレートのコレクションです。抽出されたIDLは、TypeScript SDKの生成やSolanaプログラムとの相互作用を促進するために使用できます。

ShankはIDLファイルの生成を自動化することで、Solanaプログラムの開発ワークフローを簡素化し、RustプログラムコードとクライアントサイドSDK間の橋渡しとして機能します。

クイックスタート

  1. Shank CLIをインストール: cargo install shank-cli
  2. プロジェクトにShankを追加: shank = "0.4"
  3. ShankAccountShankInstructionマクロでプログラムに注釈を付ける
  4. IDLを抽出: shank idl --out-dir ./target/idl --crate-root ./

主な機能

  • 5つの派生マクロ でSolanaプログラムに注釈(ShankAccountShankInstructionShankBuilderShankContextShankType
  • 注釈付きRustコードからの自動IDL生成
  • SolitaとKinobiとの統合によるTypeScript SDK生成
  • 型オーバーライドとパディングフィールドを含むBorshシリアライゼーションサポート
  • 可変性、署名者要件、説明を含む包括的なアカウントメタデータ

ドキュメント

  • はじめに - インストール、セットアップ、詳細な使用ガイド、包括的な例

統合

ShankはMetaplexの他のツールとシームレスに統合します:

  • Kinobi - モダンなIDL生成とクライアント作成
  • Solita - TypeScript SDK生成

リソース