DelegatesAPI | dpos-api-wrapper

Hierarchy

DelegatesAPI

Index

Methods

Methods

enable

enable(data: object, callback?: cback<Transaction<object>>): Promise<Transaction<object> | BaseApiResponse>

- Defined in types/apis/DelegatesAPI.ts:5
Parameters
- data: object
  - Optional secondSecret?: string
  - secret: string
  - username: string
- Optional callback: cback<Transaction<object>>
Returns Promise<Transaction<object> | BaseApiResponse>

getByKeyVal

getByKeyVal(key: "publicKey" | "username", value: string, callback?: cback<object>): Promise<object | BaseApiResponse>

- Defined in types/apis/DelegatesAPI.ts:13
Parameters
- key: "publicKey" | "username"
- value: string
- Optional callback: cback<object>
Returns Promise<object | BaseApiResponse>

getByPublicKey

getByPublicKey(publicKey: string, callback?: cback<object>): Promise<object | BaseApiResponse>

- Defined in types/apis/DelegatesAPI.ts:11
Parameters
- publicKey: string
- Optional callback: cback<object>
Returns Promise<object | BaseApiResponse>

getByUsername

getByUsername(username: string, callback?: cback<object>): Promise<object | BaseApiResponse>

- Defined in types/apis/DelegatesAPI.ts:9
Parameters
- username: string
- Optional callback: cback<object>
Returns Promise<object | BaseApiResponse>

getForgedByAccount

getForgedByAccount(param: string | object, callback?: cback<object>): Promise<object | BaseApiResponse>

- Defined in types/apis/DelegatesAPI.ts:24
Return the forged amount by account

Parameters
- param: string | object
  
  if string is passed it's threated as publicKey
- Optional callback: cback<object>
  
  callback to get the result
Returns Promise<object | BaseApiResponse>

getForgingStatus

getForgingStatus(callback?: cback<object>): Promise<object | BaseApiResponse>
getForgingStatus(publicKey?: string, callback?: cback<object>): Promise<object | BaseApiResponse>

- Defined in types/apis/DelegatesAPI.ts:26
Parameters
- Optional callback: cback<object>
Returns Promise<object | BaseApiResponse>
- Defined in types/apis/DelegatesAPI.ts:28
Parameters
- Optional publicKey: string
- Optional callback: cback<object>
Returns Promise<object | BaseApiResponse>

getList

getList(query?: object, callback?: cback<object>): Promise<object | BaseApiResponse>

- Defined in types/apis/DelegatesAPI.ts:7
Parameters
- Optional query: object
  - Optional limit?: number
  - Optional offset?: number
  - Optional orderBy?: string
- Optional callback: cback<object>
Returns Promise<object | BaseApiResponse>

getNextForgers

getNextForgers(limit: number, callback?: cback<object>): Promise<object | BaseApiResponse>

- Defined in types/apis/DelegatesAPI.ts:30
Parameters
- limit: number
- Optional callback: cback<object>
Returns Promise<object | BaseApiResponse>

getVoters

getVoters(publicKey: string, callback?: cback<object>): Promise<object | BaseApiResponse>

- Defined in types/apis/DelegatesAPI.ts:15
Parameters
- publicKey: string
- Optional callback: cback<object>
Returns Promise<object | BaseApiResponse>

toggleForging

toggleForging(obj: object, callback?: cback<object>): Promise<object | BaseApiResponse>

- Defined in types/apis/DelegatesAPI.ts:17
Parameters
- obj: object
  - enable: boolean
  - secret: string
- Optional callback: cback<object>
Returns Promise<object | BaseApiResponse>