MiningApi Protocol Reference


                    
                    
                    get(byAccountId:)

Default implementation

Get miner by account id.

Throws

DCoreException.Network.notFound if account does not exist.

Default Implementation

Declaration

Swift

func get(byAccountId id: AccountObjectIdConvertible) -> Single<Miner>

Parameters

`id`	Account id as `AccountObjectId` or `String` format.

Return Value

An Miner if exist.

Show on GitHub


                    
                    
                    getAll()

Default implementation

Get first 1000 miners by their name to miner account.

Default Implementation

Declaration

Swift

func getAll() -> Single<[String : Miner]>

Return Value

Map [String: Miner] of miners.

Show on GitHub


                    
                    
                    getAll(byIds:)

Default implementation

Get list of miners by their ids.

Default Implementation

Declaration

Swift

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

Parameters

ids

Miner ids as MinerObjectId or String format.

Return Value

Array [Miner] of miners.

Show on GitHub


                    
                    
                    findAllRelative(byLower:limit:)

Default implementation

Get names and ids for registered miners.

Default Implementation

Declaration

Swift

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

Parameters

`bound`	Lower bound of the first name.
`limit`	Max/default `1000`.

Return Value

List of found miner ids.

Show on GitHub


                    
                    
                    countAllMiners()

Default implementation

Get the total number of miners registered in DCore.

Default Implementation

Declaration

Swift

func countAllMiners() -> Single<UInt64>

Return Value

Number of miners.

Show on GitHub


                    
                    
                    getAllFeeds(byAccountId:limit:)

Default implementation

Get a list of published price feeds by a miner.

Default Implementation

Declaration

Swift

func getAllFeeds(byAccountId id: AccountObjectIdConvertible, limit: UInt64) -> Single<AnyValue>

Parameters

`id`	Account id as `AccountObjectId` or `String` format.
`limit`	Maximum number of price feeds to fetch, max/default `100`.

Return Value

Array of price feeds published by the miner.

Show on GitHub


                    
                    
                    getAllActualVotes()

Default implementation

Get the number of votes each miner actually has.

Default Implementation

Declaration

Swift

func getAllActualVotes() -> Single<[MinerVotes]>

Return Value

Array of [MinerVotes], mapping account names to the number of votes.

Show on GitHub


                    
                    
                    findAllVotes(byVoteIds:)

Default implementation

Given a set of votes, return the objects they are voting for. The results will be in the same order as the votes. Null will be returned for any vote ids that are not found.

Default Implementation

Declaration

Swift

func findAllVotes(byVoteIds ids: [VoteId]) -> Single<[Miner]>

Parameters

ids

Set of votes.

Return Value

Array of [Miners], mapping account names to the number of votes.

Show on GitHub


                    
                    
                    findAllVotingInfos(by:order:id:accountName:onlyMyVotes:limit:)

Default implementation

Get miner voting info list by account that match search expression.

Default Implementation

Declaration

Swift

func findAllVotingInfos(by expression: String, order: SearchOrder.MinerVoting, id: ObjectIdConvertible?, accountName: String?, onlyMyVotes: Bool, limit: Int) -> Single<[MinerVotingInfo]>

Parameters

`expression`	Set of votes.
`order`	Order, default `SearchOrder.MinerVoting.nameDesc`.
`id`	The object id of the miner to start searching from, 1.4.* or null when start from beginning, default `nil`, as `MinerObjectId` or `String` format.
`accountName`	Account name or null when searching without account.
`onlyMyVotes`	When true it selects only votes given by account.
`limit`	Maximum number of miners info to fetch, max/default `1000`.

Return Value

Array [MinerVotingInfo] of miner voting info.

Show on GitHub


                    
                    
                    getNewAssetPerBlock()

Default implementation

Get a reward for a miner from the most recent block.

Default Implementation

Declaration

Swift

func getNewAssetPerBlock() -> Single<BigInt>

Parameters

num

Block number.

Return Value

Amount of newlgenerated DCT.

Show on GitHub


                    
                    
                    getAssetPerBlock(byBlockNum:)

Default implementation

Get a reward for a miner from a specified block.

Default Implementation

Declaration

Swift

func getAssetPerBlock(byBlockNum num: UInt64) -> Single<BigInt>

Parameters

num

Block number.

Return Value

Amount of generated DCT.

Show on GitHub


                    
                    
                    createVote(forMinerIds:credentials:)

Default implementation

Create vote for miner operation.

Default Implementation

Declaration

Swift

func createVote(forMinerIds ids: [ObjectIdConvertible], credentials: Credentials) -> Single<AccountUpdateOperation>

Parameters

`ids`	The object ids of the miners, eg. 1.4.*, as `MinerObjectId` or `String` format.
`credentials`	Account credentials.

Return Value

AccountUpdateOperation.

Show on GitHub


                    
                    
                    vote(forMinerIds:credentials:)

Default implementation

Make vote for miner.

Default Implementation

Declaration

Swift

func vote(forMinerIds ids: [ObjectIdConvertible], credentials: Credentials) -> Single<TransactionConfirmation>

Parameters

`ids`	The object ids of the miners, eg. 1.4.*, as `MinerObjectId` or `String` format.
`credentials`	Account credentials.

Return Value

TransactionConfirmation.

Show on GitHub