diff options
author | Florian Dold <florian.dold@gmail.com> | 2017-05-28 16:27:34 +0200 |
---|---|---|
committer | Florian Dold <florian.dold@gmail.com> | 2017-05-28 21:55:16 +0200 |
commit | e7fa87bcc0052e1e99c6894e7e27a122374956b3 (patch) | |
tree | 56c243d08ae357533ebdb4fbf41211aa0fc914ce /src/wxApi.ts | |
parent | 08bd3dc0e8a3c2370e4e8abbaa241eaafc144f4c (diff) | |
download | wallet-core-e7fa87bcc0052e1e99c6894e7e27a122374956b3.tar.xz |
documentation and tslint settings to check for docs
Diffstat (limited to 'src/wxApi.ts')
-rw-r--r-- | src/wxApi.ts | 70 |
1 files changed, 65 insertions, 5 deletions
diff --git a/src/wxApi.ts b/src/wxApi.ts index 1f7d08fb3..8a95e75f5 100644 --- a/src/wxApi.ts +++ b/src/wxApi.ts @@ -14,6 +14,14 @@ TALER; see the file COPYING. If not, see <http://www.gnu.org/licenses/> */ +/** + * Interface to the wallet through WebExtension messaging. + */ + + +/** + * Imports. + */ import { AmountJson, CoinRecord, @@ -25,12 +33,11 @@ import { ReserveRecord, } from "./types"; + /** - * Interface to the wallet through WebExtension messaging. - * @author Florian Dold + * Query the wallet for the coins that would be used to withdraw + * from a given reserve. */ - - export function getReserveCreationInfo(baseUrl: string, amount: AmountJson): Promise<ReserveCreationInfo> { const m = { type: "reserve-creation-info", detail: { baseUrl, amount } }; @@ -48,7 +55,8 @@ export function getReserveCreationInfo(baseUrl: string, }); } -export async function callBackend(type: string, detail?: any): Promise<any> { + +async function callBackend(type: string, detail?: any): Promise<any> { return new Promise<any>((resolve, reject) => { chrome.runtime.sendMessage({ type, detail }, (resp) => { if (resp && resp.error) { @@ -60,55 +68,107 @@ export async function callBackend(type: string, detail?: any): Promise<any> { }); } + +/** + * Get all exchanges the wallet knows about. + */ export async function getExchanges(): Promise<ExchangeRecord[]> { return await callBackend("get-exchanges"); } + +/** + * Get all currencies the exchange knows about. + */ export async function getCurrencies(): Promise<CurrencyRecord[]> { return await callBackend("get-currencies"); } +/** + * Get information about a specific currency. + */ export async function getCurrency(name: string): Promise<CurrencyRecord|null> { return await callBackend("currency-info", {name}); } + +/** + * Get information about a specific exchange. + */ export async function getExchangeInfo(baseUrl: string): Promise<ExchangeRecord> { return await callBackend("exchange-info", {baseUrl}); } + +/** + * Replace an existing currency record with the one given. The currency to + * replace is specified inside the currency record. + */ export async function updateCurrency(currencyRecord: CurrencyRecord): Promise<void> { return await callBackend("update-currency", { currencyRecord }); } + +/** + * Get all reserves the wallet has at an exchange. + */ export async function getReserves(exchangeBaseUrl: string): Promise<ReserveRecord[]> { return await callBackend("get-reserves", { exchangeBaseUrl }); } + +/** + * Get all reserves for which a payback is available. + */ export async function getPaybackReserves(): Promise<ReserveRecord[]> { return await callBackend("get-payback-reserves"); } + +/** + * Withdraw the payback that is available for a reserve. + */ export async function withdrawPaybackReserve(reservePub: string): Promise<ReserveRecord[]> { return await callBackend("withdraw-payback-reserve", { reservePub }); } + +/** + * Get all coins withdrawn from the given exchange. + */ export async function getCoins(exchangeBaseUrl: string): Promise<CoinRecord[]> { return await callBackend("get-coins", { exchangeBaseUrl }); } + +/** + * Get all precoins withdrawn from the given exchange. + */ export async function getPreCoins(exchangeBaseUrl: string): Promise<PreCoinRecord[]> { return await callBackend("get-precoins", { exchangeBaseUrl }); } + +/** + * Get all denoms offered by the given exchange. + */ export async function getDenoms(exchangeBaseUrl: string): Promise<DenominationRecord[]> { return await callBackend("get-denoms", { exchangeBaseUrl }); } + +/** + * Start refreshing a coin. + */ export async function refresh(coinPub: string): Promise<void> { return await callBackend("refresh-coin", { coinPub }); } + +/** + * Request payback for a coin. Only works for non-refreshed coins. + */ export async function payback(coinPub: string): Promise<void> { return await callBackend("payback-coin", { coinPub }); } |