Account Compression: 0.1.2 release (#3672)

ngundotra · web-flow · commit b0d84fc44d45 · 2022-10-06T11:58:16.000-05:00
* ac: expose wrap_application_data_v1, hide wrap_event

* ac: separate event deserialization methods, update IDL

* ac: add test for deserializing application data event

* ac: add crate READMEs, update top-level README

* ac: bump version to 0.1.2
diff --git a/account-compression/Cargo.lock b/account-compression/Cargo.lock
diff --git a/account-compression/README.md b/account-compression/README.md
@@ -1,23 +1,31 @@
-# Account Compression
+# Account Compression (Beta)
 
 This on-chain program provides an interface for composing smart-contracts to create and use
 SPL ConcurrentMerkleTrees. The primary application of using SPL ConcurrentMerkleTrees is
 to make edits to off-chain data with on-chain verification. 
 
-Using this program requires an indexer to parse transaction information and write relevant information to an off-chain database.
+This program is targeted towards supporting [Metaplex Compressed NFTs](https://github.com/metaplex-foundation/metaplex-program-library/tree/master/bubblegum) and may be subject to change.
 
+Note: Using this program requires an indexer to parse transaction information and write relevant information to an off-chain database.
 
-## SDK 
+A _**rough draft**_ of the whitepaper for SPL ConcurrentMerkleTree's can be found [here](https://drive.google.com/file/d/1BOpa5OFmara50fTvL0VIVYjtg-qzHCVc/view).
 
-The typescript SDK for this contract will be generated using Metaplex Foundation's [Solita](https://github.com/metaplex-foundation/solita/). 
+## Rust Packages
 
-## Testing
+* `spl-account-compression`: SDK for interacting with account compression program
+* `spl-noop`: SDK for interacting with no op program, primarily for circumventing log truncation
+* `spl-concurrent-merkle-tree`: SDK for creating SPL ConcurrentMerkleTrees
+
+## Typescript SDK
+
+`@solana/spl-account-compression` is generated using Metaplex Foundation's [Solita](https://github.com/metaplex-foundation/solita/). 
+
+## Testing and Development
 
 Testing contracts locally requires the SDK to be built. 
-See the SDK folder for instructions.
 
 With a built local SDK, the test suite can be ran with:
 
 1. `yarn link @solana/spl-account-compression`
 2. `yarn`
-3. `anchor test`
+3. `yarn test`
diff --git a/account-compression/programs/account-compression/Cargo.toml b/account-compression/programs/account-compression/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "spl-account-compression"
-version = "0.1.1"
+version = "0.1.2"
 description = "Solana Program Library Account Compression Program"
 authors = ["Solana Maintainers <maintainers@solana.foundation>"]
 repository = "https://github.com/solana-labs/solana-program-library"
@@ -21,7 +21,7 @@ default = []
 anchor-lang = "0.25.0"
 bytemuck = "1.8.0"
 spl-concurrent-merkle-tree = { version = "0.1.1", path="../../../libraries/concurrent-merkle-tree", features = [ "sol-log" ]}
-spl-noop = { version = "0.1.1", path="../noop", features = [ "no-entrypoint" ]}
+spl-noop = { version = "0.1.2", path="../noop", features = [ "no-entrypoint" ]}
 
 [profile.release]
 overflow-checks = true
diff --git a/account-compression/programs/account-compression/README.md b/account-compression/programs/account-compression/README.md
@@ -0,0 +1,13 @@
+<p align="center">
+  <a href="https://solana.com">
+    <img alt="Solana" src="https://i.imgur.com/IKyzQ6T.png" width="250" />
+  </a>
+</p>
+
+# SPL Account Compression Rust SDK (Beta)
+
+More information about account compression can be found in [the solana-program-library repo](https://github.com/solana-labs/solana-program-library/tree/master/account-compression).
+
+The [Solana Program Examples repo](https://github.com/solana-developers/program-examples) will eventually include examples of how to use this program.
+
+`spl-account-compression` and this crate's implementation are targeted towards supporting [Metaplex Compressed NFTs](https://github.com/metaplex-foundation/metaplex-program-library/tree/master/bubblegum) and may be subject to change.
diff --git a/account-compression/programs/account-compression/src/data_wrapper/mod.rs b/account-compression/programs/account-compression/src/data_wrapper/mod.rs
@@ -7,7 +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 crate::events::{AccountCompressionEvent, ApplicationDataEvent, ApplicationDataEventV1};
 use anchor_lang::{prelude::*, solana_program::program::invoke};
 
 #[derive(Clone)]
@@ -29,3 +29,17 @@ pub fn wrap_event<'info>(
     )?;
     Ok(())
 }
+
+/// Wraps a custom event in the most recent version of application event data
+pub fn wrap_application_data_v1<'info>(
+    custom_data: Vec<u8>,
+    log_wrapper_program: &Program<'info, Wrapper>,
+) -> Result<()> {
+    let versioned_data = ApplicationDataEventV1 {
+        application_data: custom_data,
+    };
+    wrap_event(
+        &AccountCompressionEvent::ApplicationData(ApplicationDataEvent::V1(versioned_data)),
+        log_wrapper_program,
+    )
+}
diff --git a/account-compression/programs/account-compression/src/events/application_data.rs b/account-compression/programs/account-compression/src/events/application_data.rs
@@ -0,0 +1,12 @@
+use anchor_lang::prelude::*;
+
+#[derive(AnchorDeserialize, AnchorSerialize)]
+#[repr(C)]
+pub enum ApplicationDataEvent {
+    V1(ApplicationDataEventV1),
+}
+
+#[derive(AnchorDeserialize, AnchorSerialize)]
+pub struct ApplicationDataEventV1 {
+    pub application_data: Vec<u8>,
+}
diff --git a/account-compression/programs/account-compression/src/events/mod.rs b/account-compression/programs/account-compression/src/events/mod.rs
@@ -3,12 +3,15 @@
 
 use anchor_lang::prelude::*;
 
+mod application_data;
 mod changelog_event;
 
+pub use application_data::{ApplicationDataEvent, ApplicationDataEventV1};
 pub use changelog_event::ChangeLogEvent;
 
 #[derive(AnchorDeserialize, AnchorSerialize)]
 #[repr(C)]
 pub enum AccountCompressionEvent {
     ChangeLog(ChangeLogEvent),
+    ApplicationData(ApplicationDataEvent),
 }
diff --git a/account-compression/programs/account-compression/src/lib.rs b/account-compression/programs/account-compression/src/lib.rs
@@ -30,14 +30,16 @@ use borsh::{BorshDeserialize, BorshSerialize};
 use std::mem::size_of;
 
 pub mod canopy;
-pub mod data_wrapper;
+mod data_wrapper;
 pub mod error;
 pub mod events;
 pub mod state;
 pub mod zero_copy;
 
+pub use crate::data_wrapper::{wrap_application_data_v1, Wrapper};
+
 use crate::canopy::{fill_in_proof_from_canopy, update_canopy};
-use crate::data_wrapper::{wrap_event, Wrapper};
+use crate::data_wrapper::wrap_event;
 use crate::error::AccountCompressionError;
 use crate::events::{AccountCompressionEvent, ChangeLogEvent};
 use crate::state::{ConcurrentMerkleTreeHeader, CONCURRENT_MERKLE_TREE_HEADER_SIZE_V1};
diff --git a/account-compression/programs/noop/Cargo.toml b/account-compression/programs/noop/Cargo.toml
@@ -1,6 +1,6 @@
 [package]
 name = "spl-noop"
-version = "0.1.1"
+version = "0.1.2"
 description = "Solana Program Library No-op Program"
 authors = ["Solana Maintainers <maintainers@solana.foundation>"]
 repository = "https://github.com/solana-labs/solana-program-library"
@@ -12,8 +12,6 @@ crate-type = ["cdylib", "lib"]
 
 [features]
 no-entrypoint = []
-no-idl = []
-no-log-ix-name = []
 cpi = ["no-entrypoint"]
 default = []
 
diff --git a/account-compression/programs/noop/README.md b/account-compression/programs/noop/README.md
@@ -0,0 +1,24 @@
+<p align="center">
+  <a href="https://solana.com">
+    <img alt="Solana" src="https://i.imgur.com/IKyzQ6T.png" width="250" />
+  </a>
+</p>
+
+# SPL Noop Rust SDK
+
+This is crate provides a wrapper for invoking `spl-noop`, which does nothing. 
+It's primary use is circumventing log truncation when emitting application data by `invoke`-ing `spl-noop` with event data.
+
+<p align="center">
+  <a href="https://solana.com">
+    <img alt="Solana" src="https://i.imgur.com/IKyzQ6T.png" width="250" />
+  </a>
+</p>
+
+# SPL Account Compression Rust SDK (Beta)
+
+More information about account compression can be found in [the solana-program-library repo](https://github.com/solana-labs/solana-program-library/tree/master/account-compression).
+
+The [Solana Program Examples repo](https://github.com/solana-developers/program-examples) will eventually include examples of how to use this program.
+
+`spl-noop` and this crate's implementation are targeted towards supporting [account-compression](https://github.com/solana-labs/solana-program-library/tree/master/account-compression) and may be subject to change.
diff --git a/account-compression/sdk/idl/spl_account_compression.json b/account-compression/sdk/idl/spl_account_compression.json
@@ -327,6 +327,18 @@
     }
   ],
   "types": [
+    {
+      "name": "ApplicationDataEventV1",
+      "type": {
+        "kind": "struct",
+        "fields": [
+          {
+            "name": "applicationData",
+            "type": "bytes"
+          }
+        ]
+      }
+    },
     {
       "name": "ChangeLogEventV1",
       "type": {
@@ -483,6 +495,22 @@
         ]
       }
     },
+    {
+      "name": "ApplicationDataEvent",
+      "type": {
+        "kind": "enum",
+        "variants": [
+          {
+            "name": "V1",
+            "fields": [
+              {
+                "defined": "ApplicationDataEventV1"
+              }
+            ]
+          }
+        ]
+      }
+    },
     {
       "name": "ChangeLogEvent",
       "type": {
@@ -511,6 +539,14 @@
                 "defined": "ChangeLogEvent"
               }
             ]
+          },
+          {
+            "name": "ApplicationData",
+            "fields": [
+              {
+                "defined": "ApplicationDataEvent"
+              }
+            ]
           }
         ]
       }
diff --git a/account-compression/sdk/src/events/index.ts b/account-compression/sdk/src/events/index.ts
@@ -1,16 +1,15 @@
 import { ChangeLogEventV1 } from "../types";
 import { accountCompressionEventBeet } from "../generated/types/AccountCompressionEvent";
 import BN from 'bn.js';
+import { ApplicationDataEvent, ChangeLogEvent, ChangeLogEventV1 as CLV1 } from "../generated";
 
-export type AccountCompressionEventType = ChangeLogEventV1;
-
-export function deserializeAccountCompressionEvent(data: Buffer): AccountCompressionEventType {
+export function deserializeChangeLogEventV1(data: Buffer): ChangeLogEventV1 {
     const event = accountCompressionEventBeet.toFixedFromData(data, 0).read(data, 0)
     switch (event.__kind) {
         case "ChangeLog": {
             switch (event.fields[0].__kind) {
                 case "V1":
-                    const changeLogV1 = event.fields[0].fields[0];
+                    const changeLogV1: CLV1 = event.fields[0].fields[0];
                     return {
                         treeId: changeLogV1.id,
                         seq: new BN.BN(changeLogV1.seq),
@@ -19,5 +18,18 @@ export function deserializeAccountCompressionEvent(data: Buffer): AccountCompres
                     }
             }
         }
+        default:
+            throw Error("Unable to decode buffer as ChangeLogEvent V1");
+    }
+}
+
+export function deserializeApplicationDataEvent(data: Buffer): ApplicationDataEvent {
+    const event = accountCompressionEventBeet.toFixedFromData(data, 0).read(data, 0)
+    switch (event.__kind) {
+        case "ApplicationData": {
+            return event.fields[0]
+        }
+        default:
+            throw Error("Unable to decode buffer as ApplicationDataEvent");
     }
 }
diff --git a/account-compression/sdk/src/generated/types/AccountCompressionEvent.ts b/account-compression/sdk/src/generated/types/AccountCompressionEvent.ts
@@ -7,6 +7,10 @@
 
 import * as beet from '@metaplex-foundation/beet'
 import { ChangeLogEvent, changeLogEventBeet } from './ChangeLogEvent'
+import {
+  ApplicationDataEvent,
+  applicationDataEventBeet,
+} from './ApplicationDataEvent'
 /**
  * This type is used to derive the {@link AccountCompressionEvent} type as well as the de/serializer.
  * However don't refer to it in your code but use the {@link AccountCompressionEvent} type instead.
@@ -18,6 +22,7 @@ import { ChangeLogEvent, changeLogEventBeet } from './ChangeLogEvent'
  */
 export type AccountCompressionEventRecord = {
   ChangeLog: { fields: [ChangeLogEvent] }
+  ApplicationData: { fields: [ApplicationDataEvent] }
 }
 
 /**
@@ -38,6 +43,10 @@ export const isAccountCompressionEventChangeLog = (
   x: AccountCompressionEvent
 ): x is AccountCompressionEvent & { __kind: 'ChangeLog' } =>
   x.__kind === 'ChangeLog'
+export const isAccountCompressionEventApplicationData = (
+  x: AccountCompressionEvent
+): x is AccountCompressionEvent & { __kind: 'ApplicationData' } =>
+  x.__kind === 'ApplicationData'
 
 /**
  * @category userTypes
@@ -54,4 +63,13 @@ export const accountCompressionEventBeet =
         'AccountCompressionEventRecord["ChangeLog"]'
       ),
     ],
+    [
+      'ApplicationData',
+      new beet.FixableBeetArgsStruct<
+        AccountCompressionEventRecord['ApplicationData']
+      >(
+        [['fields', beet.tuple([applicationDataEventBeet])]],
+        'AccountCompressionEventRecord["ApplicationData"]'
+      ),
+    ],
   ]) as beet.FixableBeet<AccountCompressionEvent>
diff --git a/account-compression/sdk/src/generated/types/ApplicationDataEvent.ts b/account-compression/sdk/src/generated/types/ApplicationDataEvent.ts
diff --git a/account-compression/sdk/src/generated/types/ApplicationDataEventV1.ts b/account-compression/sdk/src/generated/types/ApplicationDataEventV1.ts
diff --git a/account-compression/sdk/src/generated/types/index.ts b/account-compression/sdk/src/generated/types/index.ts
diff --git a/account-compression/sdk/tests/events/applicationData.test.ts b/account-compression/sdk/tests/events/applicationData.test.ts
diff --git a/account-compression/sdk/tests/events/changelog.test.ts b/account-compression/sdk/tests/events/changelog.test.ts
