NftApi Protocol Reference


                    
                    
                    get(byId:)

Default implementation

Get NFT by id.

Throws

DCoreException.Network.notFound if NFT does not exist.

Default Implementation

Declaration

Swift

func get(byId id: ObjectIdConvertible) -> Single<Nft>

Parameters

`id`	NFT object id, as `NftObjectId` or `String` format.

Return Value

Nft.

Show on GitHub


                    
                    
                    getAll(byIds:)

Default implementation

Get NFTs by id.

Default Implementation

Declaration

Swift

func getAll(byIds ids: [ObjectIdConvertible]) -> Single<[Nft]>

Parameters

ids

NFT object ids, as NftObjectId or String format.

Return Value

Array of Nft objects

Show on GitHub


                    
                    
                    get(byReference:)

Default implementation

Get NFT by reference.

Throws

DCoreException.Network.notFound if NFT does not exist.

Default Implementation

Declaration

Swift

func get(byReference reference: Nft.Reference) -> Single<Nft>

Parameters


                                reference

NFT object id or symbol, as String format.

Return Value

Nft.

Show on GitHub


                    
                    
                    get(bySymbol:)

Default implementation

Get NFT by symbol.

Throws

DCoreException.Network.notFound if NFT does not exist.

Default Implementation

Declaration

Swift

func get(bySymbol symbol: String) -> Single<Nft>

Parameters


                                symbol

NFT symbol, as String format.

Return Value

Nft.

Show on GitHub


                    
                    
                    getAll(bySymbols:)

Default implementation

Get NFTs by references.

Default Implementation

Declaration

Swift

func getAll(bySymbols symbols: [String]) -> Single<[Nft]>

Parameters


                                symbols

NFT symbols, as String format.

Return Value

Array of Nft objects.

Show on GitHub


                    
                    
                    listAllRelative(byLower:limit:)

Default implementation

Get NFTs alphabetically by symbol name

Default Implementation

Declaration

Swift

func listAllRelative(byLower bound: String, limit: Int) -> Single<[Nft]>

Parameters

`bound`	lower bound of symbol names to retrieve
`limit`	maximum number of NFTs to fetch (must not exceed 100)

Return Value

Array of found Nft objects.

Show on GitHub


                    
                    
                    getDataRaw(byId:)

Default implementation

Get NFT data instance with raw model.

Throws

DCoreException.Network.notFound if NFT does not exist.

Default Implementation

Declaration

Swift

func getDataRaw(byId id: ObjectIdConvertible) -> Single<NftData<RawNft>>

Parameters

`id`	NFT data object id, as `NftDataObjectId` or `String` format.

Return Value

NftData<RawNft> object.

Show on GitHub


                    
                    
                    getAllDataRaw(byIds:)

Default implementation

Get NFT data instances with raw model.

Default Implementation

Declaration

Swift

func getAllDataRaw(byIds ids: [ObjectIdConvertible]) -> Single<[NftData<RawNft>]>

Parameters

ids

NFT data object ids, as NftDataObjectId or String format.

Return Value

Array of NftData<RawNft> objects.

Show on GitHub


                    
                    
                    getData(byId:)

Default implementation

Get NFT data instance with parsed model.

Throws

DCoreException.Network.notFound if NFT does not exist.

Default Implementation

Declaration

Swift

func getData<T>(byId id: ObjectIdConvertible) -> Single<NftData<T>> where T : NftModel

Parameters

`id`	NFT data object id, as `NftDataObjectId` or `String` format.

Return Value

NftData object.

Show on GitHub


                    
                    
                    getAllData(byIds:)

Default implementation

Get NFT data instances with parsed model.

Default Implementation

Declaration

Swift

func getAllData<T>(byIds ids: [ObjectIdConvertible]) -> Single<[NftData<T>]> where T : NftModel

Parameters

ids

NFT data object ids, as NftDataObjectId or String format.

Return Value

Array of NftData objects.

Show on GitHub


                    
                    
                    listDataRaw(byNftId:)

Default implementation

Get NFT data instances with raw model.

Default Implementation

Declaration

Swift

func listDataRaw(byNftId nftId: ObjectIdConvertible) -> Single<[NftData<RawNft>]>

Parameters


                                nftId

NFT object id as NftObjectId or String format.

Return Value

Array of NftData<RawNft> objects.

Show on GitHub


                    
                    
                    listData(byNftId:)

Default implementation

Get NFT data instances with parsed model.

Default Implementation

Declaration

Swift

func listData<T>(byNftId nftId: ObjectIdConvertible) -> Single<[NftData<T>]> where T : NftModel

Parameters


                                nftId

NFT object id as NftObjectId or String format.

Return Value

Array of NftData objects.

Show on GitHub


                    
                    
                    searchNftHistory(byNftDataId:)

Default implementation

Search NFT history, lists transfer and issue operations for NFT data instance object id.

Default Implementation

Declaration

Swift

func searchNftHistory(byNftDataId nftDataId: ObjectIdConvertible) -> Single<[TransactionDetail]>

Parameters


                                nftDataId

NFT data object id, as NftDataObjectId or String format.

Return Value

Array of TransactionDetail objects representing transfer and issue operations.

Show on GitHub


                    
                    
                    countAllNft()

Default implementation

Count all NFTs

Default Implementation

Declaration

Swift

func countAllNft() -> Single<UInt64>

Return Value

count of NFT definitions

Show on GitHub


                    
                    
                    countAllNftData()

Default implementation

Count all NFT data instances

Default Implementation

Declaration

Swift

func countAllNftData() -> Single<UInt64>

Return Value

count of NFT data instances

Show on GitHub


                    
                    
                    getNftBalancesRaw(account:nftIds:)

Default implementation

Get NFT balances per account with raw model

Default Implementation

Declaration

Swift

func getNftBalancesRaw(account: AccountObjectIdConvertible, nftIds: [ObjectIdConvertible]) -> Single<[NftData<RawNft>]>

Parameters

`account`	Account object id, as `AccountObjectId` or `String` format.
`nftIds`	NFT object ids to filter, or empty list to fetch all, as `NftObjectId` or `String` format.

Return Value

NFT data instances with raw model

Show on GitHub


                    
                    
                    getNftBalances(account:nftIds:)

Default implementation

Get NFT balances per account with parsed model

Default Implementation

Declaration

Swift

func getNftBalances<T>(account: AccountObjectIdConvertible, nftIds: [ObjectIdConvertible]) -> Single<[NftData<T>]> where T : NftModel

Parameters

`account`	Account object id, as `AccountObjectId` or `String` format.
`nftIds`	NFT object ids to filter, or empty list to fetch all, as `NftObjectId` or `String` format.

Return Value

NFT data instances with parsed model

Show on GitHub


                    
                    
                    create(credentials:symbol:maxSupply:fixedMaxSupply:description:nftModel:transferable:fee:)

Default implementation

Undocumented

Default Implementation

Undocumented

Declaration

Swift

func create<T>(credentials: Credentials, symbol: String, maxSupply: UInt32, fixedMaxSupply: Bool, description: String, nftModel: T.Type, transferable: Bool, fee: AssetAmount) -> Single<TransactionConfirmation> where T : NftModel

Show on GitHub


                    
                    
                    update(credentials:reference:maxSupply:fixedMaxSupply:description:fee:)

Default implementation

Update NFT

Default Implementation

Declaration

Swift

func update(credentials: Credentials, reference: Nft.Reference, maxSupply: UInt32?, fixedMaxSupply: Bool?, description: String?, fee: AssetAmount) -> Single<TransactionConfirmation>

Parameters

`credentials`	issuer account credentials.
`reference`	NFT object id or symbol.
`maxSupply`	update NFT max suppy.
`fixedMaxSupply`	update NFT max supply is fixed.
`description`	update text description.
`fee`	`AssetAmount` fee for the operation, if left `AssetAmount.unset` the fee will be computed in DCT asset, default `AssetAmount.unset`.

Return Value

TransactionConfirmation that NFT was updated.

Show on GitHub


                    
                    
                    updateData(credentials:id:newData:fee:)

Default implementation

Update NFT data instance

Default Implementation

Declaration

Swift

func updateData<T>(credentials: Credentials, id: ObjectIdConvertible, newData: T, fee: AssetAmount) -> Single<TransactionConfirmation> where T : NftModel

Parameters

`credentials`	issuer account credentials.
`id`	NFT data object id, as `NftDataObjectId` or `String` format.
`newData`	data model with values.
`fee`	`AssetAmount` fee for the operation, if left `AssetAmount.unset` the fee will be computed in DCT asset, default `AssetAmount.unset`.

Return Value

TransactionConfirmation that NFT data instance was updated.

Show on GitHub


                    
                    
                    issue(credentials:reference:to:data:memo:fee:)

Default implementation

Issue NFT. Creates a NFT data instance.

Default Implementation

Declaration

Swift

func issue<T>(credentials: Credentials, reference: Nft.Reference, to: AccountObjectIdConvertible, data: T?, memo: Memo?, fee: AssetAmount) -> Single<TransactionConfirmation> where T : NftModel

Parameters

`credentials`	account credentials issuing the NFT.
`reference`	NFT object id or symbol.
`to`	account object id receiving the NFT data instance as `AccountObjectId` or `String` format.
`data`	data model with values.
`memo`	optional message.
`fee`	`AssetAmount` fee for the operation, if left `AssetAmount.unset` the fee will be computed in DCT asset, default `AssetAmount.unset`.

Return Value

TransactionConfirmation that NFT was issued.

Show on GitHub


                    
                    
                    transfer(credentials:to:id:memo:fee:)

Default implementation

Transfer NFT data instance.

Default Implementation

Declaration

Swift

func transfer(credentials: Credentials, to: AccountObjectIdConvertible, id: ObjectIdConvertible, memo: Memo?, fee: AssetAmount) -> Single<TransactionConfirmation>

Parameters

`credentials`	NFT data instance owner credentials.
`to`	account object id receiving the NFT data instance as `AccountObjectId` or `String` format.
`id`	NFT data object id, as `NftDataObjectId` or `String` format.
`memo`	optional message.
`fee`	`AssetAmount` fee for the operation, if left `AssetAmount.unset` the fee will be computed in DCT asset, default `AssetAmount.unset`.

Return Value

TransactionConfirmation that NFT was transfered.

Show on GitHub