FiatProtocol
Defined in: protocols/fiat.ts:68
Base class for fiat on/off-ramp modules.
Extends
Section titled “Extends”ProtocolBase<TConfig>
Type Parameters
Section titled “Type Parameters”TConfig
Section titled “TConfig”TConfig extends object = Record<string, never>
Implements
Section titled “Implements”Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new FiatProtocol<
TConfig>(account,config?):FiatProtocol<TConfig>
Defined in: protocols/fiat.ts:72
Parameters
Section titled “Parameters”account
Section titled “account”IWalletAccountReadOnly | IWalletAccount
config?
Section titled “config?”TConfig = ...
Returns
Section titled “Returns”FiatProtocol<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”buy(
_o):Promise<BuyResult>
Defined in: protocols/fiat.ts:76
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<BuyResult>
Implementation of
Section titled “Implementation of”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”getSupportedCountries()
Section titled “getSupportedCountries()”getSupportedCountries():
Promise<SupportedCountry[]>
Defined in: protocols/fiat.ts:82
Returns
Section titled “Returns”Promise<SupportedCountry[]>
Implementation of
Section titled “Implementation of”IFiatProtocol.getSupportedCountries
getSupportedCryptoAssets()
Section titled “getSupportedCryptoAssets()”getSupportedCryptoAssets():
Promise<SupportedCryptoAsset[]>
Defined in: protocols/fiat.ts:80
Returns
Section titled “Returns”Promise<SupportedCryptoAsset[]>
Implementation of
Section titled “Implementation of”IFiatProtocol.getSupportedCryptoAssets
getSupportedFiatCurrencies()
Section titled “getSupportedFiatCurrencies()”getSupportedFiatCurrencies():
Promise<SupportedFiatCurrency[]>
Defined in: protocols/fiat.ts:81
Returns
Section titled “Returns”Promise<SupportedFiatCurrency[]>
Implementation of
Section titled “Implementation of”IFiatProtocol.getSupportedFiatCurrencies
getTransactionDetail()
Section titled “getTransactionDetail()”getTransactionDetail(
_id):Promise<FiatTransactionDetail>
Defined in: protocols/fiat.ts:79
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”Promise<FiatTransactionDetail>
Implementation of
Section titled “Implementation of”IFiatProtocol.getTransactionDetail
quoteBuy()
Section titled “quoteBuy()”quoteBuy(
_o):Promise<FiatQuote>
Defined in: protocols/fiat.ts:75
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FiatQuote>
Implementation of
Section titled “Implementation of”quoteSell()
Section titled “quoteSell()”quoteSell(
_o):Promise<FiatQuote>
Defined in: protocols/fiat.ts:77
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<FiatQuote>
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
sell()
Section titled “sell()”sell(
_o):Promise<SellResult>
Defined in: protocols/fiat.ts:78
Parameters
Section titled “Parameters”Returns
Section titled “Returns”Promise<SellResult>