Categorygithub.com/cryptometrics/cqlscalar
package
0.0.0-20220114054724-f501dc898939
Repository: https://github.com/cryptometrics/cql.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
0
Dependents
5
Files
170 SLOC

# README

Scalar

The scalar package holds constant data in the style of enums, though most primarily indexed as strings rather than integers. It inherits the name "scalar" from the graphql resource for replacing types. This helps the client/user understand the limitation of certain requests. For example, the coinbase http request for creating a new order requires a "side" body param. At the time of this README, "side" is not defined in their docs. The scalar package removes this ambiguity completely, to create an order request using the coinbase SDK you must use the model.CoinbaseNewOrderOptions struct, which types the Side field as scalar.OderSide which only has two defined constants: OrderSideBuy and OrderSideSell.

TL;DR package removes the ambiguity from questionable body/query parameters in http requests.

# Constants

No description provided by the author
No description provided by the author
No description provided by the author
EntryTypeConversion are funds converted between fiat currency and a stablecoin.
EntryTypeFee is a fee as a result of a trade.
EntryTypeMatch are funds moved as a result of a trade.
EntryTypeRebate is a fee rebate as per our fee schedule.
EntryTypeTransfer are funds moved to/from Coinbase to Coinbase Exchange.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
OrderSTP_CB = cancel boath.
OrderSTP_CN = cancel newest.
OrderSTP_CO = cancel oldest.
OrderSTP_DC = decrease and cancel, default.
No description provided by the author
No description provided by the author
PaymentMethodACHBankAccount is the PM for a regular US bank account.
PaymentMethodBankWire is the PM for a bank wire (US only).
PaymentMethodCreditCard is the PM for a credit card (can’t be used for buying/selling).
PaymentMethodCreditCard is the PM for cryptocurrency transactions.
PaymentMethodEFTBankAccount is the PM for a Canadian EFT bank account.
No description provided by the author
PaymentMethodFiatAccount is the PM for a fiat nominated Coinbase account.
PaymentMethodiDealBankAccount is the PM for a iDeal bank account (Europe).
PaymentMethodInterac is the PM for an Interac Online for Canadian bank accounts.
No description provided by the author
PaymentMethodSecure3D is the PM for a Secure3D verified payment card.
PaymentMethodSEPABankAccount is the PM for a European SEPA bank account.
No description provided by the author
Resting (open) orders can be cancelled but no new orders may be submitted.
The exchange is offline.
Kraken is operating normally.
Only post-only limit orders can be submitted.
FOK Fill or kill orders are rejected if the entire size cannot be matched.
GTC Good till canceled orders remain open on the book until canceled.
GTT Good till time orders remain open on the book until canceled or the allotted cancel_after is depleted on the matching engine.
IOC Immediate or cancel orders instantly cancel the remaining size of the limit order instead of opening it on the book.
No description provided by the author
No description provided by the author

# Type aliases

CancelAfter is the timeframe in which to cancel an order if it hasn't been filled.
EntryType indicates the reason for the account change.
OrderCancelTime represents when to cancel an order.
OrderSide represents "Buy" or "Sell".
OrderStop is either loss or entry.
OrderSTP is the order's Self trade preservation flag.
No description provided by the author
As fiat accounts can be used for buying and selling, they have an associated payment method.
No description provided by the author
OrderTimeInForce (Time in force) policies provide guarantees about the lifetime of an order.
No description provided by the author