{"id":29560905,"url":"https://github.com/decred/decred-php-api","last_synced_at":"2025-10-10T14:06:52.819Z","repository":{"id":56964586,"uuid":"124564330","full_name":"decred/decred-php-api","owner":"decred","description":"PHP API for the Decred Cryptocurrency","archived":false,"fork":false,"pushed_at":"2020-02-16T14:21:52.000Z","size":46,"stargazers_count":9,"open_issues_count":4,"forks_count":7,"subscribers_count":6,"default_branch":"master","last_synced_at":"2025-07-18T18:29:37.726Z","etag":null,"topics":["api","bitcoin","decred","php","wallet"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/decred.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2018-03-09T16:17:38.000Z","updated_at":"2021-08-20T13:34:41.000Z","dependencies_parsed_at":"2022-08-21T05:40:29.090Z","dependency_job_id":null,"html_url":"https://github.com/decred/decred-php-api","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/decred/decred-php-api","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdecred-php-api","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdecred-php-api/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdecred-php-api/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdecred-php-api/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/decred","download_url":"https://codeload.github.com/decred/decred-php-api/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/decred%2Fdecred-php-api/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":279004186,"owners_count":26083688,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-10T02:00:06.843Z","response_time":62,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","bitcoin","decred","php","wallet"],"created_at":"2025-07-18T15:39:19.567Z","updated_at":"2025-10-10T14:06:52.789Z","avatar_url":"https://github.com/decred.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Decred PHP API\n\n[![Build Status](https://github.com/decred/decred-php-api/workflows/Build%20and%20Test/badge.svg)](https://github.com/decred/decred-php-api/actions)\n[![ISC License](https://img.shields.io/badge/license-ISC-blue.svg)](http://copyfree.org)\n\u003c!--[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/decred/decred-php-api/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/decred/decred-php-api/?branch=master)--\u003e\n\u003c!--[![Code Coverage](https://scrutinizer-ci.com/g/decred/decred-php-api/badges/coverage.png?b=master)](https://scrutinizer-ci.com/g/decred/decred-php-api/?branch=master)--\u003e\n\nPHP API for the [Decred](https://decred.org) Cryptocurrency\n\n## Installation\n\nAdd composer package to your project\n```bash\ncomposer require decred/decred-php-api\n```\n\nMake sure [GMP PHP extesion](https://www.php.net/manual/en/book.gmp.php) is installed. In ubuntu:\n```bash\nsudo apt install php7.0-gmp\n```\n\n### From repository\n\nYou also can clone git package with\n```bash\ngit clone https://github.com/decred/decred-php-api.git\n```\n\nBut still you will need to fetch library dependencies with [composer](https://getcomposer.org/doc/00-intro.md).\n```bash\ncomposer install --no-dev\n```\n\nDon't forget to include composer autoloader.\n```php\ninclude __DIR__.'/../vendor/autoload.php';\n```\n\n## Usage examples\n\nLibrary have wide functionality, so you could find usage examples in `examples` library or looking into PHPUnit tests.\n\n### Generating seed\n\nFirst of all we need to get Network intance to start working with library.\n\n```php\n$testnet = \\Decred\\TestNet::instance();\n```\n\nAnd mainnet accordingly\n```php\n$mainnet = \\Decred\\MainNet::instance();\n```\n\nNow lets generate a seed, that will be also verified for usage on testnet.\nDefaut account and branch address will be derivded to verify the seed.\n\n```php\n$seed = \\Decred\\Crypto\\ExtendedKey::generateSeed($testnet);\n```\n\n### HD Wallets\n\nWhen we have usable seed we can create HD master key.\n\n```php\n$master = \\Decred\\Crypto\\ExtendedKey::newMaster($seed, $testnet);\n```\n\n`newMaster` method will return `ExtendedKey` object, that have variant API for working with HD wallets.\n\n#### `ExtendedKey::privateChildKey($index)`\n\nDerives HD private child key from parent HD private key, returns `ExtendedKey` object.\n\n#### `ExtendedKey::hardenedChildKey($index)`\n\nDerives HD hardened child key from parent HD private key, returns `ExtendedKey` object.\n\nCan't be dervied from HD public key.\n\n#### `ExtendedKey::publicChildKey($index)`\n\nDerives HD public child key from parent HD private or public key, returns `ExtendedKey` object.\n\n#### `ExtendedKey::neuter`\n\nVerify that extended key is public, returns `ExtendedKey` object.\n\n### Default account\n\nUsing this basic methods we can derive default account HD private and public keys accourding to [BIP44](https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki).\n\nHD path (m\\44'\\42'\\0')\n\n```php\n$defaultAccountPrivateKey = $master\n    -\u003ehardenedChildKey(44)\n    -\u003ehardenedChildKey(42)\n    -\u003ehardenedChildKey(0);\n\n$defaultAccountPublicKey = $master-\u003eneuter();\n```\n\n`ExtendedKey` implements `__toString()` method, so you can easily get Base58 representation of HD key.\n\n```php\necho sprintf(\"Default account HD private key: %s\\n\", $defaultAccountPrivateKey);\necho sprintf(\"Default account HD public key: %s\\n\", $defaultAccountPublicKey);\n```\n\nFrom default account we can derive 0 branch and 0 index and the get default address.\n\n```php\n$defaultAddress = $defaultAccountPublicKey\n    -\u003epublicChildKey(0)\n    -\u003epublicChildKey(0)\n    -\u003egetAddress();\n\necho sprintf(\"Default address: %s\\n\", $defaultAddress);\n```\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecred%2Fdecred-php-api","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdecred%2Fdecred-php-api","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdecred%2Fdecred-php-api/lists"}