TxAdapter<T>
TxAdapter<
T> =Pick<BaseAdapter,"getExplorerUrl"> &object
Defined in: packages/pulsar-core/src/types.ts:265
Defines the interface for a transaction adapter, which provides chain-specific logic and utilities.
Type Declaration
cancelTxAction?
optionalcancelTxAction?: (tx) =>Promise<string>
Optional: Logic to cancel a pending EVM transaction.
Parameters
tx
T
The transaction to cancel.
Returns
Promise<string>
The new transaction hash for the cancellation.
checkAndInitializeTrackerInStore
checkAndInitializeTrackerInStore: (
params) =>Promise<void> |void
Selects and initializes the correct background tracker for a given transaction.
Parameters
params
object & TrackerCallbacks<T> & Pick<ITxTrackingStore<T>, "updateTxParams" | "removeTxFromPool" | "transactionsPool">
The parameters for initializing the tracker, including the transaction and store callbacks.
Returns
Promise<void> | void
checkChainForTx
checkChainForTx: (
chainId) =>Promise<void>
Ensures the connected wallet is on the correct network for the transaction.
This method should throw an error if the chain is mismatched.
Parameters
chainId
string | number
The desired chain ID for the transaction.
Returns
Promise<void>
checkTransactionsTracker
checkTransactionsTracker: (
{ actionTxKey, connectorType, tracker }) =>object
Determines the appropriate tracker and final txKey from the result of an action.
Parameters
{ actionTxKey, connectorType, tracker }
Returns
object
An object containing the final txKey and the TransactionTracker to be used.
tracker
tracker:
TransactionTracker
txKey
txKey:
string
getConnectorInfo
getConnectorInfo: () =>
object
Returns information about the currently connected connector.
Returns
connectorType
connectorType:
string
The type of the connector (e.g., ‘metamask’, ‘phantom’).
walletAddress
walletAddress:
string
The currently connected wallet address.
getExplorerTxUrl?
optionalgetExplorerTxUrl?: (tx) =>string
Optional: Constructs a full explorer URL for a specific transaction. May require the full transaction pool to resolve details for replaced transactions.
Parameters
tx
T
The transaction object.
Returns
string
The full URL to the transaction on the explorer.
key
key:
OrbitAdapter
The unique key identifying this adapter.
retryTxAction?
optionalretryTxAction?: (params) =>Promise<void>
Optional: Logic to retry a failed transaction.
Parameters
params
object & Partial<Pick<ITxTrackingStore<T>, "executeTxAction">>
The parameters for retrying the transaction.
Returns
Promise<void>
speedUpTxAction?
optionalspeedUpTxAction?: (tx) =>Promise<string>
Optional: Logic to speed up a pending EVM transaction.
Parameters
tx
T
The transaction to speed up.
Returns
Promise<string>
The new transaction hash for the sped-up transaction.
Type Parameters
T
T extends Transaction
The specific transaction type, extending Transaction.