nifty-asset-interface 0.4.0

use borsh::{BorshDeserialize, BorshSerialize};
use shank::{ShankContext, ShankInstruction};

pub use crate::generated::{
    types::{DelegateRole, ExtensionType, Standard},
    *,
};

#[derive(BorshDeserialize, BorshSerialize, Clone, Debug, ShankInstruction, ShankContext)]
#[rustfmt::skip]
pub enum Interface {
    /// Closes an uninitialized asset (buffer) account.
    /// 
    /// You can only close the buffer account if it has not been used to create an asset.
    #[account(0, signer, writable, name="buffer", desc = "The unitialized buffer account")]
    #[account(1, writable, name="recipient", desc = "The account receiving refunded rent")]
    Close,

    /// Burns an asset.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, writable, name="signer", desc = "The owner or burn delegate of the asset")]
    #[account(2, optional, writable, name="recipient", desc = "The account receiving refunded rent")]
    #[account(3, optional, writable, name="group", desc = "Asset account of the group")]
    Burn,

    /// Creates a new asset.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, optional_signer, name="authority", desc = "The authority of the asset")]
    #[account(2, name="owner", desc = "The owner of the asset")]
    #[account(3, optional, writable, name="group", desc = "Asset account of the group")]
    #[account(4, optional, signer, name="group_authority", desc = "The delegate authority for minting assets into a group")]
    #[account(5, optional, signer, writable, name="payer", desc = "The account paying for the storage fees")]
    #[account(6, optional, name="system_program", desc = "The system program")]
    Create(MetadataInput),

    /// Approves a delegate to manage an asset.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, name="owner", desc = "The owner of the asset")]
    #[account(2, name="delegate", desc = "The delegate account")]
    Approve(DelegateInput),

    /// Allocates an extension into an uninitialized asset (buffer) account.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, optional, signer, writable, name="payer", desc = "The account paying for the storage fees")]
    #[account(2, optional, name="system_program", desc = "The system program")]
    Allocate(AllocateInput),

    /// Locks an asset.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, name="signer", desc = "Delegate or owner account")]
    Lock,

    /// Revokes a delegate.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, name="signer", desc = "Current owner of the asset or delegate")]
    Revoke(DelegateInput),

    /// Transfers ownership of the aseet to a new public key.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, name="signer", desc = "Current owner of the asset or transfer delegate")]
    #[account(2, name="recipient", desc = "The recipient of the asset")]
    #[account(3, optional, name="group", desc = "The asset defining the group, if applicable")]
    Transfer,

    /// Unlocks an asset.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, name="signer", desc = "Delegate or owner account")]
    Unlock,

    /// Unverifies a creator.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, name="creator", desc = "Creator account to unverify")]
    Unverify,

    /// Updates an asset.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, name="authority", desc = "The authority of the asset")]
    #[account(2, optional, writable, name="buffer", desc = "Extension (asset) buffer account")]
    #[account(3, optional, name="group", desc = "The asset defining the group, if applicable")]
    #[account(4, optional, signer, writable, name="payer", desc = "The account paying for the storage fees")]
    #[account(5, optional, name="system_program", desc = "The system program")]
    Update(UpdateInput),

    /// Verifies a creator.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, name="creator", desc = "Creator account to verify")]
    Verify,

    /// Writes data to an extension.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, writable, name="payer", desc = "The account paying for the storage fees")]
    #[account(2, name="system_program", desc = "The system program")]
    Write(DataInput),

    /// Adds an asset to a group.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, writable, name="group", desc = "Asset account of the group")]
    #[account(2, signer, name="authority", desc = "The authority of the assets")]
    Group,

    /// Removes an asset from a group.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, writable, name="group", desc = "Asset account of the group")]
    #[account(2, signer, name="authority", desc = "The authority of the assets")]
    Ungroup,

    /// Handover an asset to a new authority.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, name="authority", desc = "The authority of the asset")]
    #[account(2, signer, name="new_authority", desc = "The new authority of the asset")]
    Handover,

    /// Removes an extension from an asset.
    #[account(0, signer, writable, name="asset", desc = "Asset account")]
    #[account(1, signer, name="authority", desc = "The authority of the asset")]
    #[account(2, optional, name="group", desc = "The asset defining the group, if applicable")]
    #[account(3, writable, name="recipient", desc = "The account receiving refunded rent")]
    Remove(ExtensionType),
}

#[repr(C)]
#[derive(BorshSerialize, BorshDeserialize, Debug, Clone)]
pub struct AllocateInput {
    /// Extension to initialize.
    pub extension: ExtensionInput,
}

#[repr(C)]
#[derive(BorshSerialize, BorshDeserialize, Clone, Debug, PartialEq)]
pub enum DelegateInput {
    All,
    Some { roles: Vec<DelegateRole> },
}

#[repr(C)]
#[derive(BorshSerialize, BorshDeserialize, Debug, Clone)]
pub struct DataInput {
    /// Indicates whether to overwrite the buffer or not.
    pub overwrite: bool,

    /// Extension data.
    pub bytes: Vec<u8>,
}

#[repr(C)]
#[derive(BorshSerialize, BorshDeserialize, Debug, Clone)]
pub struct ExtensionInput {
    /// Extension type to initialize.
    pub extension_type: ExtensionType,

    /// Total length of the extension data.
    pub length: u32,

    /// Extension data.
    pub data: Option<Vec<u8>>,
}

#[repr(C)]
#[derive(BorshSerialize, BorshDeserialize, Debug, Clone)]
pub struct MetadataInput {
    /// Name of the asset.
    pub name: String,

    /// Indicates the standard of an asset.
    pub standard: Standard,

    /// Indicates whether the asset is mutable or not.
    pub mutable: bool,

    /// Extensions to be added to the asset.
    pub extensions: Option<Vec<ExtensionInput>>,
}

#[repr(C)]
#[derive(BorshSerialize, BorshDeserialize, Debug, Clone)]
pub struct UpdateInput {
    /// The updated name of the asset.
    pub name: Option<String>,

    /// Updates whether the asset is mutable or not.
    ///
    /// Once an asset is immutable, it cannot be made mutable.
    pub mutable: Option<bool>,

    /// Extension to be updated.
    pub extension: Option<ExtensionInput>,
}