diff --git a/framework/src/modules/nft/cc_commands/cc_transfer.ts b/framework/src/modules/nft/cc_commands/cc_transfer.ts index ae4884b76f..03a9bfbdad 100644 --- a/framework/src/modules/nft/cc_commands/cc_transfer.ts +++ b/framework/src/modules/nft/cc_commands/cc_transfer.ts @@ -31,6 +31,9 @@ import { FeeMethod } from '../types'; import { EscrowStore } from '../stores/escrow'; import { CcmTransferEvent } from '../events/ccm_transfer'; +/** + * Accepts CCMs created by the {@link CrossChainTransferCommand} and executes the cross-chain transfer on the receiving chain. + */ export class CrossChainTransferCommand extends BaseCCCommand { public schema = crossChainNFTTransferMessageParamsSchema; private _method!: NFTMethod; diff --git a/framework/src/modules/nft/commands/transfer.ts b/framework/src/modules/nft/commands/transfer.ts index 7a909c58f5..dcb3ec4a1b 100644 --- a/framework/src/modules/nft/commands/transfer.ts +++ b/framework/src/modules/nft/commands/transfer.ts @@ -38,7 +38,7 @@ export interface TransferParams { * * @example * ```sh - * ./bin/run transaction:create nft transfer 10000000 --params='{"nftID":"01000000000000010000000000000001","recipientAddress":"lskycz7hvr8yfu74bcwxy2n4mopfmjancgdvxq8xz","data":"Congratulations on completing the course!"}' + * lisk-core transaction:create nft transfer 10000000 --params='{"nftID":"01000000000000010000000000000001","recipientAddress":"lskycz7hvr8yfu74bcwxy2n4mopfmjancgdvxq8xz","data":"Congratulations on completing the course!"}' * ``` */ export class TransferCommand extends BaseCommand { diff --git a/framework/src/modules/nft/commands/transfer_cross_chain.ts b/framework/src/modules/nft/commands/transfer_cross_chain.ts index 062919f383..5b37949d51 100644 --- a/framework/src/modules/nft/commands/transfer_cross_chain.ts +++ b/framework/src/modules/nft/commands/transfer_cross_chain.ts @@ -33,6 +33,25 @@ export interface TransferCrossChainParams { includeAttributes: boolean; } +/** + * The TransferCrossChain command transfers an NFT from one account to another across chains. + * + * ## Name + * - `transferCrossChain` + * + * ## Parameters + * - `nftID` (number) : 16 byte long + * - `recipientAddress` (string) : Lisk32 address + * - `data` (string) : Optional transfer message + * - `receivingChainID` (string) : The {@link https://lisk.com/documentation/understand-blockchain/interoperability/index.html#chain-identifiers | Chain ID} of the network receiving the NFT. + * - `messageFee` (string): Fee for the execution of the CCM in Beddows + * - `includeAttributes` (boolean) : Boolean, if NFT attributes should be inlcuded in the cross-chain transfer, or not. + * + * @example + * ```sh + * lisk-core transaction:create nft transferCrossChain 10000000 --params='{"nftID":"01000000000000010000000000000001","recipientAddress":"lskycz7hvr8yfu74bcwxy2n4mopfmjancgdvxq8xz","data":"Congratulations on completing the course!","receivingChainID":"04000002","messageFee":"10000000","includeAttributes":true}' + * ``` + */ export class TransferCrossChainCommand extends BaseCommand { public schema = crossChainTransferParamsSchema;