Class: TokenDataset<D>

Token Dataset

Type parameters

Name	Type
D	extends Dataset

Hierarchy

• DatasetClass<D, Token>

  ↳ TokenDataset

Methods

cancelPublicSale

▸ cancelPublicSale(req): Promise<Token>

Cancel public token sale.

Parameters

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

Returns

Promise<Token>

---

create

▸ create(req): Promise<Token>

Create token.

Parameters

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

Returns

Promise<Token>

---

credit

▸ credit(req): Promise<Transaction>

Credit token request.

Parameters

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

Returns

Promise<Transaction>

---

enableTrading

▸ enableTrading(req): Promise<Token>

Enable token for trading on a exchange.

Parameters

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

Returns

Promise<Token>

---

getAllUpdatedAfter

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

Get all records updated after unix timestamp.

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Promise<Token[]>

Inherited from

DatasetClass.getAllUpdatedAfter

---

getAllUpdatedAfterLive

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

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

Parameters

Name	Type
updatedAfter	number
startAfter?	string

Returns

Observable<Token[]>

Inherited from

DatasetClass.getAllUpdatedAfterLive

---

getByField

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

Get records by field.

Parameters

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

Returns

Promise<Token[]>

Inherited from

DatasetClass.getByField

---

getByFieldLive

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

Get records by field. Real time stream.

Parameters

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

Returns

Observable<Token[]>

Inherited from

DatasetClass.getByFieldLive

---

getByMemberLive

▸ getByMemberLive(member, startAfter?, limit?): Observable<Token[]>

Get tokens by member. Real time stream.

Parameters

Name	Type
member	string
startAfter?	string
limit?	number

Returns

Observable<Token[]>

---

getBySpace

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

Get records by space.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Promise<Token[]>

Inherited from

DatasetClass.getBySpace

---

getBySpaceLive

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

Get records by space. Real time stream.

Parameters

Name	Type
space	string
startAfter?	string

Returns

Observable<Token[]>

Inherited from

DatasetClass.getBySpaceLive

---

getByStatusLive

▸ getByStatusLive(status?, startAfter?, limit?): Observable<Token[]>

Get status for token. Real time stream.

Parameters

Name	Type	Default value
status	TokenStatus[]	[]
startAfter?	string	undefined
limit?	number	undefined

Returns

Observable<Token[]>

---

getManyById

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

Get many records by id.

Parameters

Name	Type
setIds	string[]

Returns

Promise<Token[]>

Inherited from

DatasetClass.getManyById

---

getManyByIdLive

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

Get many records by id. Real time stream.

Parameters

Name	Type
setIds	string[]

Returns

Observable<Token[]>

Inherited from

DatasetClass.getManyByIdLive

---

id

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

Get specific record by id.

Parameters

Name	Type
setId	string

Returns

ExactDataSet<D, Token>

Inherited from

DatasetClass.id

---

importMintedToken

▸ importMintedToken(req): Promise<Transaction>

Imported minted token from the chain.

Parameters

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

Returns

Promise<Transaction>

---

mint

▸ mint(req): Promise<Transaction>

Update member details.

Parameters

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

Returns

Promise<Transaction>

---

order

▸ order(req): Promise<Transaction>

Order Token request.

Parameters

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

Returns

Promise<Transaction>

---

rank

▸ rank(req): Promise<Rank>

Rank token.

Parameters

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

Returns

Promise<Rank>

---

setAvailableForSale

▸ setAvailableForSale(req): Promise<Token>

Set token for sale on the launchpad.

Parameters

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

Returns

Promise<Token>

---

update

▸ update(req): Promise<Token>

Update token.

Parameters

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

Returns

Promise<Token>

---

vote

▸ vote(req): Promise<Vote>

Vote on token.

Parameters

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

Returns

Promise<Vote>