Solana typegen

• decodes instruction and log message data based on the IDL
• exposes useful constants such as program IDs and instruction discriminators
• provides functions that simplify selecting data items based on accounts

npm install @subsquid/solana-typegen

1. as a plain JSON file(s):
   npx squid-solana-typegen src/abi whirlpool.json
   
   If you use this option, you can also place your JSON IDLs to the idl folder and run
   npx squid-solana-typegen src/abi ./idl/*
   
2. load IDL from a Solana node or the SolanaFM registry and generate types:
   npx squid-solana-typegen src/abi whirLbMiicVdio4qvUfM5KAg6Ct8VwpYzGff3uctyCc#whirlpool
   
   Use --solana-rpc-endpoint <url> to choose the RPC endpoint for onchain IDL lookup.
3. load an IDL from an HTTP(S) URL:
   npx squid-solana-typegen src/abi https://example.com/whirlpool.json#whirlpool
   

​

Usage

1. Constants: Solana instruction discriminators for addInstruction() data requests:
   // generated by squid-solana-typegen
   import * as whirlpool from "./abi/whirlpool";
   
   const dataSource = new DataSourceBuilder()
     .setPortal("https://portal.sqd.dev/datasets/solana-mainnet")
     .addInstruction({
       where: {
         programId: [whirlpool.programId],
         d8: [whirlpool.instructions.swap.d8]
       }
     })
     .build();
   
2. Decoding of Solana instructions
   // generated by squid-solana-typegen
   import * as whirlpool from "./abi/whirlpool";
   import { augmentBlock } from "@subsquid/solana-objects";
   
   // ...
   
   // the .d8 getter below requires augmented block items
   let blocks = ctx.blocks.map(augmentBlock)
   
   for (let block of blocks) {
     for (let ins of block.instructions) {
       if (ins.programId === whirlpool.programId &&
           ins.d8 === whirlpool.instructions.swap.d8) {
   
         let decodedSwap = whirlpool.instructions.swap.decode(ins)
         let { accounts, data } = decodedSwap
       }
     }
   }
   
   decode() reads the data and accounts fields of the instruction item — request both with setFields().
3. Simplifying the account-specific data requests
   .addInstruction({
     where: {
       programId: [whirlpool.programId],
       d8: [whirlpool.instructions.swap.d8],
       // select instructions for the USDC-SOL pair only
       ...whirlpool.instructions.swap.accountSelection({
         whirlpool: ['7qbRF6YsyGuLUVs6Y1q64bdVrfe4ZcUUz1JRdoVNUJnm']
       })
     }
   })