1fff4ab788
Added available currencies and updated the constructor and setCode to the currency class Added phpmd to project Updated documentation to some some conventions, updated docs to show the new usage of the currency class, also updated the testing documentation to show how to use phpmd Small bug fix and made the configuration file have 100% code coverage Code cleanup, removed unused variables Updated dev dependencies to patch level Removed the sin_key option since it will be going away soon Removed Robo in composer.json since we do not use and updated travis config to allow failures in php 5.3 since we require 5.4 or greater Deleted robo file Large update with documentation updates, extra code functionality, and bug fixes.
79 lines
1.6 KiB
ReStructuredText
79 lines
1.6 KiB
ReStructuredText
=============
|
|
Configuration
|
|
=============
|
|
|
|
Configuration can of this library can be done in various different ways. Out of
|
|
the box, you are able to configure the client using a PHP array or by using
|
|
a yml file.
|
|
|
|
|
|
Config Options
|
|
==============
|
|
|
|
All configuration options can be found in the class Bitpay\Config\Configuration
|
|
|
|
public_key
|
|
----------
|
|
|
|
This is the full path to the public key and the name. The default for this
|
|
is ``$HOME/.bitpay/bitpay.pub``
|
|
|
|
private_key
|
|
-----------
|
|
|
|
Default for this is ``$HOME/.bitpay/bitpay.key``
|
|
|
|
network
|
|
-------
|
|
|
|
Use livenet or testnet. Valid values are ``testnet`` or ``livenet`` and it defaults
|
|
to ``livenet``.
|
|
|
|
adapter
|
|
-------
|
|
|
|
Used mostly for testing. You shouldn't need to change or update this.
|
|
|
|
key_storage
|
|
-----------
|
|
|
|
The ``key_storage`` option allows you to give a class for persisting keys and
|
|
loading them. The class must also implement ``Bitpay\Storage\StorageInterface``.
|
|
|
|
By default this uses the ``Bitpay\Storage\EncryptedFilesystemStorage``.
|
|
|
|
|
|
key_storage_password
|
|
--------------------
|
|
|
|
This is the password used to encrypt and decrypt keys on the filesystem. If you
|
|
have generated keys and change this to something else, you will be unable to
|
|
load your keys.
|
|
|
|
Example YAML config
|
|
===================
|
|
|
|
.. code-block:: yaml
|
|
|
|
# /path/to/config.yml
|
|
bitpay:
|
|
network: testnet
|
|
|
|
.. code-block:: php
|
|
|
|
$bitpay = new \Bitpay\Bitpay('/path/to/config.yml');
|
|
|
|
|
|
Example array config
|
|
====================
|
|
|
|
.. code-block:: php
|
|
|
|
$bitpay = new \Bitpay\Bitpay(
|
|
array(
|
|
'bitpay' => array(
|
|
'network' => 'testnet',
|
|
)
|
|
)
|
|
);
|