MiningModule | dcorejs

Hierarchy

ApiModule
- MiningModule

Index

Constructors

constructor

Properties

CHAIN_PROXY_TO_SELF

Methods

Constructors

constructor

new MiningModule(dbApi: DatabaseApi, apiConnector: ApiConnector, chainApi: ChainApi): MiningModule

Overrides ApiModule.constructor
- Defined in modules/mining.ts:48
Parameters
- dbApi: DatabaseApi
- apiConnector: ApiConnector
- chainApi: ChainApi
Returns MiningModule

Properties

Static CHAIN_PROXY_TO_SELF

CHAIN_PROXY_TO_SELF: string = ""

Methods

createMiner

createMiner(minerAccountId: string, URL: string, signingPublicKey: string, privateKey: string, broadcast?: boolean): Promise<Operation>

- Defined in modules/mining.ts:122
Create miner. https://docs.decent.ch/developer/classgraphene_1_1wallet_1_1detail_1_1wallet__api__impl.html#a71fd1099d86cf82f0c4a61f9a2d5803b

Parameters
- minerAccountId: string
  
  Id of account which will be miner.
- URL: string
  
  URL to miner promotional web page.
- signingPublicKey: string
  
  Public key used to signing mining operations.
- privateKey: string
  
  Private key to sign transaction.
- Default value broadcast: boolean = true
  
  Transaction is broadcasted if set to 'true'. Default value is 'true'.
Returns Promise<Operation>

Value confirming successful transaction broadcasting.

getMiner

getMiner(minerId: string): Promise<Miner>

- Defined in modules/mining.ts:557
Get miner object. https://docs.decent.ch/developer/classgraphene_1_1wallet_1_1detail_1_1wallet__api__impl.html#a43b1380512f11c9f6963ce2a5c9c81c9

Parameters
- minerId: string
  
  Miner id to be fetched, in format '1.4.X'. Example '1.4.56'.
Returns Promise<Miner>

Miner object.

getVestingBalances

getVestingBalances(accountId: string): Promise<VestingBalance[]>

- Defined in modules/mining.ts:370
List balance for user in vesting. https://docs.decent.ch/developer/classgraphene_1_1app_1_1database__api__impl.html#a4e7c681a6c7996225c714f8dc6d061a8

Parameters
- accountId: string
  
  Account id of miner in format '1.2.X'. Example '1.2.345'.
Returns Promise<VestingBalance[]>

VestingBalance object.

listMiners

listMiners(fromId: string, limit?: number): Promise<MinerNameIdPair[]>

- Defined in modules/mining.ts:536
List miners in DCore network. https://docs.decent.ch/developer/group___wallet_a_p_i___mining.html#gadd09ed33a90485888d6d885ddaa82fcd

Parameters
- fromId: string
  
  Miner id to start list from, in format '1.4.X'. Example '1.4.56', Use '0.0.0' to list from the beginning.
- Default value limit: number = 100
  
  Size of result list. Default 100(Max)
Returns Promise<MinerNameIdPair[]>

List of MinerNameIdPair.

setDesiredMinerCount

setDesiredMinerCount(accountId: string, desiredNumOfMiners: number, privateKey: string, broadcast?: boolean): Promise<Operation>

- Defined in modules/mining.ts:68
Place vote for change of number of active miners. https://docs.decent.ch/developer/classgraphene_1_1wallet_1_1detail_1_1wallet__api__impl.html#aeffdd3eb57a9f4877d660ca4ccd7d9f5

Parameters
- accountId: string
  
  Id of account which placing vote, in format '1.2.X'. Example '1.2.345'.
- desiredNumOfMiners: number
  
  Desired number of active miners in DCore network.
- privateKey: string
  
  Private key to sign transaction.
- Default value broadcast: boolean = true
  
  Transaction is broadcasted if set to 'true'. Default value is 'true'.
Returns Promise<Operation>

Value confirming successful transaction broadcasting.

setVotingProxy

setVotingProxy(accountId: string, votingAccountId: string, privateKey: string, broadcast?: boolean): Promise<Operation>

- Defined in modules/mining.ts:482
Account what is selected as proxy, his votes is taken as yours. Automatically vote for same miners as voting proxy account voted, with your balance. https://docs.decent.ch/developer/classgraphene_1_1wallet_1_1detail_1_1wallet__api__impl.html#a9c571d810992f8a72142ace75e74eceb

Parameters
- accountId: string
  
  Account if in format '1.2.X'. Example '1.2.345'.
- votingAccountId: string
  
  Id of account to be set as voting proxy, in format '1.2.X'. Set to '' for default setting. Example '1.2.345'.
- privateKey: string
  
  Private used to sign transaction.
- Default value broadcast: boolean = true
  
  Transaction is broadcasted if set to 'true'. Default value is 'true'.
Returns Promise<Operation>

Value confirming successful transaction broadcasting.

unvoteMiner

unvoteMiner(miner: string, account: string, privateKeyWif: string, broadcast?: boolean): Promise<Operation>

- Defined in modules/mining.ts:153
Remove your vote from selected miner.

Parameters
- miner: string
  
  Miner to un-vote, in format '1.4.X'. Example '1.4.5'.
- account: string
  
  Account id to un-vote miner from, in format '1.2.X'. Example '1.2.345'.
- privateKeyWif: string
  
  Private key to sign thr transaction.
- Default value broadcast: boolean = true
  
  Transaction is broadcasted if set to 'true'. Default value is 'true'.
Returns Promise<Operation>

Value confirming successful transaction broadcasting.

unvoteMiners

unvoteMiners(miners: string[], account: string, privateKeyWif: string, broadcast?: boolean): Promise<Operation>

- Defined in modules/mining.ts:172
Remove your votes from multiple miners.

Parameters
- miners: string[]
  
  List of miners to un-vote, in format '1.4.X'. Example ['1.4.5', '1.4.6'].
- account: string
  
  Account id to un-vote miner from, in format '1.2.X'. Example '1.2.345'.
- privateKeyWif: string
  
  Private key to sign thr transaction.
- Default value broadcast: boolean = true
  
  Transaction is broadcasted if set to 'true'. Default value is 'true'.
Returns Promise<Operation>

Value confirming successful transaction broadcasting.

updateMiner

updateMiner(minerId: string, minerAccountId: string, updateData: MinerUpdateData, privateKey: string, broadcast?: boolean): Promise<Operation>

- Defined in modules/mining.ts:393
Update info in miner account. https://docs.decent.ch/developer/classgraphene_1_1wallet_1_1detail_1_1wallet__api__impl.html#a4d94757da6cc355932fa01a0302e9007

Parameters
- minerId: string
  
  Miner id in format '1.4.X'. Example '1.4.56'.
- minerAccountId: string
  
  Account id of miner in format '1.2.X'. Example '1.2.345'.
- updateData: MinerUpdateData
  
  Information to be changed in miner account.
- privateKey: string
  
  Miner's private key to sign the transaction.
- Default value broadcast: boolean = true
  
  Transaction is broadcasted if set to 'true'. Default value is 'true'.
Returns Promise<Operation>

Value confirming successful transaction broadcasting.

voteForMiner

voteForMiner(miner: string, account: string, privateKeyWif: string, broadcast?: boolean): Promise<Operation>

- Defined in modules/mining.ts:229
Vote for selected miner. https://docs.decent.ch/developer/classgraphene_1_1wallet_1_1detail_1_1wallet__api__impl.html#ab0e2ae4331187fd07ad60cd090a4711f

Parameters
- miner: string
  
  Miner to vote for, in format '1.4.X'. Example '1.4.5'.
- account: string
  
  Account id to vote miner for, in format '1.2.X'. Example '1.2.345'.
- privateKeyWif: string
  
  Private key to sign thr transaction.
- Default value broadcast: boolean = true
  
  Transaction is broadcasted if set to 'true'. Default value is 'true'.
Returns Promise<Operation>

Value confirming successful transaction broadcasting.

voteForMiners

voteForMiners(miners: string[], account: string, privateKeyWif: string, broadcast?: boolean): Promise<Operation>

- Defined in modules/mining.ts:249
Add votes to multiple miners. This method is also called on voteForMiner.

Parameters
- miners: string[]
  
  List of miners to vote for, in format '1.4.X'. Example ['1.4.5', '1.4.6'].
- account: string
  
  Account id to vote miner for, in format '1.2.X'. Example '1.2.345'.
- privateKeyWif: string
  
  Private key to sign thr transaction.
- Default value broadcast: boolean = true
  
  Transaction is broadcasted if set to 'true'. Default value is 'true'.
Returns Promise<Operation>

Value confirming successful transaction broadcasting.

voteUnvoteMiners

voteUnvoteMiners(voteMiners: string[], unvoteMiners: string[], accountId: string, privateKey: string, broadcast?: boolean): Promise<Operation>

- Defined in modules/mining.ts:306
Bulk operation to vote and unvote miners in one operation. Use to avoid paying fee for multiple vote operation.

Parameters
- voteMiners: string[]
  
  List of miners to vote for, in format '1.4.X'. Example ['1.4.5', '1.4.6'].
- unvoteMiners: string[]
  
  List of miners to un-vote, in format '1.4.X'. Example ['1.4.5', '1.4.6'].
- accountId: string
  
  Id of account vote changes will be made to, in format '1.2.X'. Example '1.2.345'.
- privateKey: string
  
  Private key to sign the transaction.
- Default value broadcast: boolean = true
  
  Transaction is broadcasted if set to 'true'. Default value is 'true'.
Returns Promise<Operation>

Value confirming successful transaction broadcasting.

withdrawVesting

withdrawVesting(vestinBalanceId: string, ownerId: string, amount: number, assetId: string, privateKey: string, broadcast?: boolean): Promise<Operation>

- Defined in modules/mining.ts:440
Withdraw amount from vesting for account. NOTE: 24h after amount is vested https://docs.decent.ch/developer/classgraphene_1_1wallet_1_1detail_1_1wallet__api__impl.html#abb116624419b0f7142d725150561534a

Parameters
- vestinBalanceId: string
  
  Vesting balance id in format '1.9.X'. Example '1.9.345'.
- ownerId: string
  
  Vesting balance owner account id in format '1.2.X'. Example '1.2.345'.
- amount: number
  
  Amount of balance to be withdrawn.
- assetId: string
  
  Asset id of amount to be withdrawn.
- privateKey: string
  
  Owner's private key to sign the transaction.
- Default value broadcast: boolean = true
  
  Transaction is broadcasted if set to 'true'. Default value is 'true'.
Returns Promise<Operation>

Value confirming successful transaction broadcasting.

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

dbApi: DatabaseApi

apiConnector: ApiConnector

chainApi: ChainApi

Returns MiningModule

Properties

Static CHAIN_PROXY_TO_SELF

Methods

createMiner

Parameters

minerAccountId: string

URL: string

signingPublicKey: string

privateKey: string

Default value broadcast: boolean = true

Returns Promise<Operation>

getMiner

Parameters

minerId: string

Returns Promise<Miner>

getVestingBalances

Parameters

accountId: string

Returns Promise<VestingBalance[]>

listMiners

Parameters

fromId: string

Default value limit: number = 100

Returns Promise<MinerNameIdPair[]>

setDesiredMinerCount

Parameters

accountId: string

desiredNumOfMiners: number

privateKey: string

Default value broadcast: boolean = true

Returns Promise<Operation>

setVotingProxy

Parameters

accountId: string

votingAccountId: string

privateKey: string

Default value broadcast: boolean = true

Returns Promise<Operation>

unvoteMiner

Parameters

miner: string

account: string

privateKeyWif: string

Default value broadcast: boolean = true

Returns Promise<Operation>

unvoteMiners

Parameters

miners: string[]

account: string

privateKeyWif: string

Default value broadcast: boolean = true

Returns Promise<Operation>

updateMiner

Parameters

minerId: string

minerAccountId: string

updateData: MinerUpdateData

privateKey: string

Default value broadcast: boolean = true

Returns Promise<Operation>

voteForMiner

Parameters

miner: string

account: string

privateKeyWif: string

Default value broadcast: boolean = true

Returns Promise<Operation>

voteForMiners