syntax = "proto3";
package common.fx.v1;
option go_package = "github.com/tech/sendico/pkg/proto/common/fx/v1;fxv1";

// CurrencyPair identifies a foreign-exchange pair (e.g. EUR/USD).
message CurrencyPair {
  // base is the base currency code (ISO 4217).
  string base  = 1;
  // quote is the quote (counter) currency code (ISO 4217).
  string quote = 2;
}

// Side indicates the direction of an FX conversion relative to the pair.
enum Side {
  // SIDE_UNSPECIFIED is the default zero value.
  SIDE_UNSPECIFIED        = 0;
  // BUY_BASE_SELL_QUOTE buys the base currency, selling the quote currency.
  BUY_BASE_SELL_QUOTE     = 1;
  // SELL_BASE_BUY_QUOTE sells the base currency, buying the quote currency.
  SELL_BASE_BUY_QUOTE     = 2;
}
