​

Interface: Relayer

Defined in: packages/core/src/types.ts:171

​

Methods

​

buildOnboard()

buildOnboard(input): Promise<{ xdr: string; }>

Defined in: packages/core/src/types.ts:178

​

Parameters

input

publicKey

string

​

Returns

Promise<{ xdr: string; }>

---

​

deployContract()

deployContract(input): Promise<{ address: string; }>

Defined in: packages/core/src/types.ts:180

​

Parameters

input

passkeyPublicKey

string

​

Returns

Promise<{ address: string; }>

---

​

deploySessionAccount()?

optional deploySessionAccount(input): Promise<{ address: string; }>

Defined in: packages/core/src/types.ts:184 Deploy a policy-scoped session account bound to an ed25519 root key. OPTIONAL: a relayer that does not support session accounts omits it; the policy-account adapter then refuses to deploy with INVALID_CONFIG. POST /stellar/session-account/deploy

​

Parameters

input

rootPublicKey

string

​

Returns

Promise<{ address: string; }>

---

​

feeQuote()?

optional feeQuote(input): Promise<FeeQuote>

Defined in: packages/core/src/types.ts:176 Quote the fee-token amount + forwarder/collector for paying Soroban gas in token (gas mode “token”). OPTIONAL: a relayer that does not support gas-in-token omits it; prepare() then refuses token mode with INVALID_CONFIG. Keeping it optional makes adding token gas additive (non-breaking). POST /fee/quote

​

Parameters

input

calls

Call[]

from

string

token

string

​

Returns

Promise<FeeQuote>

---

​

getAccountState()

getAccountState(address): Promise<AccountState>

Defined in: packages/core/src/types.ts:177

​

Parameters

address

string

​

Returns

Promise<AccountState>

---

​

quoteSwap()?

optional quoteSwap(req): Promise<SwapQuote>

Defined in: packages/core/src/types.ts:188 STRETCH: gasless swap via the facilitator’s EXISTING /swap/* rail. OPTIONAL - a relayer without swap support (no swapChain) omits these; BuckspayClient.swap then fails closed with SWAP_FAILED.

​

Parameters

req

SwapQuoteRequest

​

Returns

Promise<SwapQuote>

---

​

relay()

relay(payload): Promise<Receipt>

Defined in: packages/core/src/types.ts:172

​

Parameters

payload

RelayPayload

​

Returns

Promise<Receipt>

---

​

submitOnboard()

submitOnboard(input): Promise<{ ok: boolean; }>

Defined in: packages/core/src/types.ts:179

​

Parameters

input

publicKey

string

signedTxXdr

string

​

Returns

Promise<{ ok: boolean; }>

---

​

swap()?

optional swap(req): Promise<Receipt>

Defined in: packages/core/src/types.ts:189

​

Parameters

req

SwapRequest

​

Returns

Promise<Receipt>