\n \n\n## Features\n\n- 📦 **Framework agnostic** - Use it with any framework you want\n- ♻️ **Space efficient** - Reduce package size overhead as you don't have to generate SDKs for your project to use\n- 🧑💻 **User friendly** - Easy to use and understand\n\n## Getting Started\n\n### ⚡️ Installation\n\nInstall ExplorerKit with these simple commands:\n\n- Use any package manager that you desire to install ExplorerKit\n\nUsing **npm**:\n\n```bash\nnpm add @solanafm/explorer-kit\nnpm add @solanafm/explorer-kit-idls\n```\n\nUsing **yarn**:\n\n```bash\nyarn add @solanafm/explorer-kit\nyarn add @solanafm/explorer-kit-idls\n```\n\nUsing **pnpm**:\n\n```bash\npnpm add @solanafm/explorer-kit\npnpm add @solanafm/explorer-kit-idls\n```\n\nOnce the packages have been installed, you can start using ExplorerKit in your project 🎉\n\n### 🚀 Usage\n\nHow to get a SolanaFM IdlItem to start parsing a transaction or account state for a particular program:\n\n```ts\nimport { getProgramIdl } from \"@solanafm/explorer-kit-idls\";\n\nconst programId = \"PhoeNiXZ8ByJGLkxNfZRnkUfjvmuYqLR89jjFHGqdXY\";\n// Get the IDL for a specific program hash\nconst SFMIdlItem = await getProgramIdl(programId);\n// You can also get an IDL at a specific slot context if you're trying to histroically parse a transaction / account\n// but the IDL might not be backwards compatible.\nconst historicalSFMIdlItem = await getProgramIdl(programId, {\n slotContext: 132322893,\n});\n```\n\nParsing a transaction:\n\n```ts\nimport { SolanaFMParser, checkIfInstructionParser, ParserType } from \"@solanafm/explorer-kit\";\nimport { getProgramIdl } from \"@solanafm/explorer-kit-idls\";\n\nconst programId = \"PhoeNiXZ8ByJGLkxNfZRnkUfjvmuYqLR89jjFHGqdXY\";\n// Get the IDL for a specific program hash\nconst SFMIdlItem = await getProgramIdl(programId);\n// You can also get an IDL at a specific slot context if you're trying to histroically parse a transaction / account\n// but the IDL might not be backwards compatible.\nconst historicalSFMIdlItem = await getProgramIdl(programId, {\n slotContext: 132322893,\n});\n// For now, we only support parsing transactions with an encoded base 58 message\nconst ixData = \"1AMTAauCh9UPEJKKd6LnGGtWqFvRs2aUZkv9r6wNe3PTzB1KS9TbwYzM8Cp7vUSDYZXTxXJp5M\";\n// Checks if SFMIdlItem is defined, if not you will not be able to initialize the parser layout\nif (SFMIdlItem) {\n const parser = new SolanaFMParser(SFMIdlItem, programId);\n const instructionParser = parser.createParser(ParserType.INSTRUCTION);\n\n if (instructionParser && checkIfInstructionParser(instructionParser)) {\n // Parse the transaction\n const decodedData = instructionParser.parseInstructions(ixData);\n }\n}\n```\n\nParsing an event data:\n\n```ts\nimport { SolanaFMParser. checkIfEventParser, ParserType } from \"@solanafm/explorer-kit\"\n\n// For event data they have to base-64 encoded and they can be extracted from logs or a inner instruction with CPI logs.\n// Phoenix Program Event Data\nconst eventData = \"DwEABF2SDQAAAABDfDtlAAAAAKiVfA0AAAAAL9p3EN7QVm+wCbiCUn2jVyJyazsZQYgqVRhf6h2a/pX5SjR+9eBu2sQU7NYr1TEeH7vRFNOiXSyDLJ9g+fDJrwMAAgAABPzrK7CsLqR5NiVFXYwyp7QgatDNQXbn3JA8wOVXQfANFxMTAAAAAIB/AAAAAAAAg7MAAAAAAAAAAAAAAAAAAAIBAAT86yuwrC6keTYlRV2MMqe0IGrQzUF259yQPMDlV0HwDhcTEwAAAACCfwAAAAAAAByBAAAAAAAA6EwCAAAAAAAGAgAAAAAAAAAAAAAAAAAAAAAAnzQBAAAAAABzEb6ZAAAAALveBwAAAAAA\"\nconst parser = new SolanaFMParser(SFMIdlItem);\nconst eventParser = parser.createParser(ParserType.EVENT);\n\nif (eventParser && checkIfEventParser(eventParser)) {\n // Parse the transaction\n const decodedData = parser.parseEvents(eventData);\n}\n```\n\nParsing an account data:\n\n```ts\nimport { SolanaFMParser, checkIfAccountParser, ParserType } from \"@solanafm/explorer-kit\";\n\nconst SFMIdlItem = await getProgramIdl(programId);\n\n// Account data have to be base-64 encoded\n// Stake Pool Account Data\nconst accountData =\n \"AWq1iyr99ATwNekhxZcljopQjeBixmWt+p/5CTXBmRbd3Noj1MlCDU6CVh08awajdvCUB/G3tPyo/emrHFdD8Wfh4Pippvxf8kLk81F78B7Wst0ZUaC6ttlDVyWShgT3cP/LqkIDCUdVLBkThURwDuYX1RR+JyWBHNvgnIkDCm914o2jckW1NrCzDbv9Jn/RWcT0cAMYKm8U4SfG/F878wV0XwxEYxirEMlfQJSVhXDNBXRlpU2rFNnd40gahv7V/Mvj/aPav/vdTOwRdFALTRZQlijB9G5myz+0QWe7U7EGIQbd9uHXZaGT2cvhRs7reawctIXtX1s3kTqM9YV+/wCpE2P1ZIWKAQDUAp5GdmQBAMkBAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAZAAAAAAAAAAFAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAQJwAAAAAAAAUAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAECcAAAAAAAAAAAAAAAAAAABWHWK1dGQBAAgnQqFYigEAv0rw1gHIAQAPfXpGLPQBABAnAAAAAAAAAAAAAAAAAAAAicd7jscBANVMdCNW7gEAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAAA=\";\n\nconst parser = new SolanaFMParser(SFMIdlItem);\nconst eventParser = parser.createParser(ParserType.ACCOUNT);\n\nif (eventParser && checkIfAccountParser(eventParser)) {\n // Parse the transaction\n const decodedData = eventParser.parseAccount(accountData);\n}\n```\n\nOnce the data is parsed, the returned data type will look something like this\n\n```ts\nexport type ParserOutput = {\n // The name of the struct that's being used to parse the data\n name: string;\n // The parsed data according to the IDL schema\n data: any;\n // ParserType depends on the type of parser you have initialized\n type: ParserType;\n} | null;\n```\n\nMore to be added soon...\n\nYou can also checkout the [examples](https://github.com/solana-fm/explorer-kit/examples) as well!\n\n## Caveats and Limitations\n\n- IDLs found in `@solanafm/explorer-kit-idls` are usually IDLs for programs that are immutable and are not expected to change. These IDLs can be imported directly from the package and used in your project without interacting with our API. If you wish to get the latest IDLs that might be on chain, `getProgramIdl()` will do a API call to our API to query for the relevant IDLs\n- **Account** and **Event** parsers only takes in a `base64` encoded string at the moment\n- **Instruction** parsers only takes in a `base58` encoded string at the moment\n\n## Supported Programs\n\n| Program IDs | Program | Working Parsers |\n| --------------------------------------------------------------------------------------- | ------------------------------ | -------------------------------------------- |\n| 11111111111111111111111111111111 | System Program | Account, Instructions |\n| Config1111111111111111111111111111111111111 | Config Program | Account, Instructions |\n| Stake11111111111111111111111111111111111111 | Stake Program | Account, Instructions |\n| Vote111111111111111111111111111111111111111 | Vote Program | Account, Instructions |\n| ComputeBudget111111111111111111111111111111 | Compute Budget Program | Instructions |\n| BPFLoaderUpgradeab1e11111111111111111111111 | BPF Upgradeable Loader Program | Account, Instructions |\n| TokenkegQfeZyiNwAJbNbGKPFXCWuBvf9Ss623VQ5DA | Token Program | Account, Instructions |\n| TokenzQdBNbLqP5VEhdkAS6EPFLC1PHnBqCXEpPxuEb | Token 2022 Program | Account, Instructions, Extensions (built-in) |\n| namesLPneVptA9Z5rqUDD9tMTWEJwofgaYwp8cawRkX | Name Service Program | Account, Instructions |\n| SPoo1Ku8WFXoNDMHPsrGSTSG1Y47rzgn41SLUNakuHy | Stake Pool Program | Account, Instructions |\n| ATokenGPvbdGVxr1b2hvZbsiqW5xWH25efTNsLJA8knL | Associated Token Program | Instructions |\n| PhoeNiXZ8ByJGLkxNfZRnkUfjvmuYqLR89jjFHGqdXY | Phoenix Program | Account, Instructions, Events |\n| metaqbxxUerdq28cj1RbAWkYQm3ybzjb6a8bt518x1s | Token Metadata Program | Account, Instructions |\n| auth9SigNpDKz4sJJ1DfCTuZrZNSAgh9sFD3rboVmgg | Token Auth Rules Program | Instructions |\n| AddressLookupTab1e1111111111111111111111111 | Address Lookup Table | Account, Instructions |\n| SysvarC1ock11111111111111111111111111111111 | Clock Sysvar | Account |\n| SysvarEpochSchedu1e111111111111111111111111 | Epoch Schedule Sysvar | Account |\n| SysvarFees111111111111111111111111111111111 | Fees Sysvar | Account |\n| SysvarRecentB1ockHashes11111111111111111111 | Recent Blockhashes Sysvar | Account |\n| SysvarRent111111111111111111111111111111111 | Rent Sysvar | Account |\n| SysvarRewards111111111111111111111111111111 | Rewards Sysvar | Account |\n| SysvarS1otHashes111111111111111111111111111 | Slot Hashes Sysvar | Account |\n| SysvarStakeHistory1111111111111111111111111 | Stake History Sysvar | Account |\n| MemoSq4gqABAXKb96qnH8TysNcWxMyWCqXgDLGmfcHr Memo1UhkJRfHyvLMcVucJwxXeuD728EqVDDwQDxFMNo | Memo Program | Instructions |\n| cmtDvXumGCrqC1Age74AVPhSRVXJMd8PJS91L8KbNCK | SPL Account Compression | Instructions, Events |\n| BGUMAp9Gq7iTEuizy4pqaxsTyUCBK68MDfK752saRPUY | Bubblegum | Instructions, Events |\n| TCMPhJdwDryooaGtiocG1u3xcYbRpiJzb283XfCZsDp | Tensor Compression | Instructions, Events |\n\nAnd many more programs that have their IDLs uploaded on chain. Feel free to contact anyone in the team or open a pull request to have your IDLs added to the list!\n\n## Credits\n\nExplorer Kit is hugely inspired and built upon [Kinobi](https://github.com/metaplex-foundation/kinobi). Without Kinobi, Explorer Kit would not have been possible at it's current iteration.\n\nAlso, huge thanks to the following projects and engineers for making this possible:\n\n- [Loris](https://github.com/lorisleiva) - For all the work and help he has poured into Kinobi and Umi\n- [Umi](https://github.com/metaplex-foundation/umi) - Usage of their deserializers to decode the various data types\n- [Kinobi](https://github.com/metaplex-foundation/kinobi) - Kinobi parsing of IDLs to a Kinobi Tree has been a great inspiration in creating a layout to be stored in memory for deserialization\n- [Anchor](https://github.com/coral-xyz/anchor/tree/master)\n\n## Contributing\n\nWe welcome all contributions to Explorer Kit! Feel free to open a pull request or issues to discuss your ideas and suggestions. You may checkout our [contributing guide](/CONTRIBUTING.md) for more information on how to contribute to Explorer Kit.\n\n## License\n\nExplorer Kit is licensed under the [GNU v3](/LICENSE)\n","readmeFilename":"README.md"}
![\"SolanaFM](\"images/logo.png\"){kind=logo}
\n \n![](\"https://img.shields.io/npm/v/%40solanafm%2Fexplorer-kit?logo=npm&label=explorer-kit\")
\n ![](\"https://img.shields.io/npm/v/%40solanafm%2Fexplorer-kit-idls?logo=npm&label=explorer-kit-idls\")
\n