Class: NftDataset<D>

NFT Dataset.

Type parameters

Name	Type
D	extends Dataset

Hierarchy

• DatasetClass<D, Nft>

  ↳ NftDataset

Properties

mintMetadata

• mintMetadata: Function

Mint metadata NFT

Param

Use Build5Request with data based on MintMetadataNftRequest

---

transfer

• transfer: Function

Transfer NFT

Param

Use Build5Request with data based on NftTransferRequest

Methods

bulkPurchase

▸ bulkPurchase(req): Promise<Transaction>

Bulk purchase of NFTs

Parameters

Name	Type	Description
req	Build5Request<NftPurchaseBulkRequest>	Use Build5Request with data based on NftPurchaseBulkRequest

Returns

Promise<Transaction>

---

create

▸ create(req): Promise<Nft>

Create NFT

Parameters

Name	Type	Description
req	Build5Request<NftCreateRequest>	Use Build5Request with data based on NftCreateRequest

Returns

Promise<Nft>

---

createBatch

▸ createBatch(req): Promise<Nft[]>

Create batch NFT

Parameters

Name	Type	Description
req	Build5Request<NftCreateRequest[]>	Use Build5Request with data based on NftCreateRequest

Returns

Promise<Nft[]>

---

deposit

▸ deposit(req): Promise<Transaction>

Deposit NFT

Parameters

Name	Type	Description
req	Build5Request<NftDepositRequest>	Use Build5Request with data based on ProjectDeactivateRequest

Returns

Promise<Transaction>

---

getAllUpdatedAfter

▸ getAllUpdatedAfter(updatedAfter, startAfter?): Promise<Nft[]>

Get all records updated after unix timestamp.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Promise<Nft[]>

Inherited from

DatasetClass.getAllUpdatedAfter

---

getAllUpdatedAfterLive

▸ getAllUpdatedAfterLive(updatedAfter, startAfter?): Observable<Nft[]>

Get all records updated after unix timestamp. Real time stream.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Observable<Nft[]>

Inherited from

DatasetClass.getAllUpdatedAfterLive

---

getByCollectionLive

▸ getByCollectionLive(collection, orderBy, orderByDir, startAfter?): Observable<Nft[]>

Get all NFTs by collection. Real time stream.

Parameters

Name	Type
collection	string
orderBy	string[]
orderByDir	string[]
startAfter?	string

Returns

Observable<Nft[]>

---

getByField

▸ getByField(fieldName, fieldValue, startAfter?): Promise<Nft[]>

Get records by field.

Parameters

Name	Type
fieldName	string | string[]
fieldValue	string | number | boolean | (string | number | boolean)[]
startAfter?	string

Returns

Promise<Nft[]>

Inherited from

DatasetClass.getByField

---

getByFieldLive

▸ getByFieldLive(fieldName, fieldValue, startAfter?): Observable<Nft[]>

Get records by field. Real time stream.

Parameters

Name	Type
fieldName	string | string[]
fieldValue	string | number | boolean | (string | number | boolean)[]
startAfter?	string

Returns

Observable<Nft[]>

Inherited from

DatasetClass.getByFieldLive

---

getByOwnerLive

▸ getByOwnerLive(owner, startAfter?): Observable<Nft[]>

Get all NFTs by owner. Real time stream.

Parameters

Name	Type
owner	string
startAfter?	string

Returns

Observable<Nft[]>

---

getBySpace

▸ getBySpace(space, startAfter?): Promise<Nft[]>

Get records by space.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Promise<Nft[]>

Inherited from

DatasetClass.getBySpace

---

getBySpaceLive

▸ getBySpaceLive(space, startAfter?): Observable<Nft[]>

Get records by space. Real time stream.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Nft[]>

Inherited from

DatasetClass.getBySpaceLive

---

getManyById

▸ getManyById(setIds): Promise<Nft[]>

Get many records by id.

Parameters

Name	Type
setIds	string[]

Returns

Promise<Nft[]>

Inherited from

DatasetClass.getManyById

---

getManyByIdLive

▸ getManyByIdLive(setIds): Observable<Nft[]>

Get many records by id. Real time stream.

Parameters

Name	Type
setIds	string[]

Returns

Observable<Nft[]>

Inherited from

DatasetClass.getManyByIdLive

---

id

▸ id(setId): ExactDataSet<D, Nft>

Get specific record by id.

Parameters

Name	Type
setId	string

Returns

ExactDataSet<D, Nft>

Inherited from

DatasetClass.id

---

openBid

▸ openBid(req): Promise<Transaction>

Bin on NFT.

Parameters

Name	Type	Description
req	Build5Request<NftBidRequest>	Use Build5Request with data based on NftBidRequest

Returns

Promise<Transaction>

---

order

▸ order(req): Promise<Transaction>

Buy NFT.

Parameters

Name	Type	Description
req	Build5Request<NftPurchaseRequest>	Use Build5Request with data based on NftPurchaseRequest

Returns

Promise<Transaction>

---

setForSale

▸ setForSale(req): Promise<Nft>

Set NFT for sale

Parameters

Name	Type	Description
req	Build5Request<NftSetForSaleRequest>	Use Build5Request with data based on NftSetForSaleRequest

Returns

Promise<Nft>

---

updateUnsold

▸ updateUnsold(req): Promise<Nft>

Update unsold NFT.

Parameters

Name	Type	Description
req	Build5Request<NftUpdateUnsoldRequest>	Use Build5Request with data based on NftUpdateUnsoldRequest

Returns

Promise<Nft>

---

withdraw

▸ withdraw(req): Promise<void>

Withdraw NFT

Parameters

Name	Type	Description
req	Build5Request<NftWithdrawRequest>	Use Build5Request with data based on NftWithdrawRequest

Returns

Promise<void>