NftApi | DCore SDK for JS - API documentation

Hierarchy

BaseApi
- NftApi

Index

Constructors

constructor

Properties

Constructors

constructor

new NftApi(api: DCoreApi): NftApi

Overrides BaseApi.constructor
- Defined in api/rx/NftApi.ts:33
Parameters
- api: DCoreApi
Returns NftApi

Properties

Protected api

api: DCoreApi

Methods

countAll

countAll(): Observable<number>

- Defined in api/rx/NftApi.ts:156
Count all NFTs

Returns Observable<number>

count of NFT definitions

countAllData

countAllData(): Observable<number>

- Defined in api/rx/NftApi.ts:165
Count all NFT data instances

Returns Observable<number>

count of NFT data instances

create

create(credentials: Credentials, symbol: string, maxSupply: number, fixedMaxSupply: boolean, description: string, definitions: NftDataType[], transferable: boolean, fee?: Fee): Observable<TransactionConfirmation>

- Defined in api/rx/NftApi.ts:294
Create NFT

Parameters
- credentials: Credentials
  
  account credentials issuing the NFT
- symbol: string
  
  NFT symbol
- maxSupply: number
  
  NFT max supply
- fixedMaxSupply: boolean
  
  NFT max supply is fixed and cannot be changed with update
- description: string
  
  text description
- definitions: NftDataType[]
  
  NFT model data definitions
- transferable: boolean
  
  allow transfer of NFT data instances to other accounts
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<TransactionConfirmation>

a transaction confirmation

createIssueOperation

createIssueOperation<T>(issuer: ChainObject, nft: NftRef, to: ChainObject, data: T, memo?: Memo, fee?: Fee): Observable<NftIssueOperation>

- Defined in api/rx/NftApi.ts:366
Create NFT issue operation. Creates a NFT data instance.

Type parameters
- T: NftDefinition
Parameters
- issuer: ChainObject
  
  NFT issuer
- nft: NftRef
  
  NFT object id or symbol
- to: ChainObject
  
  account object id receiving the NFT data instance
- data: T
  
  data model with values
- Optional memo: Memo
  
  optional message
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<NftIssueOperation>

nft issue operation

createNftCreateOperation

createNftCreateOperation(symbol: string, options: NftOptions, definitions: NftDataType[], transferable: boolean, fee?: Fee): Observable<NftCreateOperation>

- Defined in api/rx/NftApi.ts:269
Create NFT create operation

Parameters
- symbol: string
  
  NFT symbol
- options: NftOptions
  
  NFT options
- definitions: NftDataType[]
  
  NFT model data definitions
- transferable: boolean
  
  allow transfer of NFT data instances to other accounts
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<NftCreateOperation>

nft create operation

createTransferOperation

createTransferOperation(from: ChainObject, to: ChainObject, id: ChainObject, memo?: Memo, fee?: Fee): Observable<NftTransferOperation>

- Defined in api/rx/NftApi.ts:415
Create NFT data instance transfer operation

Parameters
- from: ChainObject
  
  NFT data instance owner account object id
- to: ChainObject
  
  receiver account object id
- id: ChainObject
  
  NFT data instance object id
- Optional memo: Memo
  
  optional message
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<NftTransferOperation>

nft transfer operation

createUpdateDataOperation

createUpdateDataOperation<T>(modifier: ChainObject, data: NftData<T>, fee?: Fee): Observable<NftUpdateDataOperation>

- Defined in api/rx/NftApi.ts:485
Create NFT data instance update operation

Type parameters
- T: NftDefinition
Parameters
- modifier: ChainObject
  
  NFT data instance owner account object id, updatable values are set in [NftUpdateDataOperation.data] map
- data: NftData<T>
  
  nft object model with data
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<NftUpdateDataOperation>

nft update data operation

createUpdateDataOperationRaw

createUpdateDataOperationRaw(modifier: ChainObject, id: ChainObject, fee?: Fee): Observable<NftUpdateDataOperation>

- Defined in api/rx/NftApi.ts:459
Create NFT data instance update operation

Parameters
- modifier: ChainObject
  
  NFT data instance owner account object id, updatable values are set in [NftUpdateDataOperation.data] map
- id: ChainObject
  
  NFT data instance object id
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<NftUpdateDataOperation>

nft update data operation

createUpdateOperation

createUpdateOperation(nft: NftRef, fee?: Fee): Observable<NftUpdateOperation>

- Defined in api/rx/NftApi.ts:319
Create NFT update operation. Fills model with actual values.

Parameters
- nft: NftRef
  
  NFT object id or symbol
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<NftUpdateOperation>

nft update operation

get

get(nft: NftRef): Observable<Nft>

- Defined in api/rx/NftApi.ts:68
Get NFT by id or symbol

Parameters
- nft: NftRef
  
  NFT object id or symbol
Returns Observable<Nft>

NFT object, or ObjectNotFoundError if none found

getAll

getAll(ids: ChainObject[]): Observable<Nft[]>

- Defined in api/rx/NftApi.ts:46
Get NFTs by id

Parameters
- ids: ChainObject[]
  
  NFT object ids
Returns Observable<Nft[]>

NFT objects, or ObjectNotFoundError if none found

getAllBySymbol

getAllBySymbol(symbols: string[]): Observable<Nft[]>

- Defined in api/rx/NftApi.ts:57
Get NFTs by symbol

Parameters
- symbols: string[]
  
  NFT symbols
Returns Observable<Nft[]>

NFT objects, or ObjectNotFoundError if none found

getAllData

getAllData<T>(ids: ChainObject[]): Observable<Array<NftData<T>>>
getAllData<T>(ids: ChainObject[], model: Newable<T>): Observable<Array<NftData<T>>>
getAllData<T>(ids: ChainObject[], model?: Newable<T>): Observable<Array<NftData<T>>>

- Defined in api/rx/NftApi.ts:95
Get NFT data instances with registered model, use [DCoreApi.registerNft] to register nft model by object id, if the model is not registered, [RawNft] will be used

Type parameters
- T
Parameters
- ids: ChainObject[]
  
  NFT data object ids
Returns Observable<Array<NftData<T>>>

NFT data objects, or ObjectNotFoundError if none found
- Defined in api/rx/NftApi.ts:107
Get NFT data instances with registered model, use [DCoreApi.registerNft] to register nft model by object id, if the model is not registered, [RawNft] will be used

Type parameters
- T
Parameters
- ids: ChainObject[]
  
  NFT data object ids
- model: Newable<T>
  
  NFT data object model
Returns Observable<Array<NftData<T>>>

NFT data objects, or ObjectNotFoundError if none found
- Defined in api/rx/NftApi.ts:109
Type parameters
- T
Parameters
- ids: ChainObject[]
- Optional model: Newable<T>
Returns Observable<Array<NftData<T>>>

getAllDataRaw

getAllDataRaw(ids: ChainObject[]): Observable<Array<NftData<RawNft>>>

- Defined in api/rx/NftApi.ts:83
Get NFT data instances with raw model

Parameters
- ids: ChainObject[]
  
  NFT data object ids
Returns Observable<Array<NftData<RawNft>>>

NFT data objects, or ObjectNotFoundError if none found

getData

getData<T>(id: ChainObject): Observable<NftData<T>>
getData<T>(id: ChainObject, model: Newable<T>): Observable<NftData<T>>
getData<T>(id: ChainObject, model?: Newable<T>): Observable<NftData<T>>

- Defined in api/rx/NftApi.ts:133
Get NFT data instance with registered model, use [DCoreApi.registerNft] to register nft model by object id, if the model is not registered, [RawNft] will be used

Type parameters
- T
Parameters
- id: ChainObject
  
  NFT data object ids
Returns Observable<NftData<T>>

NFT data objects, or ObjectNotFoundError if none found
- Defined in api/rx/NftApi.ts:144
Get NFT data instances with parsed model

Type parameters
- T
Parameters
- id: ChainObject
  
  NFT data object ids
- model: Newable<T>
  
  NFT data object model
Returns Observable<NftData<T>>

NFT data objects, or ObjectNotFoundError if none found
- Defined in api/rx/NftApi.ts:146
Type parameters
- T
Parameters
- id: ChainObject
- Optional model: Newable<T>
Returns Observable<NftData<T>>

getDataRaw

getDataRaw(id: ChainObject): Observable<NftData<RawNft>>

- Defined in api/rx/NftApi.ts:121
Get NFT data instance with raw model

Parameters
- id: ChainObject
  
  NFT data object id
Returns Observable<NftData<RawNft>>

NFT data object, or ObjectNotFoundError if none found

Private getId

getId(nft: NftRef): Observable<ChainObject>

- Defined in api/rx/NftApi.ts:537
Parameters
- nft: NftRef
Returns Observable<ChainObject>

getNftBalances

getNftBalances<T>(account: ChainObject, nftIds?: ChainObject[]): Observable<Array<NftData<T>>>
getNftBalances<T>(account: ChainObject, nftIds?: ChainObject[], model?: Newable<T>): Observable<Array<NftData<T>>>

- Defined in api/rx/NftApi.ts:190
Get NFT balances per account with registered model, use [DCoreApi.registerNfts] to register nft model by object id, if the model is not registered, [RawNft] will be used

Type parameters
- T
Parameters
- account: ChainObject
  
  account object id
- Optional nftIds: ChainObject[]
  
  NFT object ids to filter, or empty list to fetch all
Returns Observable<Array<NftData<T>>>

NFT data instances
- Defined in api/rx/NftApi.ts:202
Get NFT balances per account with parsed model

Type parameters
- T
Parameters
- account: ChainObject
  
  account object id
- Optional nftIds: ChainObject[]
  
  NFT object ids to filter, or empty list to fetch all
- Optional model: Newable<T>
  
  NFT data object model
Returns Observable<Array<NftData<T>>>

NFT data instances

getNftBalancesRaw

getNftBalancesRaw(account: ChainObject, nftIds?: ChainObject[]): Observable<Array<NftData<RawNft>>>

- Defined in api/rx/NftApi.ts:177
Get NFT balances per account with raw model

Parameters
- account: ChainObject
  
  account object id
- Default value nftIds: ChainObject[] = []
  
  NFT object ids to filter, or empty list to fetch all
Returns Observable<Array<NftData<RawNft>>>

NFT data instances with raw model

issue

issue<T>(credentials: Credentials, nft: NftRef, to: ChainObject, data: T, memo?: Memo, fee?: Fee): Observable<TransactionConfirmation>

- Defined in api/rx/NftApi.ts:390
Issue NFT. Creates a NFT data instance.

Type parameters
- T: NftDefinition
Parameters
- credentials: Credentials
  
  NFT issuer credentials
- nft: NftRef
  
  NFT object id or symbol
- to: ChainObject
  
  account object id receiving the NFT data instance
- data: T
  
  data model with values
- Optional memo: Memo
  
  optional message
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<TransactionConfirmation>

a transaction confirmation

listAllRelative

listAllRelative(lowerBound?: string, limit?: number): Observable<Nft[]>

- Defined in api/rx/NftApi.ts:216
Get NFTs alphabetically by symbol name

Parameters
- Default value lowerBound: string = ""
  
  lower bound of symbol names to retrieve
- Default value limit: number = 100
  
  maximum number of NFTs to fetch (must not exceed 100)
Returns Observable<Nft[]>

the NFTs found

listDataByNft

listDataByNft<T>(nftId: ChainObject): Observable<Array<NftData<T>>>
listDataByNft<T>(nftId: ChainObject, model: Newable<T>): Observable<Array<NftData<T>>>
listDataByNft<T>(nftId: ChainObject, model?: Newable<T>): Observable<Array<NftData<T>>>

- Defined in api/rx/NftApi.ts:239
Get NFT data instances with registered model, use [DCoreApi.registerNfts] to register nft model by object id, if the model is not registered, [RawNft] will be used

Type parameters
- T
Parameters
- nftId: ChainObject
  
  NFT object id
Returns Observable<Array<NftData<T>>>

NFT data objects
- Defined in api/rx/NftApi.ts:250
Get NFT data instances with parsed model

Type parameters
- T
Parameters
- nftId: ChainObject
  
  NFT object id
- model: Newable<T>
  
  NFT data object model
Returns Observable<Array<NftData<T>>>

NFT data objects
- Defined in api/rx/NftApi.ts:252
Type parameters
- T
Parameters
- nftId: ChainObject
- Optional model: Newable<T>
Returns Observable<Array<NftData<T>>>

listDataByNftRaw

listDataByNftRaw(nftId: ChainObject): Observable<Array<NftData<RawNft>>>

- Defined in api/rx/NftApi.ts:227
Get NFT data instances with raw model

Parameters
- nftId: ChainObject
  
  NFT object id
Returns Observable<Array<NftData<RawNft>>>

NFT data objects

Private make

make<T>(nftData: NftData<RawNft>, model?: Newable<T>): NftData<T>

- Defined in api/rx/NftApi.ts:545
Type parameters
- T
Parameters
- nftData: NftData<RawNft>
- Optional model: Newable<T>
Returns NftData<T>

Protected request

request<T>(request: BaseRequest<T> | BaseRequest<T> & WithCallback): Observable<T>

Inherited from BaseApi.request
- Defined in api/rx/BaseApi.ts:12
Type parameters
- T
Parameters
- request: BaseRequest<T> | BaseRequest<T> & WithCallback
Returns Observable<T>

transfer

transfer(credentials: Credentials, to: ChainObject, id: ChainObject, memo?: Memo, fee?: Fee): Observable<TransactionConfirmation>

- Defined in api/rx/NftApi.ts:437
Transfer NFT data instance

Parameters
- credentials: Credentials
  
  NFT data instance owner credentials
- to: ChainObject
  
  receiver account object id
- id: ChainObject
  
  NFT data instance object id
- Optional memo: Memo
  
  optional message
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<TransactionConfirmation>

a transaction confirmation

update

update(credentials: Credentials, nft: NftRef, maxSupply?: undefined | number, fixedMaxSupply?: undefined | false | true, description?: undefined | string, fee?: Fee): Observable<TransactionConfirmation>

- Defined in api/rx/NftApi.ts:339
Update NFT

Parameters
- credentials: Credentials
  
  issuer account credentials
- nft: NftRef
  
  NFT object id or symbol
- Optional maxSupply: undefined | number
  
  update max supply
- Optional fixedMaxSupply: undefined | false | true
  
  update max supply is fixed
- Optional description: undefined | string
  
  update text description
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<TransactionConfirmation>

a transaction confirmation

updateData

updateData<T>(credentials: Credentials, data: NftData<T>, fee?: Fee): Observable<TransactionConfirmation>

- Defined in api/rx/NftApi.ts:527
Update NFT data instance

Type parameters
- T: NftDefinition
Parameters
- credentials: Credentials
  
  NFT data instance credentials
- data: NftData<T>
  
  nft data object with values to update
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<TransactionConfirmation>

a transaction confirmation

updateDataRaw

updateDataRaw(credentials: Credentials, id: ChainObject, values: Map<string, any>, fee?: Fee): Observable<TransactionConfirmation>

- Defined in api/rx/NftApi.ts:504
Update NFT data instance

Parameters
- credentials: Credentials
  
  NFT data instance credentials
- id: ChainObject
  
  NFT data instance object id
- values: Map<string, any>
  
  map of field name to value which should be updated
- Optional fee: Fee
  
  fee for the operation or asset id, if left undefined the fee will be computed in DCT asset. When set, the request might fail if the asset is not convertible to DCT or conversion pool is not large enough
Returns Observable<TransactionConfirmation>

a transaction confirmation

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

api: DCoreApi

Returns NftApi

Properties

Protected api

Methods

countAll

Returns Observable<number>

countAllData

Returns Observable<number>

create

Parameters

credentials: Credentials

symbol: string

maxSupply: number

fixedMaxSupply: boolean

description: string

definitions: NftDataType[]

transferable: boolean

Optional fee: Fee

Returns Observable<TransactionConfirmation>

createIssueOperation

Type parameters

T: NftDefinition

Parameters

issuer: ChainObject

nft: NftRef

to: ChainObject

data: T

Optional memo: Memo

Optional fee: Fee

Returns Observable<NftIssueOperation>

createNftCreateOperation

Parameters

symbol: string

options: NftOptions

definitions: NftDataType[]

transferable: boolean

Optional fee: Fee

Returns Observable<NftCreateOperation>

createTransferOperation

Parameters

from: ChainObject

to: ChainObject

id: ChainObject

Optional memo: Memo

Optional fee: Fee

Returns Observable<NftTransferOperation>

createUpdateDataOperation

Type parameters

T: NftDefinition

Parameters

modifier: ChainObject

data: NftData<T>

Optional fee: Fee

Returns Observable<NftUpdateDataOperation>

createUpdateDataOperationRaw

Parameters

modifier: ChainObject

id: ChainObject

Optional fee: Fee

Returns Observable<NftUpdateDataOperation>

createUpdateOperation

Parameters

nft: NftRef

Optional fee: Fee

Returns Observable<NftUpdateOperation>

get

Parameters

nft: NftRef

Returns Observable<Nft>

getAll

Parameters