Class InternalMethod

The BaseMethod provides a generic interface for module methods.

Hierarchy

BaseMethod
- InternalMethod

Index

Constructors

constructor

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

Properties

`Private` _config

_config: ModuleConfig

`Private` _interoperabilityMethod

_interoperabilityMethod: InteroperabilityMethod

`Private` _nftMethod

_nftMethod: NFTMethod

`Private` _tokenMethod

_tokenMethod: TokenMethod

`Protected` events

events: NamedRegistry

`Protected` stores

stores: NamedRegistry

Methods

addDependencies

addDependencies(nftMethod: NFTMethod, interoperabilityMethod: InteroperabilityMethod, tokenMethod: TokenMethod): void
Parameters
- nftMethod: NFTMethod
- interoperabilityMethod: InteroperabilityMethod
- tokenMethod: TokenMethod
Returns void
- Defined in framework/src/modules/nft/internal_method.ts:55

createEscrowEntry

createEscrowEntry(methodContext: MethodContext, receivingChainID: Buffer, nftID: Buffer): Promise<void>
Parameters
- methodContext: MethodContext
- receivingChainID: Buffer
- nftID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/internal_method.ts:65

createNFTEntry

createNFTEntry(methodContext: MethodContext, address: Buffer, nftID: Buffer, attributesArray: NFTAttributes[]): Promise<void>
Parameters
- methodContext: MethodContext
- address: Buffer
- nftID: Buffer
- attributesArray: NFTAttributes[]
Returns Promise<void>
- Defined in framework/src/modules/nft/internal_method.ts:87

createUserEntry

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

getNewAttributes

getNewAttributes(_nftID: Buffer, storedAttributes: NFTAttributes[], _receivedAttributes: NFTAttributes[]): NFTAttributes[]
Parameters
- _nftID: Buffer
- storedAttributes: NFTAttributes[]
- _receivedAttributes: NFTAttributes[]
Returns NFTAttributes[]
- Defined in framework/src/modules/nft/internal_method.ts:333

getOwnChainID

getOwnChainID(): Buffer
Returns Buffer
- Defined in framework/src/modules/nft/internal_method.ts:328

hasDuplicateModuleNames

hasDuplicateModuleNames(attributesArray: NFTAttributes[]): boolean
Parameters
- attributesArray: NFTAttributes[]
Returns boolean
- Defined in framework/src/modules/nft/internal_method.ts:105

init

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

transfer

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

transferCrossChain

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

verifyTransfer

verifyTransfer(immutableMethodContext: ImmutableMethodContext, senderAddress: Buffer, nftID: Buffer): Promise<void>
Parameters
- immutableMethodContext: ImmutableMethodContext
- senderAddress: Buffer
- nftID: Buffer
Returns Promise<void>
- Defined in framework/src/modules/nft/internal_method.ts:114

verifyTransferCrossChain

verifyTransferCrossChain(immutableMethodContext: ImmutableMethodContext, senderAddress: Buffer, nftID: Buffer, sendingChainID: Buffer, receivingChainID: Buffer, messageFee: bigint, data: string): Promise<void>
Parameters
- immutableMethodContext: ImmutableMethodContext
- senderAddress: Buffer
- nftID: Buffer
- sendingChainID: Buffer
- receivingChainID: Buffer
- messageFee: bigint
- data: string
Returns Promise<void>
- Defined in framework/src/modules/nft/internal_method.ts:154

Class InternalMethod

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stores: NamedRegistry

events: NamedRegistry

Returns InternalMethod

Properties

Private _config

Private _interoperabilityMethod

Private _nftMethod

Private _tokenMethod

Protected events

Protected stores

Methods

addDependencies

Parameters

nftMethod: NFTMethod

interoperabilityMethod: InteroperabilityMethod

tokenMethod: TokenMethod

Returns void

createEscrowEntry

Parameters

methodContext: MethodContext

receivingChainID: Buffer

nftID: Buffer

Returns Promise<void>

createNFTEntry

Parameters

methodContext: MethodContext

address: Buffer

nftID: Buffer

attributesArray: NFTAttributes[]

Returns Promise<void>

createUserEntry

Parameters

methodContext: MethodContext

address: Buffer

nftID: Buffer

Returns Promise<void>

getNewAttributes

Parameters

_nftID: Buffer

storedAttributes: NFTAttributes[]

_receivedAttributes: NFTAttributes[]

Returns NFTAttributes[]

getOwnChainID

Returns Buffer

hasDuplicateModuleNames

Parameters

attributesArray: NFTAttributes[]

Returns boolean

init

Parameters

config: ModuleConfig

Returns void

transfer

Parameters

methodContext: MethodContext

recipientAddress: Buffer

nftID: Buffer

Returns Promise<void>

transferCrossChain

Parameters

methodContext: MethodContext

senderAddress: Buffer

recipientAddress: Buffer

nftID: Buffer

receivingChainID: Buffer

messageFee: bigint

data: string

includeAttributes: boolean

Optional timestamp: number

Returns Promise<void>

verifyTransfer

`Private` _config

`Private` _interoperabilityMethod

`Private` _nftMethod

`Private` _tokenMethod

`Protected` events

`Protected` stores

`Optional` timestamp: number