Skip to content
This repository was archived by the owner on Jun 7, 2025. It is now read-only.

Latest commit

 

History

History
295 lines (201 loc) · 3.87 KB

File metadata and controls

295 lines (201 loc) · 3.87 KB

WebSocket Methods

start()

Start the WebSocket.


WebSocket Events

payment_statusEvent

Get payment_status.

refreshEvent

Refresh.

rewardEvent

Reward.

total_paidEvent

Get the total paid by the pool in BTC.

total_workersEvent

Get the total of workers on the pool.

workerEvent

Get worker stats.

etchash_last_rewardEvent

Get last reward on Etchash.

ethash_last_rewardEvent

Get last reward on Ethash.

randomx_last_rewardEvent

Get last reward on RandomX.

x16rv2_last_rewardEvent

Get last reward on KawPow.

autolykos_last_rewardEvent

Get last reward on Autolykos.


WebSocket Methods

start(uuid)

Start the WebSocket.

Kind: method

Param Type
uuid String

Example

start("0cc5691e-cedb-11eb-b8bc-0242ac130003");

WebSocket Events

payment_status ⇒ Event

Get payment_status.

Kind: event

Returns:

{
    Object,
}

Example

client.on("payment_status");

refresh ⇒ Event

Refresh.

Kind: event

Returns:

{
    Object,
}

Example

client.on("refresh");

reward ⇒ Event

Get reward.

Kind: event

Returns:

{
    Object,
}

Example

client.on("reward");

total_paid ⇒ Event

Get the total paid by the pool in BTC.

Kind: event

Returns:

{
    total: Number,
}

Example

client.on("total_paid");

total_workers ⇒ Event

Get the total of workers on the pool.

Kind: event

Returns:

{
    total: Number,
}

Example

client.on("total_workers");

worker ⇒ Event

Get worker stats.

Kind: event

Returns:

{
    name: String,
    reportedHashrate: Number,
    calculatedHashrate: Number,
    lastShareAt: Number,
    online: Boolean,
}

Example

client.on("worker");

etchash_last_reward ⇒ Event

Get last reward on Etchash.

Kind: event

Returns:

{
    timestamp: Number,
}

Example

client.on("etchash_last_reward");

ethash_last_reward ⇒ Event

Get last reward on Ethash.

Kind: event

Returns:

{
    timestamp: Number,
}

Example

client.on("ethash_last_reward");

randomx_last_reward ⇒ Event

Get last reward on RandomX.

Kind: event

Returns:

{
    timestamp: Number,
}

Example

client.on("randomx_last_reward");

x16rv2_last_reward ⇒ Event

Get last reward on KawPow.

Kind: event

Returns:

{
    timestamp: Number,
}

Example

client.on("x16rv2_last_reward");