Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

New context for each lifecycle #209

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
92 changes: 92 additions & 0 deletions clients/js/baseline.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
[
{
"name": "CU: create a new, empty asset",
"unit": "Compute Units",
"value": 9805
},
{
"name": "Space: create a new, empty asset",
"unit": "Bytes",
"value": 91
},
{
"name": "CU: create a new, empty asset with empty collection",
"unit": "Compute Units",
"value": 21421
},
{
"name": "Space: create a new, empty asset with empty collection",
"unit": "Bytes",
"value": 91
},
{
"name": "CU: create a new asset with plugins",
"unit": "Compute Units",
"value": 32680
},
{
"name": "Space: create a new asset with plugins",
"unit": "Bytes",
"value": 198
},
{
"name": "CU: create a new asset with plugins and empty collection",
"unit": "Compute Units",
"value": 38466
},
{
"name": "Space: create a new asset with plugins and empty collection",
"unit": "Bytes",
"value": 198
},
{
"name": "CU: list an asset",
"unit": "Compute Units",
"value": 27622
},
{
"name": "CU: sell an asset",
"unit": "Compute Units",
"value": 37792
},
{
"name": "CU: list an asset with empty collection",
"unit": "Compute Units",
"value": 35791
},
{
"name": "CU: sell an asset with empty collection",
"unit": "Compute Units",
"value": 51043
},
{
"name": "CU: list an asset with collection royalties",
"unit": "Compute Units",
"value": 37047
},
{
"name": "CU: sell an asset with collection royalties",
"unit": "Compute Units",
"value": 56560
},
{
"name": "CU: transfer an empty asset",
"unit": "Compute Units",
"value": 5261
},
{
"name": "CU: transfer an empty asset with empty collection",
"unit": "Compute Units",
"value": 8035
},
{
"name": "CU: transfer an asset with plugins",
"unit": "Compute Units",
"value": 11386
},
{
"name": "CU: transfer an asset with plugins and empty collection",
"unit": "Compute Units",
"value": 14160
}
]
10 changes: 7 additions & 3 deletions programs/mpl-core/src/plugins/external/app_data.rs
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use borsh::{BorshDeserialize, BorshSerialize};
use solana_program::program_error::ProgramError;

use crate::plugins::abstain;
use crate::plugins::{abstain, AssetValidationCommon, AssetValidationContext};

use crate::plugins::{
Authority, ExternalPluginAdapterSchema, PluginValidation, PluginValidationContext,
Expand Down Expand Up @@ -34,14 +34,18 @@ impl AppData {
impl PluginValidation for AppData {
fn validate_add_external_plugin_adapter(
&self,
_ctx: &PluginValidationContext,
_plugin_ctx: &PluginValidationContext,
_common: &AssetValidationCommon,
_asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
abstain!()
}

fn validate_transfer(
&self,
_ctx: &PluginValidationContext,
_plugin_ctx: &PluginValidationContext,
_common: &AssetValidationCommon,
_asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
abstain!()
}
Expand Down
13 changes: 9 additions & 4 deletions programs/mpl-core/src/plugins/external/lifecycle_hook.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ use borsh::{BorshDeserialize, BorshSerialize};
use solana_program::{program_error::ProgramError, pubkey::Pubkey};

use crate::plugins::{
abstain, Authority, ExternalCheckResult, ExternalPluginAdapterSchema, ExtraAccount,
HookableLifecycleEvent, PluginValidation, PluginValidationContext, ValidationResult,
abstain, AssetValidationCommon, AssetValidationContext, Authority, ExternalCheckResult,
ExternalPluginAdapterSchema, ExtraAccount, HookableLifecycleEvent, PluginValidation,
PluginValidationContext, ValidationResult,
};

/// Lifecycle hook that CPIs into the `hooked_program`. This hook is used for any lifecycle events
Expand Down Expand Up @@ -41,14 +42,18 @@ impl LifecycleHook {
impl PluginValidation for LifecycleHook {
fn validate_add_external_plugin_adapter(
&self,
_ctx: &PluginValidationContext,
_plugin_ctx: &PluginValidationContext,
_common: &AssetValidationCommon,
_asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
abstain!()
}

fn validate_transfer(
&self,
_ctx: &PluginValidationContext,
_plugin_ctx: &PluginValidationContext,
_common: &AssetValidationCommon,
_asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
abstain!()
}
Expand Down
16 changes: 11 additions & 5 deletions programs/mpl-core/src/plugins/external/linked_app_data.rs
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
use borsh::{BorshDeserialize, BorshSerialize};

use crate::plugins::{
Authority, ExternalPluginAdapterSchema, PluginValidation, PluginValidationContext,
ValidationResult,
use crate::{
plugins::{
AssetValidationCommon, AssetValidationContext, Authority, ExternalPluginAdapterSchema,
PluginValidation, PluginValidationContext, ValidationResult,
},
state::Key,
utils::load_key,
};

/// The app data third party plugin contains arbitrary data that can be written to by the
Expand Down Expand Up @@ -31,10 +35,12 @@ impl LinkedAppData {
impl PluginValidation for LinkedAppData {
fn validate_create(
&self,
ctx: &PluginValidationContext,
_plugin_ctx: &PluginValidationContext,
common: &AssetValidationCommon,
_asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, solana_program::program_error::ProgramError> {
solana_program::msg!("LinkedAppData::validate_create");
if ctx.asset_info.is_some() {
if load_key(common.asset_info, 0)? == Key::AssetV1 {
Ok(ValidationResult::Rejected)
} else {
Ok(ValidationResult::Pass)
Expand Down
13 changes: 9 additions & 4 deletions programs/mpl-core/src/plugins/external/linked_lifecycle_hook.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@ use borsh::{BorshDeserialize, BorshSerialize};
use solana_program::{program_error::ProgramError, pubkey::Pubkey};

use crate::plugins::{
Authority, ExternalCheckResult, ExternalPluginAdapterSchema, ExtraAccount,
HookableLifecycleEvent, PluginValidation, PluginValidationContext, ValidationResult,
AssetValidationCommon, AssetValidationContext, Authority, ExternalCheckResult,
ExternalPluginAdapterSchema, ExtraAccount, HookableLifecycleEvent, PluginValidation,
PluginValidationContext, ValidationResult,
};

/// Lifecycle hook that CPIs into the `hooked_program`. This hook is used for any lifecycle events
Expand Down Expand Up @@ -41,14 +42,18 @@ impl LinkedLifecycleHook {
impl PluginValidation for LinkedLifecycleHook {
fn validate_add_external_plugin_adapter(
&self,
_ctx: &PluginValidationContext,
_plugin_ctx: &PluginValidationContext,
_common: &AssetValidationCommon,
_asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
Ok(ValidationResult::Pass)
}

fn validate_transfer(
&self,
_ctx: &PluginValidationContext,
_plugin_ctx: &PluginValidationContext,
_common: &AssetValidationCommon,
_asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
Ok(ValidationResult::Pass)
}
Expand Down
73 changes: 55 additions & 18 deletions programs/mpl-core/src/plugins/external/oracle.rs
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,9 @@ use solana_program::{program_error::ProgramError, pubkey::Pubkey};
use crate::error::MplCoreError;

use crate::plugins::{
abstain, Authority, ExternalCheckResult, ExternalValidationResult, ExtraAccount,
HookableLifecycleEvent, PluginValidation, PluginValidationContext, ValidationResult,
abstain, AssetValidationCommon, AssetValidationContext, Authority, ExternalCheckResult,
ExternalValidationResult, ExtraAccount, HookableLifecycleEvent, PluginValidation,
PluginValidationContext, ValidationResult,
};

/// Oracle plugin that allows getting a `ValidationResult` for a lifecycle event from an arbitrary
Expand Down Expand Up @@ -39,56 +40,92 @@ impl Oracle {
impl PluginValidation for Oracle {
fn validate_add_external_plugin_adapter(
&self,
_ctx: &PluginValidationContext,
_plugin_ctx: &PluginValidationContext,
_common: &AssetValidationCommon,
_asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
abstain!()
}

fn validate_create(
&self,
ctx: &PluginValidationContext,
plugin_ctx: &PluginValidationContext,
common: &AssetValidationCommon,
asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
self.validate_helper(ctx, HookableLifecycleEvent::Create)
self.validate_helper(
plugin_ctx,
common,
asset_ctx,
HookableLifecycleEvent::Create,
)
}

fn validate_transfer(
&self,
ctx: &PluginValidationContext,
plugin_ctx: &PluginValidationContext,
common: &AssetValidationCommon,
asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
self.validate_helper(ctx, HookableLifecycleEvent::Transfer)
self.validate_helper(
plugin_ctx,
common,
asset_ctx,
HookableLifecycleEvent::Transfer,
)
}

fn validate_burn(
&self,
ctx: &PluginValidationContext,
plugin_ctx: &PluginValidationContext,
common: &AssetValidationCommon,
asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
self.validate_helper(ctx, HookableLifecycleEvent::Burn)
self.validate_helper(plugin_ctx, common, asset_ctx, HookableLifecycleEvent::Burn)
}

fn validate_update(
&self,
ctx: &PluginValidationContext,
plugin_ctx: &PluginValidationContext,
common: &AssetValidationCommon,
asset_ctx: &AssetValidationContext,
) -> Result<ValidationResult, ProgramError> {
self.validate_helper(ctx, HookableLifecycleEvent::Update)
self.validate_helper(
plugin_ctx,
common,
asset_ctx,
HookableLifecycleEvent::Update,
)
}
}

impl Oracle {
fn validate_helper(
&self,
ctx: &PluginValidationContext,
plugin_ctx: &PluginValidationContext,
common: &AssetValidationCommon,
asset_ctx: &AssetValidationContext,
event: HookableLifecycleEvent,
) -> Result<ValidationResult, ProgramError> {
let oracle_account = match &self.base_address_config {
None => self.base_address,
Some(extra_account) => extra_account.derive(&self.base_address, ctx)?,
Some(extra_account) => {
extra_account.derive(&self.base_address, plugin_ctx, common, asset_ctx)?
}
};

let oracle_account = ctx
.accounts
.iter()
.find(|account| *account.key == oracle_account)
.ok_or(MplCoreError::MissingExternalPluginAdapterAccount)?;
let oracle_account = if let AssetValidationContext::Create { accounts }
| AssetValidationContext::Transfer { accounts, .. }
| AssetValidationContext::Burn { accounts, .. }
| AssetValidationContext::Update { accounts, .. } = asset_ctx
{
accounts
.iter()
.find(|account| *account.key == oracle_account)
.ok_or(MplCoreError::MissingExternalPluginAdapterAccount)?
} else {
return Err(MplCoreError::InvalidPlugin.into());
};

let offset = self.results_offset.to_offset_usize();

Expand Down
Loading