Connect WebSocket

connectWebSocket(apiKey, onMessage, onError?, onClose?)

Connects to Tachyon via WebSocket.

const socket = tachyon.connectWebSocket(
  apiKey,
  (msg) => console.log("Got message", msg),
  (err) => console.error("Socket error", err),
  () => console.log("Socket closed")
);

// later
socket.close();

Parameters:

• apiKey: User-specific API key for authentication
• onMessage Callback for incoming messages (WebsocketMessage)
• onError (optional): Callback on WebSocket error
• onClose (optional): Callback when WebSocket closes

WebsocketMessage Types:

• { type: "notification"; data: TxNotificationPayload }
• { type: "system"; data: SystemMessagePayload }
• { type: "raw"; data: any }

TxNotificationPayload Properties:

• txId: Transaction ID
• chainId: Chain ID
• status: PENDING | EXECUTED | FAILED | NEEDS_TO_BE_RETRIED
• costUSD: Execution cost
• totalNativeTokenUsed: Total native token spent
• gasPrice: Gas price used
• txHash: On-chain transaction hash
• submittedAt: ISO date string
• updatedAt: ISO date string
• retries: Number of retries

SystemMessagePayload Properties:

• message: System message string