Class NFTMethod

Hierarchy

BaseMethod
- NFTMethod

Constructors

constructor

new NFTMethod(stores: NamedRegistry, events: NamedRegistry): NFTMethod
Parameters
- stores: NamedRegistry
- events: NamedRegistry
Returns NFTMethod
Inherited from BaseMethod.constructor
- Defined in framework/src/modules/base_method.ts:18

Properties

`Private` _config

_config: ModuleConfig

`Private` _feeMethod

_feeMethod: FeeMethod

`Private` _internalMethod

_internalMethod: InternalMethod

`Private` _interoperabilityMethod

_interoperabilityMethod: InteroperabilityMethod

`Private` _tokenMethod

_tokenMethod: TokenMethod

`Protected` events

events: NamedRegistry

`Protected` stores

stores: NamedRegistry

Methods

addDependencies

addDependencies(interoperabilityMethod: InteroperabilityMethod, internalMethod: InternalMethod, feeMethod: FeeMethod, tokenMethod: TokenMethod): void
Parameters
- interoperabilityMethod: InteroperabilityMethod
- internalMethod: InternalMethod
- feeMethod: FeeMethod
- tokenMethod: TokenMethod
Returns void
- Defined in framework/src/modules/nft/method.ts:60

create

create(methodContext: MethodContext, address: Buffer, collectionID: Buffer, attributesArray: NFTAttributes[]): Promise<void>
Parameters
- methodContext: MethodContext
- address: Buffer
- collectionID: Buffer
- attributesArray: NFTAttributes[]
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:300

destroy

destroy(methodContext: MethodContext, address: Buffer, nftID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- address: Buffer
- nftID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:110

getAttributes

getAttributes(methodContext: MethodContext, module: string, nftID: Buffer): Promise<Buffer>
Parameters
- methodContext: MethodContext
- module: string
- nftID: Buffer
Returns Promise<Buffer>
- Defined in framework/src/modules/nft/method.ts:250

getAttributesArray

getAttributesArray(methodContext: MethodContext, nftID: Buffer): Promise<NFTAttributes[]>
Parameters
- methodContext: MethodContext
- nftID: Buffer
Returns Promise<NFTAttributes[]>
- Defined in framework/src/modules/nft/method.ts:236

getChainID

getChainID(nftID: Buffer): Buffer
Parameters
- nftID: Buffer
Returns Buffer
- Defined in framework/src/modules/nft/method.ts:72

getCollectionID

getCollectionID(methodContext: ImmutableMethodContext, nftID: Buffer): Promise<Buffer>
Parameters
- methodContext: ImmutableMethodContext
- nftID: Buffer
Returns Promise<Buffer>
- Defined in framework/src/modules/nft/method.ts:187

getLockingModule

getLockingModule(methodContext: ImmutableMethodContext, nftID: Buffer): Promise<string>
Parameters
- methodContext: ImmutableMethodContext
- nftID: Buffer
Returns Promise<string>
- Defined in framework/src/modules/nft/method.ts:94

getNFTOwner

getNFTOwner(methodContext: ImmutableMethodContext, nftID: Buffer): Promise<Buffer>
Parameters
- methodContext: ImmutableMethodContext
- nftID: Buffer
Returns Promise<Buffer>
- Defined in framework/src/modules/nft/method.ts:80

getNextAvailableIndex

getNextAvailableIndex(methodContext: MethodContext, collectionID: Buffer): Promise<bigint>
Parameters
- methodContext: MethodContext
- collectionID: Buffer
Returns Promise<bigint>
- Defined in framework/src/modules/nft/method.ts:272

init

init(config: ModuleConfig): void
Parameters
- config: ModuleConfig
Returns void
- Defined in framework/src/modules/nft/method.ts:56

isNFTSupported

isNFTSupported(methodContext: ImmutableMethodContext, nftID: Buffer): Promise<boolean>
Parameters
- methodContext: ImmutableMethodContext
- nftID: Buffer
Returns Promise<boolean>
- Defined in framework/src/modules/nft/method.ts:199

lock

lock(methodContext: MethodContext, module: string, nftID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- module: string
- nftID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:339

recover

recover(methodContext: MethodContext, terminatedChainID: Buffer, substorePrefix: Buffer, storeKey: Buffer, storeValue: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- terminatedChainID: Buffer
- substorePrefix: Buffer
- storeKey: Buffer
- storeValue: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:893

removeSupportAllNFTs

removeSupportAllNFTs(methodContext: MethodContext): Promise<void>
Parameters
- methodContext: MethodContext
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:709

removeSupportAllNFTsFromChain

removeSupportAllNFTsFromChain(methodContext: MethodContext, chainID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- chainID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:753

removeSupportAllNFTsFromCollection

removeSupportAllNFTsFromCollection(methodContext: MethodContext, chainID: Buffer, collectionID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- chainID: Buffer
- collectionID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:840

setAttributes

setAttributes(methodContext: MethodContext, module: string, nftID: Buffer, attributes: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- module: string
- nftID: Buffer
- attributes: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:987

supportAllNFTs

supportAllNFTs(methodContext: MethodContext): Promise<void>
Parameters
- methodContext: MethodContext
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:687

supportAllNFTsFromChain

supportAllNFTsFromChain(methodContext: MethodContext, chainID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- chainID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:721

supportAllNFTsFromCollection

supportAllNFTsFromCollection(methodContext: MethodContext, chainID: Buffer, collectionID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- chainID: Buffer
- collectionID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:780

transfer

transfer(methodContext: MethodContext, senderAddress: Buffer, recipientAddress: Buffer, nftID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- senderAddress: Buffer
- recipientAddress: Buffer
- nftID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:463

transferCrossChain

transferCrossChain(methodContext: MethodContext, senderAddress: Buffer, recipientAddress: Buffer, nftID: Buffer, receivingChainID: Buffer, messageFee: bigint, data: string, includeAttributes: boolean): Promise<void>
Parameters
- methodContext: MethodContext
- senderAddress: Buffer
- recipientAddress: Buffer
- nftID: Buffer
- receivingChainID: Buffer
- messageFee: bigint
- data: string
- includeAttributes: boolean
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:529

unlock

unlock(methodContext: MethodContext, module: string, nftID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- module: string
- nftID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/method.ts:399

Class NFTMethod

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stores: NamedRegistry

events: NamedRegistry

Returns NFTMethod

Properties

Private _config

Private _feeMethod

Private _internalMethod

Private _interoperabilityMethod

Private _tokenMethod

Protected events

Protected stores

Methods

addDependencies

Parameters

interoperabilityMethod: InteroperabilityMethod

internalMethod: InternalMethod

feeMethod: FeeMethod

tokenMethod: TokenMethod

Returns void

create

Parameters

methodContext: MethodContext

address: Buffer

collectionID: Buffer

attributesArray: NFTAttributes[]

Returns Promise<void>

destroy

Parameters

methodContext: MethodContext

address: Buffer

nftID: Buffer

Returns Promise<void>

getAttributes

Parameters

methodContext: MethodContext

module: string

nftID: Buffer

Returns Promise<Buffer>

getAttributesArray

Parameters

methodContext: MethodContext

nftID: Buffer

Returns Promise<NFTAttributes[]>

getChainID

Parameters

nftID: Buffer

Returns Buffer

getCollectionID

Parameters

methodContext: ImmutableMethodContext

nftID: Buffer

Returns Promise<Buffer>

getLockingModule

Parameters

methodContext: ImmutableMethodContext

nftID: Buffer

Returns Promise<string>

getNFTOwner

Parameters

methodContext: ImmutableMethodContext

nftID: Buffer

Returns Promise<Buffer>

getNextAvailableIndex

Parameters

methodContext: MethodContext

collectionID: Buffer

Returns Promise<bigint>

init

Parameters

config: ModuleConfig

Returns void

`Private` _config

`Private` _feeMethod

`Private` _internalMethod

`Private` _interoperabilityMethod

`Private` _tokenMethod

`Protected` events

`Protected` stores