Download the PHP package mainnet-cash/mainnet-php-generated without Composer
On this page you can find all versions of the php package mainnet-cash/mainnet-php-generated. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mainnet-cash/mainnet-php-generated
More information about mainnet-cash/mainnet-php-generated
Files in mainnet-cash/mainnet-php-generated
Package mainnet-php-generated
Short Description 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.
License unlicense
Homepage https://openapi-generator.tech
Informations about the package mainnet-php-generated
Mainnet
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: 2.5.0
- 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
:
Then run composer install
Manual Installation
Download the files and include autoload.php
:
Tests
To run the unit tests:
Getting Started
Please follow the installation procedure and then run the following:
Documentation for API Endpoints
All URIs are relative to https://rest-unstable.mainnet.cash
Class | Method | HTTP request | Description |
---|---|---|---|
ContractApi | contractFn | POST /contract/call | Call a method on a contract |
ContractApi | contractInfo | POST /contract/info | Get information about a contract from the contractId |
ContractApi | contractUtxos | POST /contract/utxos | List specific utxos on any contract |
ContractApi | createContract | POST /contract/create | Create a cashscript contract |
ContractEscrowApi | createEscrow | POST /contract/escrow/create | Create an escrow contract |
ContractEscrowApi | escrowFn | POST /contract/escrow/call | Finalize an escrow contract |
ContractEscrowApi | escrowInfo | POST /contract/escrow/info | Get information about an escrow contract from the escrowContractId |
ContractEscrowApi | escrowUtxos | POST /contract/escrow/utxos | List specific utxos on any escrow contract |
FaucetApi | getAddresses | POST /faucet/get_addresses | Get addresses to return back or donate the testnet bch and tokens |
FaucetApi | getTestnetBch | POST /faucet/get_testnet_bch | Get testnet bch |
MineApi | mine | POST /mine | Mine regtest coins to a specified address |
UtilApi | convert | POST /util/convert | convert between units |
UtilApi | getAddrsByXpubKey | POST /util/get_addrs_by_xpubkey | Derive heristic determined addresses from an extended public key, per BIP32 |
UtilApi | getXpubKeyInfo | POST /util/get_xpubkey_info | Decode information about an extended public key, per BIP32 |
WalletApi | balance | POST /wallet/balance | Get total balance for wallet |
WalletApi | createWallet | POST /wallet/create | create a new wallet |
WalletApi | depositAddress | POST /wallet/deposit_address | Get a deposit address in cash address format |
WalletApi | depositQr | POST /wallet/deposit_qr | Get receiving cash address as a qrcode |
WalletApi | encodeTransaction | POST /wallet/encode_transaction | Encode and sign a transaction given a list of sendRequests, options and estimate fees |
WalletApi | getAllNftTokenBalances | POST /wallet/get_all_nft_token_balances | Get non-fungible token balance |
WalletApi | getAllTokenBalances | POST /wallet/get_all_token_balances | Get non-fungible token balance |
WalletApi | getHistory | POST /wallet/get_history | Get a list of transactions related to a wallet |
WalletApi | getNftTokenBalance | POST /wallet/get_nft_token_balance | Get non-fungible token balance |
WalletApi | getTokenBalance | POST /wallet/get_token_balance | Get fungible token balance |
WalletApi | getTokenUtxos | POST /wallet/get_token_utxos | Get token utxos |
WalletApi | info | POST /wallet/info | Get information about a wallet |
WalletApi | maxAmountToSend | POST /wallet/max_amount_to_send | Get maximum spendable amount |
WalletApi | namedExists | POST /wallet/named_exists | Check if a named wallet already exists |
WalletApi | replaceNamed | POST /wallet/replace_named | Replace (recover) named wallet with a new walletId. If wallet with a provided name does not exist yet, it will be creted with a `walletId` supplied If wallet exists it will be overwritten without exception |
WalletApi | send | POST /wallet/send | Send some amount to a given address |
WalletApi | sendMax | POST /wallet/send_max | Send all available funds to a given address |
WalletApi | submitTransaction | POST /wallet/submit_transaction | submit an encoded and signed transaction to the network |
WalletApi | tokenBurn | POST /wallet/token_burn | Perform an explicit token burn |
WalletApi | tokenDepositAddress | POST /wallet/token_deposit_address | Get a token aware deposit address in cash address format |
WalletApi | tokenDepositQr | POST /wallet/token_deposit_qr | Get receiving token aware cash address as a qrcode |
WalletApi | tokenGenesis | POST /wallet/token_genesis | Create new token category |
WalletApi | tokenMint | POST /wallet/token_mint | Mint new non-fungible tokens |
WalletApi | utxos | POST /wallet/utxo | Get detailed information about unspent outputs (utxos) |
WalletApi | xpubkeys | POST /wallet/xpubkeys | A set of xpubkeys and paths for the wallet. |
WalletBcmrApi | bcmrAddMetadataRegistryAuthChain | POST /wallet/bcmr/add_registry_authchain | Add BCMR metadata registry from autchain, returning the built chain |
WalletBcmrApi | bcmrAddRegistry | POST /wallet/bcmr/add_registry | Add BCMR registry from parameter |
WalletBcmrApi | bcmrAddRegistryFromUri | POST /wallet/bcmr/add_registry_from_uri | Reset tracked BCMR registries |
WalletBcmrApi | bcmrBuildAuthChain | POST /wallet/bcmr/build_authchain | Build a BCMR authchain |
WalletBcmrApi | bcmrGetRegistries | POST /wallet/bcmr/get_registries | Get tracked BCMR registries |
WalletBcmrApi | bcmrGetTokenInfo | POST /wallet/bcmr/get_token_info | Get token info |
WalletBcmrApi | bcmrResetRegistries | POST /wallet/bcmr/reset_registries | Reset tracked BCMR registries |
WalletSignedApi | signedMessageSign | POST /wallet/signed/sign | Returns the message signature |
WalletSignedApi | signedMessageVerify | POST /wallet/signed/verify | Returns a boolean indicating whether message was valid for a given address |
WalletUtilApi | utilDecodeTransaction | POST /wallet/util/decode_transaction | Decode a bitcoin transaction. Accepts both transaction hash or raw transaction in hex format. |
WalletUtilApi | utilGetRawTransaction | POST /wallet/util/get_raw_transaction | Get bitcoin raw transaction |
WebhookApi | watchAddress | POST /webhook/watch_address | Create a webhook to watch cashaddress balance and transactions. |
Documentation For Models
- AuthChainElement
- BalanceRequest
- BalanceResponse
- CashscriptReceipt
- Contract
- ContractFnRequest
- ContractFnResponse
- ContractInfoRequest
- ContractInfoResponse
- ContractRequest
- ContractResponse
- ConvertRequest
- CreateSignedMessageRequest
- DepositAddressResponse
- ElectrumRawTransaction
- ElectrumRawTransactionScriptPubKey
- ElectrumRawTransactionScriptSig
- ElectrumRawTransactionVin
- ElectrumRawTransactionVout
- EncodeTransactionRequest
- EncodeTransactionResponse
- Error
- EscrowContract
- EscrowFnRequest
- EscrowInfoRequest
- EscrowInfoResponse
- EscrowRequest
- EscrowResponse
- GetAddressesResponse
- GetAddrsByXpubKeyRequest
- GetTestnetBchRequest
- GetTestnetBchResponse
- GetXpubKeyInfoRequest
- GetXpubKeyInfoResponse
- HistoryRequest
- InOutput
- InlineObject
- InlineObject1
- InlineObject2
- InlineObject3
- InlineObject4
- MaxAmountToSendRequest
- MineRequest
- NetworkEnum
- OpReturnData
- ScalableVectorGraphic
- SendMaxRequest
- SendMaxResponse
- SendRequest
- SendRequestItem
- SendRequestItemAnyOf
- SendRequestOptions
- SendResponse
- SerializedWallet
- SignedMessageResponse
- SignedMessageResponseDetails
- SignedMessageResponseRaw
- SubmitTransactionRequest
- SubmitTransactionResponse
- Token
- TokenAmountChange
- TokenBurnRequest
- TokenGenesisRequest
- TokenMintRequest
- TokenMintRequestRequests
- TokenSendRequest
- TransactionHistoryItem
- UnitType
- UtilDecodeTransactionRequest
- Utxo
- VerifySignedMessageRequest
- VerifySignedMessageResponse
- VerifySignedMessageResponseDetails
- WalletInfo
- WalletMnemonic
- WalletNamedExistsRequest
- WalletReplaceNamedRequest
- WalletRequest
- WalletResponse
- WalletType
- WatchAddressRequest
- WatchAddressResponse
- Wif
- XPubKey
- XPubKeyRequest
- XPubKeyResponse
- ZeroBalanceResponse
Documentation For Authorization
bearerAuth
- Type: Bearer authentication
Author
All versions of mainnet-php-generated with dependencies
ext-curl Version *
ext-json Version *
ext-mbstring Version *
guzzlehttp/guzzle Version ^6.2