|
| 1 | +/** |
| 2 | + * Token-2022 Configuration for Solana tokens with transfer hooks |
| 3 | + * This file contains static configurations for Token-2022 tokens to avoid RPC calls |
| 4 | + * when building transfer transactions with transfer hooks. |
| 5 | + */ |
| 6 | + |
| 7 | +import { PublicKey } from '@solana/web3.js'; |
| 8 | + |
| 9 | +/** |
| 10 | + * Interface for extra account metadata needed by transfer hooks |
| 11 | + */ |
| 12 | +export interface ExtraAccountMeta { |
| 13 | + /** The public key of the account */ |
| 14 | + pubkey: string; |
| 15 | + /** Whether the account is a signer */ |
| 16 | + isSigner: boolean; |
| 17 | + /** Whether the account is writable */ |
| 18 | + isWritable: boolean; |
| 19 | + /** Optional seed for PDA derivation */ |
| 20 | + seeds?: Array<{ |
| 21 | + /** Literal seed value or instruction account index reference */ |
| 22 | + value: string | number; |
| 23 | + /** Type of seed: 'literal' for string/buffer, 'accountKey' for instruction account index */ |
| 24 | + type: 'literal' | 'accountKey'; |
| 25 | + }>; |
| 26 | +} |
| 27 | + |
| 28 | +/** |
| 29 | + * Interface for transfer hook configuration |
| 30 | + */ |
| 31 | +export interface TransferHookConfig { |
| 32 | + /** The transfer hook program ID */ |
| 33 | + programId: string; |
| 34 | + /** The transfer hook authority */ |
| 35 | + authority: string; |
| 36 | + /** Extra account metas required by the transfer hook */ |
| 37 | + extraAccountMetas: ExtraAccountMeta[]; |
| 38 | + /** The PDA address for extra account metas (cached) */ |
| 39 | + extraAccountMetasPDA?: string; |
| 40 | +} |
| 41 | + |
| 42 | +/** |
| 43 | + * Interface for Token-2022 configuration |
| 44 | + */ |
| 45 | +export interface Token2022Config { |
| 46 | + /** The mint address of the token */ |
| 47 | + mintAddress: string; |
| 48 | + /** Token symbol */ |
| 49 | + symbol: string; |
| 50 | + /** Token name */ |
| 51 | + name: string; |
| 52 | + /** Number of decimal places */ |
| 53 | + decimals: number; |
| 54 | + /** Program ID (TOKEN_2022_PROGRAM_ID) */ |
| 55 | + programId: string; |
| 56 | + /** Transfer hook configuration if applicable */ |
| 57 | + transferHook?: TransferHookConfig; |
| 58 | + /** Whether the token has transfer fees */ |
| 59 | + hasTransferFees?: boolean; |
| 60 | +} |
| 61 | + |
| 62 | +/** |
| 63 | + * Token configurations map |
| 64 | + * Key: mintAddress or symbol |
| 65 | + */ |
| 66 | +export const TOKEN_2022_CONFIGS: Record<string, Token2022Config> = { |
| 67 | + '4MmJVdwYN8LwvbGeCowYjSx7KoEi6BJWg8XXnW4fDDp6': { |
| 68 | + mintAddress: '4MmJVdwYN8LwvbGeCowYjSx7KoEi6BJWg8XXnW4fDDp6', |
| 69 | + symbol: 'tbill', |
| 70 | + name: 'OpenEden T-Bills', |
| 71 | + decimals: 6, |
| 72 | + programId: 'TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb', // TOKEN_2022_PROGRAM_ID |
| 73 | + transferHook: { |
| 74 | + programId: '48n7YGEww7fKMfJ5gJ3sQC3rM6RWGjpUsghqVfXVkR5A', |
| 75 | + authority: 'CPNEkz5SaAcWqGMezXTti39ekErzMpDCtuPMGw9tt4CZ', |
| 76 | + extraAccountMetas: [ |
| 77 | + { |
| 78 | + pubkey: '4zDeEh2D6K39H8Zzn99CpQkaUApbpUWfbCgqbwgZ2Yf', |
| 79 | + isSigner: false, |
| 80 | + isWritable: true, |
| 81 | + }, |
| 82 | + ], |
| 83 | + extraAccountMetasPDA: '9sQhAH7vV3RKTCK13VY4EiNjs3qBq1srSYxdNufdAAXm', |
| 84 | + }, |
| 85 | + }, |
| 86 | + |
| 87 | + '3BW95VLH2za2eUQ1PGfjxwMbpsnDFnmkA7m5LDgMKbX7': { |
| 88 | + mintAddress: '3BW95VLH2za2eUQ1PGfjxwMbpsnDFnmkA7m5LDgMKbX7', |
| 89 | + symbol: 't1test', |
| 90 | + name: 'T1TEST', |
| 91 | + decimals: 6, |
| 92 | + programId: 'TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb', // TOKEN_2022_PROGRAM_ID |
| 93 | + transferHook: { |
| 94 | + programId: '2Te6MFDwstRP2sZi6DLbkhVcSfaQVffmpbudN6pmvAXo', |
| 95 | + authority: 'BLZvvaQgPUvL2RWoJeovudbHMhqH4S3kdenN5eg1juDr', |
| 96 | + extraAccountMetas: [ |
| 97 | + { |
| 98 | + pubkey: '4zDeEh2D6K39H8Zzn99CpQkaUApbpUWfbCgqbwgZ2Yf', |
| 99 | + isSigner: false, |
| 100 | + isWritable: true, |
| 101 | + }, |
| 102 | + ], |
| 103 | + extraAccountMetasPDA: 'FR5YBEisx8mDe4ruhWKmpH5nirdJopj4uStBAVufqjMo', |
| 104 | + }, |
| 105 | + }, |
| 106 | + |
| 107 | + // Add more configurations as needed |
| 108 | +}; |
| 109 | + |
| 110 | +// Create symbol mappings for convenience |
| 111 | +Object.values(TOKEN_2022_CONFIGS).forEach((config) => { |
| 112 | + TOKEN_2022_CONFIGS[config.symbol] = config; |
| 113 | +}); |
| 114 | + |
| 115 | +/** |
| 116 | + * Get token configuration by mint address |
| 117 | + * @param mintAddress - The mint address of the token |
| 118 | + * @returns Token configuration or undefined if not found |
| 119 | + */ |
| 120 | +export function getToken2022Config(mintAddress: string): Token2022Config | undefined { |
| 121 | + return TOKEN_2022_CONFIGS[mintAddress]; |
| 122 | +} |
| 123 | + |
| 124 | +/** |
| 125 | + * Get token configuration by symbol |
| 126 | + * @param symbol - The token symbol |
| 127 | + * @returns Token configuration or undefined if not found |
| 128 | + */ |
| 129 | +export function getToken2022ConfigBySymbol(symbol: string): Token2022Config | undefined { |
| 130 | + return TOKEN_2022_CONFIGS[symbol]; |
| 131 | +} |
| 132 | + |
| 133 | +/** |
| 134 | + * Check if a token has a transfer hook |
| 135 | + * @param mintAddress - The mint address of the token |
| 136 | + * @returns true if the token has a transfer hook |
| 137 | + */ |
| 138 | +export function hasTransferHook(mintAddress: string): boolean { |
| 139 | + const config = getToken2022Config(mintAddress); |
| 140 | + return config?.transferHook !== undefined; |
| 141 | +} |
| 142 | + |
| 143 | +/** |
| 144 | + * Get the extra account metas for a token's transfer hook |
| 145 | + * @param mintAddress - The mint address of the token |
| 146 | + * @returns Array of extra account metas or empty array if no transfer hook |
| 147 | + */ |
| 148 | +export function getTransferHookExtraAccounts(mintAddress: string): ExtraAccountMeta[] { |
| 149 | + const config = getToken2022Config(mintAddress); |
| 150 | + return config?.transferHook?.extraAccountMetas || []; |
| 151 | +} |
| 152 | + |
| 153 | +/** |
| 154 | + * Calculate the PDA for extra account metas |
| 155 | + * This is typically [Buffer.from('extra-account-metas'), mintPubkey.toBuffer()] |
| 156 | + * @param mintAddress - The mint address of the token |
| 157 | + * @param programId - The transfer hook program ID |
| 158 | + * @returns The PDA public key as a string |
| 159 | + */ |
| 160 | +export function calculateExtraAccountMetasPDA(mintAddress: string, programId: string): string { |
| 161 | + const mintPubkey = new PublicKey(mintAddress); |
| 162 | + const programPubkey = new PublicKey(programId); |
| 163 | + |
| 164 | + const [pda] = PublicKey.findProgramAddressSync( |
| 165 | + [Buffer.from('extra-account-metas'), mintPubkey.toBuffer()], |
| 166 | + programPubkey |
| 167 | + ); |
| 168 | + |
| 169 | + return pda.toBase58(); |
| 170 | +} |
| 171 | + |
| 172 | +/** |
| 173 | + * Add or update a token configuration at runtime |
| 174 | + * Useful for testing or adding new tokens dynamically |
| 175 | + * @param config - The token configuration to add |
| 176 | + */ |
| 177 | +export function addToken2022Config(config: Token2022Config): void { |
| 178 | + // Add both mint address and symbol keys for easy lookup |
| 179 | + TOKEN_2022_CONFIGS[config.mintAddress] = config; |
| 180 | + TOKEN_2022_CONFIGS[config.symbol] = config; |
| 181 | +} |
0 commit comments