Bitcoin and Altcoin Wallets: Exchange 2.3.4

tab_exchange_exchange_cb()

Parameters

$arg : mixed

tab_exchange_api_cb()

json_api_exchange_query_vars()

Parameters

$vars : mixed

json_api_parse_exchange_request()

Parameters

$query : mixed

rate_limit()

Parameters

$action : mixed

$user_id : mixed

get_effective_exchange_user_id()

Gets the effective user id, based on current login or API key.

Tags

throws

Exception

If passed API key does not match.

warn_if_not_zlib()

verify_exchange_args_exist()

Parameters

$arg_names : mixed

cache_response()

Parameters

$seconds_to_cache : mixed

do_not_cache_response()

superpwa_exclude_wallets_from_cache()

Exclude JSON API from being cached by SuperPWA

Parameters

$superpwa_sw_never_cache_urls : string

Comma separated list of regex patterns that match against request URL.

Tags

link

https://superpwa.com/codex/superpwa_sw_never_cache_urls/

refresh_superpwa_exclusion_list()

Forces SuperPWA to re-generate the service worker code once.

api_market_order_filter()

Inserts a new market order.

 $order_id = apply_filters(
     'wallets_api_market_order',
     null,
     array(
         'user_id' => 3,
         'market_id' => 123, // here 123 is the post_id of the BTC_DOGE market
         'amount' => 100000,
         'direction' => 'bid',
     )
 );

	add_filter(
		'wallets_api_market_order',
		function( $order_id, $args ) {
			if ( is_null( $oder_id ) ) {
				error_log(
					sprintf(
						'It was not possible for user %d to place a market %s order for %f on the %d market',
						$args['user_id'],
						$args['direction'],
						$args['amount'],
						$args['market_id']
					)
				);
			} else {
				error_log(
					sprintf(
						'User %d placed a market %s order for %f on the %d market',
						$args['user_id'],
						$args['direction'],
						$args['amount'],
						$args['market_id']
					)
				);
			}
		},
		11,
		2
	);

Parameters

$order_id : int = null

If order is placed successfully, order id will go here.

$args : array<string|int, mixed> = []

Array of arguments to this filter:

• integer user_id → (Optional) ID of the user who places the order. Default is current user.
• float amount → The amount to trade with this order. Expressed in units of the quote symbol.
• int market_id → Uniquely specifies a market via its post_id. Either specify this, or base/quote symbols.
• string base_symbol → The base symbol of the market where this order is to be placed.
• string quote_symbol → The quote symbol of the market where this order is to be placed.
• string direction → Must be one of bid or ask.
• boolean 'check_capabilities' → (Optional) Whether to check for the appropriate user capabilities. Default is true.

Tags

since

2.0.0

Accepts market_id instead of base/quote symbol pair. This is the post_id of a wallets_market post.

since

1.1.0

Introduced.

throws

Exception

If the market does not exist or the order cannot be placed (e.g. due to insufficient liquidity).

api_limit_order_filter()

Inserts a new limit order.

 $order_id = apply_filters(
     'wallets_api_limit_order',
     null,
     array(
         'user_id' => 3,
         'market_id' => 123, // here 123 is the post_id of the BTC_DOGE market
         'amount' => 100000,
         'rate' => 0.00000040,
         'direction' => 'bid',
     )
 );

	add_filter(
		'wallets_api_limit_order',
		function( $order_id, $args ) {
			if ( is_null( $oder_id ) ) {
				error_log(
					sprintf(
						'It was not possible for user %d to place a limit %s order for %f on the %d market',
						$args['user_id'],
						$args['direction'],
						$args['amount'],
						$args['market_id']
					)
				);
			} else {
				error_log(
					sprintf(
						'User %d placed a limit %s order for %f on the %d market',
						$args['user_id'],
						$args['direction'],
						$args['amount'],
						$args['market_id']
					)
				);
			}
		},
		11,
		2
	);

Parameters

$order_id : int = null

If order is placed successfully, order id will go here.

$args : array<string|int, mixed> = []

Array of arguments to this filter:

• integer user_id → (Optional) ID of the user who places the order. Default is current user.
• float amount → The amount to trade with this order. Expressed in units of the quote symbol.
• int market_id → Uniquely specifies a market via its post_id. Either specify this, or base/quote symbols.
• string base_symbol → The base symbol of the market where this order is to be placed.
• string quote_symbol → The quote symbol of the market where this order is to be placed.
• float rate The exchange rate for this limit order.
• string direction → Must be one of bid or ask.
• boolean 'check_capabilities' → (Optional) Whether to check for the appropriate user capabilities. Default is true.

Tags

since

2.0.0

Accepts market_id instead of base/quote symbol pair. This is the post_id of a wallets_market post.

since

0.1.0-beta

Introduced.

throws

Exception

If the market does not exist or the order cannot be placed.

api_cancel_order_action()

Cancels an order.

 do_action(
     'wallets_api_cancel_order',
     array(
         'user_id' => 3,
         'order_id' => 'O5b041284d64cb',
     )
 );

Parameters

$args : array<string|int, mixed> = []

Array of arguments to this action:

• integer 'order_id' → The ID of the order to cancel. This is the ID that starts with the letter "O".
• integer 'user_id' $rarr; (Optional) The ID of the user who placed this order. Default is the current user ID.
• boolean 'check_capabilities' → (Optional) Whether to check for the appropriate user capabilities. Default is true.

Tags

since

0.1.0-beta

Introduced.

throws

Exception

api_market_summary_filter()

Returns market summaries.

Parameters

$market : array<string|int, mixed> = []

Market summary will go here

$args : array<string|int, mixed> = []

Array of arguments to this filter:

• int market_id → Uniquely specifies a market via its post_id. Either specify this, or base/quote symbols.
• string base_symbol → The base symbol of the market whose summary is to be retrieved.
• string quote_symbol → The quote symbol of the market whose summary is to be retrieved.

Tags

since

2.0.0

Accepts market_id instead of base/quote symbol pair. This is the post_id of a wallets_market post.

since

0.1.0-beta

Introduced

throws

Exception

If the market does not exist or its summary cannot be retrieved.

api_orders_filter()

Returns orders.

 $order_history = apply_filters(
     'wallets_api_orders',
     null,
     array(
         'user_id' => 3,
         'open' => true,
     )
 );

 $order_history = apply_filters(
     'wallets_api_orders',
     null,
     array(
         'user_id' => 3,
         'market_id' => 123, // here 123 is the post_id of the BTC_DOGE market
         'filled' => true,
         'cancelled' => true,
     )
 );

 $order_history = apply_filters(
     'wallets_api_orders',
     null,
     array(
         'cancelled' => true,
         'from_timestamp' => time() - DAY_IN_SECONDS
     )
 );

Parameters

$orders : array<string|int, mixed> = []

Order data will go here

$args : array<string|int, mixed> = []

Array of arguments to this filter:

• integer|string user_id → (Optional) ID of the user who places the order. Default is current user. If set to the string all, orders for all users are returned.
• int market_id → (Optional) Uniquely specifies a market via its post_id. Either specify this, or base/quote symbols.
• string base_symbol → (Optional) The base symbol of the market whose orders are to be retrieved. If defined, quote_symbol must also be defined.
• string quote_symbol → (Optional) The quote symbol of the market whose orders are to be retrieved. If defined, base_symbol must also be defined.
• bool open → (Optional) Whether to retrieved open orders.
• bool filled → (Optional) Whether to retrieved filled orders.
• bool cancelled (Optional) → Whether to retrieved cancelled orders.
• integer from_timestamp (Optional) → Retrieve orders that have been created after this UNIX epoch timestamp (seconds). Default is 0.
• integer to_timestamp (Optional) → Retrieve orders that have been created before this UNIX epoch timestamp (seconds). Default is current timestamp.
• boolean 'check_capabilities' → (Optional) Whether to check for the appropriate user capabilities. Default is true.
• integer max_results → (Optional) Retrieve up to this many rows. Default is admin setting "Max Results".

Tags

since

2.0.0

Accepts market_id instead of base/quote symbol pair. This is the post_id of a wallets_market post.

since

1.0.0

Adding argument max_results.

since

0.1.0-beta

Introduced orders filter.

throws

Exception

If the orders cannot be retrieved.

api_market_order_book_filter()

Returns market order book.

Parameters

$book : array<string|int, mixed> = []

Orderbook data will be returned here

$args : array<string|int, mixed> = []

Array of arguments to this filter:

• int market_id → Uniquely specifies a market via its post_id. Either specify this, or base/quote symbols.
• string base_symbol → The base symbol of the market whose orderbook is to be retrieved.
• string quote_symbol → The quote symbol of the market whose orderbook is to be retrieved.

Tags

since

2.0.0

Accepts market_id instead of base/quote symbol pair. This is the post_id of a wallets_market post.

since

0.1.0-beta

Introduced.

throws

Exception

If the market does not exist or its orderbook cannot be retrieved.

api_prices_filter()

Returns historical market prices.

Parameters

$prices : array<string|int, mixed> = []

Price data will be returned here.

$args : array<string|int, mixed> = []

Array of arguments to this filter:

• int market_id → Uniquely specifies a market via its post_id. Either specify this, or base/quote symbols.
• string base_symbol → The base symbol of the market whose price history is to be retrieved.
• string quote_symbol → The quote symbol of the market whose price history is to be retrieved.
• string timeframe → One of 1m, 3m, 5m, 15m, 30m, 1h, 4h, 1d, 1w.
• integer from_timestamp (Optional) → Retrieve prices from trades that occurred after this UNIX epoch timestamp (seconds). Default is 0.
• integer to_timestamp (Optional) → Retrieve prices from trades that occurred before this UNIX epoch timestamp (seconds). Default is current timestamp.

Tags

since

2.0.0

Accepts market_id instead of base/quote symbol pair. This is the post_id of a wallets_market post.

since

0.1.0-beta

Introduced.

throws

Exception

If the market does not exist or its price history cannot be retrieved.

api_trades_filter()

Returns trades. Due to partially filled orders, one order can correspond to many trades.

 $trade_history = apply_filters(
     'wallets_api_trades',
     null,
     array(
         'user_id' => 3,
     )
 );

 $trade_history = apply_filters(
     'wallets_api_trades',
     null,
     array(
         'user_id' => 3,
         'market_id' => 123, // here 123 is the post_id of the BTC_DOGE market
     )
 );

 $trade_history = apply_filters(
     'wallets_api_trades',
     null,
     array(
         'from_timestamp' => time() - DAY_IN_SECONDS
     )
 );

 $trade_history = apply_filters(
     'wallets_api_trades',
     null,
     array(
         'market_id' => 123, // here 123 is the post_id of the BTC_DOGE market
     )
 );

Parameters

$trades : array<string|int, mixed> = []

Trades data will be returned here.

$args : array<string|int, mixed> = []

Array of arguments to this filter:

• integer|string user_id → (Optional) ID of the user whose trades to return. Default is current user. If set to the string all, trades for all users are returned.
• int market_id → (Optional) Uniquely specifies a market via its post_id. Either specify this, or base/quote symbols.
• string base_symbol → (Optional) The base symbol of the market whose trades are to be retrieved. If defined, quote_symbol must also be defined.
• string quote_symbol → (Optional) The quote symbol of the market whose trades are to be retrieved. If defined, base_symbol must also be defined.
• integer from_timestamp (Optional) → Retrieve trades that have been created after this UNIX epoch timestamp (seconds). Default is 0.
• integer to_timestamp (Optional) → Retrieve trades that have been created before this UNIX epoch timestamp (seconds). Default is current timestamp.
• boolean 'check_capabilities' → (Optional) Whether to check for the appropriate user capabilities. Default is true.
• integer max_results → (Optional) Retrieve up to this many rows. Default is admin setting "Max Results".

Tags

since

2.0.0

Accepts market_id instead of base/quote symbol pair. This is the post_id of a wallets_market post.

since

1.0.0

Adding argument max_results.

since

0.5.0-beta

Introduced trades filter.

throws

Exception

If the trades cannot be retrieved.

api_available_balance_exchange_filter()

Subtracts any amounts locked in open orders from the available balances of a user.

Parameters

$balances : array<string|int, mixed>

Assoc array of currency_ids to user's available balances. We'll subtract from these amounts.

$user_id : int

The user whose balances we are modifying.

Tags

since

2.0.0

Now hooks into a new filter compatible with wallets6, wallets_available_balances.

since

0.5.4-beta

Introduced.

throws

Exception

If capability checking fails.

guard_exchange_user_shortcodes()

Parameters

$caps : mixed = ['has_wallets', 'trade_funds_in_wallet']

get_market_ids()

Parameters

$include_private : mixed = true

get_market_id_by_symbols()

Get a market ID by the base and quote symbols.

Parameters

$base : string

Ticker symbol for the base currency.

$quote : string

Ticker symbol for the quote currency.

Tags

since

2.0.0

get_market_by_args()

Parses shortcode arguments to determine the specified market via any of the following methods:

Parameters

$atts : array<string|int, mixed>

The shortcode attributes, potentially containing one or more market specifiers.

Tags

throws

Exception

If a market could not be determined

get_the_market_id()

Gets the currently applicable market for shortcode UIs.

Parameters

$atts : array<string|int, mixed>

The attributes passed to the shortcode currently being displayed.

Tags

throws

Exception

If a market cannot be resolved from the available data.

get_market_name()

Parameters

$market_post : WP_Post

get_existing_market_migration_hashes()

Retrieve migration hashes for existing market posts.

check_market_order_amount_min_max()

Check if amount is within range allowed by market settings.

Parameters

$base_currency_id : int

The ticker symbol of the market's base currency

$amount : int

The value of the trade expressed in the market's base currency.

Tags

throws

Exception

If amount is not in range or the base currency id is not valid.

check_order_amount_min_max()

Checks if the amount to be traded is within admin limits.

Parameters

$currency_id : int

The currency transacted

$amount : float

The amount transacted.

Tags

throws

Exception

Will throw if it's out of range.

ensure_market_filled_orders()

Ensure that no orders that are filled are stuck in "open" status

Parameters

$table_name_orders : mixed

save_exchange_trade_transactions()

Saves all the transactions resulting from a trade.

Parameters

$txs_and_tags_to_save : array<string|int, mixed>

Array of array tuples, consisting of: 'tx' => Transaction object 'tags' => array of tag slugs (strings).

send_trade_notification_emails()

Emails the two users about their trade

Parameters

$txns_and_tags_to_email : array<string|int, mixed>

wallets_market_meta_box_currencies()

Parameters

$post : mixed

$meta_box : mixed

wallets_market_meta_box_orders()

Parameters

$post : mixed

$meta_box : mixed

wallets_market_meta_box_rates()

Parameters

$post : mixed

$meta_box : mixed