getCoopExitRequest

Gets a cooperative exit request by ID for the SparkWallet.

Method Signature

async getCoopExitRequest(id: string): Promise<CoopExitRequest | null>

Parameters

string

required

The withdrawal request ID returned by withdraw(). Not the on-chain transaction ID.Format: SparkCoopExitRequest:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Returns

CoopExitRequest | null

required

The cooperative exit request details or null if not found

The transfer field can be absent while a withdrawal is progressing. Poll the request and check for the field before reading transfer details.

Example

// Use the ID returned from withdraw(), not the on-chain txid
const exitRequest = await wallet.getCoopExitRequest(withdrawal.id);
if (exitRequest) {
  console.log("Status:", exitRequest.status);
  console.log("On-chain txid:", exitRequest.coopExitTxid);
}

Introduction

Wallets

Wallet Viewer

Utilities

Issuance

getCoopExitRequest

Method Signature

Parameters

Returns

Example

​Method Signature

​Parameters

​Returns

​Example

Method Signature

Parameters

Returns

Example