session-keys

Crates.iosession-keys
lib.rssession-keys
version2.0.4
sourcesrc
created_at2023-09-11 01:13:47.980859
updated_at2024-05-07 09:19:09.949463
descriptionGum Session Protocol (GPL Session)
homepage
repositoryhttps://github.com/magicblock-labs/gum-program-library
max_upload_size
id969110
size10,157
Gabriele Picco (GabrielePicco)

documentation

README

GPL Session

Manage sessions in your Solana Anchor Programs.

Installation

cargo add session-keys --features no-entrypoint

Usage

  1. Import the dependencies
use session_keys::{SessionError, SessionToken, session_auth_or, Session};
  1. Derive the Session trait on your instruction struct
#[derive(Accounts, Session)]
pub struct Instruction<'info> {
    .....
    pub user: Account<'info, User>,

    #[session(
        // The ephemeral keypair signing the transaction
        signer = signer,
        // The authority of the user account which must have created the session
        authority = user.authority.key()
    )]
    // Session Tokens are passed as optional accounts
    pub session_token: Option<Account<'info, SessionToken>>,

    #[account(mut)]
    pub signer: Signer<'info>,
    .....
}
  1. Add the session_auth_or macro to your instruction handler with fallback logic on who the instruction should validate the signer when sessions are not present and an appropirate ErrorCode. If you've used require*! macros in anchor_lang you already know how this works.
#[session_auth_or(
    ctx.accounts.user.authority.key() == ctx.accounts.authority.key(),
    ErrorCode
)]
pub fn ix_handler(ctx: Context<Instruction>,) -> Result<()> {
.....
}

Example

See KamikazeJoe for an example of a game using session-keys.

Commit count: 81

cargo fmt