-
Notifications
You must be signed in to change notification settings - Fork 24
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Mehdi Bounya
committed
Aug 18, 2018
1 parent
9202b3a
commit 2f21765
Showing
1 changed file
with
6 additions
and
85 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,89 +1,10 @@ | ||
| # Codeigniter-blockchain | ||
| This library allows you to use the Blockchain Wallet API, it offers easy to use methods | ||
| that will build the HTTP requests to the service for you. | ||
| ## Contents | ||
| # Codeigniter-blockchain [](https://packagist.org/packages/mehdibo/codeigniter-blockchain) [](https://packagist.org/packages/mehdibo/codeigniter-blockchain) [](https://packagist.org/packages/mehdibo/codeigniter-blockchain) | ||
|
|
||
| * [Getting Started](#getting-started) | ||
| * [Documentation](#documentation) | ||
|
|
||
| ## Getting Started | ||
| This library allows you to use the Blockchain Wallet API with your CodeIgniter application easily. | ||
|
|
||
| To use the blockchain wallet API, make sure you read the [Blockchain Wallet API](https://blockchain.info/api/blockchain_wallet_api) documentations. | ||
| You will need to run the Blockchain wallet service, Click [here](https://github.com/blockchain/service-my-wallet-v3) for setup instructions. | ||
| ## Documentation | ||
| Documentation and usage details are available in the [Repository's Wiki](https://github.com/mehdibo/Codeigniter-blockchain/wiki) | ||
|
|
||
| Start by completing the following steps: | ||
| ## Contributing | ||
| All feedback and contributions are welcome, just make sure you read the [Contributing guidelines](CONTRIBUTING.md) | ||
|
|
||
| 1. Copy `/application/libraries/Blockchain.php` to the `/application/libraries` folder. | ||
| 2. Load the library using the Codeigniter loader `$this->load->library('blockchain' , $config)`, | ||
| 3. See the [documentation](#documentation) for usage. | ||
| 4. And that's it! | ||
|
|
||
| To use this class outside Codeigniter just remove the following line found in the top: | ||
|
|
||
| `defined('BASEPATH') OR exit('No direct script access allowed');` | ||
|
|
||
| ## Documentation | ||
| ### Loading the library | ||
| Make sure you followed the steps on [Getting Started](#getting-started) first, after that you can simply load the library using: | ||
| `$this->load->library('blockchain' , $config)` | ||
|
|
||
| `$config` options are: | ||
| * `guid` - Blockchain Wallet Identifier. (the one used for login - Wallet ID) | ||
| * `main_password` - Main Blockchain password. | ||
| * `second_password` - You need to set this if double encryption is enabled . | ||
| * `api_code` - You API code, required if you are going to use the create_wallet() function. | ||
| * `base_url` - The base url used for the API. (default: http://127.0.0.1) | ||
| * `port` - If you would like to set a custom port. (default: 3000) | ||
|
|
||
| ### Create wallet | ||
| `$this->blockchain->create_wallet($password, $private_key = NULL, $email = NULL, $label = NULL)` | ||
|
|
||
| Parameters are: | ||
| * `password` - The new wallet password, must be at least 10 characters. | ||
| * `private_key` - A private key to add to the wallet (Wallet import format preferred). (optional) | ||
| * `email` - An e-mail to associate to the new wallet. (optional) | ||
| * `label` - A label to set for the wallet's first address. (Alphanumeric only) (optional) | ||
|
|
||
| ### Send funds | ||
| `$this->blockchain->send($to, $amount, $from = NULL, $fee = NULL)` | ||
|
|
||
| Parameters are: | ||
| * `to` - Recipient Bitcoin Address. | ||
| * `amount` - Amount in satoshis. | ||
| * `from` - Send from a specific Bitcoin Address. (Optional) | ||
| * `fee` - Transaction fee value in satoshi. (Must be greater than default fee) (Optional) | ||
|
|
||
| ### Send to multiple addresses | ||
| `$this->blockchain->send_many($recipients, $from = NULL, $fee = NULL)` | ||
|
|
||
| Parameters are: | ||
| * `recipients` - Recipients Bitcoin Address as an associative array, `'address' => 'amount in satoshis'`. | ||
| * `from` - Send from a specific Bitcoin Address. (Optional) | ||
| * `fee` - Transaction fee value in satoshi. (Must be greater than default fee) (Optional) | ||
|
|
||
| ### Get wallet balance | ||
| `$this->blockchain->wallet_balance()` | ||
|
|
||
| No parameters. | ||
|
|
||
| ### List addresses | ||
| `$this->blockchain->list_addresses()` | ||
|
|
||
| No parameters. | ||
|
|
||
| ### Get address balance | ||
| `$this->blockchain->address_balance($address)` | ||
|
|
||
| Parameters are: | ||
| * `address` - Bitcoin address to lookup. | ||
|
|
||
| ### Create new address | ||
| `$this->blockchain->new_address($label)` | ||
|
|
||
| Parameters are: | ||
| * `label` - The new address's label. (optional) | ||
|
|
||
| All the methods above will return the decoded JSON response from the server. | ||
|
|
||
| ## Contribution | ||
| If you find any bugs please open an issue, all contributions are welcome. |