SwapProtocol
Defined in: protocols/swap.ts:52
Base class for swap-only modules.
Extends
Section titled “Extends”ProtocolBase<TConfig>
Type Parameters
Section titled “Type Parameters”TConfig
Section titled “TConfig”TConfig extends SwapProtocolConfig = SwapProtocolConfig
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new SwapProtocol<
TConfig>(account,config?):SwapProtocol<TConfig>
Defined in: protocols/swap.ts:56
Parameters
Section titled “Parameters”account
Section titled “account”IWalletAccountReadOnly | IWalletAccount
config?
Section titled “config?”TConfig = ...
Returns
Section titled “Returns”SwapProtocol<TConfig>
Overrides
Section titled “Overrides”Properties
Section titled “Properties”_account
Section titled “_account”
protectedreadonly_account:IWalletAccountReadOnly|IWalletAccount
Defined in: protocols/base.ts:8
Inherited from
Section titled “Inherited from”_config
Section titled “_config”
protectedreadonly_config:TConfig
Defined in: protocols/base.ts:9
Inherited from
Section titled “Inherited from”Methods
Section titled “Methods”describeActivity()
Section titled “describeActivity()”describeActivity(
_tx,_ctx):ActivityItem|null
Defined in: protocols/base.ts:24
Recognize one of this protocol’s own transactions in an address’s history and
describe it for the wallet’s activity feed (“Supplied 100 USDC · Aave v3”).
Return null when the transaction is not this protocol’s: the kit then asks the
next module and finally falls back to send / receive / approve / contract call.
Must be pure and synchronous: no network, no account state. The conformance
suite feeds every module its recorded fixtures through this method.
Parameters
Section titled “Parameters”Returns
Section titled “Returns”ActivityItem | null
Inherited from
Section titled “Inherited from”quoteSwap()
Section titled “quoteSwap()”quoteSwap(
_options):Promise<SwapQuote>
Defined in: protocols/swap.ts:60
Price a same-chain swap; nothing is signed.
Parameters
Section titled “Parameters”_options
Section titled “_options”Returns
Section titled “Returns”Promise<SwapQuote>
Implementation of
Section titled “Implementation of”requireSigningAccount()
Section titled “requireSigningAccount()”
protectedrequireSigningAccount(methodName):IWalletAccount
Defined in: protocols/base.ts:29
The account, narrowed to a signing one, or a ReadOnlyAccountError naming the caller.
Parameters
Section titled “Parameters”methodName
Section titled “methodName”string
Returns
Section titled “Returns”Inherited from
Section titled “Inherited from”ProtocolBase.requireSigningAccount
swap()
Section titled “swap()”swap(
_options):Promise<SwapResult>
Defined in: protocols/swap.ts:59
Sign and broadcast a same-chain swap.
Parameters
Section titled “Parameters”_options
Section titled “_options”Returns
Section titled “Returns”Promise<SwapResult>