README

A developer friendly bitcoin cash wallet api

This API is currently in active development, breaking changes may be made prior to official release of version 1.0.0.

This PHP package is automatically generated by the OpenAPI Generator project:

• API version: 3.1.7
• Build package: org.openapitools.codegen.languages.PhpClientCodegen

Requirements

PHP 7.2 and later

Installation & Usage

Composer

To install the bindings via Composer, add the following to composer.json:

{
  "repositories": [
    {
      "type": "vcs",
      "url": "https://github.com/mainnet-cash/mainnet-php-generated.git"
    }
  ],
  "require": {
    "mainnet-cash/mainnet-php-generated": "*@dev"
  }
}

Then run composer install

Manual Installation

Download the files and include autoload.php:

    require_once('/path/to/Mainnet/vendor/autoload.php');

Tests

To run the unit tests:

composer install
./vendor/bin/phpunit

Getting Started

Please follow the installation procedure and then run the following:

<?php
require_once(__DIR__ . '/vendor/autoload.php');



// Configure Bearer authorization: bearerAuth
$config = Mainnet\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new Mainnet\Api\FaucetApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);

try {
    $result = $apiInstance->getAddresses();
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FaucetApi->getAddresses: ', $e->getMessage(), PHP_EOL;
}

?>

Documentation for API Endpoints

All URIs are relative to https://rest-unstable.mainnet.cash

Documentation For Models

• AuthChainElement
• BalanceRequest
• BalanceResponse
• ConvertRequest
• ConvertResponse
• CreateSignedMessageRequest
• DepositAddressResponse
• ElectrumRawTransaction
• ElectrumRawTransactionScriptPubKey
• ElectrumRawTransactionScriptSig
• ElectrumRawTransactionVin
• ElectrumRawTransactionVout
• EncodeTransactionRequest
• EncodeTransactionResponse
• Error
• GetAddressesResponse
• GetAddrsByXpubKeyRequest
• GetTestnetBchRequest
• GetTestnetBchResponse
• GetXpubKeyInfoRequest
• GetXpubKeyInfoResponse
• HistoryRequest
• InOutput
• InlineObject
• InlineObject1
• InlineObject2
• InlineObject3
• InlineObject4
• InlineObject5
• InlineResponse200
• MaxAmountToSendRequest
• MineRequest
• NetworkEnum
• OpReturnData
• SendMaxRequest
• SendMaxResponse
• SendRequest
• SendRequestItem
• SendRequestItemAnyOf
• SendRequestOptions
• SendResponse
• SerializedWallet
• SignedMessageResponse
• SignedMessageResponseDetails
• SignedMessageResponseRaw
• SubmitTransactionRequest
• SubmitTransactionResponse
• Token
• TokenAmountChange
• TokenBurnRequest
• TokenGenesisRequest
• TokenMintRequest
• TokenMintRequestRequests
• TokenNft
• TokenSendRequest
• TransactionHistoryItem
• UnitType
• UtilDecodeTransactionRequest
• Utxo
• VerifySignedMessageRequest
• VerifySignedMessageResponse
• VerifySignedMessageResponseDetails
• WalletInfo
• WalletMnemonic
• WalletNamedExistsRequest
• WalletNamedExistsResponse
• WalletReplaceNamedRequest
• WalletReplaceNamedResponse
• WalletRequest
• WalletResponse
• WalletType
• WatchAddressRequest
• WatchAddressResponse
• Wif
• XPubKey
• XPubKeyRequest
• XPubKeyResponse

Documentation For Authorization

bearerAuth

• Type: Bearer authentication

Author

hello@mainnet.cash