{"id":371,"date":"2020-09-29T22:06:56","date_gmt":"2020-09-29T22:06:56","guid":{"rendered":"http:\/\/bitcoinsv-io.bitproton.com\/?post_type=miner_document&#038;p=371"},"modified":"2020-09-29T19:30:53","modified_gmt":"2020-09-29T19:30:53","slug":"mapi","status":"publish","type":"miner_document","link":"https:\/\/bitcoinsv.io\/documentation\/miners\/installation\/mapi\/","title":{"rendered":"mAPI"},"content":{"rendered":"\n<p>The following instructions describe installing mAPI using tools available in most mainstream Linux distributions. We assume you use a Bourne-like shell such as&nbsp;<code>bash<\/code>.<\/p>\n\n\n\n<p>The BRFC (Bitcoin request for comment) specification can be found&nbsp;<a href=\"https:\/\/github.com\/bitcoin-sv-specs\/brfc-merchantapi\">h<\/a><a href=\"https:\/\/github.com\/bitcoin-sv-specs\/brfc-merchantapi\" target=\"_blank\" rel=\"noreferrer noopener\">ere<\/a>.<\/p>\n\n\n\n<p>The open source code of the reference implementation can be found&nbsp;<a href=\"https:\/\/github.com\/bitcoin-sv\/merchantapi-reference\" target=\"_blank\" rel=\"noreferrer noopener\">here<\/a>.<\/p>\n\n\n\n<h2 id=\"markdown-header-support\">Support<\/h2>\n\n\n\n<p>For support and general discussion of both standard and reference implementations please join the following&nbsp;<a href=\"https:\/\/t.me\/joinchat\/JB6ZzktqwaiJX_5lzQpQIA\" target=\"_blank\" rel=\"noreferrer noopener\">telegram group<\/a>.<\/p>\n\n\n\n<h2 id=\"markdown-header-configuration\">Configuration<\/h2>\n\n\n\n<p>mAPI configuration relies on a&nbsp;<a href=\"https:\/\/github.com\/bitcoin-sv\/merchantapi-reference\/blob\/master\/settings.conf\" target=\"_blank\" rel=\"noreferrer noopener\">settings.conf<\/a>&nbsp;file for the main service configurations as well as one or more fees*.json files (ex.&nbsp;<a href=\"https:\/\/github.com\/bitcoin-sv\/merchantapi-reference\/blob\/master\/fees.json\" target=\"_blank\" rel=\"noreferrer noopener\">fees.json<\/a>&nbsp;for default fees,&nbsp;<a href=\"https:\/\/github.com\/bitcoin-sv\/merchantapi-reference\/blob\/master\/fees_low.json\" target=\"_blank\" rel=\"noreferrer noopener\">fees_low.json<\/a>&nbsp;for lower fees, fees_user1.json for user1, etc.) to specify fees to be charged.<\/p>\n\n\n\n<blockquote class=\"wp-block-quote\"><p>In order to sign responses, you will also need to run\u00a0<a href=\"https:\/\/github.com\/bitcoin-sv\/minerid-reference\" target=\"_blank\" rel=\"noreferrer noopener\">Miner ID<\/a>\u00a0and provide the endpoint to mAPI in the settings configurations.<\/p><\/blockquote>\n\n\n\n<p>All settings can be overwritten with environment variables<\/p>\n\n\n\n<h3 id=\"markdown-header-settingsconf-file\">settings.conf File<\/h3>\n\n\n\n<p>Open&nbsp;<a href=\"https:\/\/github.com\/bitcoin-sv\/merchantapi-reference\/blob\/master\/settings.conf\" target=\"_blank\" rel=\"noreferrer noopener\">settings.conf<\/a>&nbsp;and edit it with your settings:<\/p>\n\n\n\n<ul><li>change&nbsp;<code>httpAddress<\/code>&nbsp;or&nbsp;<code>httpsAddress<\/code>&nbsp;to bind on specific interfaces<\/li><li>change&nbsp;<code>jwtKey<\/code>&nbsp;for tokens Generate new JWT key:<\/li><\/ul>\n\n\n\n<p><code>console $ node -e \"console.log(require('crypto').randomBytes(32).toString('hex'));\"<\/code><\/p>\n\n\n\n<ul><li>change&nbsp;<code>quoteExpiryMinutes<\/code>&nbsp;to set feeQuote expiry time<\/li><li>change count of Bitcoin nodes that mAPI is connected to as well as their respective Bitcoin RPC parameters:<\/li><li><code>bitcoin_count<\/code><\/li><li><code>bitcoin_1_host<\/code><\/li><li><code>bitcoin_1_port<\/code><\/li><li><code>bitcoin_1_username<\/code><\/li><li><code>bitcoin_1_password<\/code><\/li><li>change&nbsp;<code>minerId_URL<\/code>&nbsp;and&nbsp;<code>minerId_alias<\/code>&nbsp;to set URL alias of Miner ID<\/li><\/ul>\n\n\n\n<h3 id=\"markdown-header-feesjson-files\">fees*.json Files<\/h3>\n\n\n\n<p>Please see the\u00a0<a href=\"https:\/\/github.com\/bitcoin-sv-specs\/brfc-misc\/tree\/master\/feespec\" target=\"_blank\" rel=\"noreferrer noopener\">Fee Spec BRFC<\/a>\u00a0for the fees JSON format.<\/p>\n\n\n\n<h2 id=\"markdown-header-build-from-source\">Build from source<\/h2>\n\n\n\n<p>Make sure you have\u00a0<a href=\"https:\/\/golang.org\/\" target=\"_blank\" rel=\"noreferrer noopener\">Golang<\/a>\u00a0installed on your machine and the clone the repo<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">git clone git@github.com:bitcoin-sv\/merchantapi-reference.git\n<\/pre>\n\n\n\n<h3 id=\"markdown-header-run\">Run<\/h3>\n\n\n\n<pre class=\"wp-block-preformatted\">$ .\/run.sh\n<\/pre>\n\n\n\n<h3 id=\"markdown-header-build\">Build<\/h3>\n\n\n\n<pre class=\"wp-block-preformatted\">$ .\/build.sh\n<\/pre>\n\n\n\n<h3 id=\"markdown-header-test\">Test<\/h3>\n\n\n\n<p>Run individual tests or run all tests with:<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">$ go test .\/...\n<\/pre>\n\n\n\n<h2 id=\"markdown-header-docker\">Docker<\/h2>\n\n\n\n<h3 id=\"markdown-header-build-image\">Build Image<\/h3>\n\n\n\n<p>You can build the image yourself with your own modifications or own configurations.<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">$ docker build . -t mapi_reference:1.1.0\n<\/pre>\n\n\n\n<h3 id=\"markdown-header-pull-image\">Pull Image<\/h3>\n\n\n\n<p>You can also pull it from the public Docker Hub repository for mAPI\u00a0<a href=\"https:\/\/hub.docker.com\/r\/bitcoinsv\/mapi\" target=\"_blank\" rel=\"noreferrer noopener\">here<\/a>.<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">$ docker pull bitcoinsv\/mapi:1.1.0\n<\/pre>\n\n\n\n<h3 id=\"markdown-header-run-container\">Run Container<\/h3>\n\n\n\n<p>Example configuration:<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">$ docker run -p 9004:9004 \\\n    -e httpAddress<strong>=<\/strong>:9004 \\\n    -e bitcoin_1_host<strong>=<\/strong>host.docker.internal \\\n    -e minerId_URL<strong>=<\/strong>http:\/\/host.docker.internal:9002\/minerid \\\n    -e minerId_alias<strong>=<\/strong>testMiner \\\n    bitcoinsv\/mapi:1.1.0\n<\/pre>\n\n\n\n<p>Example running in daemon mode:<\/p>\n\n\n\n<pre class=\"wp-block-preformatted\">$ docker run -p 9004:9004 \\\n    -e httpAddress<strong>=<\/strong>:9004 \\\n    -e bitcoin_1_host<strong>=<\/strong>host.docker.internal \\\n    -e minerId_URL<strong>=<\/strong>http:\/\/host.docker.internal:9002\/minerid \\\n    -e minerId_alias<strong>=<\/strong>testMiner \\\n    --restart<strong>=<\/strong>always -d \\\n    bitcoinsv\/mapi:1.1.0\n<\/pre>\n\n\n\n<blockquote class=\"wp-block-quote\"><p><strong>Note:<\/strong>&nbsp;The&nbsp;<code>settings.conf<\/code>&nbsp;configurations will get overwritten with the above environment variables.<\/p><\/blockquote>\n","protected":false},"parent":365,"menu_order":0,"template":"","meta":[],"tags":[],"minerdoc_category":[6],"lang":"en","translations":{"zh":4539,"en":371},"yoast_head":"<!-- This site is optimized with the Yoast SEO plugin v15.0 - https:\/\/yoast.com\/wordpress\/plugins\/seo\/ -->\n<title>mAPI - Bitcoin SV<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/stag.bitcoinsv.io\/documentation\/miners\/installation\/mapi\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"mAPI - Bitcoin SV\" \/>\n<meta property=\"og:description\" content=\"The following instructions describe installing mAPI using tools available in most mainstream Linux distributions. We assume you use a Bourne-like shell such as&nbsp;bash. The BRFC (Bitcoin request for comment) specification can be found&nbsp;here. The open source code of the reference implementation can be found&nbsp;here. Support For support and general discussion of both standard and reference [&hellip;]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/stag.bitcoinsv.io\/documentation\/miners\/installation\/mapi\/\" \/>\n<meta property=\"og:site_name\" content=\"Bitcoin SV\" \/>\n<meta property=\"article:modified_time\" content=\"2020-09-29T19:30:53+00:00\" \/>\n<meta property=\"og:image\" content=\"https:\/\/bitcoinsv.io\/wp-content\/uploads\/2020\/09\/bitcoin-sv-bsv-mines-world-record-128mb-blocks.jpg\" \/>\n\t<meta property=\"og:image:width\" content=\"1234\" \/>\n\t<meta property=\"og:image:height\" content=\"616\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:creator\" content=\"@BitcoinSVNode\" \/>\n<meta name=\"twitter:site\" content=\"@BitcoinSVNode\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\/\/schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https:\/\/bitcoinsv.io\/#organization\",\"name\":\"Bitcoin SV\",\"url\":\"https:\/\/bitcoinsv.io\/\",\"sameAs\":[\"https:\/\/twitter.com\/BitcoinSVNode\"],\"logo\":{\"@type\":\"ImageObject\",\"@id\":\"https:\/\/bitcoinsv.io\/#logo\",\"inLanguage\":\"en-US\",\"url\":\"https:\/\/bitcoinsv.io\/wp-content\/uploads\/2020\/10\/bsv-logo-wh-medium.png\",\"width\":800,\"height\":144,\"caption\":\"Bitcoin SV\"},\"image\":{\"@id\":\"https:\/\/bitcoinsv.io\/#logo\"}},{\"@type\":\"WebSite\",\"@id\":\"https:\/\/bitcoinsv.io\/#website\",\"url\":\"https:\/\/bitcoinsv.io\/\",\"name\":\"Bitcoin SV\",\"description\":\"Just another WordPress site\",\"publisher\":{\"@id\":\"https:\/\/bitcoinsv.io\/#organization\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":\"https:\/\/bitcoinsv.io\/?s={search_term_string}\",\"query-input\":\"required name=search_term_string\"}],\"inLanguage\":\"en-US\"},{\"@type\":\"WebPage\",\"@id\":\"https:\/\/stag.bitcoinsv.io\/documentation\/miners\/installation\/mapi\/#webpage\",\"url\":\"https:\/\/stag.bitcoinsv.io\/documentation\/miners\/installation\/mapi\/\",\"name\":\"mAPI - Bitcoin SV\",\"isPartOf\":{\"@id\":\"https:\/\/bitcoinsv.io\/#website\"},\"datePublished\":\"2020-09-29T22:06:56+00:00\",\"dateModified\":\"2020-09-29T19:30:53+00:00\",\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\/\/stag.bitcoinsv.io\/documentation\/miners\/installation\/mapi\/\"]}]}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","pll_sync_post":[],"_links":{"self":[{"href":"https:\/\/bitcoinsv.io\/wp-json\/wp\/v2\/miner_document\/371"}],"collection":[{"href":"https:\/\/bitcoinsv.io\/wp-json\/wp\/v2\/miner_document"}],"about":[{"href":"https:\/\/bitcoinsv.io\/wp-json\/wp\/v2\/types\/miner_document"}],"version-history":[{"count":2,"href":"https:\/\/bitcoinsv.io\/wp-json\/wp\/v2\/miner_document\/371\/revisions"}],"predecessor-version":[{"id":4424,"href":"https:\/\/bitcoinsv.io\/wp-json\/wp\/v2\/miner_document\/371\/revisions\/4424"}],"up":[{"embeddable":true,"href":"https:\/\/bitcoinsv.io\/wp-json\/wp\/v2\/miner_document\/365"}],"wp:attachment":[{"href":"https:\/\/bitcoinsv.io\/wp-json\/wp\/v2\/media?parent=371"}],"wp:term":[{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/bitcoinsv.io\/wp-json\/wp\/v2\/tags?post=371"},{"taxonomy":"minerdoc_category","embeddable":true,"href":"https:\/\/bitcoinsv.io\/wp-json\/wp\/v2\/minerdoc_category?post=371"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}