A simple class for making calls to Gamecredits's API using PHP.
-
Include gamecredits.php into your PHP script:
require_once('gamecredits.php'); -
Initialize Gamecredits connection/object:
$gamecredits = new Gamecredits('username','password');Optionally, you can specify a host, port. Default is HTTP on localhost port 40001.
$gamecredits = new Gamecredits('username','password','localhost','40001');If you wish to make an SSL connection you can set an optional CA certificate or leave blank
$Gamecredits->setSSL('/full/path/to/mycertificate.cert'); -
Make calls to Gamecreditsd as methods for your object. Examples:
$gamecredits->getinfo();$gamecredits->getrawtransaction('0e3e2357e806b6cdb1f70b54c3a3a17b6714ee1f0e68bebb44a74b1efd512098',1);$gamecredits->getblock('000000000019d6689c085ae165831e934ff763ae46a2a6c172b3f1b60a8ce26f');
-
When a call fails for any reason, it will return false and put the error message in $gamecredits->error
-
The HTTP status code can be found in $gamecredits->status and will either be a valid HTTP status code or will be 0 if cURL was unable to connect.
-
The full response (not usually needed) is stored in $gamecredits->response while the raw JSON is stored in $gamecredits->raw_response
| Command | Parameters | Description | Requires unlocked wallet? |
|---|---|---|---|
| addmultisigaddress | [nrequired] ["key","key"] [account] | Currently only available on testnet Add a nrequired-to-sign multisignature address to the wallet. Each key is a GameCredits address or hex-encoded public key. If [account] is specified, assign address to [account]. | N |
| backupwallet | [destination] | Safely copies wallet.dat to destination, which can be a directory or a path with filename. | N |
| dumpprivkey | [GameCreditsaddress] | Reveals the private key corresponding to | Y |
| encryptwallet | [passphrase] | Encrypts the wallet with | N |
| getaccount | [GameCreditsaddress] | Returns the account associated with the given address. | N |
| getaccountaddress | [account] | Returns the current GameCredits address for receiving payments to this account. | N |
| getaddressesbyaccount | [account] | Returns the list of addresses for the given account. | N |
| getbalance | [account] [minconf=1] | If [account] is not specified, returns the server's total available balance. If [account] is specified, returns the balance in the account. |
N |
| getblock | [hash] | Returns information about the given block hash. | N |
| getblockcount | Returns the number of blocks in the longest block chain. | N | |
| getblockhash | [index] | Returns hash of block in best-block-chain at | N |
| getblocknumber | Deprecated. Use getblockcount. | N | |
| getconnectioncount | Returns the number of connections to other nodes. | N | |
| getdifficulty | Returns the proof-of-work difficulty as a multiple of the minimum difficulty. | N | |
| getgenerate | Returns true or false whether GameCreditsd is currently generating hashes | N | |
| gethashespersec | Returns a recent hashes per second performance measurement while generating. | N | |
| getinfo | Returns an object containing various state info. | N | |
| getmemorypool | [data] | If [data] is not specified, returns data needed to construct a block to work on:
If [data] is specified, tries to solve the block and returns true if it was successful. |
N |
| getmininginfo | Returns an object containing mining-related information:
|
N | |
| getnewaddress | [account] | Returns a new GameCredits address for receiving payments. If [account] is specified (recommended), it is added to the address book so payments received with the address will be credited to [account]. | N |
| getreceivedbyaccount | [account] [minconf=1] | Returns the total amount received by addresses with [account] in transactions with at least [minconf] confirmations. If [account] not provided return will include all transactions to all accounts. (version 0.3.24-beta) | N |
| getreceivedbyaddress | [GameCreditsaddress] [minconf=1] | Returns the total amount received by | N |
| gettransaction | [txid] | Returns an object about the given transaction containing:
|
N |
| getwork | [data] | If [data] is not specified, returns formatted hash data to work on:
If [data] is specified, tries to solve the block and returns true if it was successful. |
N |
| help | [command] | List commands, or get help for a command. | N |
| importprivkey | [GameCreditsprivkey] [label] | Adds a private key (as returned by dumpprivkey) to your wallet. | Y |
| keypoolrefill | Fills the keypool, requires wallet passphrase to be set. | Y | |
| listaccounts | [minconf=1] | Returns Object that has account names as keys, account balances as values. | N |
| listreceivedbyaccount | [minconf=1] [includeempty=false] | Returns an array of objects containing:
|
N |
| listreceivedbyaddress | [minconf=1] [includeempty=false] | Returns an array of objects containing:
To get a list of accounts on the system, execute GameCreditsd listreceivedbyaddress 0 true |
N |
| listsinceblock | [blockhash] [target-confirmations] | Get all transactions in blocks since block [blockhash], or all transactions if omitted. | N |
| listtransactions | [account] [count=10] [from=0] | Returns up to [count] most recent transactions skipping the first [from] transactions for account [account]. If [account] not provided will return recent transaction from all accounts. | N |
| move | [fromaccount] [toaccount] [amount] [minconf=1] [comment] | Move from one account in your wallet to another | N |
| sendfrom | [fromaccount] [toGameCreditsaddress] [amount] [minconf=1] [comment] [comment-to] | Y | |
| sendmany | [fromaccount] [address:amount,...] [minconf=1] [comment] | amounts are double-precision floating point numbers | Y |
| sendtoaddress | [GameCreditsaddress] [amount] [comment] [comment-to] | Y | |
| setaccount | [GameCreditsaddress] [account] | Sets the account associated with the given address. Assigning address that is already assigned to the same account will create a new address associated with that account. | N |
| setgenerate | [generate] [genproclimit] | [generate] is true or false to turn generation on or off.
Generation is limited to [genproclimit] processors, -1 is unlimited. |
N |
| signmessage | [GameCreditsaddress] [message] | Sign a message with the private key of an address. | Y |
| settxfee | [amount] | [amount] is a real and is rounded to the nearest 0.00000001 | N |
| stop | Stop GameCredits server. | N | |
| validateaddress | [GameCreditsaddress] | Return information about [GameCreditsaddress]. | N |
| verifymessage | [GameCreditsaddress] [signature] [message] | Verify a signed message. | N |
| walletlock | Removes the wallet encryption key from memory, locking the wallet. After calling this method, you will need to call walletpassphrase again before being able to call any methods which require the wallet to be unlocked. | N | |
| walletpassphrase | [passphrase] [timeout] | Stores the wallet decryption key in memory for | N |
| walletpassphrasechange | [oldpassphrase] [newpassphrase] | Changes the wallet passphrase from | N |