​

Class: BuckspayClient

Defined in: packages/core/src/client.ts:50

​

Constructors

​

Constructor

new BuckspayClient(config, sim?, opts?): BuckspayClient

Defined in: packages/core/src/client.ts:58

​

Parameters

config

BuckspayConfig

sim?

AccountSimContext

opts?

now?

() => number

​

Returns

BuckspayClient

​

Methods

​

connect()

connect(): Promise<BuckspayWallet>

Defined in: packages/core/src/client.ts:73

​

Returns

Promise<BuckspayWallet>

---

​

getAccountState()

getAccountState(address?): Promise<AccountState>

Defined in: packages/core/src/client.ts:85

​

Parameters

address?

string

​

Returns

Promise<AccountState>

---

​

grantSession()

grantSession(grant): Promise<{ receipt: Receipt; session: Session; }>

Defined in: packages/core/src/client.ts:341 Grant a policy-scoped session key (contract account model only; throws INVALID_CONFIG on classic). The root signer authorizes the install once; thereafter the session key transacts within its on-chain policies (spend limit + allowlist) without per-action root prompts.

​

Parameters

grant

SessionGrant

​

Returns

Promise<{ receipt: Receipt; session: Session; }>

---

​

pay()

pay(calls): Promise<Receipt>

Defined in: packages/core/src/client.ts:262

​

Parameters

calls

Call[]

​

Returns

Promise<Receipt>

---

​

prepare()

prepare(calls): Promise<PreparedIntent>

Defined in: packages/core/src/client.ts:109

​

Parameters

calls

Call[]

​

Returns

Promise<PreparedIntent>

---

​

quoteSwap()

quoteSwap(opts): Promise<SwapQuote>

Defined in: packages/core/src/client.ts:269 STRETCH: quote a gasless swap via the relayer’s /swap/* rail. README §4.9.

​

Parameters

opts

amount

string | bigint

tokenIn

string

tokenOut

string

​

Returns

Promise<SwapQuote>

---

​

revokeSession()

revokeSession(session): Promise<Receipt>

Defined in: packages/core/src/client.ts:347 Revoke a granted session by its object or id (contract account model only). Takes effect immediately on-chain - the session key no longer authorizes anything.

​

Parameters

session

string | Session

​

Returns

Promise<Receipt>

---

​

send()

send(signed): Promise<Receipt>

Defined in: packages/core/src/client.ts:251

​

Parameters

signed

SignedIntent

​

Returns

Promise<Receipt>

---

​

sendCalls()

sendCalls(calls): Promise<Receipt>

Defined in: packages/core/src/client.ts:354 EIP-5792-style alias of pay(calls): submit an atomic, all-or-nothing batch. Enforces the MAX_BATCH_CALLS ceiling up front so an over-cap batch fails before any simulation or signing. A single call behaves exactly like pay([call]).

​

Parameters

calls

Call[]

​

Returns

Promise<Receipt>

---

​

sign()

sign(intent): Promise<SignedIntent>

Defined in: packages/core/src/client.ts:217

​

Parameters

intent

PreparedIntent

​

Returns

Promise<SignedIntent>

---

​

swap()

swap(opts): Promise<Receipt>

Defined in: packages/core/src/client.ts:287 STRETCH: execute a gasless swap. Enforces the minOut floor BEFORE submit. README §4.9.

​

Parameters

opts

amount

string | bigint

minOut?

string

tokenIn

string

tokenOut

string

​

Returns

Promise<Receipt>

---

​

transfer()

transfer(opts): Call

Defined in: packages/core/src/client.ts:93

​

Parameters

opts

amount

string | bigint

to

string

token

string

​

Returns

Call