Struct ChainparserDeserializer

pub struct ChainparserDeserializer<'opts> { /* private fields */ }

Setup to deserialize accounts for a given program. The accounts are expected to have been serialized using the borsh format.

Uses deserializers defined inside [deserializer] modules under the hood in order to resolve the appropriate borsh deserializers for each field.

Implementations

impl<'opts> ChainparserDeserializer<'opts>

pub fn new(json_serialization_opts: &'opts JsonSerializationOpts) -> Self

Creates an instance of a ChainparserDeserializer. Make sure to use ChainparserDeserializer::add_idl_json for each program before attempting to deserialize accounts for it.

• [serialization_opts] specifying how specific data types should be deserialized.

pub fn try_add_idl_for_program<T: AccountProvider>( &mut self, account_provider: &T, program_id: &Pubkey, ) -> ChainparserResult<Option<IdlProvider>>

Attempts to find the IDL account for the given [program_id] and adds it to the deserializer. It first tries to find an anchor IDl account and then tries shank. Returns Some:: if the IDL was found and added, and None:: if neither a shank nor an anchor IDL account was found.

pub fn add_idl_json( &mut self, id: String, idl_json: &str, provider: IdlProvider, ) -> ChainparserResult<()>

Parses an [IDL] specification from the provided [idl_json] for the [id] and adds a json accounts deserializer derived from it. The id is usually the program id, possibly combined with the slot at which the IDL was uploaded.

pub fn add_idl( &mut self, id: String, idl: Idl, provider: IdlProvider, ) -> ChainparserResult<()>

Adds [IDL] specification from the provided [idl] for the [id] and adds a json accounts deserializer derived from it. The id is usually the program id, possibly combined with the slot at which the IDL was uploaded.

pub fn account_name(&self, id: &str, account_data: &[u8]) -> Option<&str>

pub fn has_idl(&self, id: &str) -> bool

Returns true if the IDL of the given [id] has been added to the deserializer. The id is usually the program id, possibly combined with the slot at which the IDL was uploaded.

pub fn added_idls(&self) -> HashSet<String>

Returns all program ids for which IDLs have been added to the deserializer.

pub fn deserialize_account_to_json_string( &self, id: &str, account_data: &mut &[u8], ) -> ChainparserResult<String>

Deserializes an account to a JSON string.

In order to specify a custom Write writer, i.e. a socket connection to write to, use [deserialize_account] instead.

• [id] is the program id of program that owns the account, possibly combined with the slot at which the IDL to use for deserialization was uploaded. make sure to add it’s IDL before via ChainparserDeserializer::add_idl_json.
• [account_data] is the raw account data as a byte array

pub fn deserialize_account_to_json<W: Write>( &self, id: &str, account_data: &mut &[u8], f: &mut W, ) -> ChainparserResult<()>

Deserializes an account and writes the resulting JSON to the provided Write write [f].

• [id] is the program id of program that owns the account, possibly combined with the slot at which the IDL to use for deserialization was uploaded. Make sure to add it’s IDL before via ChainparserDeserializer::add_idl_json.
• [account_data] is the raw account data as a byte array
• [f] is the Write writer to write the resulting JSON to, i.e. std::io::stdout() or String::new()

pub fn deserialize_account_to_json_by_name<W: Write>( &self, id: &str, name: &str, account_data: &mut &[u8], f: &mut W, ) -> ChainparserResult<()>