Class NFTEndpoint

Hierarchy

BaseEndpoint
- NFTEndpoint

Index

Constructors

Properties

Methods

addDependencies getEscrowedNFTIDs getNFT getNFTs getSupportedCollectionIDs getSupportedNFTs hasNFT isCollectionIDSupported isNFTSupported

Constructors

constructor

new NFTEndpoint(stores: NamedRegistry, offchainStores: NamedRegistry): NFTEndpoint
Parameters
- stores: NamedRegistry
- offchainStores: NamedRegistry
Returns NFTEndpoint
Inherited from BaseEndpoint.constructor
- Defined in framework/src/modules/base_endpoint.ts:20

Properties

`Private` _nftMethod

_nftMethod: NFTMethod

`Protected` offchainStores

offchainStores: NamedRegistry

`Protected` stores

stores: NamedRegistry

Methods

addDependencies

addDependencies(nftMethod: NFTMethod): void
Parameters
- nftMethod: NFTMethod
Returns void
- Defined in framework/src/modules/nft/endpoint.ts:37

getEscrowedNFTIDs

getEscrowedNFTIDs(context: ModuleEndpointContext): Promise<{
escrowedNFTIDs: string[];
}>
Gets all escrowed NFTs for a specific chain ID.

Example
```
 lisk-core endpoint:invoke nft_getEscrowedNFTIDs '{ "chainID":"04000001" }' --pretty
```
Returns
A list of escrowed NFT for the specified chain ID.
Parameters
- context: ModuleEndpointContext
Returns Promise<{
escrowedNFTIDs: string[];
}>
- Defined in framework/src/modules/nft/endpoint.ts:282

getNFT

getNFT(context: ModuleEndpointContext): Promise<{
    attributesArray: ({ module: string; attributes: string; })[];
    lockingModule?: string;
    owner: string;
}>
Gets a specific NFT.

Example
```
 lisk-core endpoint:invoke nft_getNFT '{ "id":"04000000000000010000000000000001" }' --pretty
```
Returns
The NFT with the specified "NFT ID".
Parameters
- context: ModuleEndpointContext
Returns Promise<{
    attributesArray: ({ module: string; attributes: string; })[];
    lockingModule?: string;
    owner: string;
}>
- Defined in framework/src/modules/nft/endpoint.ts:135

getNFTs

getNFTs(context: ModuleEndpointContext): Promise<{
    nfts: {
        attributesArray: ({ module: string; attributes: string; })[];
        id: string;
        lockingModule?: string;
    }[];
}>
Gets all NFT owned by a specific account.

Example
```
 lisk-core endpoint:invoke nft_getNFTs '{ "address": "lsk24cd35u4jdq8szo3pnsqe5dsxwrnazyqqqg5eu" }' --pretty
```
Returns
A list of all NFT owned by the specified account.
Parameters
- context: ModuleEndpointContext
Returns Promise<{
    nfts: {
        attributesArray: ({ module: string; attributes: string; })[];
        id: string;
        lockingModule?: string;
    }[];
}>
- Defined in framework/src/modules/nft/endpoint.ts:53

getSupportedCollectionIDs

getSupportedCollectionIDs(context: ModuleEndpointContext): Promise<{
supportedCollectionIDs: string[];
}>
Returns all supported NFT collections of the network.

Example
```
 lisk-core endpoint:invoke nft_getSupportedCollectionIDs --pretty
```
Returns
A list of all NFT collection IDs that are supported by the network.
Parameters
- context: ModuleEndpointContext
Returns Promise<{
supportedCollectionIDs: string[];
}>
- Defined in framework/src/modules/nft/endpoint.ts:193

getSupportedNFTs

getSupportedNFTs(context: ModuleEndpointContext): Promise<{
supportedNFTs: string[];
}>
Returns all NFT supported by the network.

Example
```
 lisk-core endpoint:invoke nft_getSupportedNFTs --pretty
```
Returns
A list of all supported NFT IDs
Parameters
- context: ModuleEndpointContext
Returns Promise<{
supportedNFTs: string[];
}>
- Defined in framework/src/modules/nft/endpoint.ts:351

hasNFT

hasNFT(context: ModuleEndpointContext): Promise<{
hasNFT: boolean;
}>
Checks whether an account owns a specific NFT or not.

Example
```
 lisk-core endpoint:invoke nft_hasNFT '{ "address": "lsk24cd35u4jdq8szo3pnsqe5dsxwrnazyqqqg5eu", "id":"04000000000000010000000000000001" }' --pretty
```
Returns
true if the account owns the NFT, false if not.
Parameters
- context: ModuleEndpointContext
Returns Promise<{
hasNFT: boolean;
}>
- Defined in framework/src/modules/nft/endpoint.ts:104

isCollectionIDSupported

isCollectionIDSupported(context: ModuleEndpointContext): Promise<{
isCollectionIDSupported: boolean;
}>
Checks whether a specific NFT collection ID is supported by the network.

Example
```
 lisk-core endpoint:invoke nft_isCollectionIDSupported '{ "chainID":"04000001","collectionID":"00000001" }' --pretty
```
Returns
true if the specified NFT collection is supported, false if not.
Parameters
- context: ModuleEndpointContext
Returns Promise<{
isCollectionIDSupported: boolean;
}>
- Defined in framework/src/modules/nft/endpoint.ts:233

isNFTSupported

isNFTSupported(context: ModuleEndpointContext): Promise<{
isNFTSupported: boolean;
}>
Checks whether a specific NFT is supported by the network.

Example
```
 lisk-core endpoint:invoke nft_isNFTSupported '{ "nftID":"04000000000000010000000000000001" }' --pretty
```
Returns
true if the NFT is supported, false if not.
Parameters
- context: ModuleEndpointContext
Returns Promise<{
isNFTSupported: boolean;
}>
- Defined in framework/src/modules/nft/endpoint.ts:317

Class NFTEndpoint

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

stores: NamedRegistry

offchainStores: NamedRegistry

Returns NFTEndpoint

Properties

Private _nftMethod

Protected offchainStores

Protected stores

Methods

addDependencies

Parameters

nftMethod: NFTMethod

Returns void

getEscrowedNFTIDs

Example

Returns

Parameters

context: ModuleEndpointContext

Returns Promise<{ escrowedNFTIDs: string[]; }>

getNFT

Example

Returns

Parameters

context: ModuleEndpointContext

Returns Promise<{ attributesArray: ({ module: string; attributes: string; })[]; lockingModule?: string; owner: string; }>

getNFTs

Example

Returns

Parameters

context: ModuleEndpointContext

Returns Promise<{ nfts: { attributesArray: ({ module: string; attributes: string; })[]; id: string; lockingModule?: string; }[]; }>

getSupportedCollectionIDs

Example

Returns

Parameters

context: ModuleEndpointContext

Returns Promise<{ supportedCollectionIDs: string[]; }>

getSupportedNFTs

Example

Returns

Parameters

context: ModuleEndpointContext

Returns Promise<{ supportedNFTs: string[]; }>

hasNFT

Example

Returns

Parameters

context: ModuleEndpointContext

Returns Promise<{ hasNFT: boolean; }>

isCollectionIDSupported

Example

Returns

Parameters

context: ModuleEndpointContext

Returns Promise<{ isCollectionIDSupported: boolean; }>

isNFTSupported

Example

Returns

Parameters

context: ModuleEndpointContext

Returns Promise<{ isNFTSupported: boolean; }>

Settings

Member Visibility

Theme

On This Page

`Private` _nftMethod

`Protected` offchainStores

`Protected` stores

Returns Promise<{
escrowedNFTIDs: string[];
}>

Returns Promise<{
attributesArray: ({ module: string; attributes: string; })[];
lockingModule?: string;
owner: string;
}>

Returns Promise<{
nfts: {
attributesArray: ({ module: string; attributes: string; })[];
id: string;
lockingModule?: string;
}[];
}>

Returns Promise<{
supportedCollectionIDs: string[];
}>

Returns Promise<{
supportedNFTs: string[];
}>

Returns Promise<{
hasNFT: boolean;
}>

Returns Promise<{
isCollectionIDSupported: boolean;
}>

Returns Promise<{
isNFTSupported: boolean;
}>