Class: BoopClient

Defined in: packages/boop-sdk/lib/client.ts:26

Constructors

Constructor

new BoopClient(config?: Partial<BoopClientConfig>): BoopClient;

Defined in: packages/boop-sdk/lib/client.ts:28

Parameters

config?

Partial<BoopClientConfig>

Returns

BoopClient

Methods

createAccount()

createAccount(data: CreateAccountInput): Promise<Result<CreateAccountOutput, Error>>;

Defined in: packages/boop-sdk/lib/client.ts:46

Create a new HappyAccount. If the account already exists, it will be returned.

Parameters

data

CreateAccountInput

User Creation Options

Returns

Promise<Result<CreateAccountOutput, Error>>

execute()

execute(data: ExecuteInput): Promise<Result<ExecuteOutput, Error>>;

Defined in: packages/boop-sdk/lib/client.ts:72

Submits a Boop to the network

Parameters

data

ExecuteInput

Returns

Promise<Result<ExecuteOutput, Error>>

receipt

pending()

pending(data: PendingBoopInput): Promise<Result<PendingBoopOutput, Error>>;

Defined in: packages/boop-sdk/lib/client.ts:112

Get the pending Boops of an account

Parameters

data

PendingBoopInput

Returns

Promise<Result<PendingBoopOutput, Error>>

receipt()

receipt(data: ReceiptRequestInput): Promise<Result<StateRequestOutput, Error>>;

Defined in: packages/boop-sdk/lib/client.ts:102

Get the receipt of a Boop, waiting if needed

Parameters

data

ReceiptRequestInput

Returns

Promise<Result<StateRequestOutput, Error>>

simulate()

simulate(data: SimulationInput): Promise<Result<SimulationOutput, Error>>;

Defined in: packages/boop-sdk/lib/client.ts:82

Estimates the gas for a Boop

Parameters

data

SimulationInput

Returns

Promise<Result<SimulationOutput, Error>>

state()

state(data: StateRequestInput): Promise<Result<StateRequestOutput, Error>>;

Defined in: packages/boop-sdk/lib/client.ts:92

Get the receipt of a Boop

Parameters

data

StateRequestInput

Returns

Promise<Result<StateRequestOutput, Error>>

submit()

submit(data: SubmitInput): Promise<Result<SubmitOutput, Error>>;

Defined in: packages/boop-sdk/lib/client.ts:60

Submits a Boop to the network

Parameters

data

SubmitInput

Returns

Promise<Result<SubmitOutput, Error>>

transaction hash