Download the PHP package thesuperiorcoin/superior-php without Composer

Superior-PHP

A PHP library for the Superior simplewallet JSON-RPC interface.

For more information about Superior, please visit https://getmonero.org/home.

If you found this useful, feel free to donate!

SUP: 5QaiHzo64sLDo42ky98uXtJ3zswCdpUrk1q5nSidtqovjjiC7FmxRt84Zu3HkpYQX1PLDU72aQMK6Cif4muRxwt3RyZXY6y

Installation

Install the library using Composer.

composer require thesuperiorcoin/superior-php

Create an Instance of the Wallet

Default hostname and port connects to http://127.0.0.1:16036.

To connect to an external IP or different port:

Wallet Methods

getBalance

Responds with the current balance and unlocked (spendable) balance of the wallet in atomic units. Divide by 1e8 to convert.

Example response:

getAddress

Responds with the Superior address of the wallet.

Example response:

transfer

Transfers Superior to a single recipient OR a group of recipients in a single transaction. Responds with the transaction hash of the payment.

Parameters:

• options - an array containing destinations (object OR array of objects), mixin (int), unlock_time (int), payment_id (string). Only destinations is required. Default mixin value is 4.

Example response:

transferSplit

Same as transfer(), but can split into more than one transaction if necessary. Responds with a list of transaction hashes.

Additional property available for the options array:

• new_algorithm - true to use the new transaction construction algorithm. defaults to false. (boolean)

Example response:

sweepDust

Sends all dust outputs back to the wallet, to make funds easier to spend and mix. Responds with a list of the corresponding transaction hashes.

Example response:

getPayments

Returns a list of incoming payments using a given payment ID.

Parameters:

• paymentID - the payment ID to scan wallet for included transactions (string)

getBulkPayments

Returns a list of incoming payments using a single payment ID or a list of payment IDs from a given height.

Parameters:

• paymentIDs - the payment ID or list of IDs to scan wallet for (array)
• minHeight - the minimum block height to begin scanning from (example: 800000) (int)

incomingTransfers

Returns a list of incoming transfers to the wallet.

Parameters:

• type - accepts "all": all the transfers, "available": only transfers that are not yet spent, or "unavailable": only transfers which have been spent (string)

queryKey

Returns the wallet's spend key (mnemonic seed) or view private key.

Parameters:

• type - accepts "mnemonic": the mnemonic seed for restoring the wallet, or "view_key": the wallet's view key (string)

integratedAddress

Make and return a new integrated address from your wallet address and a given payment ID, or generate a random payment ID if none is given.

Parameters:

• payment_id - a 64 character hexadecimal string. If not provided, a random payment ID is automatically generated. (string, optional)

Example response:

splitIntegrated

Returns the standard address and payment ID corresponding for a given integrated address.

Parameters:

• integrated_address - an Superior integrated address (string)

Example response:

getHeight

Usage:

Returns the current block height of the daemon.

Example response:

stopWallet

Cleanly shuts down the current simplewallet process.

Introduction

This is a list of the superior-wallet-rpc calls, their inputs and outputs, and examples of each. The program superior-wallet-rpc replaced the rpc interface that was in simplewallet and then superior-wallet-cli. All superior-wallet-rpc methods use the same JSON RPC interface. For example:

If the superior-wallet-rpc was executed with the --rpc-login argument as username:password, then follow this example:

Note: "atomic units" refer to the smallest fraction of 1 SUP according to the superiord implementation. 1 SUP = 1e8 atomic units.

Index of JSON RPC Methods:

•   getbalance
•   getaddress
•   getheight
•   transfer
•   transfer_split
•   sweep_dust
•   store
•   get_payments
•   get_bulk_payments
•   get_transfers
•   incoming_transfers
•   query_key
•   make_integrated_address
•   split_integrated_address
•   stop_wallet

JSON RPC Methods:

Return the wallet's balance. Inputs: None. Outputs: • balance - unsigned int; The total balance of the current Superior-wallet-rpc in session. • unlocked_balance - unsigned int; Unlocked funds are those funds that are sufficiently deep enough in the Superior blockchain to be considered safe to spend.

Example:

Return the wallet's address. Inputs: None. Outputs:

•   address - string; The 95-character hex address string of the superior-wallet-rpc in session.

Example:

Returns the wallet's current block height. Inputs: None. Outputs: • height - string; The current superior-wallet-rpc's blockchain height. If the wallet has been offline for a long time, it may need to catch up with the daemon.

Example:

Send superior to a number of recipients.

Inputs: • destinations - array of destinations to receive Sup: ◦ amount - unsigned int; Amount to send to each destination, in atomic units. ◦ address - string; Destination public address. • fee - unsigned int; Ignored, will be automatically calculated. • mixin - unsigned int; Number of outpouts from the blockchain to mix with (0 means no mixing). • unlock_time - unsigned int; Number of blocks before the superior can be spent (0 to not add a lock). • payment_id - string; (Optional) Random 32-byte/64-character hex string to identify a transaction. • get_tx_key - boolean; (Optional) Return the transaction key after sending. Outputs:
 • fee - Integer value of the fee charged for the txn. • tx_hash - String for the publically searchable transaction hash • tx_key - String for the transaction key if get_tx_key is true, otherwise, blank string.

Example:

Same as transfer, but can split into more than one tx if necessary.

Inputs: • destinations - array of destinations to receive Sup: ◦ amount - unsigned int; Amount to send to each destination, in atomic units. ◦ address - string; Destination public address. • fee - unsigned int; Ignored, will be automatically calculated. • mixin - unsigned int; Number of outpouts from the blockchain to mix with (0 means no mixing). • unlock_time - unsigned int; Number of blocks before the superior can be spent (0 to not add a lock). • payment_id - string; (Optional) Random 32-byte/64-character hex string to identify a transaction. • get_tx_key - boolean; (Optional) Return the transaction key after sending. – Ignored • new_algorithm - boolean; True to use the new transaction construction algorithm, defaults to false.

Outputs: • fee_list - array of: integer • tx_hash_list - array of: string

Example:

Send all dust outputs back to the wallet's, to make them easier to spend (and mix). Inputs: None. Outputs:

•   tx_hash_list - list of: string

Example (In this example, sweep_dust returns an error due to insufficient funds to sweep):

Save the blockchain. Inputs: None. Outputs: None.

Example:

Get a list of incoming payments using a given payment id.

Inputs: • payment_id - string Outputs: • payments - list of: ◦ payment_id - string ◦ tx_hash - string ◦ amount - unsigned int ◦ block_height - unsigned int ◦ unlock_time - unsigned int

Example:

Get a list of incoming payments using a given payment id, or a list of payments ids, from a given height. This method is the preferred method over get_payments because it has the same functionality but is more extendable. Either is fine for looking up transactions by a single payment ID.

Inputs: • payment_ids - array of: string • min_block_height - unsigned int; The block height at which to start looking for payments. Outputs: • payments - list of: ◦ payment_id - string ◦ tx_hash - string ◦ amount - unsigned int ◦ block_height - unsigned int ◦ unlock_time - unsigned int

Example:

Returns a list of transfers.

Inputs: • in - boolean; • out - boolean; • pending - boolean; • failed - boolean; • pool - boolean; • filter_by_height - boolean; • min_height - unsigned int; • max_height - unsigned int; Outputs: • in array of transfers: ◦ txid - string; ◦ payment_id - string; ◦ height - unsigned int; ◦ timestamp - unsigned int; ◦ amount - unsigned int; ◦ fee - unsigned int; ◦ note - string; ◦ destinations - std::list; ◦ type - string; • out array of transfers • pending array of transfers • failed array of transfers • pool array of transfers

Example:

Return a list of incoming transfers to the wallet.

Inputs: • transfer_type - string; "all": all the transfers, "available": only transfers which are not yet spent, OR "unavailable": only transfers which are already spent. Outputs: • transfers - list of: ◦ amount - unsigned int ◦ spent - boolean ◦ global_index - unsigned int; Mostly internal use, can be ignored by most users. ◦ tx_hash - string; Several incoming transfers may share the same hash if they were in the same transaction. ◦ tx_size - unsigned int

Example (Return "all" transaction types):

Example (Return "available" transactions):

Example (Return "unavailable" transaction. Note that this particular example returns 0 unavailable transactions):

Return the spend or view private key. Inputs: • key_type - string; Which key to retrieve: "mnemonic" - the mnemonic seed (older wallets do not have one) OR "view_key" - the view key Outputs: • key - string; The view key will be hex encoded, while the mnemonic will be a string of words.

Example (Query view key):

Example (Query mnemonic key):

Make an integrated address from the wallet address and a payment id.

Inputs: • payment_id - string; hex encoded; can be empty, in which case a random payment id is generated Outputs: • integrated_address - string

Example (Payment ID is empty, use a random ID):

Retrieve the standard address and payment id corresponding to an integrated address.

Inputs: • integrated_address - string Outputs: • standard_address - string • payment - string; hex encoded

Example:

Stops the wallet, storing the current state.

Inputs: None. Outputs: None.

Example:

Create a payment URI using the official URI spec.

Inputs: • address - wallet address string • amount (optional) - the integer amount to receive, in atomic units • payment_id (optional) - 16 or 64 character hexadecimal payment id string • recipient_name (optional) - string name of the payment recipient • tx_description (optional) - string describing the reason for the tx Outputs: • uri - a string containing all the payment input information as a properly formatted payment URI

Example:

Parse a payment URI to get payment information.

Inputs: • uri - a string containing all the payment input information as a properly formatted payment URI Outputs: • uri - JSON object containing parment information: ◦ address - wallet address string ◦ amount - the decimal amount to receive, in coin units (0 if not provided) ◦ payment_id - 16 or 64 character hexadecimal payment id string (empty if not provided) ◦ recipient_name - string name of the payment recipient (empty if not provided) ◦ tx_description - string describing the reason for the tx (empty if not provided)

Example: