Struct pallet_ip_pallet::pallet::Pallet

pub struct Pallet<T>(/* private fields */);

The Pallet struct, the main type that implements traits and standalone functions within the pallet.

Implementations

impl<T: Config> Pallet<T>

pub fn mint_nft( origin: OriginFor<T>, name: String, description: String, filing_date: String, jurisdiction: String, ) -> DispatchResult

Creates a new NFT representing intellectual property

Arguments

• origin - The account creating the NFT
• name - Name of the intellectual property (max length: Config::MaxNameLength)
• description - Detailed description (max length: Config::MaxDescriptionLength)
• filing_date - When the IP was filed (max length: Config::MaxNameLength)
• jurisdiction - Where the IP is registered (max length: Config::MaxNameLength)

Events

• Event::NftMinted - When NFT is successfully created

Errors

• Error::NameTooLong - If name exceeds maximum length
• Error::DescriptionTooLong - If description exceeds maximum length
• Error::FilingDateTooLong - If filing date exceeds maximum length
• Error::JurisdictionTooLong - If jurisdiction exceeds maximum length

pub fn offer_license( origin: OriginFor<T>, nft_id: T::NFTId, payment_type: PaymentType<T>, is_exclusive: bool, duration: BlockNumberFor<T>, ) -> DispatchResult

Creates a license offer for an NFT

Allows other accounts to license the NFT under specified terms.

Arguments

• origin - Must be signed by the NFT owner
• nft_id - ID of the NFT to license
• payment_type - Payment terms (see PaymentType)
• is_exclusive - Whether this is an exclusive license
• duration - How long the license lasts (in blocks)

Events

• Event::LicenseOffered - When offer is created

Errors

• Error::NftNotFound - If NFT doesn’t exist
• Error::NotNftOwner - If caller doesn’t own the NFT
• Error::NftInEscrow - If NFT is in escrow
• Error::ExclusiveLicenseExists - If trying to create offer while exclusive license exists

pub fn offer_purchase( origin: OriginFor<T>, nft_id: T::NFTId, payment_type: PaymentType<T>, ) -> DispatchResult

Creates a purchase offer for an NFT

Allows other accounts to purchase the NFT.

Arguments

• origin - Must be signed by the NFT owner
• nft_id - ID of the NFT to purchase
• payment_type - Payment terms (see PaymentType)

Events

• Event::PurchaseOffered - When offer is created

Errors

• Error::NftNotFound - If NFT doesn’t exist
• Error::NotNftOwner - If caller doesn’t own the NFT
• Error::NftInEscrow - If NFT is in escrow

pub fn accept_license( origin: OriginFor<T>, offer_id: T::OfferId, ) -> DispatchResult

Accepts a license offer

Allows the licensee to accept the offer and create a license contract.

Arguments

• origin - Must be signed by the licensee
• offer_id - ID of the offer to accept

Events

• Event::ContractCreated - When contract is created

Errors

• Error::OfferNotFound - If offer doesn’t exist
• Error::NotALicenseOffer - If offer is not a license offer

pub fn accept_purchase( origin: OriginFor<T>, offer_id: T::OfferId, ) -> DispatchResult

Accepts a purchase offer

Allows the buyer to accept the offer and create a purchase contract.

Arguments

• origin - Must be signed by the buyer
• offer_id - ID of the offer to accept

Events

• Event::ContractCreated - When contract is created

Errors

• Error::OfferNotFound - If offer doesn’t exist
• Error::NotAPurchaseOffer - If offer is not a purchase offer

pub fn make_periodic_payment( origin: OriginFor<T>, contract_id: T::ContractId, ) -> DispatchResult

Makes a periodic payment for a contract

Processes the next scheduled payment for a periodic payment contract. Handles payment calculation including any penalties from missed payments.

Arguments

• origin - Must be signed by the payer (licensee/buyer)
• contract_id - ID of the contract to make a payment for

Events

• Event::PeriodicPaymentMade - When payment is successfully processed
• Event::PaymentsCompleted - When this was the final payment due
• Event::PaymentMade - For the actual currency transfer

Errors

• Error::ContractNotFound - If contract doesn’t exist
• Error::NotPeriodicPayment - If contract uses one-time payment instead of periodic
• Error::PaymentNotDue - If current block is before next_payment_block or no payments are due
• Error::InsufficientBalance - If payer doesn’t have enough funds
• Error::ZeroPayment - If calculated payment amount is zero

pub fn expire_license( origin: OriginFor<T>, contract_id: T::ContractId, ) -> DispatchResult

Expires a license contract after its duration has ended

Allows any party to expire a license contract once its duration has passed. Cleans up contract storage and updates NFT contract mappings.

Arguments

• origin - Any signed party
• contract_id - ID of the license contract to expire

Events

• Event::ContractExpired - When license is successfully expired

Errors

• Error::ContractNotFound - If contract doesn’t exist
• Error::NotALicenseContract - If contract is a purchase contract
• Error::LicenseNotExpired - If license duration hasn’t ended yet

State Changes

• Removes contract from Contracts storage
• Updates NFTContracts mapping to remove expired license

pub fn complete_purchase( origin: OriginFor<T>, contract_id: T::ContractId, ) -> DispatchResult

Completes a purchase contract after all payments are made

Finalizes NFT ownership transfer and cleans up contract storage. Can only be called when all payments have been completed.

Arguments

• origin - Any signed party
• contract_id - ID of the purchase contract to complete

Events

• Event::ContractCompleted - When purchase is successfully completed
• Event::NftRemovedFromEscrow - When NFT is released from escrow

Errors

• Error::ContractNotFound - If contract doesn’t exist
• Error::NotAPurchaseContract - If contract is a license contract
• Error::NotPeriodicPayment - If contract is not a periodic payment contract
• Error::PaymentNotCompleted - If any payments are still due

State Changes

• Removes contract from Contracts storage
• Updates NFTContracts mapping to remove contract
• Updates Nfts storage to reflect new owner
• Removes NFT from EscrowedNfts storage

impl<T: Config> Pallet<T>

pub fn process_payment( payer: &T::AccountId, payee: &T::AccountId, amount: BalanceOf<T>, ) -> DispatchResult

Process a payment from payer to payee Returns Ok(()) if successful, Err if failed

impl<T: Config> Pallet<T>

pub fn nfts<KArg>(k: KArg) -> Option<NFT<T>>

where KArg: EncodeLike<T::NFTId>,

An auto-generated getter for Nfts.

impl<T: Config> Pallet<T>

pub fn next_nft_id() -> T::NFTId

An auto-generated getter for NextNftId.

impl<T: Config> Pallet<T>

pub fn next_offer_id() -> T::OfferId

An auto-generated getter for NextOfferId.

impl<T: Config> Pallet<T>

pub fn offers<KArg>(k: KArg) -> Option<Offer<T>>

where KArg: EncodeLike<T::OfferId>,

An auto-generated getter for Offers.

impl<T: Config> Pallet<T>

pub fn contracts<KArg>(k: KArg) -> Option<Contract<T>>

where KArg: EncodeLike<T::ContractId>,

An auto-generated getter for Contracts.

impl<T: Config> Pallet<T>

pub fn nft_contracts<KArg>(k: KArg) -> Vec<T::ContractId>

where KArg: EncodeLike<T::NFTId>,

An auto-generated getter for NFTContracts.

impl<T: Config> Pallet<T>

pub fn escrowed_nfts<KArg>(k: KArg) -> Option<T::AccountId>

where KArg: EncodeLike<T::NFTId>,

An auto-generated getter for EscrowedNfts.

Trait Implementations

impl<T: Config> BeforeAllRuntimeMigrations for Pallet<T>

fn before_all_runtime_migrations() -> Weight

Something that should happen before runtime migrations are executed.

impl<T: Config> Callable<T> for Pallet<T>

type RuntimeCall = Call<T>

impl<T> Clone for Pallet<T>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for Pallet<T>

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: Config> GetStorageVersion for Pallet<T>

type InCodeStorageVersion = NoStorageVersionSet

This type is generated by the pallet macro.

fn in_code_storage_version() -> Self::InCodeStorageVersion

Returns the in-code storage version as specified in the storage_version attribute, or [NoStorageVersionSet] if the attribute is missing.

fn on_chain_storage_version() -> StorageVersion

Returns the storage version of the pallet as last set in the actual on-chain storage.

fn current_storage_version() -> Self::InCodeStorageVersion

👎Deprecated: This method has been renamed to in_code_storage_version and will be removed after March 2024.

DEPRECATED: Use [Self::current_storage_version] instead.

impl<T: Config> Hooks<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

Block initialization hook. This is called at the very beginning of block execution.

fn on_finalize(_n: BlockNumber)

Block finalization hook. This is called at the very end of block execution.

fn on_idle(_n: BlockNumber, _remaining_weight: Weight) -> Weight

Hook to consume a block’s idle time. This will run when the block is being finalized (before [Hooks::on_finalize]).

fn on_poll(_n: BlockNumber, _weight: &mut WeightMeter)

A hook to run logic after inherent application.

fn on_runtime_upgrade() -> Weight

Hook executed when a code change (aka. a “runtime upgrade”) is detected by the FRAME Executive pallet.

fn offchain_worker(_n: BlockNumber)

Implementing this function on a pallet allows you to perform long-running tasks that are dispatched as separate threads, and entirely independent of the main blockchain execution.

fn integrity_test()

Check the integrity of this pallet’s configuration.

impl<T: Config> IntegrityTest for Pallet<T>

fn integrity_test()

See [Hooks::integrity_test].

impl<T: Config> OffchainWorker<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn offchain_worker(n: BlockNumberFor<T>)

This function is being called after every block import (when fully synced).

impl<T: Config> OnFinalize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_finalize(n: BlockNumberFor<T>)

See [Hooks::on_finalize].

impl<T: Config> OnGenesis for Pallet<T>

fn on_genesis()

Something that should happen at genesis.

impl<T: Config> OnIdle<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_idle(n: BlockNumberFor<T>, remaining_weight: Weight) -> Weight

See [Hooks::on_idle].

impl<T: Config> OnInitialize<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_initialize(n: BlockNumberFor<T>) -> Weight

See [Hooks::on_initialize].

impl<T: Config> OnPoll<<<<T as Config>::Block as HeaderProvider>::HeaderT as Header>::Number> for Pallet<T>

fn on_poll(n: BlockNumberFor<T>, weight: &mut WeightMeter)

Code to execute every now and then at the beginning of the block after inherent application.

impl<T: Config> OnRuntimeUpgrade for Pallet<T>

fn on_runtime_upgrade() -> Weight

See [Hooks::on_runtime_upgrade].

impl<T: Config> PalletInfoAccess for Pallet<T>

fn index() -> usize

Index of the pallet as configured in the runtime.

fn name() -> &'static str

Name of the pallet as configured in the runtime.

fn name_hash() -> [u8; 16]

Two128 hash of name.

fn module_name() -> &'static str

Name of the Rust module containing the pallet.

fn crate_version() -> CrateVersion

Version of the crate containing the pallet.

impl<T: Config> PalletsInfoAccess for Pallet<T>

fn count() -> usize

The number of pallets’ information that this type represents.

fn infos() -> Vec<PalletInfoData>

All of the pallets’ information that this type represents.

impl<T> PartialEq for Pallet<T>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T: Config> StorageInfoTrait for Pallet<T>

fn storage_info() -> Vec<StorageInfo>

impl<T: Config> WhitelistedStorageKeys for Pallet<T>

fn whitelisted_storage_keys() -> Vec<TrackedStorageKey>

Returns a Vec<TrackedStorageKey> indicating the storage keys that should be whitelisted during benchmarking. This means that those keys will be excluded from the benchmarking performance calculation.

impl<T> Eq for Pallet<T>