Class CrossChainTransferCommand

Accepts CCMs created by the CrossChainTransferCommand and executes the cross-chain transfer on the receiving chain.

Hierarchy

BaseCCCommand
- CrossChainTransferCommand

Index

Constructors

constructor

new CrossChainTransferCommand(stores: NamedRegistry, events: NamedRegistry): Modules.NFT.CrossChainTransferCommand
Parameters
- stores: NamedRegistry
- events: NamedRegistry
Returns Modules.NFT.CrossChainTransferCommand
Inherited from BaseCCCommand.constructor
- Defined in framework/src/modules/interoperability/base_cc_command.ts:34

Properties

`Private` _feeMethod

_feeMethod: FeeMethod

`Private` _internalMethod

_internalMethod: InternalMethod

`Private` _method

_method: NFTMethod

`Protected` events

events: NamedRegistry

schema

schema: {
    $id: string;
    properties: {
        attributesArray: {
            fieldNumber: number;
            items: {
                properties: {
                    attributes: {
                        dataType: string;
                        fieldNumber: number;
                    };
                    module: {
                        dataType: string;
                        fieldNumber: number;
                        maxLength: number;
                        minLength: number;
                        pattern: string;
                    };
                };
                required: string[];
                type: string;
            };
            type: string;
        };
        data: {
            dataType: string;
            fieldNumber: number;
            maxLength: number;
        };
        nftID: {
            dataType: string;
            fieldNumber: number;
            maxLength: number;
            minLength: number;
        };
        recipientAddress: {
            dataType: string;
            fieldNumber: number;
            format: string;
        };
        senderAddress: {
            dataType: string;
            fieldNumber: number;
            format: string;
        };
    };
    required: string[];
    type: string;
} = crossChainNFTTransferMessageParamsSchema

Type declaration

$id: string
properties: {
    attributesArray: {
        fieldNumber: number;
        items: {
            properties: {
                attributes: {
                    dataType: string;
                    fieldNumber: number;
                };
                module: {
                    dataType: string;
                    fieldNumber: number;
                    maxLength: number;
                    minLength: number;
                    pattern: string;
                };
            };
            required: string[];
            type: string;
        };
        type: string;
    };
    data: {
        dataType: string;
        fieldNumber: number;
        maxLength: number;
    };
    nftID: {
        dataType: string;
        fieldNumber: number;
        maxLength: number;
        minLength: number;
    };
    recipientAddress: {
        dataType: string;
        fieldNumber: number;
        format: string;
    };
    senderAddress: {
        dataType: string;
        fieldNumber: number;
        format: string;
    };
}
- attributesArray: {
      fieldNumber: number;
      items: {
          properties: {
              attributes: {
                  dataType: string;
                  fieldNumber: number;
              };
              module: {
                  dataType: string;
                  fieldNumber: number;
                  maxLength: number;
                  minLength: number;
                  pattern: string;
              };
          };
          required: string[];
          type: string;
      };
      type: string;
  }
  - fieldNumber: number
  - items: {
        properties: {
            attributes: {
                dataType: string;
                fieldNumber: number;
            };
            module: {
                dataType: string;
                fieldNumber: number;
                maxLength: number;
                minLength: number;
                pattern: string;
            };
        };
        required: string[];
        type: string;
    }
    - properties: {
          attributes: {
              dataType: string;
              fieldNumber: number;
          };
          module: {
              dataType: string;
              fieldNumber: number;
              maxLength: number;
              minLength: number;
              pattern: string;
          };
      }
      - attributes: {
        dataType: string;
        fieldNumber: number;
        }
        
        dataType: string
        
        fieldNumber: number
      - module: {
            dataType: string;
            fieldNumber: number;
            maxLength: number;
            minLength: number;
            pattern: string;
        }
        
        dataType: string
        
        fieldNumber: number
        
        maxLength: number
        
        minLength: number
        
        pattern: string
    - required: string[]
    - type: string
  - type: string
- data: {
      dataType: string;
      fieldNumber: number;
      maxLength: number;
  }
  - dataType: string
  - fieldNumber: number
  - maxLength: number
- nftID: {
      dataType: string;
      fieldNumber: number;
      maxLength: number;
      minLength: number;
  }
  - dataType: string
  - fieldNumber: number
  - maxLength: number
  - minLength: number
- recipientAddress: {
      dataType: string;
      fieldNumber: number;
      format: string;
  }
  - dataType: string
  - fieldNumber: number
  - format: string
- senderAddress: {
      dataType: string;
      fieldNumber: number;
      format: string;
  }
  - dataType: string
  - fieldNumber: number
  - format: string
required: string[]
type: string

`Protected` stores

stores: NamedRegistry

Accessors

name

get name(): string
Returns the name of the cross-chain command.

Returns string
Overrides BaseCCCommand.name
- Defined in framework/src/modules/nft/cc_commands/cc_transfer.ts:43

Methods

execute

execute(context: CrossChainMessageContext): Promise<void>
Applies the state changes of a command through the state machine. The hook CCCommand.execute() is triggered by a transaction identified by the module name and the command name.

Additionally, an event will be emitted that provides the information on whether a command is executed successfully or failed.

In this hook, the state can be mutated and events can be emitted.
Parameters
- context: CrossChainMessageContext
Returns Promise<void>
Overrides BaseCCCommand.execute
- Defined in framework/src/modules/nft/cc_commands/cc_transfer.ts:100

init

init(args: {
    feeMethod: FeeMethod;
    internalMethod: InternalMethod;
    method: NFTMethod;
}): void
Parameters
- args: {
      feeMethod: FeeMethod;
      internalMethod: InternalMethod;
      method: NFTMethod;
  }
  - feeMethod: FeeMethod
  - internalMethod: InternalMethod
  - method: NFTMethod
Returns void
- Defined in framework/src/modules/nft/cc_commands/cc_transfer.ts:47

verify

verify(context: CrossChainMessageContext): Promise<void>
The hook CCCommand.verify() is called to perform all necessary verifications.

In this hook, the state cannot be mutated and events cannot be emitted.

If the verification of the command was successful, for the next step the cc-command can be executed.
Parameters
- context: CrossChainMessageContext
Returns Promise<void>
Overrides BaseCCCommand.verify
- Defined in framework/src/modules/nft/cc_commands/cc_transfer.ts:53

Class CrossChainTransferCommand

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

stores: NamedRegistry

events: NamedRegistry

Returns Modules.NFT.CrossChainTransferCommand

Properties

Private _feeMethod

Private _internalMethod

Private _method

Protected events

schema

Type declaration

$id: string

attributesArray: { fieldNumber: number; items: { properties: { attributes: { dataType: string; fieldNumber: number; }; module: { dataType: string; fieldNumber: number; maxLength: number; minLength: number; pattern: string; }; }; required: string[]; type: string; }; type: string; }

fieldNumber: number

items: { properties: { attributes: { dataType: string; fieldNumber: number; }; module: { dataType: string; fieldNumber: number; maxLength: number; minLength: number; pattern: string; }; }; required: string[]; type: string; }

properties: { attributes: { dataType: string; fieldNumber: number; }; module: { dataType: string; fieldNumber: number; maxLength: number; minLength: number; pattern: string; }; }

attributes: { dataType: string; fieldNumber: number; }

dataType: string

fieldNumber: number

module: { dataType: string; fieldNumber: number; maxLength: number; minLength: number; pattern: string; }

dataType: string

fieldNumber: number

maxLength: number

minLength: number

pattern: string

required: string[]

type: string

type: string

data: { dataType: string; fieldNumber: number; maxLength: number; }

dataType: string

fieldNumber: number

maxLength: number

nftID: { dataType: string; fieldNumber: number; maxLength: number; minLength: number; }

dataType: string

fieldNumber: number

maxLength: number

minLength: number

recipientAddress: { dataType: string; fieldNumber: number; format: string; }

dataType: string

fieldNumber: number

format: string

senderAddress: { dataType: string; fieldNumber: number; format: string; }

dataType: string

fieldNumber: number

format: string

required: string[]

type: string

Protected stores

Accessors

name

Returns string

Methods

execute

Parameters

context: CrossChainMessageContext

Returns Promise<void>

init

Parameters

args: { feeMethod: FeeMethod; internalMethod: InternalMethod; method: NFTMethod; }

feeMethod: FeeMethod

internalMethod: InternalMethod

method: NFTMethod

Returns void

verify

Parameters

context: CrossChainMessageContext

Returns Promise<void>

Settings

Member Visibility

Theme

On This Page

`Private` _feeMethod

`Private` _internalMethod

`Private` _method

`Protected` events

attributesArray: {
fieldNumber: number;
items: {
properties: {
attributes: {
dataType: string;
fieldNumber: number;
};
module: {
dataType: string;
fieldNumber: number;
maxLength: number;
minLength: number;
pattern: string;
};
};
required: string[];
type: string;
};
type: string;
}

items: {
properties: {
attributes: {
dataType: string;
fieldNumber: number;
};
module: {
dataType: string;
fieldNumber: number;
maxLength: number;
minLength: number;
pattern: string;
};
};
required: string[];
type: string;
}

properties: {
attributes: {
dataType: string;
fieldNumber: number;
};
module: {
dataType: string;
fieldNumber: number;
maxLength: number;
minLength: number;
pattern: string;
};
}

attributes: {
dataType: string;
fieldNumber: number;
}

module: {
dataType: string;
fieldNumber: number;
maxLength: number;
minLength: number;
pattern: string;
}

data: {
dataType: string;
fieldNumber: number;
maxLength: number;
}

nftID: {
dataType: string;
fieldNumber: number;
maxLength: number;
minLength: number;
}

recipientAddress: {
dataType: string;
fieldNumber: number;
format: string;
}

senderAddress: {
dataType: string;
fieldNumber: number;
format: string;
}

`Protected` stores

args: {
feeMethod: FeeMethod;
internalMethod: InternalMethod;
method: NFTMethod;
}