Account Compression: Version ChangeLog + Test (#3632)

* AC: export idl in SDK, add cmt helper functions

* AC: remove unnecessary events, emit statements

* AC: update noop program id

* AC: make events a typed struct (remove anchor event attr)

* AC: update AC program id, only emit events via cpi

* AC: update TS sdk

* AC: add event tests

* AC: update Anchor.toml

* AC: remove old program ids

Author: ngundotra

account-compression/Anchor.toml

@@ -1,11 +1,8 @@
 [programs.localnet]
-spl_account_compression = "GRoLLzvxpxxu2PGNJMMeZPyMxjAUH9pKqxGXV9DGiceU"
-
-[programs.testnet]
-spl_account_compression = "GRoLLMza82AiYN7W9S9KCCtCyyPRAQP2ifBy4v4D5RMD"
+spl_account_compression = "cmtDvXumGCrqC1Age74AVPhSRVXJMd8PJS91L8KbNCK"
 
 [[test.genesis]]
-address = "WRAPYChf58WFCnyjXKJHtrPgzKXgHp6MD9aVDqJBbGh"
+address = "noopb9bkMVfRPU8AsbpTUg8AQkHtKwMYZiFUjNRtMmV"
 program = "./target/deploy/wrapper.so"
 
 [registry]

account-compression/programs/account-compression/src/canopy.rs

@@ -69,16 +69,20 @@ fn get_cached_path_length(canopy: &mut [Node], max_depth: u32) -> Result<u32> {
 pub fn update_canopy(
     canopy_bytes: &mut [u8],
     max_depth: u32,
-    change_log: Option<Box<ChangeLogEvent>>,
+    change_log: Option<&ChangeLogEvent>,
 ) -> Result<()> {
     check_canopy_bytes(canopy_bytes)?;
     let canopy = cast_slice_mut::<u8, Node>(canopy_bytes);
     let path_len = get_cached_path_length(canopy, max_depth)?;
-    if let Some(cl) = change_log {
-        // Update the canopy from the newest change log
-        for path_node in cl.path.iter().rev().skip(1).take(path_len as usize) {
-            // node_idx - 2 maps to the canopy index
-            canopy[(path_node.index - 2) as usize] = path_node.node;
+    if let Some(cl_event) = change_log {
+        match &*cl_event {
+            ChangeLogEvent::V1(cl) => {
+                // Update the canopy from the newest change log
+                for path_node in cl.path.iter().rev().skip(1).take(path_len as usize) {
+                    // node_idx - 2 maps to the canopy index
+                    canopy[(path_node.index - 2) as usize] = path_node.node;
+                }
+            }
         }
     }
     Ok(())

account-compression/programs/account-compression/src/data_wrapper/mod.rs

@@ -7,6 +7,7 @@
 //! vital to the functioning of compression. When compression logs are truncated, indexers can fallback to
 //! deserializing the CPI instruction data.
 
+use crate::events::AccountCompressionEvent;
 use anchor_lang::{prelude::*, solana_program::program::invoke};
 
 #[derive(Clone)]
@@ -19,11 +20,11 @@ impl anchor_lang::Id for Wrapper {
 }
 
 pub fn wrap_event<'info>(
-    data: Vec<u8>,
+    event: &AccountCompressionEvent,
     log_wrapper_program: &Program<'info, Wrapper>,
 ) -> Result<()> {
     invoke(
-        &spl_noop::instruction(data),
+        &spl_noop::instruction(event.try_to_vec()?),
         &[log_wrapper_program.to_account_info()],
     )?;
     Ok(())

account-compression/programs/account-compression/src/events/changelog_event.rs

@@ -1,9 +1,16 @@
 use crate::state::PathNode;
+
 use anchor_lang::prelude::*;
 use spl_concurrent_merkle_tree::changelog::ChangeLog;
 
-#[event]
-pub struct ChangeLogEvent {
+#[derive(AnchorDeserialize, AnchorSerialize)]
+#[repr(C)]
+pub enum ChangeLogEvent {
+    V1(ChangeLogEventV1),
+}
+
+#[derive(AnchorDeserialize, AnchorSerialize)]
+pub struct ChangeLogEventV1 {
     /// Public key of the ConcurrentMerkleTree
     pub id: Pubkey,
 
@@ -36,11 +43,11 @@ impl<const MAX_DEPTH: usize> From<(Box<ChangeLog<MAX_DEPTH>>, Pubkey, u64)>
             })
             .collect();
         path.push(PathNode::new(changelog.root, 1));
-        Box::new(ChangeLogEvent {
+        Box::new(ChangeLogEvent::V1(ChangeLogEventV1 {
             id: tree_id,
             path,
             seq,
             index: changelog.index,
-        })
+        }))
     }
 }

account-compression/programs/account-compression/src/events/mod.rs

@@ -1,7 +1,14 @@
 //! Anchor events are used to emit information necessary to
 //! index changes made to a SPL ConcurrentMerkleTree
+
+use anchor_lang::prelude::*;
+
 mod changelog_event;
-mod new_leaf_event;
 
 pub use changelog_event::ChangeLogEvent;
-pub use new_leaf_event::NewLeafEvent;
+
+#[derive(AnchorDeserialize, AnchorSerialize)]
+#[repr(C)]
+pub enum AccountCompressionEvent {
+    ChangeLog(ChangeLogEvent),
+}

account-compression/programs/account-compression/src/events/new_leaf_event.rs

@@ -23,7 +23,6 @@
 //! A production-ready indexer (Plerkle) can be found in the [Metaplex program library](https://github.com/metaplex-foundation/digital-asset-validator-plugin)
 
 use anchor_lang::{
-    emit,
     prelude::*,
     solana_program::sysvar::{clock::Clock, rent::Rent},
 };
@@ -40,7 +39,7 @@ pub mod zero_copy;
 use crate::canopy::{fill_in_proof_from_canopy, update_canopy};
 use crate::data_wrapper::{wrap_event, Wrapper};
 use crate::error::AccountCompressionError;
-use crate::events::ChangeLogEvent;
+use crate::events::{AccountCompressionEvent, ChangeLogEvent};
 use crate::state::{ConcurrentMerkleTreeHeader, CONCURRENT_MERKLE_TREE_HEADER_SIZE_V1};
 use crate::zero_copy::ZeroCopy;
 
@@ -49,7 +48,7 @@ pub use spl_concurrent_merkle_tree::{
     concurrent_merkle_tree::ConcurrentMerkleTree, error::ConcurrentMerkleTreeError, node::Node,
 };
 
-declare_id!("GRoLLzvxpxxu2PGNJMMeZPyMxjAUH9pKqxGXV9DGiceU");
+declare_id!("cmtDvXumGCrqC1Age74AVPhSRVXJMd8PJS91L8KbNCK");
 
 /// Context for initializing a new SPL ConcurrentMerkleTree
 #[derive(Accounts)]
@@ -243,9 +242,11 @@ pub mod spl_account_compression {
         let merkle_tree_size = merkle_tree_get_size(&header)?;
         let (tree_bytes, canopy_bytes) = rest.split_at_mut(merkle_tree_size);
         let id = ctx.accounts.merkle_tree.key();
-        let change_log = merkle_tree_apply_fn!(header, id, tree_bytes, initialize,)?;
-        wrap_event(change_log.try_to_vec()?, &ctx.accounts.log_wrapper)?;
-        emit!(*change_log);
+        let change_log_event = merkle_tree_apply_fn!(header, id, tree_bytes, initialize,)?;
+        wrap_event(
+            &AccountCompressionEvent::ChangeLog(*change_log_event),
+            &ctx.accounts.log_wrapper,
+        )?;
         update_canopy(canopy_bytes, header.get_max_depth(), None)
     }
 
@@ -310,7 +311,6 @@ pub mod spl_account_compression {
     //         index
     //     )?;
     //     wrap_event(change_log.try_to_vec()?, &ctx.accounts.log_wrapper)?;
-    //     emit!(*change_log);
     //     update_canopy(canopy_bytes, header.max_depth, Some(change_log))
     // }
 
@@ -346,7 +346,7 @@ pub mod spl_account_compression {
         fill_in_proof_from_canopy(canopy_bytes, header.get_max_depth(), index, &mut proof)?;
         let id = ctx.accounts.merkle_tree.key();
         // A call is made to ConcurrentMerkleTree::set_leaf(root, previous_leaf, new_leaf, proof, index)
-        let change_log = merkle_tree_apply_fn!(
+        let change_log_event = merkle_tree_apply_fn!(
             header,
             id,
             tree_bytes,
@@ -357,9 +357,15 @@ pub mod spl_account_compression {
             &proof,
             index,
         )?;
-        wrap_event(change_log.try_to_vec()?, &ctx.accounts.log_wrapper)?;
-        emit!(*change_log);
-        update_canopy(canopy_bytes, header.get_max_depth(), Some(change_log))
+        update_canopy(
+            canopy_bytes,
+            header.get_max_depth(),
+            Some(&change_log_event),
+        )?;
+        wrap_event(
+            &AccountCompressionEvent::ChangeLog(*change_log_event),
+            &ctx.accounts.log_wrapper,
+        )
     }
 
     /// Transfers `authority`.
@@ -442,10 +448,16 @@ pub mod spl_account_compression {
         let id = ctx.accounts.merkle_tree.key();
         let merkle_tree_size = merkle_tree_get_size(&header)?;
         let (tree_bytes, canopy_bytes) = rest.split_at_mut(merkle_tree_size);
-        let change_log = merkle_tree_apply_fn!(header, id, tree_bytes, append, leaf)?;
-        wrap_event(change_log.try_to_vec()?, &ctx.accounts.log_wrapper)?;
-        emit!(*change_log);
-        update_canopy(canopy_bytes, header.get_max_depth(), Some(change_log))
+        let change_log_event = merkle_tree_apply_fn!(header, id, tree_bytes, append, leaf)?;
+        update_canopy(
+            canopy_bytes,
+            header.get_max_depth(),
+            Some(&change_log_event),
+        )?;
+        wrap_event(
+            &AccountCompressionEvent::ChangeLog(*change_log_event),
+            &ctx.accounts.log_wrapper,
+        )
     }
 
     /// This instruction takes a proof, and will attempt to write the given leaf
@@ -480,7 +492,7 @@ pub mod spl_account_compression {
         fill_in_proof_from_canopy(canopy_bytes, header.get_max_depth(), index, &mut proof)?;
         // A call is made to ConcurrentMerkleTree::fill_empty_or_append
         let id = ctx.accounts.merkle_tree.key();
-        let change_log = merkle_tree_apply_fn!(
+        let change_log_event = merkle_tree_apply_fn!(
             header,
             id,
             tree_bytes,
@@ -490,8 +502,14 @@ pub mod spl_account_compression {
             &proof,
             index,
         )?;
-        wrap_event(change_log.try_to_vec()?, &ctx.accounts.log_wrapper)?;
-        emit!(*change_log);
-        update_canopy(canopy_bytes, header.get_max_depth(), Some(change_log))
+        update_canopy(
+            canopy_bytes,
+            header.get_max_depth(),
+            Some(&change_log_event),
+        )?;
+        wrap_event(
+            &AccountCompressionEvent::ChangeLog(*change_log_event),
+            &ctx.accounts.log_wrapper,
+        )
     }
 }

account-compression/programs/account-compression/src/lib.rs

@@ -3,7 +3,7 @@ use solana_program::{
     pubkey::Pubkey,
 };
 
-declare_id!("WRAPYChf58WFCnyjXKJHtrPgzKXgHp6MD9aVDqJBbGh");
+declare_id!("noopb9bkMVfRPU8AsbpTUg8AQkHtKwMYZiFUjNRtMmV");
 
 #[cfg(not(feature = "no-entrypoint"))]
 use solana_program::entrypoint;

account-compression/programs/noop/src/lib.rs

@@ -0,0 +1,3 @@
+dist/
+test-ledger/
+yarn-error.log

account-compression/sdk/.gitignore

@@ -0,0 +1,4 @@
+node_modules/
+test-ledger/
+tests/
+yarn-error.log