Currency class
The currency class is designed to work with Apirone currencies and contains all necessary data and methods. It is used to synchronize settings between the API and local settings, allows you to set the transfer address and processing fees in the API.
Create an instance
To create an instance, call the Currency::init() method and pass the json currency object received from the API account info method as a parameter.
INFO
If you work with currencies via the Settings class, you do not have to initialize the Currency class yourself.
Properties
| Property | Method get | Description |
|---|---|---|
name | getName() | The full name of the cryptocurrency |
abbr | getAbbr() | Cryptocurrency abbreviation |
units | getUnits() | The minimal unit used for cryptocurrency |
unitsFactor | getUnitsFactor() | Factor for minimal unit |
dustRate | getDustRate() | Fee free threshold. We don't charge the service fee for payments under this amount |
address | getAddres() | Forwarding destination address |
policy | getPoloicy() | Processing fee policies |
Almost all properties are read-only. Two properties address and policy are available for modification. To do this, use setAddress() and setPolicy() methods.
Sinchronize with account
| Method | Description |
|---|---|
loadSettings() | |
saveSettings() | |
hasError() | |
getError() |
Additional methods
| Method | Description |
|---|---|
isTestnet() | Checks whether the currency is a testnet. For example tbtc. |
isNetwork() | Is the token over network (blockchain) |
isToken() | Is a network-based token. |
getTokens() | Returns an array with network tokens. An array of all currencies is used as a parameter. |