Client

@buff-beacon-project/curby-client • Docs

---

@buff-beacon-project/curby-client / Client

Class: Client

A client for fetching randomness from the CURBy RNG chain

Example

import { Client } from '@buff-beacon-project/curby-client'

const client = Client.create()
const randomness = await client.randomness()
console.log(randomness)

Constructors

new Client()

new Client(options?): Client

Parameters

Parameter	Type	Description
options?	ClientOptions	The options for the client

Returns

Client

Defined in

src/client.ts:112

Methods

fetchPulsePair()

fetchPulsePair(indexOrCid?): Promise<PulsePair>

Fetch the a pulse and its predecessor by index or CID

Parameters

Parameter	Type
indexOrCid?	number | IntoCid

Returns

Promise<PulsePair>

Defined in

src/client.ts:121

---

latest()

latest(): Promise<undefined | RandomnessRound>

Get the latest round data

Returns

Promise<undefined | RandomnessRound>

Defined in

src/client.ts:191

---

pair()

pair(): Promise<LatestPulsePair>

Get the latest and previous pulse

Returns

Promise<LatestPulsePair>

Defined in

src/client.ts:207

---

prev()

prev(): Promise<undefined | null | Pulse>

Get the previous pulse

Returns

Promise<undefined | null | Pulse>

Defined in

src/client.ts:199

---

randomness()

randomness(round?): Promise<null | ByteHelper>

Get the latest randomness or the randomness for a specific round

Parameters

Parameter	Type
round?	number

Returns

Promise<null | ByteHelper>

Defined in

src/client.ts:166

---

refresh()

refresh(): Promise<undefined | RandomnessRound>

Refresh the internal state of the client

Returns

Promise<undefined | RandomnessRound>

Defined in

src/client.ts:144

---

waitForNext()

waitForNext(__namedParameters): Promise<undefined | RandomnessRound>

Wait for the next pulse

Parameters

Parameter	Type
__namedParameters	WaitOptions

Returns

Promise<undefined | RandomnessRound>

Defined in

src/client.ts:218

---

watch()

watch(options?): AsyncGenerator<undefined | RandomnessRound, void, unknown>

Poll for the latest randomness

Parameters

Parameter	Type	Description
options?	WaitOptions	The options for waiting

Returns

AsyncGenerator<undefined | RandomnessRound, void, unknown>

Example

const client = Client.create()
for await (const round of client.watch()){
  console.log(round.randomness)
}

Defined in

src/client.ts:255

---

create()

static create(options?): Client

Create a new client

Parameters

Parameter	Type	Description
options?	ClientOptions	The options for the client

Returns

Client

Defined in

src/client.ts:105