@drift-labs/sdk
Version:
SDK for Drift Protocol
175 lines (174 loc) • 8.57 kB
JavaScript
;
Object.defineProperty(exports, "__esModule", { value: true });
exports.TransactionConfirmationManager = void 0;
const config_1 = require("../config");
const types_1 = require("../tx/types");
const txConstants_1 = require("../constants/txConstants");
const reportTransactionError_1 = require("../tx/reportTransactionError");
const promiseTimeout_1 = require("./promiseTimeout");
const confirmationStatusValues = {
processed: 0,
confirmed: 1,
finalized: 2,
};
/**
* Class to await for transaction confirmations in an optimised manner. It tracks a shared list of all pending transactions and fetches them in bulk in a shared RPC request whenever they have an "overlapping" polling interval. E.g. tx1 with an interval of 200ms and tx2 with an interval of 300ms (if sent at the same time) will be fetched together at 600ms, 1200ms, 1800ms, etc.
*/
class TransactionConfirmationManager {
constructor(connection) {
this.pendingConfirmations = new Map();
this.intervalId = null;
this.connection = connection;
}
async confirmTransactionWebSocket(txSig, timeout = 30000, desiredConfirmationStatus = config_1.DEFAULT_CONFIRMATION_OPTS.commitment) {
const start = Date.now();
const subscriptionCommitment = desiredConfirmationStatus || config_1.DEFAULT_CONFIRMATION_OPTS.commitment;
let response = null;
let subscriptionId;
const confirmationPromise = new Promise((resolve, reject) => {
try {
subscriptionId = this.connection.onSignature(txSig, (result, context) => {
response = {
context,
value: result,
};
resolve(null);
}, subscriptionCommitment);
}
catch (err) {
reject(err);
}
});
// We do a one-shot confirmation check just in case the transaction is ALREADY confirmed when we create the websocket confirmation .. We want to run this concurrently with the onSignature subscription. If this returns true then we can return early as the transaction has already been confirmed.
const oneShotConfirmationPromise = this.connection.getSignatureStatuses([
txSig,
]);
const resolveReference = {};
// This is the promise we are waiting on to resolve the overall confirmation. It will resolve the faster of a positive oneShot confirmation, or the websocket confirmation, or the timeout.
const overallWaitingForConfirmationPromise = new Promise((resolve) => {
resolveReference.resolve = resolve;
});
// Await for the one shot confirmation and resolve the waiting promise if we get a positive confirmation result
oneShotConfirmationPromise.then(async (oneShotResponse) => {
var _a, _b;
if (!oneShotResponse || !((_a = oneShotResponse === null || oneShotResponse === void 0 ? void 0 : oneShotResponse.value) === null || _a === void 0 ? void 0 : _a[0]))
return;
const resultValue = oneShotResponse.value[0];
if (resultValue.err) {
await (0, reportTransactionError_1.throwTransactionError)(txSig, this.connection);
}
if (this.checkStatusMatchesDesiredConfirmationStatus(resultValue, desiredConfirmationStatus)) {
response = {
context: oneShotResponse.context,
value: oneShotResponse.value[0],
};
(_b = resolveReference.resolve) === null || _b === void 0 ? void 0 : _b.call(resolveReference);
}
}, (onRejected) => {
throw onRejected;
});
// Await for the websocket confirmation with the configured timeout
(0, promiseTimeout_1.promiseTimeout)(confirmationPromise, timeout).then(() => {
var _a;
(_a = resolveReference.resolve) === null || _a === void 0 ? void 0 : _a.call(resolveReference);
}, (onRejected) => {
throw onRejected;
});
try {
await overallWaitingForConfirmationPromise;
}
finally {
if (subscriptionId !== undefined) {
this.connection.removeSignatureListener(subscriptionId);
}
}
const duration = (Date.now() - start) / 1000;
if (response === null) {
throw new types_1.TxSendError(`Transaction was not confirmed in ${duration.toFixed(2)} seconds. It is unknown if it succeeded or failed. Check signature ${txSig} using the Solana Explorer or CLI tools.`, txConstants_1.NOT_CONFIRMED_ERROR_CODE);
}
return response;
}
async confirmTransactionPolling(txSig, desiredConfirmationStatus = config_1.DEFAULT_CONFIRMATION_OPTS.commitment, timeout = 30000, pollInterval = 1000, searchTransactionHistory = false) {
// Interval must be > 400ms and a multiple of 100ms
if (pollInterval < 400 || pollInterval % 100 !== 0) {
throw new Error('Transaction confirmation polling interval must be at least 400ms and a multiple of 100ms');
}
return new Promise((resolve, reject) => {
this.pendingConfirmations.set(txSig, {
txSig,
desiredConfirmationStatus,
timeout,
pollInterval,
searchTransactionHistory,
startTime: Date.now(),
resolve,
reject,
});
if (!this.intervalId) {
this.startConfirmationLoop();
}
});
}
startConfirmationLoop() {
this.intervalId = setInterval(() => this.checkPendingConfirmations(), 100);
}
async checkPendingConfirmations() {
const now = Date.now();
const transactionsToCheck = [];
for (const [txSig, request] of this.pendingConfirmations.entries()) {
if (now - request.startTime >= request.timeout) {
request.reject(new Error(`Transaction confirmation timeout after ${request.timeout}ms`));
this.pendingConfirmations.delete(txSig);
}
else if ((now - request.startTime) % request.pollInterval < 100) {
transactionsToCheck.push(request);
}
}
if (transactionsToCheck.length > 0) {
await this.checkTransactionStatuses(transactionsToCheck);
}
if (this.pendingConfirmations.size === 0 && this.intervalId) {
clearInterval(this.intervalId);
this.intervalId = null;
}
}
checkStatusMatchesDesiredConfirmationStatus(status, desiredConfirmationStatus) {
if (status.confirmationStatus &&
confirmationStatusValues[status.confirmationStatus] >=
confirmationStatusValues[desiredConfirmationStatus]) {
return true;
}
return false;
}
async checkTransactionStatuses(requests) {
const txSigs = requests.map((request) => request.txSig);
const { value: statuses } = await this.connection.getSignatureStatuses(txSigs, {
searchTransactionHistory: requests.some((req) => req.searchTransactionHistory),
});
if (!statuses || statuses.length !== txSigs.length) {
throw new Error('Failed to get signature statuses');
}
for (let i = 0; i < statuses.length; i++) {
const status = statuses[i];
const request = requests[i];
if (status === null) {
continue;
}
if (status.err) {
this.pendingConfirmations.delete(request.txSig);
request.reject(await (0, reportTransactionError_1.getTransactionErrorFromTxSig)(request.txSig, this.connection));
continue;
}
if (confirmationStatusValues[status.confirmationStatus] === undefined ||
confirmationStatusValues[request.desiredConfirmationStatus] ===
undefined) {
throw new Error(`Invalid confirmation status when awaiting confirmation: ${status.confirmationStatus}`);
}
if (this.checkStatusMatchesDesiredConfirmationStatus(status, request.desiredConfirmationStatus)) {
request.resolve(status);
this.pendingConfirmations.delete(request.txSig);
}
}
}
}
exports.TransactionConfirmationManager = TransactionConfirmationManager;