diff options
Diffstat (limited to 'src/types/ReserveTransaction.ts')
-rw-r--r-- | src/types/ReserveTransaction.ts | 273 |
1 files changed, 273 insertions, 0 deletions
diff --git a/src/types/ReserveTransaction.ts b/src/types/ReserveTransaction.ts new file mode 100644 index 000000000..2ec859498 --- /dev/null +++ b/src/types/ReserveTransaction.ts @@ -0,0 +1,273 @@ +/* + This file is part of GNU Taler + (C) 2019 Taler Systems S.A. + + GNU Taler is free software; you can redistribute it and/or modify it under the + terms of the GNU General Public License as published by the Free Software + Foundation; either version 3, or (at your option) any later version. + + GNU Taler is distributed in the hope that it will be useful, but WITHOUT ANY + WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR + A PARTICULAR PURPOSE. See the GNU General Public License for more details. + + You should have received a copy of the GNU General Public License along with + GNU Taler; see the file COPYING. If not, see <http://www.gnu.org/licenses/> + */ + +/** + * @author Florian Dold <dold@taler.net> + */ + +/** + * Imports. + */ +import { + codecForString, + typecheckedCodec, + makeCodecForObject, + makeCodecForConstString, + makeCodecForUnion, +} from "../util/codec"; +import { runBlock } from "../util/helpers"; +import { + AmountString, + Base32String, + EddsaSignatureString, + TimestampString, + EddsaPublicKeyString, + CoinPublicKeyString, +} from "./talerTypes"; + +export const enum ReserveTransactionType { + Withdraw = "WITHDRAW", + Deposit = "DEPOSIT", + Payback = "PAYBACK", + Closing = "CLOSING", +} + +export interface ReserveWithdrawTransaction { + type: ReserveTransactionType.Withdraw; + + /** + * Amount withdrawn. + */ + amount: AmountString; + + /** + * Hash of the denomination public key of the coin. + */ + h_denom_pub: Base32String; + + /** + * Hash of the blinded coin to be signed + */ + h_coin_envelope: Base32String; + + /** + * Signature of 'TALER_WithdrawRequestPS' created with the reserves's + * private key. + */ + reserve_sig: EddsaSignatureString; + + /** + * Fee that is charged for withdraw. + */ + withdraw_fee: AmountString; +} + +export interface ReserveDepositTransaction { + type: ReserveTransactionType.Deposit; + + /** + * Amount withdrawn. + */ + amount: AmountString; + + /** + * Sender account payto://-URL + */ + sender_account_url: string; + + /** + * Transfer details uniquely identifying the transfer. + */ + wire_reference: string; + + /** + * Timestamp of the incoming wire transfer. + */ + timestamp: TimestampString; +} + +export interface ReserveClosingTransaction { + type: ReserveTransactionType.Closing; + + /** + * Closing balance. + */ + amount: AmountString; + + /** + * Closing fee charged by the exchange. + */ + closing_fee: AmountString; + + /** + * Wire transfer subject. + */ + wtid: string; + + /** + * Hash of the wire account into which the funds were returned to. + */ + h_wire: string; + + /** + * This is a signature over a + * struct TALER_ReserveCloseConfirmationPS with purpose + * TALER_SIGNATURE_EXCHANGE_RESERVE_CLOSED. + */ + exchange_sig: EddsaSignatureString; + + /** + * Public key used to create exchange_sig. + */ + exchange_pub: EddsaPublicKeyString; + + /** + * Time when the reserve was closed. + */ + timestamp: TimestampString; +} + +export interface ReservePaybackTransaction { + type: ReserveTransactionType.Payback; + + /** + * Amount paid back. + */ + amount: AmountString; + + /** + * Receiver account details. + */ + receiver_account_details: any; + + /** + * Wire transfer identifier. + */ + wire_transfer: any; + + /** + * This is a signature over + * a struct TALER_PaybackConfirmationPS with purpose + * TALER_SIGNATURE_EXCHANGE_CONFIRM_PAYBACK. + */ + exchange_sig: EddsaSignatureString; + + /** + * Public key used to create exchange_sig. + */ + exchange_pub: EddsaPublicKeyString; + + /** + * Time when the funds were paid back into the reserve. + */ + timestamp: TimestampString; + + /** + * Public key of the coin that was paid back. + */ + coin_pub: CoinPublicKeyString; +} + +/** + * Format of the exchange's transaction history for a reserve. + */ +export type ReserveTransaction = + | ReserveWithdrawTransaction + | ReserveDepositTransaction + | ReserveClosingTransaction + | ReservePaybackTransaction; + +export const codecForReserveWithdrawTransaction = runBlock(() => + typecheckedCodec<ReserveWithdrawTransaction>( + makeCodecForObject<ReserveWithdrawTransaction>() + .property("amount", codecForString) + .property("h_coin_envelope", codecForString) + .property("h_denom_pub", codecForString) + .property("reserve_sig", codecForString) + .property( + "type", + makeCodecForConstString(ReserveTransactionType.Withdraw), + ) + .property("withdraw_fee", codecForString) + .build("ReserveWithdrawTransaction"), + ), +); + +export const codecForReserveDepositTransaction = runBlock(() => + typecheckedCodec<ReserveDepositTransaction>( + makeCodecForObject<ReserveDepositTransaction>() + .property("amount", codecForString) + .property("sender_account_url", codecForString) + .property("timestamp", codecForString) + .property("wire_reference", codecForString) + .property("type", makeCodecForConstString(ReserveTransactionType.Deposit)) + .build("ReserveDepositTransaction"), + ), +); + +export const codecForReserveClosingTransaction = runBlock(() => + typecheckedCodec<ReserveClosingTransaction>( + makeCodecForObject<ReserveClosingTransaction>() + .property("amount", codecForString) + .property("closing_fee", codecForString) + .property("exchange_pub", codecForString) + .property("exchange_sig", codecForString) + .property("h_wire", codecForString) + .property("timestamp", codecForString) + .property("type", makeCodecForConstString(ReserveTransactionType.Closing)) + .property("wtid", codecForString) + .build("ReserveClosingTransaction"), + ), +); + +export const codecForReservePaybackTransaction = runBlock(() => + typecheckedCodec<ReservePaybackTransaction>( + makeCodecForObject<ReservePaybackTransaction>() + .property("amount", codecForString) + .property("coin_pub", codecForString) + .property("exchange_pub", codecForString) + .property("exchange_sig", codecForString) + .property("receiver_account_details", codecForString) + .property("timestamp", codecForString) + .property("type", makeCodecForConstString(ReserveTransactionType.Payback)) + .property("wire_transfer", codecForString) + .build("ReservePaybackTransaction"), + ), +); + +export const codecForReserveTransaction = runBlock(() => + typecheckedCodec<ReserveTransaction>( + makeCodecForUnion<ReserveTransaction>() + .discriminateOn("type") + .alternative( + ReserveTransactionType.Withdraw, + codecForReserveWithdrawTransaction, + ) + .alternative( + ReserveTransactionType.Closing, + codecForReserveClosingTransaction, + ) + .alternative( + ReserveTransactionType.Payback, + codecForReservePaybackTransaction, + ) + .alternative( + ReserveTransactionType.Deposit, + codecForReserveDepositTransaction, + ) + .build<ReserveTransaction>("ReserveTransaction"), + ), +); |