solana/accountsdb-plugin-interface
Lijun Wang 379e3ec848
Add Accountsdb plugin documentations (#21746)
Add the public facing documentation about the plugin framework: explaining the interface, how to load plugin and the example PostgreSQL plugin implementation.
Updated the rust documentation for the plugin interfaces for accounts and slot.
This changes are targeted for v1.8. Information about transactions will be updated later.
2021-12-10 15:54:40 -08:00
..
src Add Accountsdb plugin documentations (#21746) 2021-12-10 15:54:40 -08:00
Cargo.toml Add Accountsdb plugin documentations (#21746) 2021-12-10 15:54:40 -08:00
README.md AccountsDb plugin framework (#20047) 2021-09-30 14:26:17 -07:00

README.md

Solana

Solana AccountsDb Plugin Interface

This crate enables an AccountsDb plugin to be plugged into the Solana Validator runtime to take actions at the time of each account update; for example, saving the account state to an external database. The plugin must implement the AccountsDbPlugin trait. Please see the detail of the accountsdb_plugin_interface.rs for the interface definition.

The plugin should produce a cdylib dynamic library, which must expose a C function _create_plugin() that instantiates the implementation of the interface.

The solana-accountsdb-plugin-postgres crate provides an example of how to create a plugin which saves the accounts data into an external PostgreSQL databases.

More information about Solana is available in the Solana documentation.

Still have questions? Ask us on Discord