diff --git a/404.html b/404.html index 4b9783d7c9..c4022610dd 100644 --- a/404.html +++ b/404.html @@ -9,13 +9,13 @@ - + -

404

There's nothing here.
+ - + diff --git a/API/Greenfield/Plugins/index.html b/API/Greenfield/Plugins/index.html new file mode 100644 index 0000000000..8075a8c93f --- /dev/null +++ b/API/Greenfield/Plugins/index.html @@ -0,0 +1,23 @@ + + + + BTCPay Greenfield API (Plugins) + + + + + + + + + + + + diff --git a/API/Greenfield/Plugins/swagger.json b/API/Greenfield/Plugins/swagger.json new file mode 100644 index 0000000000..1946f8f1d3 --- /dev/null +++ b/API/Greenfield/Plugins/swagger.json @@ -0,0 +1,862 @@ +{ + "openapi": "3.0.0", + "info": { + "title": "BTCPay Server Greenfield Plugin API", + "version": "Plugins", + "description": "Plugin APIs for BTCPay Server", + "contact": { + "name": "BTCPay Server", + "url": "https://btcpayserver.org" + }, + "license": { + "name": "MIT", + "url": "https://github.com/btcpayserver/btcpayserver/blob/master/LICENSE" + } + }, + "servers": [ + { + "url": "/", + "description": "BTCPay Server Greenfield API" + }, + { + "url": "/", + "description": "BTCPay Server Greenfield Plugin API" + } + ], + "components": { + "schemas": { + "ValidationProblemDetails": { + "type": "array", + "description": "An array of validation errors of the request", + "items": { + "type": "object", + "description": "A specific validation error on a json property", + "properties": { + "path": { + "type": "string", + "nullable": false, + "description": "The json path of the property which failed validation" + }, + "message": { + "type": "string", + "nullable": false, + "description": "User friendly error message about the validation" + } + } + } + }, + "ProblemDetails": { + "type": "object", + "description": "Description of an error happening during processing of the request", + "properties": { + "code": { + "type": "string", + "nullable": false, + "description": "An error code describing the error" + }, + "message": { + "type": "string", + "nullable": false, + "description": "User friendly error message about the error" + } + } + }, + "UnixTimestamp": { + "type": "number", + "format": "int32", + "example": 1592312018, + "description": "A unix timestamp in seconds" + }, + "SpeedPolicy": { + "type": "string", + "description": "This is a risk mitigation parameter for the merchant to configure how they want to fulfill orders depending on the number of block confirmations for the transaction made by the consumer on the selected cryptocurrency.\n`\"HighSpeed\"`: 0 confirmations (1 confirmation if RBF enabled in transaction) \n`\"MediumSpeed\"`: 1 confirmation \n`\"LowMediumSpeed\"`: 2 confirmations \n`\"LowSpeed\"`: 6 confirmations\n", + "x-enumNames": [ + "HighSpeed", + "LowMediumSpeed", + "LowSpeed", + "MediumSpeed" + ], + "enum": [ + "HighSpeed", + "LowMediumSpeed", + "LowSpeed", + "MediumSpeed" + ] + }, + "CheckoutType": { + "type": "string", + "description": "`\"V1\"`: The original checkout form \n`\"V2\"`: The new experimental checkout form", + "nullable": true, + "default": "V1", + "x-enumNames": [ + "V1", + "V2" + ], + "enum": [ + "V1", + "V2" + ] + }, + "TimeSpan": { + "type": "number", + "format": "int32", + "example": 90 + }, + "TimeSpanSeconds": { + "allOf": [ + { + "$ref": "#/components/schemas/TimeSpan" + } + ], + "format": "seconds", + "description": "A span of times in seconds" + }, + "TimeSpanMinutes": { + "allOf": [ + { + "$ref": "#/components/schemas/TimeSpan" + } + ], + "format": "minutes", + "description": "A span of times in minutes" + }, + "PaymentMethodId": { + "type": "string", + "description": "Payment method IDs are a combination of crypto code and payment type. Available payment method IDs for Bitcoin are: \n- `\"BTC-OnChain\"` (with the equivalent of `\"BTC\"`) \n-`\"BTC-LightningLike\"`: Any supported LN-based payment method (Lightning or LNURL) \n- `\"BTC-LightningNetwork\"`: Lightning \n- `\"BTC-LNURLPAY\"`: LNURL \n \nNote: Separator can be either `-` or `_`." + }, + "LNbankEditWalletRequest": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the wallet" + } + } + }, + "LNbankReceiveRequest": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "The description of the transaction", + "nullable": true + }, + "attachDescription": { + "type": "boolean", + "description": "Whether or not the description should be attached to the Lightning invoice", + "nullable": true, + "default": false + }, + "amount": { + "type": "string", + "description": "Amount wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" + }, + "privateRouteHints": { + "type": "boolean", + "nullable": true, + "description": "True if the invoice should include private route hints. If null, it falls back to the wallet's default." + }, + "expiry": { + "description": "Expiration time in minutes", + "allOf": [ + { + "$ref": "#/components/schemas/TimeSpanMinutes" + } + ] + } + } + }, + "LNbankSendRequest": { + "type": "object", + "properties": { + "destination": { + "type": "string", + "description": "The destination of the transaction: Payment Request, LNURL or Lightning Address" + }, + "description": { + "type": "string", + "nullable": true, + "description": "The internal description of the transaction" + }, + "comment": { + "type": "string", + "nullable": true, + "description": "The LNURL comment if the destination is a LNURL" + }, + "explicitAmount": { + "type": "string", + "nullable": true, + "description": "If the invoice amount is unspecified, explicit amount is required. Value wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" + } + } + }, + "LNbankWalletDataList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LNbankWalletData" + } + }, + "LNbankWalletData": { + "type": "object", + "x-abstract": true, + "additionalProperties": false, + "properties": { + "id": { + "type": "string", + "description": "The id of the wallet", + "nullable": false + }, + "name": { + "type": "string", + "description": "The name of the wallet" + }, + "createdAt": { + "description": "The creation time of the wallet", + "allOf": [ + { + "$ref": "#/components/schemas/UnixTimestamp" + } + ] + }, + "balance": { + "type": "string", + "description": "Amount wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" + }, + "accessKey": { + "type": "string", + "description": "The access key for the wallet" + }, + "lnurlPayBech32": { + "type": "string", + "description": "Bech32 representation of LNURL for pay requests", + "example": "lnurl1dp68gup69uhnzv3h9cczuvpwxyarzdp3xsez7ctsdyhhvvf0d3hxyctwdvhkcmn4wfkz7v3kxccr2dekxyknsctyxgkngveexyknsv33vykngvr9v5unjv3evfnrwde0wpshj5c6cpv" + }, + "lnurlPayUri": { + "type": "string", + "description": "URI representation of LNURL for pay requests", + "example": "lnurlp://example.com/api/v1/lnbank/lnurl/26605761-8ad2-4391-821a-40ee9929bf77/pay" + }, + "lightningAddressIdentifier": { + "type": "string", + "description": "The Lightning Address username part before the '@' sign", + "example": "willy" + } + } + }, + "LNbankTransactionDataList": { + "type": "array", + "items": { + "$ref": "#/components/schemas/LNbankTransactionData" + } + }, + "LNbankTransactionData": { + "type": "object", + "x-abstract": true, + "additionalProperties": false, + "properties": { + "id": { + "type": "string", + "description": "The id of the transaction", + "nullable": false + }, + "walletId": { + "type": "string", + "description": "The id of the wallet", + "nullable": false + }, + "invoiceId": { + "type": "string", + "description": "The id of the associated Lightning invoice", + "nullable": true + }, + "withdrawConfigId": { + "type": "string", + "description": "The id of the withdraw configuration used for this transaction", + "nullable": true + }, + "description": { + "type": "string", + "description": "The description of the transaction" + }, + "status": { + "type": "string", + "description": "The status of the transaction" + }, + "paymentRequest": { + "type": "string", + "description": "The payment request of the transaction" + }, + "paymentHash": { + "type": "string", + "description": "The payment hash of the transaction" + }, + "preimage": { + "type": "string", + "description": "The preimage of the transaction", + "nullable": true + }, + "amount": { + "type": "string", + "description": "Amount wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" + }, + "amountSettled": { + "type": "string", + "description": "Settled amount wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" + }, + "routingFee": { + "type": "string", + "description": "Routing fee wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" + }, + "createdAt": { + "description": "The creation time of the transaction", + "allOf": [ + { + "$ref": "#/components/schemas/UnixTimestamp" + } + ] + }, + "expiresAt": { + "description": "The expiration time of the transaction", + "allOf": [ + { + "$ref": "#/components/schemas/UnixTimestamp" + } + ] + }, + "paidAt": { + "description": "The payment time of the transaction", + "allOf": [ + { + "$ref": "#/components/schemas/UnixTimestamp" + } + ] + } + } + } + }, + "securitySchemes": { + "API_Key": { + "type": "apiKey", + "description": "BTCPay Server supports authenticating and authorizing users through an API Key that is generated by them. Send the API Key as a header value to Authorization with the format: `token {token}`. For a smoother experience, you can generate a url that redirects users to an API key creation screen.\n\n The following permissions are available to the context of the user creating the API Key:\n\n* `unrestricted`: Unrestricted access\n* `btcpay.user.candeleteuser`: Delete user\n* `btcpay.user.canviewprofile`: View your profile\n* `btcpay.user.canmodifyprofile`: Manage your profile\n* `btcpay.user.canmanagenotificationsforuser`: Manage your notifications\n* `btcpay.user.canviewnotificationsforuser`: View your notifications\n\nThe following permissions are available if the user is an administrator:\n\n* `btcpay.server.canviewusers`: View users\n* `btcpay.server.cancreateuser`: Create new users\n* `btcpay.server.canmanageusers`: Manage users\n* `btcpay.server.canmodifyserversettings`: Manage your server\n* `btcpay.server.canuseinternallightningnode`: Use the internal lightning node\n* `btcpay.server.canviewlightninginvoiceinternalnode`: View invoices from internal lightning node\n* `btcpay.server.cancreatelightninginvoiceinternalnode`: Create invoices with internal lightning node\n\nThe following permissions applies to all stores of the user, you can limit to a specific store with the following format: `btcpay.store.cancreateinvoice:6HSHAEU4iYWtjxtyRs9KyPjM9GAQp8kw2T9VWbGG1FnZ`:\n\n* `btcpay.store.canmodifystoresettings`: Modify your stores\n* `btcpay.store.canviewcustodianaccounts`: View exchange accounts linked to your stores\n* `btcpay.store.canmanagecustodianaccounts`: Manage exchange accounts linked to your stores\n* `btcpay.store.candeposittocustodianaccount`: Deposit funds to exchange accounts linked to your stores\n* `btcpay.store.canwithdrawfromcustodianaccount`: Withdraw funds from exchange accounts to your store\n* `btcpay.store.cantradecustodianaccount`: Trade funds on your store's exchange accounts\n* `btcpay.store.webhooks.canmodifywebhooks`: Modify stores webhooks\n* `btcpay.store.canviewstoresettings`: View your stores\n* `btcpay.store.cancreateinvoice`: Create an invoice\n* `btcpay.store.canviewinvoices`: View invoices\n* `btcpay.store.canmodifyinvoices`: Modify invoices\n* `btcpay.store.canmodifypaymentrequests`: Modify your payment requests\n* `btcpay.store.canviewpaymentrequests`: View your payment requests\n* `btcpay.store.canmanagepullpayments`: Manage your pull payments\n* `btcpay.store.canarchivepullpayments`: Archive your pull payments\n* `btcpay.store.cancreatepullpayments`: Create pull payments\n* `btcpay.store.cancreatenonapprovedpullpayments`: Create non-approved pull payments\n* `btcpay.store.canuselightningnode`: Use the lightning nodes associated with your stores\n* `btcpay.store.canviewlightninginvoice`: View the lightning invoices associated with your stores\n* `btcpay.store.cancreatelightninginvoice`: Create invoices from the lightning nodes associated with your stores\n\nNote that API Keys only limits permission of a user and can never expand it. If an API Key has the permission `btcpay.server.canmodifyserversettings` but that the user account creating this API Key is not administrator, the API Key will not be able to modify the server settings.\nSome permissions may include other permissions, see [this operation](#operation/permissionsMetadata).\n", + "name": "Authorization", + "in": "header" + }, + "Basic": { + "type": "http", + "description": "BTCPay Server supports authenticating and authorizing users through the Basic HTTP authentication scheme. Send the user and password encoded in base64 with the format `Basic {base64(username:password)}`. Using this authentication method implicitly provides you with the `unrestricted` permission", + "scheme": "Basic" + }, + "LNbank_Access_Key": { + "type": "http", + "scheme": "bearer", + "description": "LNbank supports authenticating and authorizing users through an Access Key that is generated by them in the LNbank wallet settings. Send the API Key as a header value to Authorization with the format: `Bearer {token}`.\n\n The following permissions are available to the context of the user creating the API Key:\n\n* `btcpay.plugin.lnbank.canviewwallet`: Simple reading access\n* `btcpay.plugin.lnbank.cancreateinvoices`: Invoices can be created, but not paid\n* `btcpay.plugin.lnbank.cansendmoney`: The user can send money from the wallet\n* `btcpay.plugin.lnbank.canmanagewallet`: Manage the wallet and send money\n* `btcpay.plugin.lnbank.canmanagelnbank`: Admin users can manage the LNbank instance\n" + } + } + }, + "security": [ + { + "API_Key": [], + "Basic": [] + }, + { + "LNbank_Access_Key": [] + } + ], + "externalDocs": { + "description": "BTCPay Greenfield API (v1)", + "url": "https://docs.btcpayserver.org/API/Greenfield/v1/" + }, + "paths": { + "/api/v1/lnbank/wallets": { + "get": { + "tags": [ + "LNbank" + ], + "summary": "Get wallets", + "description": "View information about the available wallets", + "operationId": "LNbankWallets_GetWallets", + "responses": { + "200": { + "description": "List of wallets", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankWalletDataList" + } + } + } + } + }, + "security": [ + { + "API_Key": [ + "btcpay.user.canmodifyprofile" + ] + } + ] + }, + "post": { + "tags": [ + "LNbank" + ], + "summary": "Create a new wallet", + "description": "Create a new wallet", + "operationId": "LNbankWallets_CreateWallet", + "requestBody": { + "x-name": "request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankEditWalletRequest" + } + } + }, + "required": true, + "x-position": 1 + }, + "responses": { + "200": { + "description": "Information about the new wallet", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankWalletData" + } + } + } + }, + "400": { + "description": "A list of errors that occurred when creating the wallet", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "403": { + "description": "If you are authenticated but forbidden to add new wallets" + } + }, + "security": [ + { + "API_Key": [ + "btcpay.user.canmodifyprofile" + ] + } + ] + } + }, + "/api/v1/lnbank/wallets/{walletId}": { + "get": { + "tags": [ + "LNbank" + ], + "summary": "Get wallet", + "parameters": [ + { + "name": "walletId", + "in": "path", + "required": true, + "description": "The wallet to fetch", + "schema": { + "type": "string" + } + } + ], + "description": "View information about the specified wallet", + "operationId": "LNbankWallets_GetWallet", + "responses": { + "200": { + "description": "Specified wallet", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankWalletData" + } + } + } + }, + "403": { + "description": "If you are authenticated but forbidden to view the specified wallet" + }, + "404": { + "description": "The key is not found for this wallet" + } + }, + "security": [ + { + "LNbank_Access_Key": [ + "btcpay.plugin.lnbank.canviewwallet" + ] + } + ] + }, + "put": { + "tags": [ + "LNbank" + ], + "summary": "Update wallet", + "parameters": [ + { + "name": "walletId", + "in": "path", + "required": true, + "description": "The wallet to update", + "schema": { + "type": "string" + } + } + ], + "description": "Update the specified wallet", + "requestBody": { + "x-name": "request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankEditWalletRequest" + } + } + }, + "required": true, + "x-position": 1 + }, + "operationId": "LNbankWallets_UpdateWallet", + "responses": { + "200": { + "description": "Updated specified wallet", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankWalletData" + } + } + } + }, + "400": { + "description": "A list of errors that occurred when updating the wallet", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "403": { + "description": "If you are authenticated but forbidden to update the specified wallet" + }, + "404": { + "description": "The key is not found for this wallet" + } + }, + "security": [ + { + "LNbank_Access_Key": [ + "btcpay.plugin.lnbank.canmanagewallet" + ] + } + ] + }, + "delete": { + "tags": [ + "LNbank" + ], + "summary": "Remove wallet", + "description": "Removes the specified wallet.", + "parameters": [ + { + "name": "walletId", + "in": "path", + "required": true, + "description": "The wallet to remove", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "The wallet has been removed" + }, + "400": { + "description": "A list of errors that occurred when removing the wallet", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "403": { + "description": "If you are authenticated but forbidden to remove the specified wallet" + }, + "404": { + "description": "The key is not found for this wallet" + } + }, + "security": [ + { + "LNbank_Access_Key": [ + "btcpay.plugin.lnbank.canmanagewallet" + ] + } + ] + } + }, + "/api/v1/lnbank/wallets/{walletId}/receive": { + "post": { + "tags": [ + "LNbank" + ], + "summary": "Receive to wallet", + "parameters": [ + { + "name": "walletId", + "in": "path", + "required": true, + "description": "The receiving wallet", + "schema": { + "type": "string" + } + } + ], + "description": "Create an invoice for the specified wallet", + "requestBody": { + "x-name": "request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankReceiveRequest" + } + } + }, + "required": true, + "x-position": 1 + }, + "operationId": "LNbankWallets_Receive", + "responses": { + "200": { + "description": "Invoice created", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankTransactionData" + } + } + } + }, + "400": { + "description": "A list of errors that occurred when creating the invoice", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "403": { + "description": "If you are authenticated but forbidden to create an invoice for the specified wallet" + }, + "404": { + "description": "The key is not found for this wallet" + } + }, + "security": [ + { + "LNbank_Access_Key": [ + "btcpay.plugin.lnbank.cancreateinvoices" + ] + } + ] + } + }, + "/api/v1/lnbank/wallets/{walletId}/send": { + "post": { + "tags": [ + "LNbank" + ], + "summary": "Send from wallet", + "parameters": [ + { + "name": "walletId", + "in": "path", + "required": true, + "description": "The sending wallet", + "schema": { + "type": "string" + } + } + ], + "description": "Pay destination (Payment Request, LNURL or Lightning Address) from the specified wallet", + "requestBody": { + "x-name": "request", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankSendRequest" + } + } + }, + "required": true, + "x-position": 1 + }, + "operationId": "LNbankWallets_Send", + "responses": { + "200": { + "description": "Payment settled", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankTransactionData" + } + } + } + }, + "201": { + "description": "Payment sent, but in progress", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankTransactionData" + } + } + } + }, + "400": { + "description": "A list of errors that occurred when paying the destination", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/ValidationProblemDetails" + } + } + } + }, + "403": { + "description": "If you are authenticated but forbidden to send money from the specified wallet" + }, + "404": { + "description": "The key is not found for this wallet" + } + }, + "security": [ + { + "LNbank_Access_Key": [ + "btcpay.plugin.lnbank.cansendmoney" + ] + } + ] + } + }, + "/api/v1/lnbank/wallets/{walletId}/transactions": { + "get": { + "tags": [ + "LNbank" + ], + "summary": "Get transactions", + "description": "View information about the wallet transactions", + "operationId": "LNbankTransactions_GetTransactions", + "parameters": [ + { + "name": "walletId", + "in": "path", + "required": true, + "description": "The wallet to fetch", + "schema": { + "type": "string" + } + } + ], + "responses": { + "200": { + "description": "List of transactions", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankTransactionDataList" + } + } + } + }, + "403": { + "description": "If you are authenticated but forbidden to view the specified wallet" + }, + "404": { + "description": "The key is not found for this wallet or transaction" + } + }, + "security": [ + { + "LNbank_Access_Key": [ + "btcpay.plugin.lnbank.canviewwallet" + ] + } + ] + } + }, + "/api/v1/lnbank/wallets/{walletId}/transactions/{transactionId}": { + "get": { + "tags": [ + "LNbank" + ], + "summary": "Get transaction", + "parameters": [ + { + "name": "transactionId", + "in": "path", + "required": true, + "description": "The transaction to fetch", + "schema": { + "type": "string" + } + }, + { + "name": "walletId", + "in": "path", + "required": true, + "description": "The wallet to fetch", + "schema": { + "type": "string" + } + } + ], + "description": "View information about the specified transaction", + "operationId": "LNbankTransactions_GetTransaction", + "responses": { + "200": { + "description": "Specified transaction", + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/LNbankTransactionData" + } + } + } + }, + "403": { + "description": "If you are authenticated but forbidden to view the specified wallet or transaction" + }, + "404": { + "description": "The key is not found for this wallet or transaction" + } + }, + "security": [ + { + "LNbank_Access_Key": [ + "btcpay.plugin.lnbank.canviewwallet" + ] + } + ] + } + } + }, + "tags": [ + { + "name": "LNbank" + } + ] +} diff --git a/API/Greenfield/v1/index.html b/API/Greenfield/v1/index.html index 7eaabea892..4e2c478ddb 100644 --- a/API/Greenfield/v1/index.html +++ b/API/Greenfield/v1/index.html @@ -6,7 +6,6 @@ - diff --git a/API/Greenfield/v1/swagger.json b/API/Greenfield/v1/swagger.json index 17e576d95e..091e7800a7 100644 --- a/API/Greenfield/v1/swagger.json +++ b/API/Greenfield/v1/swagger.json @@ -4090,492 +4090,6 @@ ] } }, - "/api/v1/lnbank/wallets": { - "get": { - "tags": [ - "LNbank" - ], - "summary": "Get wallets", - "description": "View information about the available wallets", - "operationId": "LNbankWallets_GetWallets", - "responses": { - "200": { - "description": "List of wallets", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankWalletDataList" - } - } - } - } - }, - "security": [ - { - "API_Key": [ - "btcpay.user.canmodifyprofile" - ] - } - ] - }, - "post": { - "tags": [ - "LNbank" - ], - "summary": "Create a new wallet", - "description": "Create a new wallet", - "operationId": "LNbankWallets_CreateWallet", - "requestBody": { - "x-name": "request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankEditWalletRequest" - } - } - }, - "required": true, - "x-position": 1 - }, - "responses": { - "200": { - "description": "Information about the new wallet", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankWalletData" - } - } - } - }, - "400": { - "description": "A list of errors that occurred when creating the wallet", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "403": { - "description": "If you are authenticated but forbidden to add new wallets" - } - }, - "security": [ - { - "API_Key": [ - "btcpay.user.canmodifyprofile" - ] - } - ] - } - }, - "/api/v1/lnbank/wallets/{walletId}": { - "get": { - "tags": [ - "LNbank" - ], - "summary": "Get wallet", - "parameters": [ - { - "name": "walletId", - "in": "path", - "required": true, - "description": "The wallet to fetch", - "schema": { - "type": "string" - } - } - ], - "description": "View information about the specified wallet", - "operationId": "LNbankWallets_GetWallet", - "responses": { - "200": { - "description": "Specified wallet", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankWalletData" - } - } - } - }, - "403": { - "description": "If you are authenticated but forbidden to view the specified wallet" - }, - "404": { - "description": "The key is not found for this wallet" - } - }, - "security": [ - { - "LNbank_Access_Key": [ - "btcpay.plugin.lnbank.canviewwallet" - ] - } - ] - }, - "put": { - "tags": [ - "LNbank" - ], - "summary": "Update wallet", - "parameters": [ - { - "name": "walletId", - "in": "path", - "required": true, - "description": "The wallet to update", - "schema": { - "type": "string" - } - } - ], - "description": "Update the specified wallet", - "requestBody": { - "x-name": "request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankEditWalletRequest" - } - } - }, - "required": true, - "x-position": 1 - }, - "operationId": "LNbankWallets_UpdateWallet", - "responses": { - "200": { - "description": "Updated specified wallet", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankWalletData" - } - } - } - }, - "400": { - "description": "A list of errors that occurred when updating the wallet", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "403": { - "description": "If you are authenticated but forbidden to update the specified wallet" - }, - "404": { - "description": "The key is not found for this wallet" - } - }, - "security": [ - { - "LNbank_Access_Key": [ - "btcpay.plugin.lnbank.canmanagewallet" - ] - } - ] - }, - "delete": { - "tags": [ - "LNbank" - ], - "summary": "Remove wallet", - "description": "Removes the specified wallet.", - "parameters": [ - { - "name": "walletId", - "in": "path", - "required": true, - "description": "The wallet to remove", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "The wallet has been removed" - }, - "400": { - "description": "A list of errors that occurred when removing the wallet", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "403": { - "description": "If you are authenticated but forbidden to remove the specified wallet" - }, - "404": { - "description": "The key is not found for this wallet" - } - }, - "security": [ - { - "LNbank_Access_Key": [ - "btcpay.plugin.lnbank.canmanagewallet" - ] - } - ] - } - }, - "/api/v1/lnbank/wallets/{walletId}/receive": { - "post": { - "tags": [ - "LNbank" - ], - "summary": "Receive to wallet", - "parameters": [ - { - "name": "walletId", - "in": "path", - "required": true, - "description": "The receiving wallet", - "schema": { - "type": "string" - } - } - ], - "description": "Create an invoice for the specified wallet", - "requestBody": { - "x-name": "request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankReceiveRequest" - } - } - }, - "required": true, - "x-position": 1 - }, - "operationId": "LNbankWallets_Receive", - "responses": { - "200": { - "description": "Invoice created", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankTransactionData" - } - } - } - }, - "400": { - "description": "A list of errors that occurred when creating the invoice", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "403": { - "description": "If you are authenticated but forbidden to create an invoice for the specified wallet" - }, - "404": { - "description": "The key is not found for this wallet" - } - }, - "security": [ - { - "LNbank_Access_Key": [ - "btcpay.plugin.lnbank.cancreateinvoices" - ] - } - ] - } - }, - "/api/v1/lnbank/wallets/{walletId}/send": { - "post": { - "tags": [ - "LNbank" - ], - "summary": "Send from wallet", - "parameters": [ - { - "name": "walletId", - "in": "path", - "required": true, - "description": "The sending wallet", - "schema": { - "type": "string" - } - } - ], - "description": "Pay destination (Payment Request, LNURL or Lightning Address) from the specified wallet", - "requestBody": { - "x-name": "request", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankSendRequest" - } - } - }, - "required": true, - "x-position": 1 - }, - "operationId": "LNbankWallets_Send", - "responses": { - "200": { - "description": "Payment settled", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankTransactionData" - } - } - } - }, - "201": { - "description": "Payment sent, but in progress", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankTransactionData" - } - } - } - }, - "400": { - "description": "A list of errors that occurred when paying the destination", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/ValidationProblemDetails" - } - } - } - }, - "403": { - "description": "If you are authenticated but forbidden to send money from the specified wallet" - }, - "404": { - "description": "The key is not found for this wallet" - } - }, - "security": [ - { - "LNbank_Access_Key": [ - "btcpay.plugin.lnbank.cansendmoney" - ] - } - ] - } - }, - "/api/v1/lnbank/wallets/{walletId}/transactions": { - "get": { - "tags": [ - "LNbank" - ], - "summary": "Get transactions", - "description": "View information about the wallet transactions", - "operationId": "LNbankTransactions_GetTransactions", - "parameters": [ - { - "name": "walletId", - "in": "path", - "required": true, - "description": "The wallet to fetch", - "schema": { - "type": "string" - } - } - ], - "responses": { - "200": { - "description": "List of transactions", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankTransactionDataList" - } - } - } - }, - "403": { - "description": "If you are authenticated but forbidden to view the specified wallet" - }, - "404": { - "description": "The key is not found for this wallet or transaction" - } - }, - "security": [ - { - "LNbank_Access_Key": [ - "btcpay.plugin.lnbank.canviewwallet" - ] - } - ] - } - }, - "/api/v1/lnbank/wallets/{walletId}/transactions/{transactionId}": { - "get": { - "tags": [ - "LNbank" - ], - "summary": "Get transaction", - "parameters": [ - { - "name": "transactionId", - "in": "path", - "required": true, - "description": "The transaction to fetch", - "schema": { - "type": "string" - } - }, - { - "name": "walletId", - "in": "path", - "required": true, - "description": "The wallet to fetch", - "schema": { - "type": "string" - } - } - ], - "description": "View information about the specified transaction", - "operationId": "LNbankTransactions_GetTransaction", - "responses": { - "200": { - "description": "Specified transaction", - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/LNbankTransactionData" - } - } - } - }, - "403": { - "description": "If you are authenticated but forbidden to view the specified wallet or transaction" - }, - "404": { - "description": "The key is not found for this wallet or transaction" - } - }, - "security": [ - { - "LNbank_Access_Key": [ - "btcpay.plugin.lnbank.canviewwallet" - ] - } - ] - } - }, "/misc/rate-sources": { "get": { "tags": [ @@ -13396,215 +12910,6 @@ } } }, - "LNbankEditWalletRequest": { - "type": "object", - "properties": { - "name": { - "type": "string", - "description": "The name of the wallet" - } - } - }, - "LNbankReceiveRequest": { - "type": "object", - "properties": { - "description": { - "type": "string", - "description": "The description of the transaction", - "nullable": true - }, - "attachDescription": { - "type": "boolean", - "description": "Whether or not the description should be attached to the Lightning invoice", - "nullable": true, - "default": false - }, - "amount": { - "type": "string", - "description": "Amount wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" - }, - "privateRouteHints": { - "type": "boolean", - "nullable": true, - "description": "True if the invoice should include private route hints. If null, it falls back to the wallet's default." - }, - "expiry": { - "description": "Expiration time in minutes", - "allOf": [ - { - "$ref": "#/components/schemas/TimeSpanMinutes" - } - ] - } - } - }, - "LNbankSendRequest": { - "type": "object", - "properties": { - "destination": { - "type": "string", - "description": "The destination of the transaction: Payment Request, LNURL or Lightning Address" - }, - "description": { - "type": "string", - "nullable": true, - "description": "The internal description of the transaction" - }, - "comment": { - "type": "string", - "nullable": true, - "description": "The LNURL comment if the destination is a LNURL" - }, - "explicitAmount": { - "type": "string", - "nullable": true, - "description": "If the invoice amount is unspecified, explicit amount is required. Value wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" - } - } - }, - "LNbankWalletDataList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LNbankWalletData" - } - }, - "LNbankWalletData": { - "type": "object", - "x-abstract": true, - "additionalProperties": false, - "properties": { - "id": { - "type": "string", - "description": "The id of the wallet", - "nullable": false - }, - "name": { - "type": "string", - "description": "The name of the wallet" - }, - "createdAt": { - "description": "The creation time of the wallet", - "allOf": [ - { - "$ref": "#/components/schemas/UnixTimestamp" - } - ] - }, - "balance": { - "type": "string", - "description": "Amount wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" - }, - "accessKey": { - "type": "string", - "description": "The access key for the wallet" - }, - "lnurlPayBech32": { - "type": "string", - "description": "Bech32 representation of LNURL for pay requests", - "example": "lnurl1dp68gup69uhnzv3h9cczuvpwxyarzdp3xsez7ctsdyhhvvf0d3hxyctwdvhkcmn4wfkz7v3kxccr2dekxyknsctyxgkngveexyknsv33vykngvr9v5unjv3evfnrwde0wpshj5c6cpv" - }, - "lnurlPayUri": { - "type": "string", - "description": "URI representation of LNURL for pay requests", - "example": "lnurlp://example.com/api/v1/lnbank/lnurl/26605761-8ad2-4391-821a-40ee9929bf77/pay" - }, - "lightningAddressIdentifier": { - "type": "string", - "description": "The Lightning Address username part before the '@' sign", - "example": "willy" - } - } - }, - "LNbankTransactionDataList": { - "type": "array", - "items": { - "$ref": "#/components/schemas/LNbankTransactionData" - } - }, - "LNbankTransactionData": { - "type": "object", - "x-abstract": true, - "additionalProperties": false, - "properties": { - "id": { - "type": "string", - "description": "The id of the transaction", - "nullable": false - }, - "walletId": { - "type": "string", - "description": "The id of the wallet", - "nullable": false - }, - "invoiceId": { - "type": "string", - "description": "The id of the associated Lightning invoice", - "nullable": true - }, - "withdrawConfigId": { - "type": "string", - "description": "The id of the withdraw configuration used for this transaction", - "nullable": true - }, - "description": { - "type": "string", - "description": "The description of the transaction" - }, - "status": { - "type": "string", - "description": "The status of the transaction" - }, - "paymentRequest": { - "type": "string", - "description": "The payment request of the transaction" - }, - "paymentHash": { - "type": "string", - "description": "The payment hash of the transaction" - }, - "preimage": { - "type": "string", - "description": "The preimage of the transaction", - "nullable": true - }, - "amount": { - "type": "string", - "description": "Amount wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" - }, - "amountSettled": { - "type": "string", - "description": "Settled amount wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" - }, - "routingFee": { - "type": "string", - "description": "Routing fee wrapped in a string, represented in a millistatoshi string. (1000 millisatoshi = 1 satoshi)" - }, - "createdAt": { - "description": "The creation time of the transaction", - "allOf": [ - { - "$ref": "#/components/schemas/UnixTimestamp" - } - ] - }, - "expiresAt": { - "description": "The expiration time of the transaction", - "allOf": [ - { - "$ref": "#/components/schemas/UnixTimestamp" - } - ] - }, - "paidAt": { - "description": "The payment time of the transaction", - "allOf": [ - { - "$ref": "#/components/schemas/UnixTimestamp" - } - ] - } - } - }, "UpdateNotification": { "type": "object", "additionalProperties": false, @@ -15817,11 +15122,6 @@ "type": "http", "description": "BTCPay Server supports authenticating and authorizing users through the Basic HTTP authentication scheme. Send the user and password encoded in base64 with the format `Basic {base64(username:password)}`. Using this authentication method implicitly provides you with the `unrestricted` permission", "scheme": "Basic" - }, - "LNbank_Access_Key": { - "type": "http", - "scheme": "bearer", - "description": "LNbank supports authenticating and authorizing users through an Access Key that is generated by them in the LNbank wallet settings. Send the API Key as a header value to Authorization with the format: `Bearer {token}`.\n\n The following permissions are available to the context of the user creating the API Key:\n\n* `btcpay.plugin.lnbank.canviewwallet`: Simple reading access\n* `btcpay.plugin.lnbank.cancreateinvoices`: Invoices can be created, but not paid\n* `btcpay.plugin.lnbank.cansendmoney`: The user can send money from the wallet\n* `btcpay.plugin.lnbank.canmanagewallet`: Manage the wallet and send money\n* `btcpay.plugin.lnbank.canmanagelnbank`: Admin users can manage the LNbank instance\n" } } }, @@ -15941,9 +15241,6 @@ { "name": "Webhooks", "description": "Webhook operations" - }, - { - "name": "LNbank" } ], "openapi": "3.0.0", @@ -15970,9 +15267,6 @@ { "API_Key": [], "Basic": [] - }, - { - "LNbank_Access_Key": [] } ], "x-webhooks": { @@ -16277,5 +15571,9 @@ } } } + }, + "externalDocs": { + "description": "BTCPay Greenfield Plugins API", + "url": "https://docs.btcpayserver.org/API/Greenfield/Plugins/" } } diff --git a/AdvancedForms/index.html b/AdvancedForms/index.html index 24868e03ae..981b9b689f 100644 --- a/AdvancedForms/index.html +++ b/AdvancedForms/index.html @@ -9,7 +9,7 @@ - + @@ -151,6 +151,6 @@ →

- + diff --git a/Apps/index.html b/Apps/index.html index 3baa869afb..c6d709e5d2 100644 --- a/Apps/index.html +++ b/Apps/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

- + diff --git a/BTCPayServer/LocalDevSetup/index.html b/BTCPayServer/LocalDevSetup/index.html index ef976996fc..c23a562ae3 100644 --- a/BTCPayServer/LocalDevSetup/index.html +++ b/BTCPayServer/LocalDevSetup/index.html @@ -9,7 +9,7 @@ - + @@ -72,6 +72,6 @@ type=lnd-rest;server=https://127.0.0.1:8084/;macaroonfilepath="local path to admin.macaroon on your computer, without these quotes";allowinsecure=true

Now you can create a lightning invoice on BTCPay Server regtest and make a payment through Polar.

PLEASE NOTE: You may get an exception break in Visual Studio. You must quickly click "Continue" in VS so the invoice is generated. Or, uncheck the box that says, "Break when this exception type is thrown".

# FAQ

# docker-compose up dev failed or tests are not passing, what should I do?

  1. Run docker-compose down --volumes (this will reset your test environment)
  2. Run docker-compose pull (this will ensure you have the latest images)
  3. Run again with docker-compose up dev

# How to run the Altcoin environment?

docker-compose -f docker-compose.altcoins.yml up dev

If you still have issues, try to restart docker.

# How to run the Selenium test with a browser?

Run dotnet user-secrets set RunSeleniumInBrowser true to run tests in browser.

To switch back to headless mode (recommended) you can run dotnet user-secrets remove RunSeleniumInBrowser.

# Session not created: This version of ChromeDriver only supports Chrome version 88

When you run tests for selenium, you may end up with this error. This happen when we update the selenium packages on BTCPay Server while you did not update your chrome version.

If you want to use a older chrome driver on this page (opens new window) then point to it with

dotnet user-secrets set ChromeDriverDirectory "path/to/the/driver/directory"

- + diff --git a/BTCPayServer/Security/index.html b/BTCPayServer/Security/index.html index 663e546e47..7dde3b7277 100644 --- a/BTCPayServer/Security/index.html +++ b/BTCPayServer/Security/index.html @@ -9,7 +9,7 @@ - + @@ -89,6 +89,6 @@ →

- + diff --git a/BTCPayServer/db-migration/index.html b/BTCPayServer/db-migration/index.html index e1139c37cb..254cca38d9 100644 --- a/BTCPayServer/db-migration/index.html +++ b/BTCPayServer/db-migration/index.html @@ -9,7 +9,7 @@ - + @@ -58,6 +58,6 @@ GitHub (opens new window)

# Migration from SQLite and MySQL to Postgres

# Introduction

This document is intended for BTCPay Server integrators such as Raspiblitz, Umbrel, Embassy OS or anybody running BTCPay Server on SQLite or MySql.

If you are a user of an integrated solution, please contact the integrator directly and provide them with the link to this document.

BTCPay Server has for long time supported three different backends:

  1. Postgres
  2. SQLite
  3. MySql

While most of our users are using the Postgres backend, maintaining supports for all those databases has been very challenging, and Postgres is the only one part of our test suite.

As a result, we regret to inform you that we decided to stop the support of MySql and SQLite.

We understand that dropping support might be painful for users and integrators of our product, and we will do our best to provide a migration path.

Please keep us informed if you experience any issues while migrating on our community chat (opens new window).

# Procedure

In order to successfully migrate, you will need to run BTCPay Server 1.7.8 or newer.

As a reminder there are three settings controlling the choice of backend of BTCPay Server which can be controller by command line, environment variable or configuration settings.

Command line argument Environment variable
--postgres BTCPAY_POSTGRES="..."
--mysql BTCPAY_MYSQL="..."
--sqlitefile BTCPAY_SQLITEFILE="blah.db"

If you are currently using mysql or sqlitefile, and you wish to migrate to postgres, you simply need to add the command line argument --postgres or the environment variable BTCPAY_POSTGRES pointing to a fresh postgres database.

It is strongly advised not to create a database in Postgres before performing the migration with BTCPay Server. This is because BTCPay Server will automatically create the necessary database for you. However, if you must create the database manually, please ensure that the C_TYPE and COLLATE settings are both set to C.

Careful: Do not remove the former mysql or sqlitefile setting, you should have both: the postgres setting and the former sqlite/mysql setting

From 1.7.8, BTCPay Server will interprete this and attempt to copy the data from mysql and sqlite into the new postgres database.

Note that once the migration is complete, the old mysql and sqlite settings will simply be ignored.

If the migration fails, you can revert the postgres setting you added, so the next restart will run on the old unsupported database. You can retry a migration by adding the postgres setting again.

# Known issues

- + diff --git a/BTCPayServer/greenfield-authorization/index.html b/BTCPayServer/greenfield-authorization/index.html index 423d7289a8..371d38f4cc 100644 --- a/BTCPayServer/greenfield-authorization/index.html +++ b/BTCPayServer/greenfield-authorization/index.html @@ -9,7 +9,7 @@ - + @@ -68,6 +68,6 @@ →

- + diff --git a/BTCPayServer/greenfield-development/index.html b/BTCPayServer/greenfield-development/index.html index 3dbf61474b..6faf0aa390 100644 --- a/BTCPayServer/greenfield-development/index.html +++ b/BTCPayServer/greenfield-development/index.html @@ -9,7 +9,7 @@ - + @@ -78,6 +78,6 @@ →

- + diff --git a/BTCPayVsOthers/index.html b/BTCPayVsOthers/index.html index 599480129b..513079a953 100644 --- a/BTCPayVsOthers/index.html +++ b/BTCPayVsOthers/index.html @@ -9,7 +9,7 @@ - + @@ -69,6 +69,6 @@ →

- + diff --git a/ColdCardWallet/index.html b/ColdCardWallet/index.html index fbfd49729b..3f89e9a3c0 100644 --- a/ColdCardWallet/index.html +++ b/ColdCardWallet/index.html @@ -9,7 +9,7 @@ - + @@ -58,6 +58,6 @@ GitHub (opens new window)

# Connecting Coldcard Wallet to BTCPay Server

This document shows how to use a Coldcard Wallet with your BTCPay Server.

# Coldcard Wallet Setup

This guide assumes, you have a Coldcard wallet set up. To configure the Coldcard, please see the quick setup guide on manufacturer's website (opens new window).

# Quick Setup

  1. Insert the MicroSD card into the Coldcard wallet.
  2. Go to Advanced > MicroSD Card > Electrum Wallet > Native-Segwit
  3. Insert the MicroSD card back into your PC
  4. In BTCPay Server, Stores > Settings > Setup > Connect an existing wallet > Import wallet file
  5. Choose File > select the wallet file earlier exported from Coldcard.
  6. Click Continue
  7. Confirm the addresses match the ones shown in your BTCPay Server.

The Coldcard is now connected to your BTCPay Server. Payments go directly to Coldcard. The video below shows how to connect your BTCPay store to your Coldcard.

# Spending from BTCPay Server wallet with Coldcard (PSBT)

Once there are some funds in received to your BTCPay Wallet connected to Coldcard, you can spend them by using PSBT (opens new window) (Partially Signed Bitcoin Transactions). This allows completely offline signing of your transactions, without ever having to connect your hardware wallet to the internet.

  1. Wallets > Manage > Send
  2. Fill in destination address and the amount
  3. Click on the Sign with a wallet supporting PSBT button.
  4. You will be redirected to PSBT tab, with pre-filled information, click on the Sign with a wallet supporting PSBT (save as file)
  5. Save the file onto MicroSD card
  6. Insert MicroSD into your Coldcard.
  7. In Coldcard, click on the Ready To Sign
  8. Review the transaction information, and click OK button to sign it.
  9. Transaction will be saved onto MicroSD.
  10. In BTCPay, go to PSBT tab of the wallet and upload the signed PSBT file.
  11. Click Decode
  12. Click Other Actions and select Review
  13. Review your transactions and click Broadcast to broadcast it on the network.

The video below shows how to connect your BTCPay store to your Coldcard.

- + diff --git a/Community/index.html b/Community/index.html index c7d5c0c6f8..5b05e3b3fd 100644 --- a/Community/index.html +++ b/Community/index.html @@ -9,7 +9,7 @@ - + @@ -62,6 +62,6 @@

- + diff --git a/Configurator/index.html b/Configurator/index.html index 52242c0822..9bf083cb63 100644 --- a/Configurator/index.html +++ b/Configurator/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

- + diff --git a/Contribute/Design/index.html b/Contribute/Design/index.html index e5bb24e545..7ff13e89e5 100644 --- a/Contribute/Design/index.html +++ b/Contribute/Design/index.html @@ -9,7 +9,7 @@ - + @@ -67,6 +67,6 @@ →

- + diff --git a/Contribute/Dev/index.html b/Contribute/Dev/index.html index 0d9fde24f7..6740ab02d3 100644 --- a/Contribute/Dev/index.html +++ b/Contribute/Dev/index.html @@ -9,7 +9,7 @@ - + @@ -58,6 +58,6 @@ GitHub (opens new window)

# Coding BTCPay Server

# Why coding matters

By helping the project grow, become more mature, advanced and elaborate, coders working on BTCPay Server are a central component of the project.

If you have coding skills, be it writing or reviewing code, you can contribute to BTCPay Server.

# Where to start

If you're a developer looking to help, but you're not sure where to begin, check the good first issue label (opens new window), which contains small pieces of work that have been specifically flagged as being friendly to new contributors.

Contributors looking to do something a bit more challenging, before opening a pull request, please create an issue (opens new window) or join our community chat (opens new window) to get early feedback, discuss best ways to tackle the problem and to ensure there is no work duplication.

We are actively looking for developers who can take on and resolve GitHub issues and help with development. If you would like to help us, but need some guidance, the #dev channel on Mattermost (opens new window) is the place to ask questions.

# Setup Developer Environment

If you are interested in getting started as a developer or tester of the software behind BTCPay Server, check out the Setup Developer Environment guide that will walk you step by step through every software used in development with BTCPay such as Git, GitBash, Github, Docker, Visual Studio, Postgres, etc. If you have never coded before and you are looking to learn something new, start here.

# Local BTCPay Development

If you already have a developer environment setup you can start with the BTCPay specific Local Development documentation.

# Local BTCPay Testing

Once you have your development environment tools setup and your local BTCPay Server running, view the Local Testing guide. This shows you how to use BTCPay in regtest mode for use in development and for users who want to test new features before they are released.

# Requirements

Software requirements (ie. IDE) can also be found in local development.

# Videos

BTCPay Server development videos can be found here or on the BTCPayServer YouTube (opens new window) channel.

- + diff --git a/Contribute/DevCode/index.html b/Contribute/DevCode/index.html index 9ff3e50a42..cb50553d2a 100644 --- a/Contribute/DevCode/index.html +++ b/Contribute/DevCode/index.html @@ -9,7 +9,7 @@ - + @@ -99,6 +99,6 @@ →

- + diff --git a/Contribute/DevTest/index.html b/Contribute/DevTest/index.html index a4b7cf9102..6fb5cb6a7a 100644 --- a/Contribute/DevTest/index.html +++ b/Contribute/DevTest/index.html @@ -9,7 +9,7 @@ - + @@ -73,6 +73,6 @@ →

- + diff --git a/Contribute/Misc/index.html b/Contribute/Misc/index.html index c0c5171ca0..114abfbee7 100644 --- a/Contribute/Misc/index.html +++ b/Contribute/Misc/index.html @@ -9,7 +9,7 @@ - + @@ -64,6 +64,6 @@

- + diff --git a/Contribute/Translate/index.html b/Contribute/Translate/index.html index f94ea6872a..cac5187b29 100644 --- a/Contribute/Translate/index.html +++ b/Contribute/Translate/index.html @@ -9,7 +9,7 @@ - + @@ -77,6 +77,6 @@ →

- + diff --git a/Contribute/Write/index.html b/Contribute/Write/index.html index dfd93f590e..8ca2700105 100644 --- a/Contribute/Write/index.html +++ b/Contribute/Write/index.html @@ -9,7 +9,7 @@ - + @@ -59,6 +59,6 @@ GitHub (opens new window)

# Documenting BTCPay Server

# Why documentation matters

Documentation is essential to give users of all skill levels concise and clear information about the software and how to use it. BTCPay server has many different use cases and as a result many different kinds of users seeking information from the documentation. Writers contributing to BTCPay Server are as important as any other contributor.

If you have technical knowledge in a certain area, want to help document new features or simply get involved in the BTCPay Server project, documentation is a great place to get started with contributing.

If you have writing skills or if you have a fair knowledge of the English language, then you can contribute to BTCPay Server or review the work of other contributors. Writing contributors can help in a number of places.

# BTCPay Documentation

Documentation work needing to be completed can be found in the open issues page (opens new window) on Github. For information on how to start a documentation task, see the documentation guide.

For documentation guidance or discussion of a new documentation idea, join the #documentation channel on Mattermost (opens new window).

# BTCPay Blog

Another great way to contribute is by writing content for the BTCPay blog. To get started on a blog topic, join the #content creation channel on Mattermost (opens new window).

# Requirements

In order to contribute to BTCPay Server as a writer there are some requirements.

Since most of the documentation done in BTCPay Server is submitted and reviewed through Github, you must have a Github account (opens new window). It's also on Github that you can contribute by reviewing the documentation work done by others (pull requests).

Important note: Contributions explained in this documentation are meant to be done in English only. If you wish to contribute in other languages, see Translations.

# Text Editor

It is recommended to have a Rich-Text editor.

Notepad++ (opens new window) is a decent software and easy to use for the newer contributors.

For more advanced users, Visual Studio Code (VS Code) (opens new window) is a good choice. The Markdown All In One extension in VS Code is also recommended, for visual comfort while editing and the ability to preview Markdown changes. This is helpful for the BTCPay documentation which is written primarily in Markdown.

These are only recommended: If you already use other similar software that you're accustomed to, you are free to continue using them.

# Version Control

To be able to manage your contributions (such as forking repositories, creating and working on branches, making pull requests and issues, etc.) it's recommended you have Github Desktop (opens new window). You can see the step by step guide to making a pull request using Github Desktop here.

- + diff --git a/Contribute/WriteBlog/index.html b/Contribute/WriteBlog/index.html index fd72baa5b5..b30ba16332 100644 --- a/Contribute/WriteBlog/index.html +++ b/Contribute/WriteBlog/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

- + diff --git a/Contribute/WriteDocs/index.html b/Contribute/WriteDocs/index.html index 2a2dff4579..4f1027ba81 100644 --- a/Contribute/WriteDocs/index.html +++ b/Contribute/WriteDocs/index.html @@ -9,7 +9,7 @@ - + @@ -68,6 +68,6 @@ →

- + diff --git a/Contribute/WriteSoftware/index.html b/Contribute/WriteSoftware/index.html index 7784b405a3..5011e1d4e4 100644 --- a/Contribute/WriteSoftware/index.html +++ b/Contribute/WriteSoftware/index.html @@ -9,7 +9,7 @@ - + @@ -70,6 +70,6 @@ →

- + diff --git a/Contribute/index.html b/Contribute/index.html index a3c6dc4438..27babcc460 100644 --- a/Contribute/index.html +++ b/Contribute/index.html @@ -9,7 +9,7 @@ - + @@ -58,6 +58,6 @@ GitHub (opens new window)

# How to contribute to BTCPay Server?

BTCPay Server is built and maintained entirely by volunteer contributors around the internet.

We welcome, appreciate and encourage new contributions.

Depending on your skills and interest, you can help in a number of ways:

Every contribution is important and if you have any questions, feel free to consult our growing community.

- + diff --git a/CreateStore/index.html b/CreateStore/index.html index 2d9260a98c..e84a8a6282 100644 --- a/CreateStore/index.html +++ b/CreateStore/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

- + diff --git a/CreateWallet/index.html b/CreateWallet/index.html index 5300d15f95..7c44a85212 100644 --- a/CreateWallet/index.html +++ b/CreateWallet/index.html @@ -9,7 +9,7 @@ - + @@ -67,6 +67,6 @@ →

- + diff --git a/CustomIntegration/index.html b/CustomIntegration/index.html index ededb82797..8fe2b443c7 100644 --- a/CustomIntegration/index.html +++ b/CustomIntegration/index.html @@ -9,7 +9,7 @@ - + @@ -92,6 +92,6 @@ →

- + diff --git a/Dashboard/index.html b/Dashboard/index.html index 7d115be169..c22c9b9699 100644 --- a/Dashboard/index.html +++ b/Dashboard/index.html @@ -9,7 +9,7 @@ - + @@ -69,6 +69,6 @@ →

- + diff --git a/Deployment/Azure/index.html b/Deployment/Azure/index.html index 85a050ba89..f58e4570ef 100644 --- a/Deployment/Azure/index.html +++ b/Deployment/Azure/index.html @@ -9,7 +9,7 @@ - + @@ -58,6 +58,6 @@ GitHub (opens new window)

# Azure Deployment

This setup is similar to the Docker Deployment, except that the docker-compose is hosted by Microsoft Azure.

# One-click setup

Start by clicking the following button:

Deploy to Azure (opens new window)

You can log into Azure (opens new window) with your Microsoft account.

Final installation steps:

Fill in the remaining options: Azure Resource Config

For advanced users, you can connect via SSH with the information on https://EXAMPLE.MYSITE.com/server/services/ssh, and:

Approximate Cost (unpruned, Bitcoin-only, after Azure $200 free trial): 60 USD per month

After all your nodes have synced and you've confirmed everything works, follow this guide to fine-tune for savings; costs should drop to 30 or 40 USD per month.

Learn more: btcpayserver/btcpayserver-azure (opens new window)

- + diff --git a/Deployment/AzurePennyPinching/index.html b/Deployment/AzurePennyPinching/index.html index dff28a3dfc..a2ebb81258 100644 --- a/Deployment/AzurePennyPinching/index.html +++ b/Deployment/AzurePennyPinching/index.html @@ -9,7 +9,7 @@ - + @@ -92,6 +92,6 @@ →

- + diff --git a/Deployment/Clovyr/index.html b/Deployment/Clovyr/index.html index baf5fe556c..45cac85161 100644 --- a/Deployment/Clovyr/index.html +++ b/Deployment/Clovyr/index.html @@ -9,7 +9,7 @@ - + @@ -71,6 +71,6 @@ →

- + diff --git a/Deployment/DreamlabNetwork/index.html b/Deployment/DreamlabNetwork/index.html index 286d0d058a..ecb93aa605 100644 --- a/Deployment/DreamlabNetwork/index.html +++ b/Deployment/DreamlabNetwork/index.html @@ -9,7 +9,7 @@ - + @@ -86,6 +86,6 @@ →

- + diff --git a/Deployment/DynamicDNS/index.html b/Deployment/DynamicDNS/index.html index 8a4abc3355..43d6ed7d66 100644 --- a/Deployment/DynamicDNS/index.html +++ b/Deployment/DynamicDNS/index.html @@ -9,7 +9,7 @@ - + @@ -71,6 +71,6 @@ →

- + diff --git a/Deployment/GoogleCloud/index.html b/Deployment/GoogleCloud/index.html index 88ef613921..79971f6281 100644 --- a/Deployment/GoogleCloud/index.html +++ b/Deployment/GoogleCloud/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

- + diff --git a/Deployment/Hack0/index.html b/Deployment/Hack0/index.html index 6da7b1fc6e..2bf60c417f 100644 --- a/Deployment/Hack0/index.html +++ b/Deployment/Hack0/index.html @@ -9,7 +9,7 @@ - + @@ -71,6 +71,6 @@ →

- + diff --git a/Deployment/Hardware/index.html b/Deployment/Hardware/index.html index 84b43ce991..f24dbde5d8 100644 --- a/Deployment/Hardware/index.html +++ b/Deployment/Hardware/index.html @@ -9,7 +9,7 @@ - + @@ -58,6 +58,6 @@ GitHub (opens new window)

# Hardware Deployment

Hardware deployment is advised when you want to be in total control of your own infrastructure.

Those are very useful for personal use or for people who wants absolute control over their infrastructure.

The main downside of hardware deployment is that it requires some hardware investment, and higher learning curve. The availability of your server will also probably lower than using a VPS such as LunaNode, as you are more likely to suffer from internet down time or hardware failure.

If you are still not sure whether you need hardware deployment, please see our diagram.

While all hardware deployments are similar to one another, we document step by step the process on three different hardware settings.

You can easily adapt those documentation on the custom hardware you prefer, we support arm32, arm64 and amd64.

Note that those solutions are all based on our docker deployment system.

- + diff --git a/Deployment/HardwareAsAService/index.html b/Deployment/HardwareAsAService/index.html index 94b94be4dc..aea6272dc4 100644 --- a/Deployment/HardwareAsAService/index.html +++ b/Deployment/HardwareAsAService/index.html @@ -9,7 +9,7 @@ - + @@ -70,6 +70,6 @@ →

- + diff --git a/Deployment/LightningInABox/index.html b/Deployment/LightningInABox/index.html index 4bbd9a25a9..1530c45251 100644 --- a/Deployment/LightningInABox/index.html +++ b/Deployment/LightningInABox/index.html @@ -9,7 +9,7 @@ - + @@ -87,6 +87,6 @@ →

- + diff --git a/Deployment/LunaNode/index.html b/Deployment/LunaNode/index.html index 9cf824e535..9f9c2e7a80 100644 --- a/Deployment/LunaNode/index.html +++ b/Deployment/LunaNode/index.html @@ -9,7 +9,7 @@ - + @@ -74,6 +74,6 @@ →

- + diff --git a/Deployment/ManualDeployment/index.html b/Deployment/ManualDeployment/index.html index 160ee73c94..243e6aed3f 100644 --- a/Deployment/ManualDeployment/index.html +++ b/Deployment/ManualDeployment/index.html @@ -9,7 +9,7 @@ - + @@ -112,6 +112,6 @@ →

- + diff --git a/Deployment/ManualDeploymentExtended/index.html b/Deployment/ManualDeploymentExtended/index.html index a0e456c0c2..d9e53a2e70 100644 --- a/Deployment/ManualDeploymentExtended/index.html +++ b/Deployment/ManualDeploymentExtended/index.html @@ -9,7 +9,7 @@ - + @@ -732,6 +732,6 @@

- + diff --git a/Deployment/RaspberryPi4/index.html b/Deployment/RaspberryPi4/index.html index 7c81cc7d1d..39944367bc 100644 --- a/Deployment/RaspberryPi4/index.html +++ b/Deployment/RaspberryPi4/index.html @@ -9,7 +9,7 @@ - + @@ -166,6 +166,6 @@ →

- + diff --git a/Deployment/ReverseProxyToTor/index.html b/Deployment/ReverseProxyToTor/index.html index 9e35a8e2c8..f2657707b4 100644 --- a/Deployment/ReverseProxyToTor/index.html +++ b/Deployment/ReverseProxyToTor/index.html @@ -9,7 +9,7 @@ - + @@ -265,6 +265,6 @@ →

- + diff --git a/Deployment/ReverseSSHtunnel/index.html b/Deployment/ReverseSSHtunnel/index.html index 4bc6f5f445..361a6e02a2 100644 --- a/Deployment/ReverseSSHtunnel/index.html +++ b/Deployment/ReverseSSHtunnel/index.html @@ -9,7 +9,7 @@ - + @@ -109,6 +109,6 @@ →

- + diff --git a/Deployment/ThirdPartyHosting/index.html b/Deployment/ThirdPartyHosting/index.html index 59e8fbe51f..47b925e54a 100644 --- a/Deployment/ThirdPartyHosting/index.html +++ b/Deployment/ThirdPartyHosting/index.html @@ -9,7 +9,7 @@ - + @@ -68,6 +68,6 @@ →

- + diff --git a/Deployment/index.html b/Deployment/index.html index 5e0bd9ec46..add112c40b 100644 --- a/Deployment/index.html +++ b/Deployment/index.html @@ -9,7 +9,7 @@ - + @@ -62,6 +62,6 @@ →

- + diff --git a/Deployment/voltagecloud/index.html b/Deployment/voltagecloud/index.html index 0e6a257b6c..43d57b589c 100644 --- a/Deployment/voltagecloud/index.html +++ b/Deployment/voltagecloud/index.html @@ -9,7 +9,7 @@ - + @@ -90,6 +90,6 @@ →

- + diff --git a/Deployment/webdeployment/index.html b/Deployment/webdeployment/index.html index 26f45052d7..345b8c4050 100644 --- a/Deployment/webdeployment/index.html +++ b/Deployment/webdeployment/index.html @@ -9,7 +9,7 @@ - + @@ -74,6 +74,6 @@ Found a deployment that is missing, and do you want it added or notified us? Join the community chat (opens new window) on Mattermost by downloading Mattermost app (opens new window), or on Telegram (opens new window) and tell us about it. You can also create an issue in the BTCPay server Documents on Github (opens new window).

- + diff --git a/Development/Altcoins/index.html b/Development/Altcoins/index.html index 99e8a97d22..f67e7e1ca9 100644 --- a/Development/Altcoins/index.html +++ b/Development/Altcoins/index.html @@ -9,7 +9,7 @@ - + @@ -70,6 +70,6 @@ →

- + diff --git a/Development/GreenFieldExample-NodeJS/index.html b/Development/GreenFieldExample-NodeJS/index.html index aeb9a8e4a7..cde8a399c2 100644 --- a/Development/GreenFieldExample-NodeJS/index.html +++ b/Development/GreenFieldExample-NodeJS/index.html @@ -9,7 +9,7 @@ - + @@ -173,6 +173,6 @@ →

- + diff --git a/Development/GreenFieldExample/index.html b/Development/GreenFieldExample/index.html index 35215898ce..e380ae9415 100644 --- a/Development/GreenFieldExample/index.html +++ b/Development/GreenFieldExample/index.html @@ -9,7 +9,7 @@ - + @@ -112,6 +112,6 @@ →

- + diff --git a/Development/GreenfieldExample-PHP/index.html b/Development/GreenfieldExample-PHP/index.html index 83137d0bf8..969a3b0866 100644 --- a/Development/GreenfieldExample-PHP/index.html +++ b/Development/GreenfieldExample-PHP/index.html @@ -9,7 +9,7 @@ - + @@ -158,6 +158,6 @@ →

- + diff --git a/Development/InvoiceMetadata/index.html b/Development/InvoiceMetadata/index.html index 7c3524bc56..c58542fddc 100644 --- a/Development/InvoiceMetadata/index.html +++ b/Development/InvoiceMetadata/index.html @@ -9,7 +9,7 @@ - + @@ -132,6 +132,6 @@ →

- + diff --git a/Development/LocalDev/index.html b/Development/LocalDev/index.html index 1ac343fb88..ddd440e44d 100644 --- a/Development/LocalDev/index.html +++ b/Development/LocalDev/index.html @@ -9,7 +9,7 @@ - + @@ -77,6 +77,6 @@ dotnet test -c Altcoins-Debug

# HTTPS support for local development

Some browser security features may require that you use HTTPS to be properly tested.

In this case, use Bitcoin-HTTPS (or Altcoin-HTTPS) launch profile. This will create a self signed certificate for your development purpose.

However, your browser will not trust it, making it difficult to debug.

You can instruct your OS to trust this development time certificate by running:

dotnet dev-certs https --trust
 

# Videos

For more information check out these videos:

and these notes:

- + diff --git a/Development/LocalDevelopment/index.html b/Development/LocalDevelopment/index.html index 7e3aa6a014..b28c7afb32 100644 --- a/Development/LocalDevelopment/index.html +++ b/Development/LocalDevelopment/index.html @@ -9,7 +9,7 @@ - + @@ -98,6 +98,6 @@ →

- + diff --git a/Development/Plugins/index.html b/Development/Plugins/index.html index 9188455649..9a9058f280 100644 --- a/Development/Plugins/index.html +++ b/Development/Plugins/index.html @@ -9,7 +9,7 @@ - + @@ -236,6 +236,6 @@ →

- + diff --git a/Development/TestnetDemo/index.html b/Development/TestnetDemo/index.html index 435b6c3c25..4113b12468 100644 --- a/Development/TestnetDemo/index.html +++ b/Development/TestnetDemo/index.html @@ -9,7 +9,7 @@ - + @@ -63,6 +63,6 @@

- + diff --git a/Development/Theme/index.html b/Development/Theme/index.html index 286691d58c..f0c33eda85 100644 --- a/Development/Theme/index.html +++ b/Development/Theme/index.html @@ -9,7 +9,7 @@ - + @@ -2436,6 +2436,6 @@ →

- + diff --git a/Development/index.html b/Development/index.html index bbcb5b4bd3..0bf49c624c 100644 --- a/Development/index.html +++ b/Development/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

- + diff --git a/Docker/backup-restore/index.html b/Docker/backup-restore/index.html index a0cd56140b..71ae293a09 100644 --- a/Docker/backup-restore/index.html +++ b/Docker/backup-restore/index.html @@ -9,7 +9,7 @@ - + @@ -123,6 +123,6 @@ →

- + diff --git a/Docker/chatwoot/index.html b/Docker/chatwoot/index.html index 73247e7422..67f7a9e962 100644 --- a/Docker/chatwoot/index.html +++ b/Docker/chatwoot/index.html @@ -9,7 +9,7 @@ - + @@ -69,6 +69,6 @@
  1. Wait for BTPay to be online and then create the database for chatwoot
docker exec -ti chatwoot sh -c "export DISABLE_DATABASE_ENVIRONMENT_CHECK=1 && bundle exec rails db:reset"
 
  1. Go to chatwoot website at https://chatwoot.xpayserver.com and set up.
- + diff --git a/Docker/cloudflare-tunnel/index.html b/Docker/cloudflare-tunnel/index.html index ca88abd280..ac37758b7e 100644 --- a/Docker/cloudflare-tunnel/index.html +++ b/Docker/cloudflare-tunnel/index.html @@ -9,7 +9,7 @@ - + @@ -77,6 +77,6 @@ →

- + diff --git a/Docker/fastsync/index.html b/Docker/fastsync/index.html index 7d557758da..d10f73e8d0 100644 --- a/Docker/fastsync/index.html +++ b/Docker/fastsync/index.html @@ -9,7 +9,7 @@ - + @@ -86,6 +86,6 @@ →

- + diff --git a/Docker/fireflyiii/index.html b/Docker/fireflyiii/index.html index 36b1f244fe..056b616b81 100644 --- a/Docker/fireflyiii/index.html +++ b/Docker/fireflyiii/index.html @@ -9,7 +9,7 @@ - + @@ -71,6 +71,6 @@ →

- + diff --git a/Docker/index.html b/Docker/index.html index 990c85b850..391827564d 100644 --- a/Docker/index.html +++ b/Docker/index.html @@ -9,7 +9,7 @@ - + @@ -142,7 +142,7 @@

Or on powershell:

cd docker-compose-generator
 $BTCPAYGEN_DOCKER_IMAGE="btcpayserver/docker-compose-generator:local"
 

Then run ./build.sh or . .\build.ps1. -This will generate your docker-compose in the Generated folder, which you can then run and test.

Note that BTCPayServer developers will not spend excessive time testing your image, so make sure it works.

# Support

Image Version x64 arm32v7 arm64v8 links
btcpayserver/docker-compose-generator latest ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/docker-compose 1.28.6 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/lightning v23.08 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
saubyk/c-lightning-rest 0.10.6 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
shahanafarooqui/rtl 0.14.1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/lnd v0.16.4-beta-1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/bitcoin 25.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/btcpayserver 1.11.6$<BTCPAY_BUILD_CONFIGURATION>? ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/monero 0.18.2.2-4 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
nicolasdorier/nbxplorer 2.3.66 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/letsencrypt-nginx-proxy-companion 1.12.2 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
nginx 1.23.3 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/docker-gen 0.7.8 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/btctransmuter 0.0.59 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/cloudflared 2023.7.3 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/btcpayserver-configurator 0.0.21 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/eps 0.2.2 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/joinmarket 0.9.5 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
nicolasdorier/ndlc-cli 1.0.1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
pihole/pihole 2023.05.2 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/tor 0.4.7.10 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/woocommerce 3.1.0 ✔️ (opens new window) ️❌ ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/postgres 13.10 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
kamigawabul/btglnd latest ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
kamigawabul/docker-bitcoingold 0.15.2 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
acinq/eclair release-0.7.0 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
chekaz/docker-bitcoinplus 2.7.0 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
dalijolijo/docker-bitcore 0.90.9.10 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
btcpayserver/dash 19.2.0 ✔️ (opens new window) ️❌ ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/dogecoin 1.14.6 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
chekaz/docker-feathercoin 0.16.3 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
groestlcoin/lightning v23.05 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
groestlcoin/groestlcoin-lightning-charge version-0.4.22 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
groestlcoin/groestlcoin-spark version-0.2.16 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
groestlcoin/eclair v0.6.0 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
groestlcoin/lnd v0.10.0-grs ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
btcpayserver/groestlcoin 25.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/elements 22.1.1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/litecoin 0.21.2.1-2 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
wakiyamap/docker-monacoin 0.20.2 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
redis 6.2.2-buster ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
bluewalletorganization/lndhub v1.4.1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
jvandrew/btcqbo 0.3.36 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
shesek/bwt 0.2.2-electrum ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
chatwoot/chatwoot v1.7.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
lukechilds/electrumx latest ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
fireflyiii/core latest ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
podcastindexorg/podcasting20-helipad v0.1.10 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
jvandrew/librepatron 0.7.39 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
jvandrew/isso atron.22 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
lightninglabs/lightning-terminal v0.9.2-alpha-path-prefix ✔️ (opens new window) ️❌ ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
mempool/frontend v2.5.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
mempool/backend v2.5.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
mariadb 10.11 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
kukks/nnostr-relay v0.0.17 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
sphinxlightning/sphinx-relay v2.2.9 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
djbooth007/tallycoin_connect v1.8.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
talaia/python-teos latest ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
apotdevin/thunderhub base-v0.13.21 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
lncapital/torq 0.20.3 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
timescale/timescaledb latest-pg14 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
zammad/zammad-docker-compose zammad-postgresql-3.4.0-4 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
memcached 1.5.22-alpine ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
traefik v2.6 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
chekaz/docker-trezarcoin 0.13.0 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
romanornr/docker-viacoin 0.15.2 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)

# FAQ

# How can I modify my environment?

As root, run . btcpay-setup.sh; this will show you the environment variable it is expecting. +This will generate your docker-compose in the Generated folder, which you can then run and test.

Note that BTCPayServer developers will not spend excessive time testing your image, so make sure it works.

# Support

Image Version x64 arm32v7 arm64v8 links
btcpayserver/docker-compose-generator latest ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/docker-compose 1.28.6 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/lightning v23.08 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
saubyk/c-lightning-rest 0.10.6 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
shahanafarooqui/rtl 0.14.1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/lnd v0.16.4-beta-1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/bitcoin 25.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/btcpayserver 1.11.7$<BTCPAY_BUILD_CONFIGURATION>? ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/monero 0.18.3.1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
nicolasdorier/nbxplorer 2.3.66 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/letsencrypt-nginx-proxy-companion 1.12.2 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
nginx 1.23.3 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/docker-gen 0.7.8 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/btctransmuter 0.0.59 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/cloudflared 2023.7.3 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/btcpayserver-configurator 0.0.21 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/eps 0.2.2 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/joinmarket 0.9.5 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
nicolasdorier/ndlc-cli 1.0.1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
pihole/pihole 2023.05.2 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/tor 0.4.7.10 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/woocommerce 3.1.0 ✔️ (opens new window) ️❌ ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/postgres 13.10 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
kamigawabul/btglnd latest ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
kamigawabul/docker-bitcoingold 0.15.2 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
acinq/eclair release-0.7.0 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
chekaz/docker-bitcoinplus 2.7.0 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
dalijolijo/docker-bitcore 0.90.9.10 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
btcpayserver/dash 19.2.0 ✔️ (opens new window) ️❌ ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/dogecoin 1.14.6 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
chekaz/docker-feathercoin 0.16.3 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
groestlcoin/lightning v23.05 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
groestlcoin/groestlcoin-lightning-charge version-0.4.22 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
groestlcoin/groestlcoin-spark version-0.2.16 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
groestlcoin/eclair v0.6.0 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
groestlcoin/lnd v0.10.0-grs ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
btcpayserver/groestlcoin 25.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/elements 22.1.1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
btcpayserver/litecoin 0.21.2.1-2 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
wakiyamap/docker-monacoin 0.20.2 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
redis 6.2.2-buster ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
bluewalletorganization/lndhub v1.4.1 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
jvandrew/btcqbo 0.3.36 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
shesek/bwt 0.2.2-electrum ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
chatwoot/chatwoot v1.7.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
lukechilds/electrumx latest ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
fireflyiii/core latest ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
podcastindexorg/podcasting20-helipad v0.1.10 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
jvandrew/librepatron 0.7.39 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
jvandrew/isso atron.22 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
lightninglabs/lightning-terminal v0.9.2-alpha-path-prefix ✔️ (opens new window) ️❌ ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
mempool/frontend v2.5.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
mempool/backend v2.5.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
mariadb 10.11 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
kukks/nnostr-relay v0.0.17 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
sphinxlightning/sphinx-relay v2.2.9 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
djbooth007/tallycoin_connect v1.8.0 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
talaia/python-teos latest ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
apotdevin/thunderhub base-v0.13.21 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
lncapital/torq 0.20.3 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
timescale/timescaledb latest-pg14 ✔️ (opens new window) ✔️ (opens new window) ✔️ (opens new window) Github (opens new window) - DockerHub (opens new window)
zammad/zammad-docker-compose zammad-postgresql-3.4.0-4 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
memcached 1.5.22-alpine ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
traefik v2.6 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
chekaz/docker-trezarcoin 0.13.0 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)
romanornr/docker-viacoin 0.15.2 ✔️ (opens new window) ️❌ ️❌ Github (opens new window) - DockerHub (opens new window)

# FAQ

# How can I modify my environment?

As root, run . btcpay-setup.sh; this will show you the environment variable it is expecting. For example, if you support btc and ltc already, and want to add btg:

export BTCPAYGEN_CRYPTO3='btg'
 . btcpay-setup.sh -i
 

# I deployed before btcpay-setup.sh existed (before May 17, 2018), can I migrate to this new system?

Yes, run the following commands to update:

sudo su -
@@ -218,6 +218,6 @@
       
       →
     

- + diff --git a/Docker/joinmarket/index.html b/Docker/joinmarket/index.html index e11a5b08d1..191d368170 100644 --- a/Docker/joinmarket/index.html +++ b/Docker/joinmarket/index.html @@ -9,7 +9,7 @@ - + @@ -108,6 +108,6 @@ →

- + diff --git a/Docker/lightning-terminal/index.html b/Docker/lightning-terminal/index.html index 06c2419953..dd939bb197 100644 --- a/Docker/lightning-terminal/index.html +++ b/Docker/lightning-terminal/index.html @@ -9,7 +9,7 @@ - + @@ -75,6 +75,6 @@ →

- + diff --git a/Docker/ndlc/index.html b/Docker/ndlc/index.html index 404e7b4869..65f9c4ce26 100644 --- a/Docker/ndlc/index.html +++ b/Docker/ndlc/index.html @@ -9,7 +9,7 @@ - + @@ -71,6 +71,6 @@ →

- + diff --git a/Docker/pihole/index.html b/Docker/pihole/index.html index cd322e1082..b2bb116bf0 100644 --- a/Docker/pihole/index.html +++ b/Docker/pihole/index.html @@ -9,7 +9,7 @@ - + @@ -76,6 +76,6 @@ →

- + diff --git a/Docker/tallycoin-connect/index.html b/Docker/tallycoin-connect/index.html index 2b804df451..069d0b7546 100644 --- a/Docker/tallycoin-connect/index.html +++ b/Docker/tallycoin-connect/index.html @@ -9,7 +9,7 @@ - + @@ -76,6 +76,6 @@ →

- + diff --git a/Drupal/index.html b/Drupal/index.html index cd906bfbc8..efbefcc9fd 100644 --- a/Drupal/index.html +++ b/Drupal/index.html @@ -9,7 +9,7 @@ - + @@ -69,6 +69,6 @@ →

- + diff --git a/ElectrumPersonalServer/index.html b/ElectrumPersonalServer/index.html index 75e0a7b6b4..713079ed8e 100644 --- a/ElectrumPersonalServer/index.html +++ b/ElectrumPersonalServer/index.html @@ -9,7 +9,7 @@ - + @@ -73,6 +73,6 @@ →

- + diff --git a/ElectrumWallet/index.html b/ElectrumWallet/index.html index 4256781117..8c65aed350 100644 --- a/ElectrumWallet/index.html +++ b/ElectrumWallet/index.html @@ -9,7 +9,7 @@ - + @@ -61,6 +61,6 @@

If you are running a version older than Electrum 4, also enter the following command and press 'enter'

wallet.storage.write()
 
ElectrumWallet

Restart your Electrum and verify that the newly set gap limit is correct by entering in the console:

wallet.gap_limit
 

There's no good answer to how much you should set the gap limit to. Most merchants set 100-200. If you're a big merchants with high transaction volume, you can try with even higher gap limit.

For more details about the Gap Limit, check the FAQ.

Electrum and BTCPay Server are now connected. Any payments received to your BTCPay will be visible in Electrum, where you can further spend them.

- + diff --git a/ElectrumX/index.html b/ElectrumX/index.html index 36fc2244d5..027f24df4d 100644 --- a/ElectrumX/index.html +++ b/ElectrumX/index.html @@ -9,7 +9,7 @@ - + @@ -75,6 +75,6 @@ →

- + diff --git a/FAQ/Altcoin/index.html b/FAQ/Altcoin/index.html index cfa6dc709d..e5a2dabec0 100644 --- a/FAQ/Altcoin/index.html +++ b/FAQ/Altcoin/index.html @@ -9,7 +9,7 @@ - + @@ -71,6 +71,6 @@

- + diff --git a/FAQ/Apps/index.html b/FAQ/Apps/index.html index 7db1b0bf2b..5f3e1f5b73 100644 --- a/FAQ/Apps/index.html +++ b/FAQ/Apps/index.html @@ -9,7 +9,7 @@ - + @@ -180,6 +180,6 @@ →

- + diff --git a/FAQ/Deployment/index.html b/FAQ/Deployment/index.html index ca50743f81..e9580caeb5 100644 --- a/FAQ/Deployment/index.html +++ b/FAQ/Deployment/index.html @@ -9,7 +9,7 @@ - + @@ -286,6 +286,6 @@ →

- + diff --git a/FAQ/General/index.html b/FAQ/General/index.html index acfcb1652f..0b26b1d4de 100644 --- a/FAQ/General/index.html +++ b/FAQ/General/index.html @@ -9,7 +9,7 @@ - + @@ -80,6 +80,6 @@ →

- + diff --git a/FAQ/Integrations/index.html b/FAQ/Integrations/index.html index 8f0e71f00b..47b487f4ab 100644 --- a/FAQ/Integrations/index.html +++ b/FAQ/Integrations/index.html @@ -9,7 +9,7 @@ - + @@ -116,6 +116,6 @@ →

- + diff --git a/FAQ/LightningNetwork/index.html b/FAQ/LightningNetwork/index.html index f2b43e653b..0855109aa0 100644 --- a/FAQ/LightningNetwork/index.html +++ b/FAQ/LightningNetwork/index.html @@ -9,7 +9,7 @@ - + @@ -189,6 +189,6 @@ →

- + diff --git a/FAQ/ServerSettings/index.html b/FAQ/ServerSettings/index.html index c7fd55fdc0..be8f49bc4f 100644 --- a/FAQ/ServerSettings/index.html +++ b/FAQ/ServerSettings/index.html @@ -9,7 +9,7 @@ - + @@ -122,6 +122,6 @@ →

- + diff --git a/FAQ/Stores/index.html b/FAQ/Stores/index.html index 38567c618a..283804e317 100644 --- a/FAQ/Stores/index.html +++ b/FAQ/Stores/index.html @@ -9,7 +9,7 @@ - + @@ -77,6 +77,6 @@ →

- + diff --git a/FAQ/Synchronization/index.html b/FAQ/Synchronization/index.html index 40d30ef2c2..b7a481163e 100644 --- a/FAQ/Synchronization/index.html +++ b/FAQ/Synchronization/index.html @@ -9,7 +9,7 @@ - + @@ -132,6 +132,6 @@ →

- + diff --git a/FAQ/Wallet/index.html b/FAQ/Wallet/index.html index fad96fba86..ba34cf49a6 100644 --- a/FAQ/Wallet/index.html +++ b/FAQ/Wallet/index.html @@ -9,7 +9,7 @@ - + @@ -78,6 +78,6 @@ →

- + diff --git a/FAQ/index.html b/FAQ/index.html index 1fbec43857..da3ed265bf 100644 --- a/FAQ/index.html +++ b/FAQ/index.html @@ -9,7 +9,7 @@ - + @@ -58,6 +58,6 @@ GitHub (opens new window)

# Frequently Asked Questions and Common Issues

This document contains a Table of contents to all FAQ and common issues.

# General FAQ

General, non-technical questions about BTCPay. What it is, how it works, what are its features, why is it different and who can use it.

# Deployment FAQ

Questions and solutions to BTCPay installation.

# General Deployment FAQ

# Web Deployment FAQ

# Luna Node Web Deployment FAQ

# Manual Deployment FAQ

# Synchronization FAQ

Common questions and issues that may occur during the initial sync of BTCPay.

# Integrations FAQ

Questions about e-commerce and other integrations.

# Integrations General

# WooCommerce FAQ

# Server Settings FAQ

Common problems and questions server admins have.

# Maintenance FAQ

# Theme / Customization FAQ

# Policies FAQ

# Services FAQ

# Files FAQ

# Stores FAQ

Store settings explained.

# Wallet FAQ

Here are some of the questions and problems about wallets in BTCPay.

# Apps FAQ

Frequent questions about the applications in BTCPay.

# Lightning Network FAQ

Lightning Network troubleshooting and common problems.

# Lightning Network General FAQ

# Lightning Network LND FAQ

# Lightning Network Core Lightning (CLN) FAQ

# Altcoins FAQ

- + diff --git a/Forms/index.html b/Forms/index.html index 558b1df1dc..5e7c995938 100644 --- a/Forms/index.html +++ b/Forms/index.html @@ -9,7 +9,7 @@ - + @@ -89,6 +89,6 @@ IVPN

If you'd like to support the project, please visit the donation page.

- + diff --git a/Guide/index.html b/Guide/index.html index dd93227210..f3c60db1f2 100644 --- a/Guide/index.html +++ b/Guide/index.html @@ -9,7 +9,7 @@ - + @@ -85,6 +85,6 @@ →

- + diff --git a/HardwareWalletIntegration/index.html b/HardwareWalletIntegration/index.html index 3960a49f7d..293cfa09a2 100644 --- a/HardwareWalletIntegration/index.html +++ b/HardwareWalletIntegration/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

- + diff --git a/Invoices/index.html b/Invoices/index.html index f3baedf6af..1e63aacad9 100644 --- a/Invoices/index.html +++ b/Invoices/index.html @@ -9,7 +9,7 @@ - + @@ -68,6 +68,6 @@ →

- + diff --git a/LNDhubAPI/index.html b/LNDhubAPI/index.html index 8a78893e9c..b122d18e7a 100644 --- a/LNDhubAPI/index.html +++ b/LNDhubAPI/index.html @@ -9,7 +9,7 @@ - + @@ -73,6 +73,6 @@ →

- + diff --git a/LNbank/LNDhub/index.html b/LNbank/LNDhub/index.html index cf9e71c1e2..cf406854a7 100644 --- a/LNbank/LNDhub/index.html +++ b/LNbank/LNDhub/index.html @@ -9,7 +9,7 @@ - + @@ -73,6 +73,6 @@ →

- + diff --git a/LNbank/Troubleshooting/index.html b/LNbank/Troubleshooting/index.html index c0f9655659..5e47785c3c 100644 --- a/LNbank/Troubleshooting/index.html +++ b/LNbank/Troubleshooting/index.html @@ -9,7 +9,7 @@ - + @@ -80,6 +80,6 @@ →

- + diff --git a/LNbank/index.html b/LNbank/index.html index 0cbe15412a..befb0daffa 100644 --- a/LNbank/index.html +++ b/LNbank/index.html @@ -9,7 +9,7 @@ - + @@ -63,6 +63,6 @@ LNbank wallets can be seen as layer 3 sub-accounts.
  • All LNbank accounts use the internal Lightning node and share the Node ID of that node.
  • Channels and liquidity are managed by the server admin.
  • # Caveats

    Users rely on the server admin as the custodian, be aware of that trust relationship. When using LNbank on a third-party instance whose owner you don't know, mitigate the risks by following this advise:

    # Features and Compatibility

    # How to activate and use LNbank

    # Server admin

    # User

    # Support this plugin

    Support this plugin (opens new window)
    - + diff --git a/LedgerWallet/index.html b/LedgerWallet/index.html index 1e7d6d739e..de59e2a0e9 100644 --- a/LedgerWallet/index.html +++ b/LedgerWallet/index.html @@ -9,7 +9,7 @@ - + @@ -59,6 +59,6 @@ GitHub (opens new window)

    # Connecting Ledger Wallet to BTCPay Server

    This document shows how to connect Ledger Nano S Wallet to BTCPay Server.

    WARNING

    Direct Ledger Nano S integration is no longer supported. For Bitcoin wallets, you can use your Ledger hardware wallet regularly via the new hardware wallet integration.

    For altcoin wallets, you can spend funds from your external wallet, sign a transaction within the internal wallet with HD Private Key or mnemonic seed or a hot wallet.

    To set up a new altcoin wallet, add the extended public key manually or create a new wallet.

    # Ledger Nano S Wallet Setup

    This guide assumes, you have a Nano S wallet set up. To configure the Nano S, please see the quick setup guide on manufacturer's website (opens new window).

    # Requirements

    1. Bitcoin App installed on the Ledger
    2. Google Chrome or Firefox
    3. For Firefox, U2F needs to be enabled in about:config
    4. No other U2F devices plugged in into your PC (Yubikey, other wallets, etc)

    # Quick Setup

    1. Plug in Ledger Nano S into your PC.
    2. Open the Bitcoin app on your Ledger.
    3. In BTCPay Server, Store > Settings > Wallet > Setup > Derivation Scheme > Import from Hardware Device > Ledger wallet
    4. Select the account which you want to use, in most cases it's the Account 0
    5. Confirm the Export public key on the wallet.
    6. The extended public key will now automatically be added from Ledger to your BTCPay Server Store.
    7. Make sure that the derivation scheme is Enabled
    8. Click Continue
    9. Confirm the address match in BTCPay.

    Your Ledger wallet is now connected to your BTCPay. Payments go directly to Ledger.

    # Manual Setup

    If you have more than 20 accounts in your Ledger you might not be able to find the correct account because the select shows a maximum of 20 entries. In this case you can manually find the extended public key for your wanted account in these steps:

    1. Open the Ledger live app (opens new window)
    2. Accounts -> choose your account
    3. Edit Account on the top right via the tool-icon
    4. In Edit Account -> ADVANCED LOGS
    5. Copy the extended public key string
    6. Paste it manually into the "DerivationScheme" textfield
    7. Continue with Step 7 of the Quick Setup above
    Ledger Account "Advanced Logs" info screenshot

    # Spending from BTCPay Server wallet with Ledger

    Once there are some funds in received to your BTCPay Wallet connected to Ledger, you can spend them by signing a transaction with your hardware wallet. This allows easy interaction of the Ledger wallet with your full node, without leaking information to third-party servers.

    1. Plug in Ledger Nano S into your PC.
    2. Open the Bitcoin app on your Ledger.
    3. In BTCPay, go to Wallets > Manage > Send
    4. Fill in destination address and the amount
    5. Click on the Sign with your Ledger Wallet device.
    6. BTCPay will establish a connection with the Ledger wallet and display transaction information on the wallet screen.
    7. Confirm the transaction on the Ledger.
    8. In Ledger, click on the Ready To Sign
    9. Review your transactions and click Broadcast to broadcast it on the network.

    The video below shows how to connect your BTCPay store to your Ledger and how to use Ledger with the internal BTCPay wallet.

    - + diff --git a/LightningNetwork/index.html b/LightningNetwork/index.html index d4bbb7faf3..35710c094b 100644 --- a/LightningNetwork/index.html +++ b/LightningNetwork/index.html @@ -9,7 +9,7 @@ - + @@ -109,6 +109,6 @@

    - + diff --git a/LightningNetwork_PaymentChannels/index.html b/LightningNetwork_PaymentChannels/index.html index d72edb5c88..606b64c4b1 100644 --- a/LightningNetwork_PaymentChannels/index.html +++ b/LightningNetwork_PaymentChannels/index.html @@ -9,7 +9,7 @@ - + @@ -58,6 +58,6 @@ GitHub (opens new window)

    # Opening and operating payment channels

    Given that the Lightning Network is a relatively new technology under active development, getting your freshly deployed node ready to send and receive payments, still, requires a couple of steps.

    Overview:

    1. The lightning node is deployed, enabled and its on-chain wallet is funded
    2. A peer is identified and the first payment channel is opened
    3. Inbound and outbound liquidity is acquired. The node is now able to send and receive
    4. Liquidity management, an ongoing process to maintain the capacity to send and receive

    Key considerations:

    • Choosing the channel partner. Consider opening the first channel to a well connected peer with robust uptime. This will increase the chances for your payments to be routed and settled.
    • Inbound vs outbound capacity. Outbound capacity allows nodes to send payments whereas inbound capacity allows nodes to receive payments. As a merchant using lightning, having inbound capacity is essential for customers to be able to pay you.
    • Inbound capacity. A node adds inbound capacity by either spending sats from its local balance or having other nodes in the network open channels to it.
    • Liquidity management: maintaining the ability to send and receive is a continous process where a balance between inbound vs outbound capacity has to be maintained across payment channels. This capacity distribution must be adjusted depending upon the use case of the node operator.
    • Lightning Service Providers: LSPs offer paid third-party services that improve the ease of operating a lightning network node. Such services can be used to acquire inbound capacity or to automate the rebalancing process.

    Below a set of good resources for a deeper dive into topics such as:

    - + diff --git a/Magento/index.html b/Magento/index.html index da05e85a86..c1b530fd12 100644 --- a/Magento/index.html +++ b/Magento/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

    - + diff --git a/NBXplorer/API/index.html b/NBXplorer/API/index.html index 82937cd21d..70d2750168 100644 --- a/NBXplorer/API/index.html +++ b/NBXplorer/API/index.html @@ -9,7 +9,7 @@ - + @@ -263,7 +263,7 @@ ], "version": "1.0.3.5" } -

    instanceName can be configured via configuration's key instancename.

    # Get a new unused address

    HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/addresses/unused

    Error codes:

    Optional parameters:

    Returns:

    {
    +

    instanceName can be configured via configuration's key instancename.

    # Get a new unused address

    HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/addresses/unused

    Error codes:

    Optional parameters:

    Returns:

    {
       "trackedSource": "DERIVATIONSCHEME:tpubD6NzVbkrYhZ4Wo2RMq8Xbnrorf1xnABkKMS3EGshPkQ3Z4N4GN8uyLuDPvnK7Ekc2FHdXbLvcuZny1gPiohMksFGKmaX3APD2DbTeBWj751-[p2sh]",
       "feature": "Deposit",
       "derivationStrategy": "tpubD6NzVbkrYhZ4Wo2RMq8Xbnrorf1xnABkKMS3EGshPkQ3Z4N4GN8uyLuDPvnK7Ekc2FHdXbLvcuZny1gPiohMksFGKmaX3APD2DbTeBWj751-[p2sh]",
    @@ -655,6 +655,6 @@
           
           →
         

    - + diff --git a/NBXplorer/Postgres-Migration/index.html b/NBXplorer/Postgres-Migration/index.html index b7b884064b..ec8a538b6a 100644 --- a/NBXplorer/Postgres-Migration/index.html +++ b/NBXplorer/Postgres-Migration/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

    - + diff --git a/NBXplorer/Postgres-Schema/index.html b/NBXplorer/Postgres-Schema/index.html index 82b3c0b017..fa5c48e2a4 100644 --- a/NBXplorer/Postgres-Schema/index.html +++ b/NBXplorer/Postgres-Schema/index.html @@ -9,7 +9,7 @@ - + @@ -87,6 +87,6 @@ →

    - + diff --git a/NBXplorer/index.html b/NBXplorer/index.html index ef7924d8c3..9aacaa2b09 100644 --- a/NBXplorer/index.html +++ b/NBXplorer/index.html @@ -9,7 +9,7 @@ - + @@ -108,6 +108,6 @@ →

    - + diff --git a/Nostr/index.html b/Nostr/index.html index a6f9cdce2a..8c3d9e0244 100644 --- a/Nostr/index.html +++ b/Nostr/index.html @@ -9,7 +9,7 @@ - + @@ -67,6 +67,6 @@ →

    - + diff --git a/Notifications/index.html b/Notifications/index.html index 702e300514..b8a2864794 100644 --- a/Notifications/index.html +++ b/Notifications/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ {Invoice.Status} {Invoice.OrderId}

    Find the source here for possible updates (opens new window)

    Create new Email rule
    - + diff --git a/OpenCart/index.html b/OpenCart/index.html index 909cc1f91a..96765865b9 100644 --- a/OpenCart/index.html +++ b/OpenCart/index.html @@ -9,7 +9,7 @@ - + @@ -88,6 +88,6 @@ →

    - + diff --git a/Payjoin/index.html b/Payjoin/index.html index 117c536240..437a02a403 100644 --- a/Payjoin/index.html +++ b/Payjoin/index.html @@ -9,7 +9,7 @@ - + @@ -59,6 +59,6 @@ GitHub (opens new window)

    # BTCPay Server Payjoin Guide

    This document explains how to use BTCPay Server's Payjoin feature. For a detailed, technical explanation of how payjoin is implemented, check BIP78 (opens new window)

    You can follow this video to better understand what payjoin is and how to use it.

    # Enabling Payjoin as a merchant

    1. Create a store
    2. Configure a hot wallet for your derivation scheme. Be sure to use either segwit or segwit wrapped as the address type.
    3. Enable Payjoin/P2EP in the "General Settings" and click "Save"

    It's important to note that you will need at least 1 UTXO for payjoin to work.

    Receive PayJoin in BTCPay Server
    Receive PayJoin in BTCPay Server
    Receive PayJoin in BTCPay Server

    # Paying to Payjoin as a user

    The BTCPay Wallet supports Payjoin.

    1. Retrieve the BIP21 payment link from a BTCPay Server invoice which has payjoin enabled by either:
      • Scan the QR code with the camera scanning feature
      • Copy the link from the "Open in wallet" button and paste it in the "Parse BIP21" prompt
    2. The send form should be populated with the payment details. You can check if the invoice supports payjoin by expanding "advanced settings" to see if there is a "Payjoin endpoint" input with a url.
    3. Sign your transaction using either BTCPay Server's hardware wallet support via BTCPay Vault or the hot wallet feature.
    4. Once your original transaction is ready, you will be given the option to either Broadcast (Payjoin) or to Broadcast (Simple). Choose Broadcast (Payjoin).
    5. The payjoin server will propose a new special transaction, if possible. If the payjoin server is unable to do the payjoin, the original transaction is broadcast instead.
    6. If you are using a hardware wallet, you will be asked to sign the payjoin transaction again (the hot wallet feature signs the transaction for you automatically).
    7. Congratulations, you've just helped improve Bitcoin's fungibility and your financial sovereignty!
    Receive PayJoin in BTCPay Server
    Receive PayJoin in BTCPay Server
    Receive PayJoin in BTCPay Server
    Receive PayJoin in BTCPay Server

    # Why did a payjoin not happen?

    There's multiple reasons for this:

    # Supported wallets

    Please contact and encourage your wallet developers to add support. The more widespread the usage of payjoin, the more broken the heuristics used by blockchain analysis companies become and can effectively trace your financial history. If you are a wallet developer, please contact us if you need help or have feedback.

    - + diff --git a/PaymentRequests/index.html b/PaymentRequests/index.html index 32cb412091..63947ef3a4 100644 --- a/PaymentRequests/index.html +++ b/PaymentRequests/index.html @@ -9,7 +9,7 @@ - + @@ -93,6 +93,6 @@ →

    - + diff --git a/Payouts/index.html b/Payouts/index.html index a22f0a8983..b70c4cab1a 100644 --- a/Payouts/index.html +++ b/Payouts/index.html @@ -9,7 +9,7 @@ - + @@ -81,6 +81,6 @@ →

    - + diff --git a/PodServer/index.html b/PodServer/index.html index 47cab05d15..9a04fe9d28 100644 --- a/PodServer/index.html +++ b/PodServer/index.html @@ -9,7 +9,7 @@ - + @@ -68,6 +68,6 @@ →

    - + diff --git a/PrestaShop/index.html b/PrestaShop/index.html index 05eb1cbb21..2fe9ca2a8d 100644 --- a/PrestaShop/index.html +++ b/PrestaShop/index.html @@ -9,7 +9,7 @@ - + @@ -70,6 +70,6 @@ →

    - + diff --git a/PullPayments/index.html b/PullPayments/index.html index 8922ef2bc1..524323dbdd 100644 --- a/PullPayments/index.html +++ b/PullPayments/index.html @@ -9,7 +9,7 @@ - + @@ -100,6 +100,6 @@ 6
  • Clicking on the notification brings the sender to a page listing all outstanding payouts 7
  • Check the payout to approve, pay and confirm 8
  • You are then brought to the normal wallet user interface of BTCPay Server
  • WARNING

    Clicking on Confirm selected payouts will use the current exchange rate of your wallet's store settings. The rate is then fixed, even if you don't complete the payment. Payments made at a later time will use this previously confirmed rate.

    # Additional use cases for the Pull Payments feature

    The Pull Payment feature can be used in multiple applications, the first one being Refunds.

    - + diff --git a/Refund/index.html b/Refund/index.html index 716fbcc2d5..f904f290a3 100644 --- a/Refund/index.html +++ b/Refund/index.html @@ -9,7 +9,7 @@ - + @@ -67,6 +67,6 @@ →

    - + diff --git a/RegisterAccount/index.html b/RegisterAccount/index.html index 6201c25e1c..9fd23320cd 100644 --- a/RegisterAccount/index.html +++ b/RegisterAccount/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

    - + diff --git a/Reporting/index.html b/Reporting/index.html index 25ca222d9b..b0fbec1e30 100644 --- a/Reporting/index.html +++ b/Reporting/index.html @@ -9,7 +9,7 @@ - + @@ -68,6 +68,6 @@ (opens new window)

    - + diff --git a/Shopify/index.html b/Shopify/index.html index b33b28f339..caf4b87e48 100644 --- a/Shopify/index.html +++ b/Shopify/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

    - + diff --git a/Shopware/index.html b/Shopware/index.html index 84c599df74..e946e06c0b 100644 --- a/Shopware/index.html +++ b/Shopware/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

    - + diff --git a/Support/index.html b/Support/index.html index dbb2575d0f..de5caaeda1 100644 --- a/Support/index.html +++ b/Support/index.html @@ -9,7 +9,7 @@ - + @@ -68,6 +68,6 @@ →

    - + diff --git a/TicketTailor/index.html b/TicketTailor/index.html index 2a09f802ac..468ea1969f 100644 --- a/TicketTailor/index.html +++ b/TicketTailor/index.html @@ -9,7 +9,7 @@ - + @@ -69,6 +69,6 @@ →

    - + diff --git a/Transmuter/DCA/index.html b/Transmuter/DCA/index.html index d6a597b188..84ea78350d 100644 --- a/Transmuter/DCA/index.html +++ b/Transmuter/DCA/index.html @@ -9,7 +9,7 @@ - + @@ -73,6 +73,6 @@ →

    - + diff --git a/Transmuter/EmailReceiptsPreset/index.html b/Transmuter/EmailReceiptsPreset/index.html index a9df9c5a95..ad575a037e 100644 --- a/Transmuter/EmailReceiptsPreset/index.html +++ b/Transmuter/EmailReceiptsPreset/index.html @@ -9,7 +9,7 @@ - + @@ -67,6 +67,6 @@ →

    - + diff --git a/Transmuter/index.html b/Transmuter/index.html index dacade909f..bc9247b58d 100644 --- a/Transmuter/index.html +++ b/Transmuter/index.html @@ -9,7 +9,7 @@ - + @@ -67,6 +67,6 @@ There must be a class implementing BtcTransmuterExtension in this library. This file bootstraps the plugin name and adds all the services to system on startup.

    # Adding a Trigger

    # Adding an Action

    # Adding an External Service

    - + diff --git a/Trocador/index.html b/Trocador/index.html index fcde348c98..ca84cdb101 100644 --- a/Trocador/index.html +++ b/Trocador/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

    - + diff --git a/Troubleshooting/index.html b/Troubleshooting/index.html index 6589e8eb1f..acd62614aa 100644 --- a/Troubleshooting/index.html +++ b/Troubleshooting/index.html @@ -9,7 +9,7 @@ - + @@ -98,6 +98,6 @@ →

    - + diff --git a/TryItOut/index.html b/TryItOut/index.html index ef7341a893..21b432668e 100644 --- a/TryItOut/index.html +++ b/TryItOut/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

    - + diff --git a/UseCase/index.html b/UseCase/index.html index 1b34066572..0a71929329 100644 --- a/UseCase/index.html +++ b/UseCase/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

    - + diff --git a/Vault/HowToVerify/index.html b/Vault/HowToVerify/index.html index 87dfb5dbb7..37f3d52862 100644 --- a/Vault/HowToVerify/index.html +++ b/Vault/HowToVerify/index.html @@ -9,7 +9,7 @@ - + @@ -83,6 +83,6 @@ →

    - + diff --git a/VirtueMart/index.html b/VirtueMart/index.html index a5fe86d1ad..5d87575ff1 100644 --- a/VirtueMart/index.html +++ b/VirtueMart/index.html @@ -9,7 +9,7 @@ - + @@ -88,6 +88,6 @@ →

    - + diff --git a/Wabisabi/index.html b/Wabisabi/index.html index 48e42a575b..62c4aa4d6c 100644 --- a/Wabisabi/index.html +++ b/Wabisabi/index.html @@ -9,7 +9,7 @@ - + @@ -88,6 +88,6 @@ →

    - + diff --git a/Walkthrough/index.html b/Walkthrough/index.html index 700743cc18..4655c2ea09 100644 --- a/Walkthrough/index.html +++ b/Walkthrough/index.html @@ -9,7 +9,7 @@ - + @@ -80,6 +80,6 @@ →

    - + diff --git a/Wallet/index.html b/Wallet/index.html index 8406a6ddd9..19651213c8 100644 --- a/Wallet/index.html +++ b/Wallet/index.html @@ -9,7 +9,7 @@ - + @@ -61,6 +61,6 @@ PSBT is supported in BTCPay Server and can be signed with compatible hardware and software wallets.

    The construction of a fully signed Bitcoin transaction goes through the following steps:

    Check this tutorial on how to sign a PSBT transaction with ColdCard Hardware Wallet, completely offline/air-gapped.

    # Signing with a hardware wallet

    BTCPay Server has built-in hardware wallet support allowing you to use your hardware wallet with BTCPay, without leaking information to third-party apps or servers.

    Check instructions on how to set up and sign with a compatible hardware wallet (opens new window).

    # Signing with a hot wallet

    If you created a new wallet when setting up your store and enabled it as a hot wallet, since version 1.2.0, we've added an option that when a hot wallet is created, it'll automatically use the seed stored on a server to sign.

    DANGER

    Using the hot wallet feature comes with security implications; please be sure to read and understand them over at the Hot Wallet documentation

    # Advanced Settings

    Certain wallet features are available for advanced users. Toggle the Advanced Settings within the Send tab to preview them.

    # Don't create UTXO change

    This option is available in the Advanced mode of the Send page.

    It is a privacy enhancing feature which is useful when you're sending funds to another wallet of yours or to an exchange. It makes sure that no change UTXO is created by rounding up the amount sent.

    By default this feature is disabled, so if your wallet has a UTXO of 1.1 BTC and you input an amount equal to 1.0 BTC, the resulting transaction will have two outputs 0.1 BTC of change, and 1.0 BTC to your destination.

    Blockchain analysis will understand that those 0.1 BTC of change belong to the same entity which controlled 1.1 BTC before, and can track the future purchase you make under the same pattern.

    By enabling this feature, BTCPay Server wallet will round up the amount sent to 1.1 BTC such that no change output is sent back to you.

    Warning: Despite the fact, in this example, that you entered 1.0 in the amount field, the amount that will really be sent to your destination will be 1.1 BTC.

    # RBF (Replace-By-Fee)

    Replace-By-Fee (RBF) is a Bitcoin protocol feature that allows you to replace a previously broadcast transaction (while unconfirmed). This allows randomizing your wallet's transaction fingerprint, or simply for replacing it with a higher fee rate to move the transaction higher in the queue of confirmation (mining) priority. This will effectively replace the original transaction as the higher fee rate will be prioritized and once confirmed, invalidating the original one (double spend).

    Press the Advanced Settings button to view the RBF options:

    RBF Options
    # Coin Selection

    Coin selection is an advanced privacy-enhancing feature that allows you to specifically select coins that you would like to spend when crafting a transaction. For example, paying with coins that are fresh from a coinjoin mix.

    To make the selection easier, coin-selection works natively with the wallet labels feature. This allows you to label any incoming funds for smoother UTXO management and spending.

    Coin Selection
    # Other features
    # Camera QR scan

    Scan option in wallet (camera icon in send screen) lets you use your device’s camera to scan a QR code containing an address or BIP21 payment link. It auto-populates the sending information so that you don’t have to manually copy-paste an address and amount.

    QR Scan
    # Paste BIP21 address

    This option decodes a BIP21 payment link. It's useful when you're trying to pay a Payjoin invoice.

    # Receive

    The Receive tab generates an unused address which can be used to receive payments. The same can be achieved by generating an invoice (Invoices > Create new invoice).

    Wallet Receive

    # Pull Payments

    This feature gives you the ability to create a Pull Payment, so that an outside individual may request to pull funds from your wallet.

    For more information, see Pull Payments.

    # Payouts

    This section lets you manage Pull Payments and gives you the ability to accept or decline payouts requested by outside individuals.

    For more information, see Payouts.

    # Re-scan

    The Rescan relies on Bitcoin Core 0.17.0's scantxoutset to scan the current state of the blockchain (called UTXO Set) for coins belonging to the configured derivation scheme.

    Wallet Rescan

    Wallet re-scan solves two critical problems for BTCPay users:

    1. Gap limit
    2. Importing a previously used wallet

    Gap limit: Most wallets typically have the address gap limit set to 20. This means that if a merchant receives 21 or more consecutive unpaid invoices, those wallets show the incorrect balance and some transactions may not be visible.

    Wallet import: When users add a derivation scheme of a wallet that had transactions in the past (previously used wallet), BTCPay won't be able to show the balance and transactions from the past.

    Wallet rescan progress

    Re-scan is a feature that solves both of these problems. Once the scan is complete, BTCPay Server will show the correct balance, along with the past transactions of the wallet.

    Wallet re-scan requires access to the full node which means that this function is only available for server owners.

    Users who use a third-party host should use a newly generated xpub key and also use an external wallet like Electrum which allows them to increase the gap limit.

    # Settings

    In the top right corner of your wallet you will find the wallet settings. In the wallet settings tab you can adjust certain settings. If you've configured your wallet by creating a new wallet or using an existing wallet via the hardware wallet integration these settings will be pre-configured.

    If you manually added the extended public key from an external wallet, you'd need to adjust AccountKeyPath that you can find in your external wallet, for example m/84'/0'/0' to be able to spend from the BTCPay Wallet.

    In wallet settings you will also find the speed policy for the specific store. There are 2 main settings under Payment, Payment invalid if transaction fails to confirm in ... after invoice creation and Consider the invoice confirmed when the payment transaction.... The latter lets you set the number of confirmations required to be recognized as settled.

    Wallet settings
    - + diff --git a/WalletSetup/index.html b/WalletSetup/index.html index 57e59571c3..0bfad170e9 100644 --- a/WalletSetup/index.html +++ b/WalletSetup/index.html @@ -9,7 +9,7 @@ - + @@ -58,6 +58,6 @@ GitHub (opens new window)

    # (3) Wallet Setup

    After account registration and store creation, it's time to configure a wallet in your BTCPay Server, so that you can start receiving payments into it.

    There are two ways to set up a wallet in BTCPay Server:

    There are many options on how set up a wallet with your BTCPay Server. It's up to you to decide what works best for your use-case. Once you configure a wallet, you're all set. The next step, is to start exploring the features.

    Proceed to the next step - What's Next?.

    - + diff --git a/WasabiWallet/index.html b/WasabiWallet/index.html index 1b67ba1066..828ac9e83f 100644 --- a/WasabiWallet/index.html +++ b/WasabiWallet/index.html @@ -9,7 +9,7 @@ - + @@ -67,6 +67,6 @@ After the loading is done and the wallet is opened, click on the 3 dots at the top right corner to go to Wallet Info .

    Wasabi Find Wallet Info

    Select and copy the Extended Account Public Key. This is the public key from which BTCPay will derive addresses. This cannot be used to derive private keys and spend the bitcoin.

    Wasabi Extended Account Public Key

    # Setup store wallet

    1. Assuming you created a store and are now in the Dashboard. Click on Set up a wallet
    Connect Wasabi Wallet to BTCPay Server
    1. As you did the above steps in wasabi, Click Connect an existing wallet
    Connect Wasabi Wallet to BTCPay Server
    1. Choose Enter extended public key
    Connect Wasabi Wallet to BTCPay Server
    1. Paste the Extended Account Public Key into derivation scheme field as it is, without adding anything else and click Continue
    Connect Wasabi Wallet to BTCPay Server
    1. Return to the Wasabi Wallet. Click the Receive button and generate a new address.
    Wasabi Receive
    1. Compare the address you see in Wasabi Wallet to addresses shown in BTCPay Server. Find a match, continue.
    Connect Wasabi Wallet to BTCPay Server
    1. When you found a match, your wallet is now connected to the store.
    Connect Wasabi Wallet to BTCPay Server

    # Connecting Wasabi to BTCPay Server Full Node (If you're self-hosting BTCPay)

    After the wallets are connected, it is highly recommended to connect Wasabi Wallet to your full node in BTCPay. The process is easy but can only be done if you self-host BTCPay and are logged in as Admin. Tor has to be enabled in BTCPay (it is enabled by default). This process enhances privacy even further.

    In BTCPay, go Server Settings > Services > Full node P2P > See Information. On the BTCP-P2P page, click on the Show Confidential QR Code. Bellow the QR Code, there's a link See QR Code information by clicking here, so click on the link to reveal your string. Copy the string but remove bitcoin-p2p:// part.

    In Wasabi, go to the Bitcoin tab at Settings and paste the endpoint in Bitcoin P2P Endpoint.

    Restart Wasabi to apply the changes.

    # Configuring the Gap Limit in Wasabi

    At the search bar on top, click on Wallet Folder. Shortly the json file will be shown in a sub-folder. Open that file with a text editor like notepad. Find the line "MinGapLimit": 21, and change it to "MinGapLimit": 100, and save the file.

    There's no good answer to how much you should set the gap limit to. Most merchants set 100-200. If you're a big merchant with high transaction volume, you can try with even a higher gap limit.

    For more details about the Gap Limit, check the FAQ.

    Wasabi Wallet and BTCPay Server are now connected. Any payments received to your BTCPay will be visible in Wasabi, where you can further spend or mix them.

    - + diff --git a/WhatsNext/index.html b/WhatsNext/index.html index 92f72dd222..8a94189b50 100644 --- a/WhatsNext/index.html +++ b/WhatsNext/index.html @@ -9,7 +9,7 @@ - + @@ -66,6 +66,6 @@ →

    - + diff --git a/WooCommerce/index.html b/WooCommerce/index.html index 36a93ddfd7..5540855d48 100644 --- a/WooCommerce/index.html +++ b/WooCommerce/index.html @@ -9,7 +9,7 @@ - + @@ -116,6 +116,6 @@ →

    - + diff --git a/Zapier/index.html b/Zapier/index.html index 4a7a0582d8..880e2d1192 100644 --- a/Zapier/index.html +++ b/Zapier/index.html @@ -9,7 +9,7 @@ - + @@ -77,6 +77,6 @@ →

    - + diff --git a/assets/js/10.46d80c52.js b/assets/js/10.bfd2aba6.js similarity index 95% rename from assets/js/10.46d80c52.js rename to assets/js/10.bfd2aba6.js index d3ec2ad1e4..93cc54af35 100644 --- a/assets/js/10.46d80c52.js +++ b/assets/js/10.bfd2aba6.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{541:function(A,e,t){A.exports=t.p+"assets/img/FrontPage.616c97f1.png"},542:function(A,e,t){A.exports=t.p+"assets/img/TicketApp.3fcd4bd4.png"},543:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAvYAAABHCAMAAABbNvPrAAABJlBMVEX///+Ee/+l6v//6v9Se///1f8Ap////8+FJYrN///NiSkhJSkhic/qrGdhrOuFJWep5/8Ae/+E1f+FJSn/56xhJYr/zIohY6zq//9hY6zZ2tpVWVwAkP/n///G1f9Svv+lkP+l1f/G///Gp/+VkP/nvv8hiaypYykhJYqniSmFzP///+upY2dhJSmprGeFzM8hJWfNrGdhrKxhrM+lvv+EkP+lp/+FY2dhic/qrIqFic+piaxSkP+Evv+FrKzq/+vNiWfN/+upY4qEp/+FY6whY2dhY2dhJWchiYrNzIqFiWeFiYqpzP/NiYqpzKzNrKxSp/+p5+up589hiYrn1f8hY4rqzIqprIrXrGeFrOshJYGKYynN/8/q/8+prOvG6v9hY4qFY4oOC5SBAAAOD0lEQVR4AezBgQAAAACAoP2pF6kCAAAAAAAAAJj9slyMHIaBsJe7duKrU4aFMjMzvv8z3YyjTXKXMkO0SUxjST8+q+53sVI5M6hUZfRcq9XV663R1/StNsEdq6FNuiJ5voUBn7uD/+m/e0FbVdh3NOLsnCs/hn2OZQeLXol9Y8AYEzwH+8EhNg9iT8mrsR8eGf3J2BdWc2WiHz0X+/rrq72w/Czsx0YfwT4vKbAvbHzCTIzn0a5NtirVtnMdJdZlvzRVdZMt//cgwndaJCnLXOLETKc0OVuGswjv9JxzblrN1bv4lpxrQ4qpeixr5Vlm0Qdw4fzC4tKyWlmwamW1f3DNmGWU7nV8tTEbXjpsMKmX0SGj2mwCRwhHtiybxVSyPTAySg/AEn0TIIQgDV9EmiEQeJk5hIZbBXv6wQyDi9x67MM4R351kqTeWWAOsihR6aywr2UTxpgJ6QvvQn+lWk/v712wvKsAKUmeK6uamyb2qUSwJ+fdSM0Q846q7HW4sN9SM3WQXuYaNHVGAfOU3VHCiRDrZgiAgHPj4JAV+wiDxebgGtZIo15Mqn0Pe4AZjowSSajYwEQCNZmG62X2GwN8l33IY8aTvxCDBxaeVk6wIRDs4YelXqo9Z+ADk/EEv9qmSWqkrAOZ9lFlvyrsS5mh3XED6ZaBNTFlfY4qpy35S0BafZfYiyS525fn6t4FRUR77uy0NReJW64Rd/a5R2RSQoPkbm9JCRki3biYD2/3NYetnAqMSRL7OexjORoiTMAz2MthoY59ebNXIsIZniMq9ok/eRhLyGVoyNEwEZ4ASpMk6RN+LuJpiSq5fgsrqn3M9EyUHAbBfq6DFogL9iIRBRcVzgh5hosuf2V/JAR7qoi9g01Slq/2BIZdAsyLwyV+IJtHYpHYc+k+7LnLepCpX/4XexsP/sOe9xc5VFfX+K2iOmMqwd7ANqW40ynXfAlHNisLHI5cJElqyxAX8bSPJPvVd7Hibi9MyzCDPZvSndhnqj0XbvDutbg5U+3ZwVmg3Y19Wu1J5c7JaLhz3SRp2WrPzt3YcxeBo+7xas9Z+QdYbxzjvf3b3lkwOY4kUXh7ed1w1LHMvN5jZmZmxv//Jy6/qs9WlkLh8Iw1fb67fDEGlbJA9lN2dnW+SQKaydt7jjYX6MjRBt853C9S2ts83WznjgIheN/OkdPeDMT20p4Tjy16++hjbA+f3/pqRPbxgO9vNNr7O268h/7LtMelNlLK0+9F0Pz9L0LzFtvD9s0Q24dddNnT/vYHxPaQzThH2kejsX2iPc/RqN//fkT232/zTrE9w020p13a94iK5mmR0v5Zmzmy/3mjYJQedB5o3yJ8ad+2YZa9vZs88Jn37uVESPMdac95dnLeYJd/kfaGErpnfxHt0cIPu7eP47aTI6cxf/dHe9oTosROjmMk2j/U94IS7Z3rkz/WMBjKdAz/kx3tjXiiLboyNSELv9LyGoOwxTMtUtrbzJH9HygKhUKhUCgUCoVCoVAoFAqFQqFQKBQKhULps3r65kFcfPgEOeGx8I+vgyxEwdWK2Fwd2348zIsmOegBo6CeBEFJPHctCZmScUjjHK15WSol7Y+TGr66aLExc/EU2ot7pz05BcpLyKU0T5Pn1TQjZg0dwB3SvmhPIs3DJkv2vLRIxnl9yT3TDA7Q/nHf3iPtdZW3P/3P0f6qJQXBTJ7ILfsZSc0oWf63aF+Jx9IeHkJ7GSu/yTjG5/dc+od3zU0aGD6fR5YbSvs+Iu2v4/x5eYNRYoTo+Cpi9Qt+oHSVYcJGRqji+/nHWkKXcsLATmT4I84DlXxJM7gzIWvZnLRI4gwm0QsD8tA+mMYwCU66kXYJMzv/1aPsRYcxLCfMtERNaFsYKV803x6pVV7kZ5AvMnM8xcm27ADXGIeugSWbY/egUTITSYqWCtq/JROl/WMw+mHT5xPtkcjySHLDRHvsLx7m5TGkhq8zKKKth6NjM+cIoxFPByEnFV+IUol2k5xwJzLMucEQLWkGNZH2TS37pe+H6m9rLygdZ/MYW95Je+48JueRaf+tJjqkkRGlfVMT2qZ8kXZ+Nvzi2X4RLhKxpDPzQksD1xhjuIZYMmfJqH7QKFGhsf2HVZYglpLfEN67Ig7MR77YpQ/70DbRvgf/MD3a6ZW1KnSA8/Gv2+tvVUV9LKg0qfhgV5ITTiJDGcXzTEWiibSn6f1vfzweu17BOFg6jQGgsrE9hJTJE+0JvpiIA35+SPubRuneNglaek8vwkUynDPL/hSJcdQslOveWZBT3h4CZ28vvwl+eAnO6+Z9ybTHMNO+S8wjgqEnQ2PS7gVpz2gtpiL8GYEwRBWfxElywklkaDykwC9rBjWR9k31+sXbLwYv7RXUDmw9mtLp5TUcnHl71mIKPfyGynva04BmcZvki32tXoT3FE/O3G9Vf0ve3dNTSr93z52gYnvYuhDb45h7DPRLzi/SXrlhoj2uHudu/30nac+AtjNhQueeHJf2ySEqMky0n5R8PjTZ0z4OfrSNx81D9pJSaQxdu3Tj7Ty2N1Dh9Dd/helA+/c/+utYsN7eJXijgj6ajPbQAb1GhLjb5O0Z6w5QyN6esN2dHJnaQp1Xv/PwIu2VG460h+0GSG+12P6NnRyd0ZEXSnu7CP7Xjggo+DfRPskJFRkmTz0p+XxosqM9NI7I/pvxsJd74x45jbF99vZG2H0npzORhTz9my9yKO0VONKW5IubFtuHtbjusb0zY+QC2iRItFxDvGBEY+EuaN/DcZ3vWxzJbwKRFz9HZM4p4xX//wMfyg0H2iPM3cX4mBsqNW9/4QbPi79tbQlGEoYd0j7JCRUZJtonJZ8PTaS9pGMvx17BT8Iij5z0d18wtmdemdkjKKMXRYfwdDunPYyfyReVJMZgLpKdHGeOWZ75vafinvsDtq6hsf9jZ7STUzBmORXcJ//NMHZZqx9EP1sU9P1F++ubVXMZzpr2hTfY3yza337sfv5ce+2+aNG+UCgUCoVCoVAoFAqFQqFQOAFkEJwAJSmnQ1XgaSb3s8/4zB9Pl5McuS1pfsLJo2mAzebq+MnOQEl5BoXAXm0JBwvSJ/WFK8DUyDO6bpPel9nlyTOj/fLnI+3vc7JRSWm2h0rKFZVkvj0v2j+8rPhTX7gKyUhYuf3TGdPe9IH/M9onJaX5d2QEqqQ8f9qfnHjMH1AVCDbFn/mRQy1CBIGv9zTND+fCg0gGe5GrpiC0mOHSd2dFQksM8lm0lHUq+1Gl8M9/0cvEt6SoUI3eVMkwCujE41lMlAbulXjmdm2fjscwldUMsyzwWrfGOTPJbjixUfTHCPMxDggbCbme7iV+bpQKajouUnOgzJE7jK87Lx4rP5J3/0oAE+8RKcbwemGOfJb2e5mjKsYjNZVZSckYKykpmefXTUCJzbZpKf/2pNmAfBM+Y8dKHcCyj5jPZaX2WFNmIu0VCOrtVZykWoToTR43wX4qPKhdNJOmGe253mH2nqkioSUGezkdK/tRpZBzOidFhV2j9w37NXEej5skDUxKPF6ehkswcJiqT/KNlF2fUjP19rEcqxi63tkYh4SN18gLsX/i765c09kiNQ9wIjooEZgt3sqJXWzG1IoUW1dpaFui/VQ0kZ7HaSqTkpJhVlFSpmc/hTZ8p32fZfo+GhzAK1BkOcpKpcm6osLH9wLBifZ67Fktwjc+bOHB1NZoz79c73B3CyfB0KwiYVNpfHBWgQqYOaxGb+zng+6TUNAZ6ORjNpWTKAvsQ0Zfhet72oNraT9f7iFhY7DgD1cO7co1HRepudfYZoj554uXkCyInwF4xZ36INXVsi3RfiqaKFEPayqzklJerqOk9PKdgnET7Xur3wd2wPU6fG+YyUrtsb63VyA49/apFiEvcP7hofDgW/Gm0f71phgcSgElukv/dAlo7faVAZdor6gw9xtpr2JqifbjVE6iLFDat8+a44n22En7cdrDwkaDiSyQGU1d5M5c2kMeeLMdF58qJ1p+UZHiFIbEGLZl2ls9Thodo6nM2hqGWUdJyceCVMKVD96+X5HfB3bpVyuHV3ExykrtsX5sb/wi7Y3ts7eH9kHwf8RTLjyIydzbZ9rLhMF9SrQbP73AMu15Sf0Waa8Sb9nbO5WTTLLAZW+P9ZK3x+CAsJHXH1/ZzZWPpi5Sc6+x/5z49l8Zer74ydv/PMIRaZEr6yb15Uh7rupYTWVWUjr6iUpKwYDeSjNv35fMFNrZ4gyDyDLLSu2xHqS9AkFpH1BfmGsRQvs3vhNvpsKDimKRThnbJ9oLYk12cvYVCeXR7T//9ZRR5jLt1ej9zX6LtFeJN2PObConmWSBLQKex/Z0SLH9OMYhYSMsZE5ie1c+mrpIzQG1FaM1TH8Ss4yLnyoncvR0j3hH2hMeXS3R/llVjEdpKgdvz5LcyTlNSak15/wUlOX3HT3e7b4PL8kB+vB/U2Q5ykrtgcmqtFcgCPU7p9UX5lqE0J5SnrnwIFavu5NDzyXaG0P6O7o84sO+8hzfceNCMDHRXo2e/ZZprxJvxpz5VEySZYEUInTDJNHeKoZWKRzGOChsJMSJB/ZbV67pfJGYy72Pt8G97YfFK2KU9vxKrUjRz6ev21hgTntVjEdqKpOSkuvl6HQlJW+4YWKu/im0t09H42brZ9q+D+1AG8DhFVmOslJ6aFK4V92T7D2nRUKjM1A/nudHdugzKugxj2fe2SxSt7syNld34FHuDgSehQw3ELbHywLPa5Hs1K8KVYx3oKS8I2zOv7p1oVAoFAqFQqFQKBQKhUKhUCgUCoVCofBvZQspYm2wM7AAAAAASUVORK5CYII="},544:function(A,e,t){A.exports=t.p+"assets/img/ExternalService_Setup.9c2a74c4.png"},545:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABAcAAAESCAIAAAAOhSuaAAAZLElEQVR4AezXgQAAAAACoP2lH+SyKIVvAABYAQAAWAEAAGAFAACAFQAAAFYAAABYAQAAYAUAAIAVAAAAVgAAAFgBAABgBQAAgBUAAABWAGPvDDwb2dow/rcUl1wwAQO0LkTRKG0tt+Uj6yK1SCzGXr6VspGSCAZBCEUIQlgxrCpVobJBI2iEVaGSUlLKlHAwzLfpZt40JzmVt5u737h9fgZb2545c96D5znnPeddInflv35f+W30vK3cuf8uBl+P4pFYotKyHfdVAgAAAAC4Akf0LipZIxJe10ea7/HR1rf3jEzR6gxei0hqpbxvVzyZpvsS4ArETatcSO5vbWg0mPpGeCuWKNV6Q9cXXJd2vL7Fvzy4AAAAAACvzRUMzvN7+jNSOFq+dV8IXAFcgdOv/nc7oB7V1IVPgm9SJ99+vnNfEQAAAACAK3Duzg5JsfneFQz77dPRhkYo1/rnXAHtk4S3Zp+jF7sCcd05q5jxyEbu4jW5AqdfjgafTqfA6ngwQ7rPXIHTPz7Y1b6HPnLUHrqvBwAAAADAFYhmemOi2LTteKF2dStcQjz0Lq2Ckaz6wxU0015X0/+4KyCp6vuWfe0KBpUoTbDQ35X2vTvFffesYBRaLgAAAAAA+L+5gsHnKO0SBP7MN213qcAVwBXcVaNeyN6UrhwXAAAAAAD4zBUMawnNU2zrmebQXTZwBXAF9NUUMgAAAAAA4CdX0CvteqkdodyluygXmalzt4NGLro62nDQ86MfCdGvl5L7m6sBL0d/P11p3rpzuO/WR9n2lGUe1Dcjo0QmWxKXi555sC+trBEZt6athiNG4bRrO8vV7qJ+GPLSrozje5XdCo4OrdKIzT5/VQbuIp1nhUBW7XbHSr3b0MaBiKWsDjXIDwTXFfTL/5E/diGch7Y1OoOheUcR9oyjs+7D3PQkalx8qyTe6KPfj1mjH8+T3lbYbvHanaWdD031TRF9Kd9pbzSrvQC9SxZrfeESjMnvBwAAAAAAV0DajiQR3xXcn8S1OZfziMuj+Tcaadup2pSOtE8/airFrMeqN0xX4PSPFXfdaLHS1XBprkDaaQnlO9Nac4MGtue4C7gCZufVIZhxBf1eJTrbpvYomnmB4LsCWXn/FtzJL1YH4Obkw2ZwXmf0/VJXKFxBr5MPSQPrtFLaM13tFrfG/7tvPSiiT4h2IaI9E0TG5PcPAAAAAIArELWEp1fCxa77EleQTHwKzl7ZKS4ynjgLht+b5dNG3SolIvoKrdp2Z1SdvrF/YBatRv20kn0/UcaB9ye2t+R8bJpZ04y/oSR14/uPj0+pac/cdaNHEiWrfl4rm0ZY81o7qIml5vnYXwyvq7EqbRfcVt5KX3p98thPg+7C3zHMcedLLdvld14OgdIVhKPR0GihfTd+aGYPovrEPwQT59QeIxB8V0D2iS4giubO+8JxldxU3nq/r0WSk85Qz2tinitIJt7MUertnOdJYpYtm4JSePz7xrGtjL50KJ+2CL6HL2Xs6hq9izH5fQAAAAAA4ApIvJIA+upyXQE9oU/TJahEK7vuJc9U+nN1VeDvicQcfP74oSIntPTKUdoHqA7U5wpUJ6fpjISsMjcK336uXoEkFp0+6eO1dEv8yCz6FJQ3ENR+g995dQgk1U7/m25MhndgTTYWSOizA8GvV3Bj7evS/kNkJpGJTid7A/g4pESvQkN0dCW7Am/KFTsDyfld5tempT9xVdweT8hPDfFsjEQtGZhco2RdiemLfcu1AX/yAwAAAAD4zxVcvNAVBKKjDJmn2FZMuTR7b+3P6jPHnYN9Elf0TekKnE7uD+UZCVowXst3luMKiG5p52kiE/24nm87C+9CcDuvDgGpdtW1PySFVzSz6RKsQHBcAWF3yjP5UYHNj9VrhYj/gwZw3ih1ZFdALmIG+isqVyylDwXp0xQx6hff0J6JpSjyzZv8AAAAAAD/DlegkrAPx+8nCkwtuIPZ1kLSnOEKOk/U5DNX5ketwc9VMZu9WZ9OEaylrfL74I91/WxLLP5R7M7LIVC4AsoNU55UJliBYLsCYnTuOaJL2fbZC/FkMBX+TXrv5zt5cCiJi5g1Qk+zsK5LO7L9UHwvJRrJR5aXOPkBAAAAAHzgCkhjcc8VnAnluuwKZ8Vd2P32eaNaMrOHxh6VvOW4AvuLoX6dlG6+7PtDh43U9FevHTYEp2V259UhUKt2lStgB0Jun4+4aeSeegMtWr6RhbXqoffKrmCrdOUqIAOgJetCuoCL7IcyRqKWXFF7tpdPfgAAAAAAf9xB1Mpqv8trqNw7iBTClyGMrq0fV0lKD8MVkDr85a6AsE9I1lOKCKNldufVIeC7AlYg1O3zGZwmvYO5lG1PLXNdgTqylAJEyUL0Ilr+V8WI8Qr+5AcAAAAA8IcrEGcHv8vZF3xXoHIa+0eN+rnyubqXjtKO78kpVGr1807vvpbguoLPtGacqarfW2/1xdJdgdP9ITrp2Sl2WS2zO79UV8APxBJcAR2ZoM7UnalCyOFD65n507wRLMlOvxZIt2ijjP5KFSPGdgR/8gMAAAAA+MQVUI0n9a2dPFdAqm4Bvehd10MpN7bzc+cKWqZXWCrTdH5pBeKr4q532tVMaN7J4xtOy9zOL9UV8AOxNFdAgpuKTjTN4JR8V7OwK6DDvnSKgP6KyhSov5eiozbP/MkPAAAAAOAnV0CL3HTB5YAtSdUnO+n2G0JdQyr1VaHhnnEFko2h8gt0n/2vcQXdSc762dBzCFS/TNEy9ZDf+eW7An4gWK6gVVRXLpP2CiiJn8aT6wrUPFRjdH8R/VvK9VJEXzRU5er4kx8AAAAAwFeuQE4doZsijcJpdzB0JwwfepdWwUhWb9WyUj7ZqbYZzkO78rHQksXomtlyCarnReJMFl606CvvPNDp1WLnwZW4beTS1mC5roBsFelj0Ur9MefGevl76WZNfueX7gr4geC5ghTNKyHPBOlcgSTBA9FS23YlBuf5lHXHcQXyke5wLp+gMgULRJ+umaKSCFMmR/SpXgFn8gMAAAAA+MMVEOIyv0PGQPlEywu4AklCUa3ccR3fg1hIJ71FUpgKwWYefy259/131jdC88QZrSVTldyEaabIsdyfxCcfEtT/NFLj4seZ+J+rARKOvJtJ1ZeTUu4QVSeQCh5r0eqt6iBHUI8mRx07sAYus/PLdwXcQLBdwYo0pJujL5p3BxENIP3X6o6RGc+fQ2NnNUgvZbgCaUPmewfo5PFiroDKk9Gs3jMyUm1j5uQHAAAAAPCVK6Cl6Ij+066AEO38bkDZlJ5r0XulkrekERvPFfxaV/ft5uTDuvIrAjHeXoH6DhnKHZLSfuQNhADVD/bqEoQU1woxOr98V8ANBM8V5OSW5UJm5W/Cnab3hbYRZp/gPnevQDY/tNfE2SkadgoRXX03FH/yAwAAAAD4yhUQdrdWPDT2nqzjBla3w++ShQrdmrKYK6DWDmLh1SCtm4YjRpaaIuxONR0L6d7aatpq2wpxRgy71TS1rIciZt12Jzh3zYoZj2xotO6+ub1/UKpe9oXjqmG5Ak/6K/SouMiseW+XClqJb1bq3baueUvO2Ybtsju/fFfACwTztLHzcHVhjabW1o8Pp+86Kl+og3LbKpvG3rpOmwbhrViiZLVvBP9cgXy8nsoUcPPHBheVrBEJ6fQVkXihRlOaWGDy+xAA/tfeHXDIleZ7HL8A9k2swWBeSoABAiCCwAW9NhC9xpIlWQtoGtPAQmiDTQ/TmAuuQFJJD21iI7mRi1u6QyY6kgDOfZL/dO1vd55tlepU59T05+MxKqfOOX26A//vnFMdAFQBAACgCgAAAFUAAACoAgAAQBUAAACqAAAAUAUAAIAqAAAAVAEAAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUAQAAoAoAAGD1qQIAAEAVAAAAqgAAAFAFAACAKgAAAFQBAACgCgAAAFUAAACogun2pc+/+OzGgyEcbl+pLecDAACogstXLn1+5dZUFZxfAAC4V3DzVsuAy9uHqgAAAM5tFUyG57cuf3Fp+3mvCh5cb48Y1ZqVw72b7fWk7dY21n2GtqX2yZx4f9rcDgAAjLUK6kXN91EFFQDX7/0jD+p1NUCriNp5NvTnSYYojXpdxwIAACOtgoyBrII0uXE85bcqmN03iBLI6T/PXIfEOccHAABUQdwNiCqIp4BqdaqgHdXOEDvn/YRccchIAQCAKqhR/uatqoKc8vNewTxVUGeWAasGAABVUKN/fji4Tfz1dFC9nrsK8nMFqwUAAFRBTf9VBbMPE79fN6/Pf68gT3W8YvunAAAAqgAAAFAFAACAKgAAAFQBAACgCgAAAFUAAACoAgAAQBUAAACqAAAAUAUAAIAqAAAAVAEAAKAKXrw8evj42f39R+NZlmVZlmVZlmW1Kb3N6susgkiC/UdPj169HsYEAABoU3qb1TMMllUFrT8kwWgBACAM2sS+9CpoNyaG0QEAAHJiVwVnDwAAVAEAAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUwd7WhS8vbuwNJexvfHnxwub+MJ+9zYvtPMdra29oDm5fjY21ru5O64CD3bV/bF+/fRAbj9faTm0FAIBlUwVX19dqWA/TnfULH1gFNcTX6zowAqPm/jx5bDnY3WjHVhVUUdRRZxcGAACgCmJGn83xG5vrC1VBnTMzI6qg3p2N/iGqIPbMCwAAgKVRBbt7OxEAx+P4tDbmxJ+3AlLsUw8O5SNJUQWx5xxVUBdQ15OPFXXCI0sDAAAWoAqmMbjPxvocymMEzz37nyuoo0Ln5D2dJ4hqz73N2pjTf780AABgUargeLCOLVEFMcpHIaQ4vA6sfRapgllddHaLU8XlxUYAAFiUKoj/T1/zfY7dTT5N1J3powpq9I8xfbEniFLnFxbFzh/n4wcAAKAKauLfqVE7SyBH8P2NevfkKsgMyD/mV5y7CmJj/7ZDhgoAAJyCKqjX9XHerIKc+6+uz95d7Ami2TSfHw7u/GbSE64wT5W/VhUAAE5JFeSTP90qyIl8vn/FrF8Fs5N39u9WQf5raJtbearF/00DAABQBYvIfhiL7A0AAFgmVZC/J3Q88l9OAACAZVAFMXyP50Gd+AjE/PcuAABAFQAAAKoAAABQBQAAgCoAAABUAQAAcK6q4OHjZ0evXg8AAMD4tFm9TexLr4IXL4/2Hz0dYRgAAIAkaLN6m9iXWAUZBq0/2o0Jy7Isy7Isy7LGs9qUHkmwQBWcQwAAgCoAAACyCgAAAFUAAACoAgAAQBUAAACqAAAAUAUAAIAqAAAAVAEAAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUAQAAoAoAAABVAAAAqAIAAEAVTLcvff7FZ/+8Lm0/HwAAgHN3r+Dezc8ubx8OAACAKgAAAFTB8et46/Obk2E43L7y2Y0H7b/1oFF7Hcc/uO4BJAAA+LVUQY34V25NhzK5UYP+uyqIof/5rcv1+uckuH6vcywAALCaVXB8WyCn/NzYxCGdY90uAACAFa6C+N1ENye1vZVApkLu0w45voeQK3YDAABWswrqAaH2UNDkxuzRoJPuFcR2AABg5asgt1y59C+PFdXTRPFZgnwNAAD8mqqgZv36PHHeK9i+dbnzu4byX0OLcgAAAFaoClLnNxHFE0QAAMA5qYLJjfjQ8PmoAgAAUAX5z5Z9EQ8U/bqqAAAAVAEAAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUAQAAoApevDx6+PjZ/f1HlmVZlmVZlmWNZ7Upvc3qS6yCTIL9R0+PXr0eAACAMWlTepvVMwyWVQWtP0abBAAAIAzaxL70Kmg3JgYAAGBkcmL/pFUAAACoAgAAQBUAAACqAAAAUAUAAIAqAAAAVAEAAKAKAAAAVQAAAKiCva0LX16crY29Dzl082Icu7U3LGB/o3OGM3Swu1ZfvdbV3enwyUx31i9s7p/8dxQ7nOZbXr99EFsAAFAFNQrX6xjN9zdidkxZBWs7B7OJNo5daDzd263XZ14Fednz77ncKsiN2Sp7O/UaAIDxuvbV9fw/7+2Pq1IFWQILVEFzcPtq7b/Alw6qoPtDXh0AAEwe/JBV0P64MlWQU2k+V5N3EuJBoxxYsyIqD/KhoNpSh8z64f2Bea8g5dea7VAn2WmHvLuk/8ovnVeSX31zP7/H25uzK+/P+nG2OjbugcT3nm/Ftxk/hJ2tn3erP+61L5G75bFxSXPcKwjzXMB/x489/hai97p/rflYlyABADjl7YL2YsU+V5Bja2d2nL17sHs7qyCH1/fvbrSNMf3HvBuDeHz1nHrza2W01NnqdW7PE+ZXzBSpr1KvU/ZPDsHdATovO7/f+O5q/6iR+mNef3urXm/Wxu55SlZKXNvcF5Db4ycW31Tnr7XejTyoPQEAWPR2QXuxIlWQ43XnCaKYkjvTat5SSDmVxtlyY+yWU2/3waS8hu4JY3CPb622x/eY4pCQtxfySmLPzsXUW3FV/bLKy8jTdqsgVVTU2ea9gDh5/FRjnzxJ5yLrkuooAAAWuF3Q1op92jinwDk+Y5CDZmd7Pm+TO8eUn/J/Udf4m2u2vV7kpeYJ475HtspCVVAXnEflnvmMTT7p9AFVkJc6TxXkXZQ5LiC+i9lNj7z43Ln/VNLpf+sRAIDbBW2tWhXE7D7HvYLcub+x/wRLm63jy3UPrEE29a+hTpUnjNdhgSqoU21t5FfMPfttM18VxIsPuVeQJ5zzAuKGSf23meNewRIyAACA1X+CqAbWEz5X0Jvd40n6mKTXcgzd25q9zsfZ82H3/pnjhBub8YhLfK5g8SrI7z3f7X6uYIEqiOk/frAn/A6iejd+MnNeQDxctLH57x++OuFzBQAA+FfM6mGS/EhrPqySVZDihG1kjzE3ZtCYyE/80vkUUFZB74RZF3HOeargn/8ttoiZ+BLxZFS91XlQat4qyItc29w6+V5B/ijim53rAvqPQuU+nb/W/JnERgAAVq8KRiem3vMIAABUQTyedP4AAIAqqGdyxv+0OgAAqAIAAEAVAAAAqgAAAFAFAACAKgAAAFa8Ch4+fnb06vUwPgAAQJvV28S+9Cp48fJo/9HTEYYBAABIgjart4l9iVWQYdD6o92YGM+yLMuyLMuyLKtN6ZEEC1TBeQYAAPSrAAAAUAUAAIAqAAAAVAEAAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUAQAAoAoAAABV8Ne94bd/Hv7j2ohWu552VSXdvf/DH/70l//8/fo5X+2H0H4UAwAAnKYKMgl+89VYYiBXu6oKg0yCtWt/lAS12o/i44QBAACqYEx3CTp3DNIv7xK4YzAAAMCpq2CMMZAryYBfrgEAAFSBKgAAAFWgCgAAQBWoAgAAUAWqAAAAVIEqAAAAVaAKAABAFagCAABQBaoAAABUgSoAAIClVMFkaH56khuHrw9jy3iq4O7hEKZ355+w4wxvnnzzkcf37/7+5ueL+ebx2zy/KgAAYHWq4O3w0zB8feoq+N2TYThcYhXETF+FcHhnCVVw52B48/i7xargpFXNcDAZaRUAAKAKvn83Y69UFfx+Mh3e/v1vqgAAgI9EFfzu2vDjMPw46VfB92+Hcjz0187x7uG7Q2bqraVVQUzYMZeXuIFQI35sjzPUW7FznKdUctQhM/UV+1XQucL40nkltfP4qgAAAFXQXjRfRxXMhv54fTzxf1sPHcXhZ3OvYCYH+r89mT7+bjagz/5P/52DmuNrRn+SVdDeqhcn3Suo/SsP4uTzVEG7pDezK7w7ueNeAQAAq1AFGQP1Iqb/3Pkw7ye8u2nw/bdn/gRRjd2dJ4hi8q65vHeGO/mZ4JOqIF7nBcxbBXl5qgAAgBWpgmqA77+NKpgMoamdZ88R1W5nWwUxZOf4ns/55M69uw1ZC/0q6HxgoFcasVu3W5p6a/xVAACAKsjJvn34OO8VxLu52p4/HcadhLOsghjf48WH3CvIt+a8V1DnnOteQb47mVYYqAIAAFaiCvKzxb3PFXSOyhL4NE8QxVBer2vyjtedzxV8E2GwjM8VtBd5SaoAAIDVqYJ4jihL4Mchf79Q7fAvv4Mo9oy3zuZfMYvtb6cH/d9NVMP6L34HUZwkbwj0fwdRJME8nyvoHDWZjuB3EAEAoApGsOarAmsAAABVoAoAAEAVqAIAAFAFqgAAAFSBKgAAAFWgCgAAQBWoAgAAUAWqYBEAAKiC3/55vEnQri394U9/kQG52g9kAACA01fBX/eG33w1xiRoV9WuLd29/8PatT+KgVrtR9F+IAMAAJymCjIMxnbHoF1PJkGGgTsGdZdAEgAA8EFVAAAAqAIAAEAVAAAAqgAAAFAFAACAKgAAAFQBAACgCgAAAFUAAACoAgAAQBUAAACqAAAAUAUAAIAqAAAAVMH//O//jXlZlmVZlmVZluVeQQ8AAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUAQAAoAoAAABVAAAAqAIAAEAVAAAAqgAAAFAFAACAKgAAAFQBAADw/z4lNZUNoEtYAAAAAElFTkSuQmCC"},546:function(A,e,t){A.exports=t.p+"assets/img/SIN_PairingCode.cd005782.jpg"},547:function(A,e,t){A.exports=t.p+"assets/img/ExternalService_Add.f82f2998.png"},548:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABGAAAAEHCAIAAABupae7AAAZRElEQVR4AezXAQkAAAACoP6fLmiHvjCFAwAABAkAAECQAAAABAkAAECQAAAABAkAAECQAAAABAkAAECQAAAABAkAAECQAAAABAkAAECQAAAABAkAAECQAAAAxt4ZeDaytXH4bykuWTABA7QuRNEobS235SPrIrFIFONevpWykZIKBkEIRQhCWDGsKlWhcoNE0AirQjWlpJQJ4WCYb9N23jQnObl5e7P3i+3vMdjY9MyZeQ/Ok/ec9/ykggTAffH3dyu/DK8PpXv356L313EsFI2Xmrbjvm0AAAAAACBIjripl9JGKLiuP05/h5e2vr1nHOWtds9x3wbNpPfsiuuo4b4GCJK4bRZzicjWhkYvU98IbkXjhcrNwF0Krgs7Xt9iX/suAAAAAAB4s4LUu8ju6TOsIFy8c18JBAmC5HTL/932qd9qsr4kwTepkx++3LtvEQAAAAAACJJzf35Ik9elF6RBt3U2THMFMs0fJ0iUPQtuTV7HrxYkcd0+L5mx0Eam/pYEyekWw/6Xw8m3+vwyA/qSCZLTPTnY1b6HPnTcGrhvEAAAAAAACJJopDZGk1dtO5arXN0JlxD9m0srZyTKyyFIjZTX1dQPF6Rk/Ye1/JYEqVcK0wAL/FlqPbhjPHTOc0au6f7/AQAAAAAAEKTelzDljny/ZRu2u1AgSBCk+3LYC9n7wpXjAgAAAAAAsKyCNKjENW/yun7UGLiLBoIEQaKnppABAAAAAACwlIJ0U9j11j4FMpfuvNSPxsoV9GqZ8OowDaVnhx8J0a0WEpHNVZ+3nyeSKjXu3Ck8dKrDnTm0I8Wvb4aGK/1saZ497/4o+9JKG6Hn1rTVYMjInXVsZ7EaI6qHAW9donHyoDJP/3CvP72xyev3Us9ldH6+EMgCY7et5McN7TkQ0aTVpgb5geAKUrf4H+XDzsLpt6zhfi3N27a0Zxyfd/pT1+9R4+JbKf5eH34/ag0/XiS8BOlu/tqdpJUNjPdtVvRpQeDecFR7AfqYyFe6wiUYg3+pAAAAAACAINE0l2aHfEF6OI1pU8q7icvj6TXxtO1k5X7MB84+aSp50KPlW6YgOd0TRbU0LVq4GixMkKT8WyDbHp92b9CLvXHcOQWJ0Xl1CCYEqXtTCk+2qT36AzMQfEGSJOQX/052vvOFbk//2PRP64weKXSEQpBu2tmA9GKdZlKb0dVOfuv5fyNW/++iL1q5kDYjiIzBv4QAAAAAAECQRCXuTd2C+Y77GkFKxD/7J+tfi/qRN0/1B/fN4lmtahXiIX2FfsvvTExw9Y3IgZm3atWzUnp/JAm+/VPbS0ScmGbaNGPvaUOL8f3j41Vo2BPV0vRQvGBVLypF0whqXmsHFbHQhXD2V8PrarRMSaS70gfpSa9PH/tp0Bk7O4b53PlC03b5nVeHQBKkYDgcGKZfdmOHZvogrI9Uyh+/oPYYgeALEpkklbALZy66wplhR6UP3ve1UGKiM/54RUwTpET8/RRpaWU8PYtatuxHheDz940TWxl9qZYJJY7Sppk0dnWN7sUY/MsEAAAAAAAEiebxNBf8y+UKEl2Bz+OnfIpmet1bXVbqTp1i+v4czbZ7Xz79UZJXfN0Uw5QdKvfUe5BUBSdoP5U84d7IfWMI0t+f2ON0SRXWUk3xtPTus19OK6nVi995dQgkgaH/TdVGr7dnjdJN5DzMQDAEibi1IrqUlQopVvrdlz1RDDy+UmKUCls/vpIFyRty+XZPkuDL7Nq4BRFX+e3nAfm5JmbGSFQSvlEhPutKjFfJL1Z6vMG/5AAAAAAAQJDqrxQkX3i4hOwlthVV/mD/YEUmp6qOOwX7NKbom1KQnHbmV+V+KkojrGXbixIkykLsvFzpRx/Xsy1n7twUt/PqEJDAqArHkRWsaGbDJViB4AgSYbeLEwsIfZufytcKn/mVXuC0t9SWBImEahL6q3exr/1p6+v89GiKGHXz7ymTZvWoVwR/8AMAAAAAgJ9NkBSz+f7J/mgyqnYPf7o5l6UwBKn9YmI94yiesNX7ZwfF5iZ6TjuO1lJWcd//lO1JN8X8D8XuvDoEJDC0eHJ2jQ2CEwi2IBHDchEhXdqZk66LFy9TobLSfb/cyy+HVjkSk074cpnidWFHNjHF89JKPLnSwwIG/zICAAAAAABBoukmdw/SuVD+Wr/CycMIu9u6qJULZvrQ2NuiKmoMQbK/GvJd1PvpF1yMe1BLjj/12mFNcFpmd14dArXAqAWJHQi5fS7itpZ5qUlauHgrO4bqovvKgrRVuHIVkAtpiaqQSjiSiSljJCqJFaW+LmDwAwAAAACAJali10xr76Rf1tlV7BQOwJgjXltPdZnliylINFH+NwWJsE/JcGgNFaNldufVIeALEj8Q6vZZ9M4SVHTO25lDLXMFSR1ZWiNHq+noRpQUUsSIcQvm4F9CAAAAAAAgSOL84J28PIkvSCrpihzXqhfK6+phvAKBV2ktV6pUL9o3D5U4V5C+UCbhqKy+b7XZFQsXJKfzNP+mayffYbXM6PziBYkRiAUKEm2vos5UnacKDd7iwENrxvhp3AqWvdDXfKkmpU/pr1QxYiSpmIN/CQEAAAAAgCDRMZrqEtg8QaIJ7hxTZyr45q1Js51/tgepaXpndx41HPf18AXpKr/rFQkw45pXsOGW0TKj8wsXJEYgFi9I5B50mFXD9I+ZjBqGIFGNBG/HEf1VxOqrYyRHR/4dgTX4lx8AAAAAAAgSpT6oWnSPPztXboin+mmE+pjO5F+K6ewMQSKjk491onNy/hVB6oz2t5wPSJa8I2IVLVMP+Z1fvCDxA8ESpGZeOhxWnUGiDT/0PvmCpKJfjlIFPPo3LYacGX1RU5wIzBj8yw0AAAAAAARJXltFZZeN3FmnN3BHDPo3l1bOSJTv1DNseUO82ricfqv0KdeU5+VrZtMl6MjUCUuhOSilAqR8FG36z7f7rsRdLZOyeosVJDJMUgXRTP46eRLOxPNSmWp+5xcvSKxA8AUpSeNKyCNB2oMk2YgvXGjZE0Z0kU1a9xxBkithBDPZOB1/NEf0qVAhHbU05nuiS+cgMQb/sgEAAAAAAEEixGV2hxxJeYWL8wkSzSafL30jcmCmzcfrIBrQaeo5bgW/+IP7R49fS+x9/876RkBhKZRheNwtE46bZpLk7eE0NnoQv/6bkTSfbn0U+23Vp55Ds8p8U6VvWlxHpx7RRNznqU75TrXpy6+HE8OOHXjaw+r8ggWJGQi+IK1Ir3Rz+ETTqtjRC6T/Wt0xjp7Hz6Gxs+qnmzIESUrTfe8AFWyYT5DoBFga1XuPvUoau7pGt2YM/mUFAAAAAACCRAmKkP6PBYkQreyuT9mUnmnSfa0IFZIemy7XZp2puq7u2+3pH+vKp/BFeRkkdRUyWlwnr4uT0kq+/VN7/LyjgKIwHa/zCxYkTiD4gpSRW5bPii1+E+44N18puTR5+SPcDJLsgZSB5OQPB+1cSFdXF2QM/qUGAAAAAACCRNidSv7Q2Hvx675vdTv4MZErUd2t+QSJWjuIBlf99Gt6MGSkqSnCbpdT0YDu/eKeslq2Yp5KDDrlFLWsB0Jm1XZHOPeNkhkLbWiUjdncjhwUypdd4bgKuILkWZBiai7qR2ve3aUzQ8U3K/lxW9e8RES6Zrv8zi9ckHiBYBZpcPpXdWs4tLaeHpye67hYVwflrlk0jb11nVJJwa1ovGC1bgV/D5JclYSOP+IusOzVS2kjFNDpKUKxXIWGNHvw/6+9O+Cw69z3OH4BnDdxFEFfSoACARBB4II5biDmqEMOyXEAYdABDoRRnMyhgwJXIZ1ml9E6kdzqxd1mSlupNoDnPtO/3fu7q2vHyulkZ+3M5+OvVtesvWbNBuvrWXtnzgAABBIAAIBAAgAAEEgAAAACCQAAQCABAAAIJAAAAIEEAAAgkAAAAAQSAACAQAIAABBIAAAAAgkAAACBBAAAIJAAAAAEEgAAgEACAAAQSAAAAAIJAABAIG0FAABAIAEAAAgkAAAAgQQAACCQAAAABBIAAIBAAgAAEEgAAAACaXlw/cq779x93MLZwc3aAwAAcMkC6cbN61duPlgKJAAAQCBdufegF9GNgzOBBAAACKTj9s2DG+9eP/hmLJAe3+nP4NX8ElGf3uvbx/2wvrNWn/qeOibL6ufTxv75AwAABFJtVOpEIFUL3fn0/0qptiuHKqjOD67+yZN0EV21Xa+dOQAAQCBFF8XGwPHdCp5aQarVpEEURQjFmesldU4AAICZB1KuEUUgxWNyNcNAqlf1M8TBucqUUy8BAADYikCqqrn3oAIpgidWkKYFUp1ZEQEAANsbSFVB8Z0KPX7q8bnanh5I+RkkAACA7QykCqFVIK2+g+F87t2ZvoKUp1pN7QcAAJhRIAEAAAgkAAAAgQQAACCQAAAABBIAAIBAAgAAEEgAAAAIJAAAAIEEAAAgkAAAAAQSAACAQAIAANhAIH37/fMvn3792cmT+YwxxhhjjDGm36X3e/XGxgKp6ujkyVfPf/ixzQkAANDv0vu9ukbaaCD1KlVHAAAw20bqd+yNjQVSX7lrAADAhrhjF0gAAIA7doEEAAAIJIEEAAAIJIEEAAAIJIEEAAAIJIEEAAAIJIEEAAAIJIEEAAAIJIEEAAAIJIG02L/63rX7ixbKyf33rl3dO2kTLPauXX1vMPv9lMvD3au3jpZtKH7F7sPT9hvVn7CaKdc84c+pk+QVAgCAQLoUgXRrd2eQMdU2rxwbpw9vjbXWxQTS+oMX+5VhF08gAQAgkC5jIGUGrMLg/t6uQBJIAAAIpMsWSEeLw2qh2Ll3slzt7I+c7RyeDp9AmxJIlS7xwnwAL/Ijn/Sr/XXY6veeHu2s9uQJ1wdS/F39JfVbVk/iDf/S/F0/qz98EEi1P64/CupwP08LAAACabsDaRklsOqc6IQskDxyciBFVlVpHGUgnR9WG7UzSyn2x/b6zyDVa2tnNU8+LlitFedZ7FXq1PG1PRpI8Xmq4QHSCAAAgfSWBVIuE9WezIAsn4yliYFUWVL5kSo/Flks8ZJVitRVvfIjdrkzoyguMuX5xwIpX1X7h4tgAAAgkN6WQIqGqVLKTujycbusi2mBFBuDJsk1n3yMLSdb5dUDKXtm5CLz4b31gZRP/eXBAgkAAIH0lgZSxc9hZVJ0Qql8ytK4wBWkaqT4+FMbeE2BVFc1dQWpNpJAAgBAIL29gZSf2xkGUq0s3aoH3l45kOpHaz+DdFqNlJ9B2kQgDf/2Ov+EzyAJJAAABNIlCKRcJxkGUibEKwVSnjy+iW7kW+yqoMYee4un78ZbqA7Ok08JpLykvf2XriBVIk548G+LAQAgkARSmp5SAACAQLrEgZRPvgEAAALpsgbSYi/+HdW3FAAACCSBBAAACCSBBAAACCSBBAAACCSBBAAACCSBBAAACCSB9OXTr5//8GMDAADmp9+r9zv2tjEC6dvvn588+UojAQDADOuo36v3O/a2MQKpGqlXaV+5M8YYY4wxxsxn+l365utIIAEAAAgkAAAAgQQAACCQAAAABBIAAIBAAgAAEEgAAAACCQAAQCABAAAgkAAAAAQSAACAQAIAABBIAAAAAgkAAEAgAQAACCQAAACBBAAAIJAAAAAEEgAAgEACAAAQSAAAADMLpOXB9SvvvvP/5/rBNw0AAODyriB9eu+dGwdnDQAAYEAgAQAACKTYjh9duXfc2tnBzXfuPu7/rSfx+na8/vGdt+4JPQAAQCBV7dx8sGzl+G41z3kgRf988+BGbbeqozufDl+7/QAAAIG0WiyK4Imdw5eMvLbCaasBAAACKb/d7t5x7e9RlNWUx/SXrFaWcuKwLQcAAAikeoKuPzV3fPf8v+UlK0hvcREBAAACqfbcvD547q4et4vPHeX22wkAABBIlT3xaaJaQTp4cGPs2+riH5ytiNpaAACAQEpj32WXj9gBAABcokCqb/euHBJIAADApQ2k+pdh360n7gQSAABgBekVAAAACCQAAACBBAAAIJAAAAAEEgAAgEACAAAQSAAAAAIJAABAIAEAAAikb79//uXTrz87eWKMMcYYY4yZz/S79H6v3jZGIFUdnTz56vkPPzYAAGBO+l16v1ffaCMJpF6l6ggAAGbbSP2OvW2MQOordw0AANgMd+wCCQAAcMcukAAAAIEkkAAAAIGUBBIAACCQBBIAACCQBBIAACCQBBIAACCQBBIAACCQBBIAACCQBNLycPfqe9dqdg5P27nTh7euXb11tBw/ePfhaR1Tr4qplyz2c+f9RRvKY2r2TtobUn/Iuou8sCust67eHwAABBLzDKTFXt76nz48PFk1w+7OSDac3O+pUIGUO2tPdsUvJXB6tBONNHbMy9UZ9hcbD6RBzywOJ10tAADcfv9OLgb0/92WQBJI2QbD/Tu3dqOdVs2wt39/YiDFq2phaosCqdIxLxsAACY6fvx5BlL/3y0NJCtIg2bI8qmd/X9PpgfS+tLIY/I8FSr1u36+sOFDbvWj3BPXcLhfO1v97+Jopw6LvsrnCe8vJq8gpThJnDkv4D/jhHH+X70tYyeJZx23HwCARaS+sS2P2AmkSJGqhWEg1ZLRScukyRya+Ihd/TSNfk4pF4vyDLUzLqzHQ1xkpEX2Un0gKlurtvdqZ/RPnGekHrNVhi/M9ycvYOx9i406cxx8tIg+zLd02wEAWETqG1sVSAIpi6I6JJuh4iT3TAqkjJ/80XhElVhuOsoTZiDldp0k+iRekv87/rtG/7T1AVlni4PjF9VJTsauORbQ4jLyp9OfSwQAYOsWkfps55c0CKT1iyp1fx/39NNXkNLEQKqzVVEMYiPTK6ZOMj2Q8gwTAimSb/Xn12uHBVi/MUuvzlkFNb6UNP7YXj5SCADANi8i9dnWQBJI44sqtfPW0cPKpNcdSLVysrdflzG+gjT2qmmBFBvTV5CGJ6wPYr30AmJ1K9a4JqwgKSIAAF/zzZsLpPhMzvoVpNqu9ZPXHki1Mz/Ds/4zSK8eSHHa2n5pIC326qe5gpTvUlj7tuzf36sz52XUb1z/GSQAAAQSb/Jb7IaPq2UzxOLGRQfS8Em5+BeTIiHiIvPrEGrq+MmBlK+Ndar132KXD+Ote9OGH4LKw+ItjcsYfhdfLmoNntzbJAAABJJAAgAABJJAAgAABJJAAgAABJJAAgAABJJAAgAABJJAAgAABFIQSAAAgEASSAAAgEASSF8+/fr5Dz+2+QEAAPq9er9jbxsjkL79/vnJk680EgAAzLCO+r16v2NvGyOQqpF6lfaVO2OMMcYYY8x8pt+lb6COBNLmAQAACCQAAACBBAAAIJAAAAAEEgAAgEACAAAQSAAAAAIJAABAIAEAAAgkAAAAgQQAACCQAAAABBIAAIBAAgAAEEh/W7Tf/6X92+0ZTb+eflUlPfrs8z/++a///h+7l3z6m9DfigYAAFxgIFUd/e79edVRTb+qaqSso53bf1JHNf2tuNhGAgAAgTS7taPBOlKydvTrdaQGAABcYCDNto5q0q8LwbQCAAAIJNMKAAAgkEwrAACAQDKtAAAAAsm0AgAACCTTCgAAIJBMKwAAgEAyrQAAAALJtAIAAAgk0zYNAAAE0nHrvnuWO9sHZ7VnZoH06KyF5aPpsRFn+OnZhxdcMh/986dWF/Ph0xd1/q0NJAAAEEgv2netffCbA+kPz1o7e32BlHlTsXT2yWsIpE9O209PP/rXAullU/l0eiyQAABg7oH08XlubFEg9Tlethf//LtAAgCAiyaQ/nC7fdHaF8fjgfTxi1ZW/VMHx0/Pzl+yUj96vYFUsZGJUmpZKWsn9scZ6kdx8PA8VV/1kpXMm9FAGl5h/Oq4kjpYIAEAwIwDqW90H2Qgrfontlfx8496Ki9evpkVpDIIob8/Wz79aNUqtf5TCVRJU7nyLAOp/6g2XraCVMdXKeXJJwRSv6SffrnCR8efWEECAICtCqTsotrIEIqDz3KV6Xwp6eN/bPwRuyqQ4SN2GSGZKMMzfJJfpfDSQMrtvIBpgRSXt22BBAAAAqlyqAdPBNJxG6qDVw/a1WGbD6TqjSyZ4YNweXCeIVef1gfS+IeLKrqmBFIdHA/UbVcgAQCAQKrIqe9siBWk+GlOP/K7s1pf2nggZcnExvQVpGikyStIdc5JK0j50+NlNdJ2BRIAAAik/EqG4WeQxl9VUfQmH7HLPqntipDYHvkM0ofVSK/tM0h9Iy5pawMJAAAEUj1ol1H0RctvqKsDht9il0fWjzb2D8XG/hfL0/Fvt6tuGX6LXZ4kl4nGv8Uu6mjKZ5BGXnW89C12AAAw60Da/EwLJNMKAAAgkEwrAACAQDKtAAAAAsm0AgAACCTTCgAAIJBMKwAAgEAyrQAAAALJNAAA4AID6fd/mW8d9WtLf/zzXxVRTn9DGgAAcIGB9LdF+937c6yjflX92tKjzz7fuf0nXVTT34r+hjQAAODiAqkaaXbrSP16so6ykWodydqROgIAgOmBBAAAIJAAAAAEEgAAAAIJAABAIAEAAAgkAAAAgQQAACCQAAAABBIAAIBAAgAAEEgAAAACCQAAQCABAAAIJAAAgPkE0n/99/8YY4wxxhhj5jyNiwokAAAAgQQAACCQAAAABBIAAAD/C76ESSiiPNgkAAAAAElFTkSuQmCC"},549:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA/oAAACaCAIAAACWmKQxAAAR1klEQVR4AezWgYUEMBQFwOu/ySB+B08E/FwPWWysmSrm7/woAADgq90HAAB0HwAA0H0AAED3AQBA95NU1XgJAABQVUk+6n6SOedaq7sPAADwhu5ea805k9x3v6r23gcAAHjP3ruq7rs/xjgAAMAbLsau+wAAoPsAAIDuAwAAug8AAOg+AACg+wAAcE/3AQAA3QcAAHQfAADQfQAAQPcBAOCe7gMAALoPAADoPgAAoPsAAIDuAwDAW3QfAAD4Z+8MPBtp+jj+txRHCjYgQOsggkRpolzKS+KwcUgc1vPilXCR0ggWQQhFCEI4EU6VxymVBo2gFapCpeVIOTYciyXvzn6TeSedtnN7b9zz9PH7CCrZnZ2dmePzm/nN3D9W9y/KG282Nw6H87+CweGm+/TSxfwfBDEsvXG7tTyY/yQPrffu9Xrr2/wVYY1HN9Zv/EdEEARBEATp/uAw6DrHdm30yOYDzL2MY0tUlZMc+7L41SbdJ0j3/TOqbbvvqJkDWfedh0G7nNnZCrALthLGUW86XwMEQRAEQZDu26dF5hzv26Jd3DTi7Ms3wRWlHprMRT6eWH+f2X3CvvvaLGYitRcs2bpsV4xk7vPDa9Z9e3LazH+IVi9es+5/62ZCm1q2O5V1/1s7/SYY2onHduPh0Cb7PmIO7PmvQRAEQRAE6b40Zy9O5EOk3oa3V2f9EQPst+4omefvAjQRlqxqrnT7Ves+5H6z9Gp1X5ERZ416o9kcOOP6nvey52t4CEEQBEEQlLs/buxiIn8lANguFHMrs/6z44/uZeHqiHL31wvpPun+012W+zKbSxAEQRAEQbrvm6ta2HWLWGMspvfkT0eNXWHW3+kzG9PKA2fVVG67+XdewnEomW+PbTH94rpb+hDVmMOFwqlii09eSvcGtpL5L3fz55me1TKR0Mbyyt5j3bcnf9YWec8sIyJbPXtabe2zYuBx5pLd+xRkYczlfJFC3Szus2dJ1fZlnLDwt7UrcW0EqyU8puKZUc7sqmvmUmirTS2SrZ4/COWwCk+sYR2NGYpm6iNbkELhI9UEt4sfLpfTYaOQQt6IW+Z+oX1lvdD+R7l3y+Z9Z/b4lc5Dr24ktoJe18Qz1f7UeRySTbpFdgG7sXh8P1+Ae6tZrwL4qS/p/qoW8w9CF97497NBfVmOXkPKu7J6Msrhal+383sh1kF7xda17d5x1TQS0nN/pjenL+u+M6pG1hXJEARBEARBus835urdKd+8yywfYcBy1h+7DAuntmgq7/V0aCtdMEsf454LhksXi9/ti3LYdawdo2SaFbO4z6woWh09ujeeO8C9wq8S08+6d0EoYZQrB65gRcMRUbvtwWHUc9akW1qloIc0ZmCx+lPF2f28tipS9mkeXu6KoHPX0qGGet40S0YS8vfHycyv7mPNRPjpruGmZ3DVQ0wFbYUF4u1M033BmCa0BgRxV09HQvsF9+1SXpWCmPednJiVT/o2+yaZY+3cHDxSdmvYMM2c9+htvcjKP/HCqvt2WoOnul+Wc3shrwH/c/x9LmN9MbxwLpX3ujK9hZfizeVVzFz0YwABDF9S0HWNjYFybifo5aOzdkbTdfQg7zXW1JFo+Dndvz1hz33LCkwY7FmNi9my8eNpPartGSWMMd7CqupxfAzXLbeqy7bSitVqMrAjPVfVm2rddx6+fmLjOYzIkCAIgiCINUC6D+XFkTvzUfXtwkgQBmBCetrWkV2wOuGa5EsCvYMwE2XTcxd7WPIKmfDJ1EseLeBezMvOwVU1jJnv5wU9Wb2058Dqs8Kh3XzCPlIe/MDP3GWzHVle8Sx4tqDdiSaT4EkzyV5B59WGBSIY8Kv7mM5Hi8Hzgom9OOIorKiw1rvFG42vhBImrdSiNXAj4qhze/H23ewGlgV+PZkHsUcw3WZvLYZM29BS+XYxj9yZWawuGBKoGJh1ssy/G2N+lzAGHG9cIRmM99pe7WrZa9ZZedt/Mg/rLx6C3qMp9M5UXT2O7+HqjFnriUPuezfDn6voTYXu844IH/YtZ04QBEEQxJog3Rfz8sfNGBJ7FmEA7MT+WnAvSHFBh6lgQUD0ZrjL4gwf+QPRwb1wKXAue498HNDTufsDMyhnOfcOnk99vm0m3AKzXWvx4ggMMN/MfZRz1/oXvvSt+1gPCRwOMUG+oZV75+UAVktQ7G7zhl/8bdRpmiUjFUNK0sqBLatX3rf30ZK/rPvTrpBoJBQrfQkWUdCOUf9zLDgomkv+LNoHD82f2mKnyL32f+fuBytDeUVFXT0R9XDFCBTbU0h+Q2/iucreVOj+9VGYB5wEQRAEQawL0n1MheLUHe8PKCmMCun7w4rGXVAyFfkb/J096p31Vz7DO1t1r4D8k6z7/G/pdSC4EpjlheIjgR7qL7m79Cy/uu8MS2g0BEuFU5uFT2yilz0Xf/A1BCTlF8x6+7RzEH9OEKVv/Ou+XILCtpFkjxQpdiR8uj60HP7u8VK3/6iXb76L7abutfVt1eXfqKvH8TFcpfaUnuuvN+WSMW4RIxEEQRAEsU5I9zGpv/Gx2fiIrB4xIyVYahzFMFHtQ/eh0RJ+dV9eCoA9r4qjPLv/gjYhkyTTnbFJ9zfB/JktSJs8u48MEMk4pQR9CWwCTrVuXe9nNcRiAksaOS8LMRUKidevBef7Dbovz+6LywgyzuzmrPlHZHWnLLY4y6h1X+ogFgutWfdRPQWK4epL9330plSytKODIAiCIIg1QboPMH8fDWvIW1jJSIntxkU5Uyk7P8s/ip27wBqe9Kb+dR+GhMxpITVfnbuvGfLGU3E/AGIb5OWD53L3scGURxGJxlj8Vdb9R/aWKxS3cc1C/ox8IYwzjoRZbSRK8Q2mvnW/57yk+1i6UeTuP709dDa5FUKpsyLqhu0HYnOh8p2TsVr3uQQL6fKTth74Gd0//yndV1aPoxiu/nTfR2/+5tNsCYIgCIIg3ceUuegxQkaK+P9wqXVftLfFESV5fSsAH/Kl+zBRM7pIIyl4B++E9PTKRO9DJxuSTuYJZT5zl312w+7jzan2sLojncyjxSsXtrgsgJdiD9rR09LsvuyRAS24NDysogQDmrheMTv+N3sojoXJp7bCkbAP3V92kJYqVgrljlwT7tZanB0sczT0XrQWk07mCeyYCJkkz8Zl/Mia4CLw+zEsRTZ5c3mHJqHaCt1HU1f4vd7w0HT9xWUKHBiFA4KKpe6DQvdV1eP4G64K3ffVm3LJ6Jdg7ODUmq8PgiAIgiBI94GX2SJlsyD/BGkePhNypmcrZ+GXuiPL8a378gHtrWt7VSVx0nk5ww/L/1DujGZzCXnDLj8bRz6pHQFGwjjqrQi0fdMuJv53VPydZJyyK4vbOmHnUvbRjxHO1Mf/XXDjI5mHYV8epRdHyxvH0ycb8O64kNTQOPXhspx+3UiGNAhxMld/+kx6nC4v/EcERh2nyANr1BIP70dzKXUfTPtV963RzoX2zY8Xc/fRSszC2fW5LwrdV1ZPRj1c1brvszf/y94dWAAIRlEY3aolWqQtftAGbdIATRKAVgiQcAOIknjOmeLD8+5XuQ8AyH3W6z9PKQAAyH32pZ07r9nPAgCAArnPNo8tp+oZDQAAALlfQI6nu36YcqoOAAByHwAAkPsAAIDcBwCA9+Q+AAAg9wEAALkPAADIfQAAQO4DAMA9uQ8AAMh9AABA7gMAAHIfAACQ+wAA8BO5DwAAyH0AAEDuAwAAch8AAB6S+wd7Z4PiNgwG0bMsECDHWgLkJAaSmwR0FAcfI5AcosUwVfPoCCFwF2LmsZRWK+v7MT9PtpJ67pfj12V5G1imw3Gaf1We5bxOqH/5j7xuJ4Qe4FG+D8evPz/f5bUOztc6oh+VpsLrYK0Lg4frnUHGUzrfHhzcfsFPYZl+OPkQQgghhOi+nPhUnu//rPorA5Y9b677WHMD3ZedQ4sRBVsa1ni9s1hdNWD8O7ZwtCW6H0IIIYQPIroPOZbYnc7aAMDSPkf3uY6NYuUVXquZn2yo0f0QQgghhOg+5FiCKzPjs39Jcz3uUv0Px2bqhVp2mThOieQZm/Yliu7P2FD3mTN1nzPbXktDVWKMzpk8E8XLfeuYCRJjsTYflcnuIU8kg5T+LosTUOoYK8WI7ojfofGGov9IfuDmIrQWRNX/pLFMdVzX9gP5tEMIIYQQ9qD7tGEZ52o8qwBNM38lVVrHZV3vWwKodhVHyLHGW6Hbl2gadx1O92GlJgoy7Og+gj7KtA7yzQDWoYhzsNU6urJC4xARPkqBBdHzR7nNyA0r++pe9/llMreV4sKW7nNnOC9G9yXZzL95c5lAKU+0ztSrBRVI07QNawfyaYcQQggh7EL3+VzZfCoX1ug9r3kARhMYgvg1eQnHJY5cipOpyEO6zxcOvf2JN12v+75MjXMyi+3PMR1QStwUdV9B+EqHdJ/3xQfihf7m2pYyDbQdi7BMP4eBmHYIIYQQwo50nyqmh/rVHSHW8Dzqmv32m410X+kxBMSxL7vjh3mA+RofLqu+jes+pJNOb6RWv8IcTGOXoMsspPlegpUO6D5yYG7tQNPcurmI4mP5DaEyVLbong1k0t4RIYQQQojuQ3OL1LPKWamq1PY8L7ubP91vqxgnc9l+lL7ue9n1m6Jh3Vf39KdJDzuB3tN9+r0Fx1qwpq90TPftNyP1n+5rHPSe7rPkvu77QC7t/RBCCCGE6D7sSg998RU90qbxUxxb6j70lIwc5mGxEEfzRZwoBC6upXyXBnVfNn/FW5TO2X3MMWf3AQu5lKd/Y9CuFG3h7eZnEp7lqnWan2RoH6P3R6EGzu73dd8HMmnviBBCCCFE96HLlEWolXVWCBbOkPR0H1bXP//jD5n0/5stZm7jcr7VfXzv0HThUuzSmO4brzX91EwuiDkaRFG40PQQuwvdtValai8//6q+Ldj12dB8X4QEOjd3mTDIKGhaX/d9oH7av9u5A81GoigAw88XoEDfIwissLDYByiBPkUKfYh2ZxlKlCqqDVSlLbRq9sSRdVdF14A7me9z1GRyGxT895oGAGD4ud8fZU0CAIDcPxDFkzYHBQAAuc/Fz/J5kuEDAEDuAwAAch8AAJD7AADQj9wHAADkPgAAIPcBAAC5DwAAyH0AAOhB7gMAAHL/8WlzdX172a6MMcYYY4wx+yaaOcp5SLmfrd+ubjbPrx0AALBfNHOUc/TzkHI/9ij/2foAAKD4o5+HlPuX7aoDAAD697PcBwCAmsl9AABA7gMAQP3kPgAAIPcBAKBWcn/kAABA7gMAAHIfAAAqIvcBAAC5vz6fHh1PFm1XuD+b552BAwAAuT+bT4/my7XcBwDgAH37/mNydPx34uXYTvdPl9H3s/N7uQ8AwMG5+PW7zP14Obrcb7r1cnY8PVt/zv18ufvrxMqtZlEsLrcKzWleA1QIAAf8ebQ/wtzPi/lyXeZ+WfPl/TLrt/uESfGLuQ0AoEIADvjjYpS5X9R8eZE1f9J0O+1JLi4vZufLRa6Jxdn9AFQHwAF/Hu2PNvcz4iPcy9zf3pn8MxH0xTagOY3j/Pi5XR8f5UmeWgEAOOCPGXfuhwj3/M/dzP39B/a5JWgW8e7usD+jHwAAajX23A/NYnuK/+nZ/T3f4Ll7K7p/muf9AABQK7mfR/WZ++UGIKe4//nLfPJzAACgBnIfAACQ+wAAUD+5DwAAyH0AAKiV3AcAAEae+wAAgNwHAID6yX0AAEDuAwBAjeT+1fXt5vm1AwAAvhLlHP08pNx/fNq0q5svix8AALR+lHP085ByP4s/9iiX7coYY4wxxhizb6KZs/Vrzv3+AAAAuQ8AAMj9HgAAQO4DAAByHwAAkPsAAIDcBwAA5H4fAAAg9wEAALkPAADIfQAAQO4DAAByvz8AAJD7AACA3AcAAOQ+AAAg9wEAALnfHwAAyH0AAEDuAwAAch8AAJD7AACA3AcAALkv9wEAQO4DAAByHwAAkPsAAIDcBwAA5D4AAMh9uQ8AAHL/7u7u/f29AwAA6vP29hbF3j/3X15eHh4ePj4+OgAAoCZR6dHqUez9cz+LP3YMNwAAQE2i0rP1++c+AABQP7kPAAByHwAAOCB/AMAZOz6GwTbrAAAAAElFTkSuQmCC"},550:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA+8AAAC7CAIAAACb7zgOAAAVsUlEQVR4AezWAYaDMRQGwL3/JR/i3eATAckCUP6iINWZU8zfAQAAvpPNfwgAAGweAACweQAAsPkk3V03AQAAujvJu80nGWPMOffe5w4AAMDee845xkjyuPnuXmud+wAAAGut7n7cfFUdAADgVlVl8wAAYPMAAIDNAwAANg8AADYPAADYPAAAYPMAAPDDbB4AAGweAACweQAAwOYBAMDmAQAAmwcAAGweAACweQAAsHkAAMDmAQAAmwcAAJt/9c/eGXg2snUB/G8pliyYgAFahSgSpanyWh6JxcQiUcT7sBJepHQEgyCUIARhWDVUlWeVygaNYCtUhEqWJWFJKYPQb86c9jS3t9d0vn1d+vX8BPvSyb13zr3hd0/O3PcynJtL794v7fderINe2Wv/ndm9Zf5/mNiGt2zS9vT2mfyw094y+GBPXtdtfutP5rdId/+9d8vl85fpiWEYhmEYtvnuftSzjZVa/5GsR0Cm88ezhTdnJzl4s/TFZZt/GoZtfnaUh6+G4UxewuZvxl8O8jtrOnShxzP7zuDm9k3DMAzDMGzz7mlpSRKmQSMJb76LChbSs0Dxd09mnJv/zfzst6z85q6jllp3dNosfIxXz1+zzbvjL81SZq3Wfc027/ZqCS2aqPZc2ebDzKz6NzE9tpFMbCR1DVqO4LbhzcIwDMMwbPOYcRfT8NPWh/dLq7EVzNmLir/TGnOlzW8Go62WWpwytMbXbPPo7u/M12vzMmTzYWZWzVWv/YO+uacFEPpU6/stwzAMwzBvuW5+2NgQ0vDo9yvFUk7wjOvjXe+yWLXPdfO/HbZ5tnnlpONXkmEYhmGYN/wU7EUt5ilFojFcrL0pnPbB8ilnP++AXmtmdy7a/JVT+GMZKnD07YI9dBdLDq5Oqx/v6wGWk5lqZwKfVTCftqvZmA77Cv2P0vH3Dtk8XdBtlrBiGIoNUqVW//rJSof239HHyuh2IIu5WrvAAUx6jWLK6wuLj3eK9sXs0S7CaP0I2FdgEKj0CLv5UoQ2c0f3A+vXHn7f+NFpFLOJ5Sh0qi1vFm2qeJaDGVneLhyNFzWdXvJI8OMLL7p3d/RPLbMODUJU17PVs6k6/tcXjpmh8H60Rw8O3jnIb+va40ZItUez3sHHuIaV3Af9xTUw69t4R/ingdLm0XrphVMgdwGhS4sLyb10yvgnWhVK3AHdI8274NzuwC5t6tDU3QTd9Bv5balfuLFDC+vXMVy19kSaTbXNq2dWvT5lfp7kYFWbXfeWYZg3DMMwbPNopcJze1GUeM/yMWdPYrpUPHWFnKKR1pfTRau8m/SVMeb50J03nZsxX3Q282bFKqV9i42s19GnJaaHhq+5+nZuzyp7/rQWjy36zXzcMvwWlo2CBRegvf118oS6uWeliJjvxP3JCuYwv9tpFFOjVLHM3Ba63afjn+FsHtst0A6H9gzeIPd7VJuEAUSrw8FXLKuQ0uEy3AYIwUzm9iiYcX+8192mVclvwwWr+PGT0ePqixOI8Cp0vZmH9hvnXljc7n6cQlopGqjjiYO+YkcX9ycoX/a62Mtv6v79Urj0lN+1mVuPeo3AdoVsfsNIr+k7Ra+LFEwK/RUqyC2YRAw1rAE9thZT2fzoxKr8bazA9ds56KvZnQldwELCLrAFWmY0bKu0o1PcZDAg0cSutyDvR7sGGzxy7rRh6Fv5Mty+P4/FWnULrhf6pR8ZMLAWzhc2FcLmFTMbtD6Jm2HDoLlgGIZ54zAM2zxaKR5Wc9uvrqIKo+VjahlrJCjrTPngbUrot/diIEBWb8Fr4yT3pOMZR+3fW7WLm1tkdmauLDj0qLkNjRv2CISJNI7S7SJzuAU0ckqZw1CvvH+PG1ugSml7LEoeun4om6eWsdQBw7W9ueWPimqTtFLbj8Hksj+jocIPHfS7BwXToALoi2oMDxoKX2kjhnTN7N6FlDQxe/hT8fHFCuzZtUvvr5ptauSnkwG9bg7Q5nEL99W9+5CTXbr/sYJCnXOmtAYa0EvYShtopHC/ixy1jIcTY9xe2V+rIwrsN9pzErRgYEWl4akPIcjYMjr3Q1PD5qav77H9nku3hv3ifw7xDEpk3PpTWYQWstImYH2K36Yo3A7DMAzDMGzzQk38sJnAqhu0fFQN1FayPbIQwxHz3ygx4uk3xFeTVO8RXStKWwXJoTFzT7akUCiC7B93DvSYb9aBfidO+h3Z9oPm7uCbYW0ejyNEPcWCpQ921zbw46jsaJZYyjI4sw+sUmYjGdOpmISCSVdSrDCYoW1eDinR3hMLgaTyJC1lts7HLnoqhUt+YTRQtdHsKZI0Tgr1r9fNaxa9A+sTu6BlJr3kQFFApBcOBp2bIkOTnmwM5VujQ+WdhmXmUkmsnsLg/6rNB69PXNGfIrTTYBiGYRiGbR41C8+rgX9QdQ04IqaQexWNfEJSFvkd+nfw2eEq4yGHxmGg+wZ+Skgho8GjcKPZK8ZAfYW1eWwQtyjwMDHsgkA3wQuxNgkFkZKp+h/5stU8PKtnqJfAYIa3eTk4wTJ9M2wVsX7JfwTCGS/U0piHZ5228BrO5GCK78h/DW3zgV1gWLL19qPh9cauYo1l6p1HF3e/u1K4pGUg9kv5cm0tW7DqrX+c8sa/ZPPB65PapJ0GwzAMwzBs85Ty3G02dqnkZqHyu1FPYDl4CJtX5OaLpyrTwpoHsfiHbF6Vm1c4DSaboaqEyl3Ilp7MfVKOmTROHokMlUaYba+OBUcIpUoQq1ErRe3c/XDxH7xD6uWlbV7OzVOcFbjjC8fa1O4egaBwSeVMwaotZ+5xOb2AzTuz550toyr0Cm3z+GXZqA/mFPx/1ebV61N+HoNhGIZhGLZ5BLPv8ZgmWDgmmBMbSbLAYJtX180rHtrDlK1QAD2yjcgz6ubp0UNVLX6u2cxhzXFQXXKs1qdNAhVqSyORQbWKFYp5ehwWHiNeLRV20dIWbnCvIww+rM3/aY8Cbf5rUN28lj9+qm5+dCXWKaFz40MUFC7kyjm+fIZqz3tljarqfW565bVn1c2358+yeayhomWGzHon7YmyJkoIyPy6e9SZhLV5aTowsL9k89hU8PpkGIZhGIZtXglWxkuyhU5Gj2wSQQI6cbKadKaNlnVIxwXcXmXtPR1ZUzCWNcOgNC1eUF2XzrTRkpUFjVM8C+sn9b+J/6tO6cyQyLqFkkcuCycSFqEjXRyJDG54Ilo0AvdOmfhoRPMLb5DLuq/v/tkve/nEejyUzaNK4nks5d26NBI6iQgPnymVnSk8bJDVpTNt9MznseJ0f5wpf3gaPt9MGw8KF0Ye3DRItYHJZyNCawAOiomnDUVuXlxsWqpUKZqHP4K7GNkLXfgrJ4JRlcD9JAUE1yS2E9rmZyd/aTgdsLZ3luOx1dA2r5jZwPVJXy59p8mlNgzDMAzDNi8lL7GgRXpAViyZCBJQZNang8Chwrjs4KEuCiadKlxMZ7H35PPm2wf5TTqvPV9vo2mpIC/fao4eKxQdoA4nu+cO6BxxOvn+zn1jH+sX0khUDkrpfFA0KZKjoxIMHiyt1p50wlXa4Md1jCTavMRN/wBcFoKTO5o+dYS8eag8i336Zf/hLPyEd+WlK5wZn6J5TGG4gmwecQc23jUsgOrX6UhdN4+43+p3h5ku548nAV0gkzPhTH31MsOZFW4TAxLW5nGcGFhtq9S6HP7vlTbSzKrX5xuzeYZhGIZhm2cGDTrZ5hXBMAzDMAzDsM0zN6dQu699wgKhVwDDMAzDMAzDNs9MHLNw97/zjKY/Tzkg/2XXDiwohqEAio77l/sAFI/MEQQhBI3OkAIVChS0nDPFxQUAQM1/xv7/XaP2BAAANQ8AAKh5AAB4Ss0DAABqHgAAUPMAAKDmAQAANQ8AAKh5AABAzQMAgJoHAADUPAAAoOYBAEDNAwAAah4AAFDzAACAmgcAADW/6L1HxHaTUhpjTOC1AAA1HxG11mORc26tlXKyc8Y8kRxBFP4tBA7ubywhOfkKSydiUlKQdiP+gyOkhgAhIN0UzbLJigRrZKKzzpJJEZFX5Rv7k59Lavdq5LX1ni4YmuquV1U94k1P3fy4WCyallydffdp79u/+bI9Xi74+fLL+An+UqaDo6/l895spSY7GgtDSHK+nH2alt17PAO9ioTvcjlGcNHNv91H8e+sGxI1jMhd9svl0R+DUW4Z3DsqX9tjiftCV/gXFzQMwzAMq/nb29ufgb7vvw+s1+vNr7YQxIGuxPWuSy4F1Xw7E8poq/l27P7D1TgV7+ahdIdrVjY0euh7lh5+NwazmEvL4Gb1/L+CYRiGYTV/dXX1E3BycrK/v394ePj8/Hx9fb2V/tgeVvNW81bzug40OrzgR0ItsUP+8zAMwzAMq/lSSt/3PwQuLi4mk8nBwcFisdgMboT+VmfzIsjQGACB0pUpx6VnYFqK6CFpRQgDaJeh22e2ihHaSDuQCibKR4YmU0AgfAGMAt41ZKWksjvhLONnBWqeOT8ql39KzOBQ5uAsrhnvIBNlRAV3iXiRwzTMMOuCrej15Qxh4kf4VcI5gYathblwkZRvvIpDzTM/qtFpmat5Pu/JdqIlJoIYHPFGQ7A0EHvNjNiz1kGyKkuGYRiGYTV/f38/ATayvg9UqnmVINAH0EbQJRCRVBIhLiEj8AdeJRd7D1Q0UK/EXHZmhz11Ia5TNU8DEIgfyTk/qU1DTmgQylmuEbvkPKhSzQ9+U9cUdqtl93cjKn9BO6l4wpY2lLDdiivkhCsIVG0tzA1i6k7LN2rFpTleNXq+XdWSd4FuJ65D3U/ojcYGHsZC1ww8u3PBLZiUZZYlhWEYhmH4bP709HQSOD8/7wOtap56KDRN/q4/LvSUTmUEzBLNFC7CJtMuXD9dp1LN68TK9fOQOTe8Y4qAa3IiUoc8pGEGMtfycKIjADOWVjxly+mUerJ4TriKQO3W4lx6h/34FYcx33o1qnl5g9RwC4BSduSP1TCICyWf3vV5rRWGYRiGYTX/u6A/Pj7ugVY1L728fKfPV+1VQkfMRKOgDYNCgX/+ub5Ob1PzcERB06Tt2NeRqy7lTJ7goI4yNZ+4hjswkZFEcGcVT9mqXh+myOIJ4ToCNVtLBzErKd9YFc+1bHunTb6dSB6Px/9Uzcf1EKM+c6aPoxpCTZYMwzAMw2r+5ubm6empD6zX637A4+Pjw8NDM9cKZVB1Nq+nklxcNUqdmqfN9mfz4LnFSa24y+NSMaTdR3kPtHDIXcv7DR3Jz+aTDhZlq9PzD4aScAOBmq3F1IlHLd94FYexLguS6gVQy3w70alu5io1z+SjBPjt4LHmbL4iS4ZhGIZhNf/y8nJ3d3cl2Ej519fXhqZ5/c4GZVyNmo/x6r75BjUPv/A1dt98HjJylSDlHBooJuatzANVDZNlEncRPlIhI4AOasVTtpgeF3OEKeUQwpUEOLepbz4v3ygVr++0AWcsKF+orNhO0OJTnVKl5nHfzeZ4Hqjom4eN9s2nMAzDMAyr+ff397e3t18Fm8GPj4+mb9qw9YUSR1+X59qI32npVjUfHom5lWqeE+dnlWfzmEiVrL0KSU7y5iJNncSbceZEfCVGcj5bJZ02ietIoyaWI7mYzivOjIEtp8PgL2fPGFHCNQQatpbS0PKNVnGmgjREzed3n1rm20keZprUPJgoYfkfvXn/22/s3aENADAMA8H9tw40CreluxGKHljN/0oAoOahQEqOqd/9AQA1Dxl4VCGTHgBAzcN3AEvKd8nQxU4dANQ8AACg5gEAQM0DAABqHgAAUPMAADBOzQMAgJoHAADUPAAAoOYBAAA1DwAAah4AAFDzAACAmgcAADUPAACoeQAAQM0DAABqHgAA1DwAAKDmAQAANQ8AAGoeAABQ8wAAgJoHAADUPAAAqHkAAEDNAwAAah4AANQ8AACg5gEAgP6aP3bOAEOWGIqia2k0elmlMSsJUjspspRELaPp2cSnH//KXJHfpvwx5RyD8qSSl2o4lbnqc7vfLtf4+9geB/Ta8m0pn1Y+nD1db6m+Lut6uZfnkZPr4aQ6XvqojQye/LN8XPJuZQAAAADA5t1KH2Wrv8XmhWz+gE4k0GbzDjb/gwAAAABg84+yXNdmZWwem/9VAAAAAHA2b35s8ZtQ2z31dXln1O9lGzr033s1IIS15aivLSoa43GgtaloSZthgkgN2Dwi2oi/VIdb1tK+KSO2ozmtvaWUsHl78usmm3+tWMryesLPfgYZvzfjFQAAAAA4g83reN7Utq6q1LXTx6iH+EY9hDWuY7yJo705xGm0ZDfqLUs6ux4eJb2K0UMMkFLPzubVgBpTz5Ozed+ylo6i+mlVu9YM2Z5St4vYdTwN7Vo/jWxeD1wzTJqxykkAAAAAwOb9JD7vJsEhi+GaYY2e0lHdb7cwjKQ5xsie5bLj/InGv2vzPmY6/3zLsYTGj9HturBO1LA1M+hEW8u7N6PKiQEAAADA5rvjXkU4LHbiQmla7EpqgRPlQzphjTkl3Jr2SwbmfZt3Tdft37N59eYNSLX7eM/4vULTjm3e59Tq1oxVTgoAAAAANi93bNk1d6q2/lYgdH5szG1eUn7Q2bz6/PbZvLDoji/qZ/Oq+077k3XvxNYS3owqpwEAAAAAm1ceXRauxMvc5j1QPs/Nv2/zWjeuY/z/yc1PbF6xeO9Bs+la/83w3LzGDHLz01cmb8YrpwAAAAAAm7dvvFhiu0txjNTWkjB596SNbtFy8teZzXcf2El5cjZvK9o3bbQpR2NS/efcvFI0jlZc8rpojOqpaqdfvg7UBkkb++0GzVjltAAAAACQtPnTbh1gWAxDARTd/+YKQohQ2UDEqwLoGIMB1Q/1H85xF3F/AQAAbh4AAHDzAADg5gEAADcPAAC4eQAAcPMAAICbBwAA3DwAAODmAQDAzQMAAG7+2wAAwM3PFbWPrTRJkiRJd9U+5opcNz9XlLbHcV4AAMC9OM7S9rki0c3XPj5ceQAAMPS1j0Q3v5V2AQAAL/+zmwcAgGduHgAAcPMAAPA+Nw8AALh5AABIxM0DAABuHgAA3LybBwAANw8AALh5AADIyM0DAABuHgAA3LybBwAANw8AALh5AADIx80DAABuHgAA3LybBwAANw8AALh5AADIx80DAABuHgAA3LybBwAANw8AALh5AADIxM0DAABuHgAA3LybBwAAN1/7iOO8AACAJ3GctY9ENz9XlLYbegAAeFz50va5ItHN/w197WMr7S5JkiRJtY//lc9z8wAAwHvcPAAAuHkAAMDNAwAAbh4AANw8AADg5gEAADcPAAC4eQAAcPMAAICbBwAA3DwAALh5AADAzQMAAG4eAABw8wAA4OYBAAA3DwAAuHkAAHDzAACAm88NAADcPAAA4OYBAAA3DwAAbh4AAHDzAACAmwcAADf/AzdqrTUOa7yAAAAAAElFTkSuQmCC"},551:function(A,e,t){A.exports=t.p+"assets/img/CustomerEmailBody.d9e6d6a4.png"},552:function(A,e,t){A.exports=t.p+"assets/img/EmployeeEmail.f299755f.png"},553:function(A,e,t){A.exports=t.p+"assets/img/FinalRecipeView.863abe31.png"},554:function(A,e,t){A.exports=t.p+"assets/img/ReceivedCustomerEmailBody.7466a15a.png"},555:function(A,e,t){A.exports=t.p+"assets/img/EmployeeEmailBody.ea00b163.jpg"},786:function(A,e,t){"use strict";t.r(e);var i=t(9),a=Object(i.a)({},(function(){var A=this,e=A._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":A.$parent.slotKey}},[e("h1",{attrs:{id:"btcpay-email-receipts-ticket-sale-guide"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-email-receipts-ticket-sale-guide"}},[A._v("#")]),A._v(" BTCPay Email Receipts - Ticket Sale Guide")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(541),alt:"FrontPage",title:"FrontPage"}})]),A._v(" "),e("p",[A._v("This guide shows how to setup a simple event ticket sale system, using the "),e("strong",[A._v("BTCPay Email Receipts")]),A._v(" preset in Transmuter.")]),A._v(" "),e("p",[A._v("Transmuter is currently in "),e("em",[A._v("alpha state")]),A._v(", but this preset relies mainly on sending emails, so it's fairly easy to use with your BTCPay, even if you are not a developer. What you will need in addition to Transmuter is, a BTCPayServer instance with at least one store and a few email accounts for testing your ticketing setup. This guide is using Gmail for simplicity, although other email clients can be used.")]),A._v(" "),e("h2",{attrs:{id:"how-the-ticket-sale-system-works"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-the-ticket-sale-system-works"}},[A._v("#")]),A._v(" How the Ticket Sale System Works")]),A._v(" "),e("p",[A._v("Create a simple BTCPay Point Of Sale App that sells tickets for a future event with limited quantity.\nWhen someone purchases a ticket in the connected BTCPayServer POS App, send the customer an email receipt containing their QR code event ticket and send an email receipt to the event organizer, alerting of the ticket sale and the payment details.")]),A._v(" "),e("h2",{attrs:{id:"btcpay-pos-app-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-pos-app-setup"}},[A._v("#")]),A._v(" BTCPay POS App Setup")]),A._v(" "),e("p",[A._v('First create a Point of Sale App in BTCPayServer called "Ticket App" with one product (our event ticket), which has an inventory limit of quantity 30.')]),A._v(" "),e("figure",[e("img",{attrs:{src:t(542),alt:"TicketApp",title:"TicketApp"}})]),A._v(" "),e("h2",{attrs:{id:"transmuter-email-receipts-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transmuter-email-receipts-setup"}},[A._v("#")]),A._v(" Transmuter Email Receipts Setup")]),A._v(" "),e("p",[A._v("In our Transmuter create a Preset > BTCPay Email Receipts.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(543),alt:"Presets",title:"Presets"}})]),A._v(" "),e("figure",[e("img",{attrs:{src:t(544),alt:"ExternalService_Setup",title:"ExternalService_Setup"}})]),A._v(" "),e("p",[A._v("Next, connect our BTCPay as an external service to Transmuter.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(545),alt:"CreateBTCPayService",title:"CreateBTCPayService"}})]),A._v(" "),e("p",[A._v("Next obtain a pairing code from our BTCPay. So Transmuter can send emails when BTCPay POS invoices are paid.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(546),alt:"SIN_PairingCode",title:"SIN_PairingCode"}})]),A._v(" "),e("p",[A._v("Once pairing is successful shows in your BTCPay, go back to Transmuter press Save to authorize your BTCPay client connection.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(547),alt:"ExternalService_Add",title:"ExternalService_Add"}})]),A._v(" "),e("p",[A._v("Next create an email sending SMTP service.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(548),alt:"CreateExternalService_SMTP",title:"CreateExternalService_SMTP"}})]),A._v(" "),e("p",[A._v("See this "),e("RouterLink",{attrs:{to:"/FAQ/FAQ-ServerSettings/#how-to-configure-smtp-settings-in-btcpay"}},[A._v("SMTP settings example")]),A._v(" for setup. Save after data is updated, and return to preset of Email Forwarder.")],1),A._v(" "),e("figure",[e("img",{attrs:{src:t(549),alt:"InvoiceStatusTrigger",title:"InvoiceStatusTrigger"}})]),A._v(" "),e("p",[A._v("Choose the invoice status to send ticket email receipts on. During testing, use the "),e("strong",[A._v("New")]),A._v(" invoice status, so that payment is not required to send emails. Once everything is setup correctly and working properly, choose a status like "),e("RouterLink",{attrs:{to:"/Invoices/"}},[A._v("Paid or Confirmed")]),A._v(".")],1),A._v(" "),e("figure",[e("img",{attrs:{src:t(550),alt:"SendEmailToCustomerEmail",title:"SendEmailToCustomerEmail"}})]),A._v(" "),e("p",[A._v("Select send email to the address registered on the BTCPay Invoice. Be sure that the refund email setting has not been "),e("RouterLink",{attrs:{to:"/FAQ/FAQ-Stores/#how-to-disable-email-on-invoices"}},[A._v("disabled")]),A._v(" in your BTCPay store, in order to prompt customers to provide their email before paying the invoice.")],1),A._v(" "),e("p",[A._v("Next supply the sending email address, email subject and email body. Note the highlighted line in the picture below, it uses http://goqr.me/api to create a QR code of the invoice payment which will be used as the event ticket inside the customer's receipt email.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(551),alt:"CustomerEmailBody",title:"CustomerEmailBody"}})]),A._v(" "),e("p",[A._v("After saving, there will be a recipe which has been generated by the preset. In the action group, there will be one email for the customer. Next, add a second email to notify the owner of the ticket sale. This is also important in case the customer provides an incorrect email, the event organizer will still receive their payment information.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(552),alt:"EmployeeEmail",title:"EmployeeEmail"}})]),A._v(" "),e("p",[A._v("Add your second email account details, email subject and HTML email body. Note some of the purchase data you can insert into the event organizer email receipt. Press save.")]),A._v(" "),e("p",[A._v("Be sure to enable your recipe (checkbox).")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(553),alt:"FinalRecipeView",title:"FinalRecipeView"}})]),A._v(" "),e("p",[A._v("Once the recipe is "),e("strong",[A._v("enabled")]),A._v(", start creating invoices in the BTCPay POS Ticket App and see the emails sent. Providing a valid email in the POS invoice creation process will send an event ticket email receipt to the customer and a payment email to the event organizer.")]),A._v(" "),e("p",[A._v("When the QR code contained in the customer email is scanned (with phone camera for example), it will lead to the BTCPay invoice page to verify the ticket at your event.")]),A._v(" "),e("p",[A._v("Below is a basic HTML email template that the customer would receive and a basic HTML email template that the event organizer would receive, with some invoice data from the time of purchase. Feel free to improve these demo "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcTransmuter/tree/master/docs/templates",target:"_blank",rel:"noopener noreferrer"}},[A._v("templates"),e("OutboundLink")],1),A._v(".")]),A._v(" "),e("p",[e("img",{attrs:{src:t(554),alt:"ReceivedCustomerEmailBody",title:"ReceivedCustomerEmailBody"}}),A._v(" "),e("img",{attrs:{src:t(555),alt:"EmployeeEmailBody",title:"EmployeeEmailBody"}})])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[10],{558:function(A,e,t){A.exports=t.p+"assets/img/FrontPage.616c97f1.png"},559:function(A,e,t){A.exports=t.p+"assets/img/TicketApp.3fcd4bd4.png"},560:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAvYAAABHCAMAAABbNvPrAAABJlBMVEX///+Ee/+l6v//6v9Se///1f8Ap////8+FJYrN///NiSkhJSkhic/qrGdhrOuFJWep5/8Ae/+E1f+FJSn/56xhJYr/zIohY6zq//9hY6zZ2tpVWVwAkP/n///G1f9Svv+lkP+l1f/G///Gp/+VkP/nvv8hiaypYykhJYqniSmFzP///+upY2dhJSmprGeFzM8hJWfNrGdhrKxhrM+lvv+EkP+lp/+FY2dhic/qrIqFic+piaxSkP+Evv+FrKzq/+vNiWfN/+upY4qEp/+FY6whY2dhY2dhJWchiYrNzIqFiWeFiYqpzP/NiYqpzKzNrKxSp/+p5+up589hiYrn1f8hY4rqzIqprIrXrGeFrOshJYGKYynN/8/q/8+prOvG6v9hY4qFY4oOC5SBAAAOD0lEQVR4AezBgQAAAACAoP2pF6kCAAAAAAAAAJj9slyMHIaBsJe7duKrU4aFMjMzvv8z3YyjTXKXMkO0SUxjST8+q+53sVI5M6hUZfRcq9XV663R1/StNsEdq6FNuiJ5voUBn7uD/+m/e0FbVdh3NOLsnCs/hn2OZQeLXol9Y8AYEzwH+8EhNg9iT8mrsR8eGf3J2BdWc2WiHz0X+/rrq72w/Czsx0YfwT4vKbAvbHzCTIzn0a5NtirVtnMdJdZlvzRVdZMt//cgwndaJCnLXOLETKc0OVuGswjv9JxzblrN1bv4lpxrQ4qpeixr5Vlm0Qdw4fzC4tKyWlmwamW1f3DNmGWU7nV8tTEbXjpsMKmX0SGj2mwCRwhHtiybxVSyPTAySg/AEn0TIIQgDV9EmiEQeJk5hIZbBXv6wQyDi9x67MM4R351kqTeWWAOsihR6aywr2UTxpgJ6QvvQn+lWk/v712wvKsAKUmeK6uamyb2qUSwJ+fdSM0Q846q7HW4sN9SM3WQXuYaNHVGAfOU3VHCiRDrZgiAgHPj4JAV+wiDxebgGtZIo15Mqn0Pe4AZjowSSajYwEQCNZmG62X2GwN8l33IY8aTvxCDBxaeVk6wIRDs4YelXqo9Z+ADk/EEv9qmSWqkrAOZ9lFlvyrsS5mh3XED6ZaBNTFlfY4qpy35S0BafZfYiyS525fn6t4FRUR77uy0NReJW64Rd/a5R2RSQoPkbm9JCRki3biYD2/3NYetnAqMSRL7OexjORoiTMAz2MthoY59ebNXIsIZniMq9ok/eRhLyGVoyNEwEZ4ASpMk6RN+LuJpiSq5fgsrqn3M9EyUHAbBfq6DFogL9iIRBRcVzgh5hosuf2V/JAR7qoi9g01Slq/2BIZdAsyLwyV+IJtHYpHYc+k+7LnLepCpX/4XexsP/sOe9xc5VFfX+K2iOmMqwd7ANqW40ynXfAlHNisLHI5cJElqyxAX8bSPJPvVd7Hibi9MyzCDPZvSndhnqj0XbvDutbg5U+3ZwVmg3Y19Wu1J5c7JaLhz3SRp2WrPzt3YcxeBo+7xas9Z+QdYbxzjvf3b3lkwOY4kUXh7ed1w1LHMvN5jZmZmxv//Jy6/qs9WlkLh8Iw1fb67fDEGlbJA9lN2dnW+SQKaydt7jjYX6MjRBt853C9S2ts83WznjgIheN/OkdPeDMT20p4Tjy16++hjbA+f3/pqRPbxgO9vNNr7O268h/7LtMelNlLK0+9F0Pz9L0LzFtvD9s0Q24dddNnT/vYHxPaQzThH2kejsX2iPc/RqN//fkT232/zTrE9w020p13a94iK5mmR0v5Zmzmy/3mjYJQedB5o3yJ8ad+2YZa9vZs88Jn37uVESPMdac95dnLeYJd/kfaGErpnfxHt0cIPu7eP47aTI6cxf/dHe9oTosROjmMk2j/U94IS7Z3rkz/WMBjKdAz/kx3tjXiiLboyNSELv9LyGoOwxTMtUtrbzJH9HygKhUKhUCgUCoVCoVAoFAqFQqFQKBQKhULps3r65kFcfPgEOeGx8I+vgyxEwdWK2Fwd2348zIsmOegBo6CeBEFJPHctCZmScUjjHK15WSol7Y+TGr66aLExc/EU2ot7pz05BcpLyKU0T5Pn1TQjZg0dwB3SvmhPIs3DJkv2vLRIxnl9yT3TDA7Q/nHf3iPtdZW3P/3P0f6qJQXBTJ7ILfsZSc0oWf63aF+Jx9IeHkJ7GSu/yTjG5/dc+od3zU0aGD6fR5YbSvs+Iu2v4/x5eYNRYoTo+Cpi9Qt+oHSVYcJGRqji+/nHWkKXcsLATmT4I84DlXxJM7gzIWvZnLRI4gwm0QsD8tA+mMYwCU66kXYJMzv/1aPsRYcxLCfMtERNaFsYKV803x6pVV7kZ5AvMnM8xcm27ADXGIeugSWbY/egUTITSYqWCtq/JROl/WMw+mHT5xPtkcjySHLDRHvsLx7m5TGkhq8zKKKth6NjM+cIoxFPByEnFV+IUol2k5xwJzLMucEQLWkGNZH2TS37pe+H6m9rLygdZ/MYW95Je+48JueRaf+tJjqkkRGlfVMT2qZ8kXZ+Nvzi2X4RLhKxpDPzQksD1xhjuIZYMmfJqH7QKFGhsf2HVZYglpLfEN67Ig7MR77YpQ/70DbRvgf/MD3a6ZW1KnSA8/Gv2+tvVUV9LKg0qfhgV5ITTiJDGcXzTEWiibSn6f1vfzweu17BOFg6jQGgsrE9hJTJE+0JvpiIA35+SPubRuneNglaek8vwkUynDPL/hSJcdQslOveWZBT3h4CZ28vvwl+eAnO6+Z9ybTHMNO+S8wjgqEnQ2PS7gVpz2gtpiL8GYEwRBWfxElywklkaDykwC9rBjWR9k31+sXbLwYv7RXUDmw9mtLp5TUcnHl71mIKPfyGynva04BmcZvki32tXoT3FE/O3G9Vf0ve3dNTSr93z52gYnvYuhDb45h7DPRLzi/SXrlhoj2uHudu/30nac+AtjNhQueeHJf2ySEqMky0n5R8PjTZ0z4OfrSNx81D9pJSaQxdu3Tj7Ty2N1Dh9Dd/helA+/c/+utYsN7eJXijgj6ajPbQAb1GhLjb5O0Z6w5QyN6esN2dHJnaQp1Xv/PwIu2VG460h+0GSG+12P6NnRyd0ZEXSnu7CP7Xjggo+DfRPskJFRkmTz0p+XxosqM9NI7I/pvxsJd74x45jbF99vZG2H0npzORhTz9my9yKO0VONKW5IubFtuHtbjusb0zY+QC2iRItFxDvGBEY+EuaN/DcZ3vWxzJbwKRFz9HZM4p4xX//wMfyg0H2iPM3cX4mBsqNW9/4QbPi79tbQlGEoYd0j7JCRUZJtonJZ8PTaS9pGMvx17BT8Iij5z0d18wtmdemdkjKKMXRYfwdDunPYyfyReVJMZgLpKdHGeOWZ75vafinvsDtq6hsf9jZ7STUzBmORXcJ//NMHZZqx9EP1sU9P1F++ubVXMZzpr2hTfY3yza337sfv5ce+2+aNG+UCgUCoVCoVAoFAqFQqFQOAFkEJwAJSmnQ1XgaSb3s8/4zB9Pl5McuS1pfsLJo2mAzebq+MnOQEl5BoXAXm0JBwvSJ/WFK8DUyDO6bpPel9nlyTOj/fLnI+3vc7JRSWm2h0rKFZVkvj0v2j+8rPhTX7gKyUhYuf3TGdPe9IH/M9onJaX5d2QEqqQ8f9qfnHjMH1AVCDbFn/mRQy1CBIGv9zTND+fCg0gGe5GrpiC0mOHSd2dFQksM8lm0lHUq+1Gl8M9/0cvEt6SoUI3eVMkwCujE41lMlAbulXjmdm2fjscwldUMsyzwWrfGOTPJbjixUfTHCPMxDggbCbme7iV+bpQKajouUnOgzJE7jK87Lx4rP5J3/0oAE+8RKcbwemGOfJb2e5mjKsYjNZVZSckYKykpmefXTUCJzbZpKf/2pNmAfBM+Y8dKHcCyj5jPZaX2WFNmIu0VCOrtVZykWoToTR43wX4qPKhdNJOmGe253mH2nqkioSUGezkdK/tRpZBzOidFhV2j9w37NXEej5skDUxKPF6ehkswcJiqT/KNlF2fUjP19rEcqxi63tkYh4SN18gLsX/i765c09kiNQ9wIjooEZgt3sqJXWzG1IoUW1dpaFui/VQ0kZ7HaSqTkpJhVlFSpmc/hTZ8p32fZfo+GhzAK1BkOcpKpcm6osLH9wLBifZ67Fktwjc+bOHB1NZoz79c73B3CyfB0KwiYVNpfHBWgQqYOaxGb+zng+6TUNAZ6ORjNpWTKAvsQ0Zfhet72oNraT9f7iFhY7DgD1cO7co1HRepudfYZoj554uXkCyInwF4xZ36INXVsi3RfiqaKFEPayqzklJerqOk9PKdgnET7Xur3wd2wPU6fG+YyUrtsb63VyA49/apFiEvcP7hofDgW/Gm0f71phgcSgElukv/dAlo7faVAZdor6gw9xtpr2JqifbjVE6iLFDat8+a44n22En7cdrDwkaDiSyQGU1d5M5c2kMeeLMdF58qJ1p+UZHiFIbEGLZl2ls9Thodo6nM2hqGWUdJyceCVMKVD96+X5HfB3bpVyuHV3ExykrtsX5sb/wi7Y3ts7eH9kHwf8RTLjyIydzbZ9rLhMF9SrQbP73AMu15Sf0Waa8Sb9nbO5WTTLLAZW+P9ZK3x+CAsJHXH1/ZzZWPpi5Sc6+x/5z49l8Zer74ydv/PMIRaZEr6yb15Uh7rupYTWVWUjr6iUpKwYDeSjNv35fMFNrZ4gyDyDLLSu2xHqS9AkFpH1BfmGsRQvs3vhNvpsKDimKRThnbJ9oLYk12cvYVCeXR7T//9ZRR5jLt1ej9zX6LtFeJN2PObConmWSBLQKex/Z0SLH9OMYhYSMsZE5ie1c+mrpIzQG1FaM1TH8Ss4yLnyoncvR0j3hH2hMeXS3R/llVjEdpKgdvz5LcyTlNSak15/wUlOX3HT3e7b4PL8kB+vB/U2Q5ykrtgcmqtFcgCPU7p9UX5lqE0J5SnrnwIFavu5NDzyXaG0P6O7o84sO+8hzfceNCMDHRXo2e/ZZprxJvxpz5VEySZYEUInTDJNHeKoZWKRzGOChsJMSJB/ZbV67pfJGYy72Pt8G97YfFK2KU9vxKrUjRz6ev21hgTntVjEdqKpOSkuvl6HQlJW+4YWKu/im0t09H42brZ9q+D+1AG8DhFVmOslJ6aFK4V92T7D2nRUKjM1A/nudHdugzKugxj2fe2SxSt7syNld34FHuDgSehQw3ELbHywLPa5Hs1K8KVYx3oKS8I2zOv7p1oVAoFAqFQqFQKBQKhUKhUCgUCoVCofBvZQspYm2wM7AAAAAASUVORK5CYII="},561:function(A,e,t){A.exports=t.p+"assets/img/ExternalService_Setup.9c2a74c4.png"},562:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABAcAAAESCAIAAAAOhSuaAAAZLElEQVR4AezXgQAAAAACoP2lH+SyKIVvAABYAQAAWAEAAGAFAACAFQAAAFYAAABYAQAAYAUAAIAVAAAAVgAAAFgBAABgBQAAgBUAAABWAGPvDDwb2dow/rcUl1wwAQO0LkTRKG0tt+Uj6yK1SCzGXr6VspGSCAZBCEUIQlgxrCpVobJBI2iEVaGSUlLKlHAwzLfpZt40JzmVt5u737h9fgZb2545c96D5znnPeddInflv35f+W30vK3cuf8uBl+P4pFYotKyHfdVAgAAAAC4Akf0LipZIxJe10ea7/HR1rf3jEzR6gxei0hqpbxvVzyZpvsS4ArETatcSO5vbWg0mPpGeCuWKNV6Q9cXXJd2vL7Fvzy4AAAAAACvzRUMzvN7+jNSOFq+dV8IXAFcgdOv/nc7oB7V1IVPgm9SJ99+vnNfEQAAAACAK3Duzg5JsfneFQz77dPRhkYo1/rnXAHtk4S3Zp+jF7sCcd05q5jxyEbu4jW5AqdfjgafTqfA6ngwQ7rPXIHTPz7Y1b6HPnLUHrqvBwAAAADAFYhmemOi2LTteKF2dStcQjz0Lq2Ckaz6wxU0015X0/+4KyCp6vuWfe0KBpUoTbDQ35X2vTvFffesYBRaLgAAAAAA+L+5gsHnKO0SBP7MN213qcAVwBXcVaNeyN6UrhwXAAAAAAD4zBUMawnNU2zrmebQXTZwBXAF9NUUMgAAAAAA4CdX0CvteqkdodyluygXmalzt4NGLro62nDQ86MfCdGvl5L7m6sBL0d/P11p3rpzuO/WR9n2lGUe1Dcjo0QmWxKXi555sC+trBEZt6athiNG4bRrO8vV7qJ+GPLSrozje5XdCo4OrdKIzT5/VQbuIp1nhUBW7XbHSr3b0MaBiKWsDjXIDwTXFfTL/5E/diGch7Y1OoOheUcR9oyjs+7D3PQkalx8qyTe6KPfj1mjH8+T3lbYbvHanaWdD031TRF9Kd9pbzSrvQC9SxZrfeESjMnvBwAAAAAAV0DajiQR3xXcn8S1OZfziMuj+Tcaadup2pSOtE8/airFrMeqN0xX4PSPFXfdaLHS1XBprkDaaQnlO9Nac4MGtue4C7gCZufVIZhxBf1eJTrbpvYomnmB4LsCWXn/FtzJL1YH4Obkw2ZwXmf0/VJXKFxBr5MPSQPrtFLaM13tFrfG/7tvPSiiT4h2IaI9E0TG5PcPAAAAAIArELWEp1fCxa77EleQTHwKzl7ZKS4ynjgLht+b5dNG3SolIvoKrdp2Z1SdvrF/YBatRv20kn0/UcaB9ye2t+R8bJpZ04y/oSR14/uPj0+pac/cdaNHEiWrfl4rm0ZY81o7qIml5vnYXwyvq7EqbRfcVt5KX3p98thPg+7C3zHMcedLLdvld14OgdIVhKPR0GihfTd+aGYPovrEPwQT59QeIxB8V0D2iS4giubO+8JxldxU3nq/r0WSk85Qz2tinitIJt7MUertnOdJYpYtm4JSePz7xrGtjL50KJ+2CL6HL2Xs6hq9izH5fQAAAAAA4ApIvJIA+upyXQE9oU/TJahEK7vuJc9U+nN1VeDvicQcfP74oSIntPTKUdoHqA7U5wpUJ6fpjISsMjcK336uXoEkFp0+6eO1dEv8yCz6FJQ3ENR+g995dQgk1U7/m25MhndgTTYWSOizA8GvV3Bj7evS/kNkJpGJTid7A/g4pESvQkN0dCW7Am/KFTsDyfld5tempT9xVdweT8hPDfFsjEQtGZhco2RdiemLfcu1AX/yAwAAAAD4zxVcvNAVBKKjDJmn2FZMuTR7b+3P6jPHnYN9Elf0TekKnE7uD+UZCVowXst3luMKiG5p52kiE/24nm87C+9CcDuvDgGpdtW1PySFVzSz6RKsQHBcAWF3yjP5UYHNj9VrhYj/gwZw3ih1ZFdALmIG+isqVyylDwXp0xQx6hff0J6JpSjyzZv8AAAAAAD/DlegkrAPx+8nCkwtuIPZ1kLSnOEKOk/U5DNX5ketwc9VMZu9WZ9OEaylrfL74I91/WxLLP5R7M7LIVC4AsoNU55UJliBYLsCYnTuOaJL2fbZC/FkMBX+TXrv5zt5cCiJi5g1Qk+zsK5LO7L9UHwvJRrJR5aXOPkBAAAAAHzgCkhjcc8VnAnluuwKZ8Vd2P32eaNaMrOHxh6VvOW4AvuLoX6dlG6+7PtDh43U9FevHTYEp2V259UhUKt2lStgB0Jun4+4aeSeegMtWr6RhbXqoffKrmCrdOUqIAOgJetCuoCL7IcyRqKWXFF7tpdPfgAAAAAAf9xB1Mpqv8trqNw7iBTClyGMrq0fV0lKD8MVkDr85a6AsE9I1lOKCKNldufVIeC7AlYg1O3zGZwmvYO5lG1PLXNdgTqylAJEyUL0Ilr+V8WI8Qr+5AcAAAAA8IcrEGcHv8vZF3xXoHIa+0eN+rnyubqXjtKO78kpVGr1807vvpbguoLPtGacqarfW2/1xdJdgdP9ITrp2Sl2WS2zO79UV8APxBJcAR2ZoM7UnalCyOFD65n507wRLMlOvxZIt2ijjP5KFSPGdgR/8gMAAAAA+MQVUI0n9a2dPFdAqm4Bvehd10MpN7bzc+cKWqZXWCrTdH5pBeKr4q532tVMaN7J4xtOy9zOL9UV8AOxNFdAgpuKTjTN4JR8V7OwK6DDvnSKgP6KyhSov5eiozbP/MkPAAAAAOAnV0CL3HTB5YAtSdUnO+n2G0JdQyr1VaHhnnEFko2h8gt0n/2vcQXdSc762dBzCFS/TNEy9ZDf+eW7An4gWK6gVVRXLpP2CiiJn8aT6wrUPFRjdH8R/VvK9VJEXzRU5er4kx8AAAAAwFeuQE4doZsijcJpdzB0JwwfepdWwUhWb9WyUj7ZqbYZzkO78rHQksXomtlyCarnReJMFl606CvvPNDp1WLnwZW4beTS1mC5roBsFelj0Ur9MefGevl76WZNfueX7gr4geC5ghTNKyHPBOlcgSTBA9FS23YlBuf5lHXHcQXyke5wLp+gMgULRJ+umaKSCFMmR/SpXgFn8gMAAAAA+MMVEOIyv0PGQPlEywu4AklCUa3ccR3fg1hIJ71FUpgKwWYefy259/131jdC88QZrSVTldyEaabIsdyfxCcfEtT/NFLj4seZ+J+rARKOvJtJ1ZeTUu4QVSeQCh5r0eqt6iBHUI8mRx07sAYus/PLdwXcQLBdwYo0pJujL5p3BxENIP3X6o6RGc+fQ2NnNUgvZbgCaUPmewfo5PFiroDKk9Gs3jMyUm1j5uQHAAAAAPCVK6Cl6Ij+066AEO38bkDZlJ5r0XulkrekERvPFfxaV/ft5uTDuvIrAjHeXoH6DhnKHZLSfuQNhADVD/bqEoQU1woxOr98V8ANBM8V5OSW5UJm5W/Cnab3hbYRZp/gPnevQDY/tNfE2SkadgoRXX03FH/yAwAAAAD4yhUQdrdWPDT2nqzjBla3w++ShQrdmrKYK6DWDmLh1SCtm4YjRpaaIuxONR0L6d7aatpq2wpxRgy71TS1rIciZt12Jzh3zYoZj2xotO6+ub1/UKpe9oXjqmG5Ak/6K/SouMiseW+XClqJb1bq3baueUvO2Ybtsju/fFfACwTztLHzcHVhjabW1o8Pp+86Kl+og3LbKpvG3rpOmwbhrViiZLVvBP9cgXy8nsoUcPPHBheVrBEJ6fQVkXihRlOaWGDy+xAA/tfeHXDIleZ7HL8A9k2swWBeSoABAiCCwAW9NhC9xpIlWQtoGtPAQmiDTQ/TmAuuQFJJD21iI7mRi1u6QyY6kgDOfZL/dO1vd55tlepU59T05+MxKqfOOX26A//vnFMdAFQBAACgCgAAAFUAAACoAgAAQBUAAACqAAAAUAUAAIAqAAAAVAEAAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUAQAAoAoAAGD1qQIAAEAVAAAAqgAAAFAFAACAKgAAAFQBAACgCgAAAFUAAACogun2pc+/+OzGgyEcbl+pLecDAACogstXLn1+5dZUFZxfAAC4V3DzVsuAy9uHqgAAAM5tFUyG57cuf3Fp+3mvCh5cb48Y1ZqVw72b7fWk7dY21n2GtqX2yZx4f9rcDgAAjLUK6kXN91EFFQDX7/0jD+p1NUCriNp5NvTnSYYojXpdxwIAACOtgoyBrII0uXE85bcqmN03iBLI6T/PXIfEOccHAABUQdwNiCqIp4BqdaqgHdXOEDvn/YRccchIAQCAKqhR/uatqoKc8vNewTxVUGeWAasGAABVUKN/fji4Tfz1dFC9nrsK8nMFqwUAAFRBTf9VBbMPE79fN6/Pf68gT3W8YvunAAAAqgAAAFAFAACAKgAAAFQBAACgCgAAAFUAAACoAgAAQBUAAACqAAAAUAUAAIAqAAAAVAEAAKAKXrw8evj42f39R+NZlmVZlmVZlmW1Kb3N6susgkiC/UdPj169HsYEAABoU3qb1TMMllUFrT8kwWgBACAM2sS+9CpoNyaG0QEAAHJiVwVnDwAAVAEAAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUwd7WhS8vbuwNJexvfHnxwub+MJ+9zYvtPMdra29oDm5fjY21ru5O64CD3bV/bF+/fRAbj9faTm0FAIBlUwVX19dqWA/TnfULH1gFNcTX6zowAqPm/jx5bDnY3WjHVhVUUdRRZxcGAACgCmJGn83xG5vrC1VBnTMzI6qg3p2N/iGqIPbMCwAAgKVRBbt7OxEAx+P4tDbmxJ+3AlLsUw8O5SNJUQWx5xxVUBdQ15OPFXXCI0sDAAAWoAqmMbjPxvocymMEzz37nyuoo0Ln5D2dJ4hqz73N2pjTf780AABgUargeLCOLVEFMcpHIaQ4vA6sfRapgllddHaLU8XlxUYAAFiUKoj/T1/zfY7dTT5N1J3powpq9I8xfbEniFLnFxbFzh/n4wcAAKAKauLfqVE7SyBH8P2NevfkKsgMyD/mV5y7CmJj/7ZDhgoAAJyCKqjX9XHerIKc+6+uz95d7Ami2TSfHw7u/GbSE64wT5W/VhUAAE5JFeSTP90qyIl8vn/FrF8Fs5N39u9WQf5raJtbearF/00DAABQBYvIfhiL7A0AAFgmVZC/J3Q88l9OAACAZVAFMXyP50Gd+AjE/PcuAABAFQAAAKoAAABQBQAAgCoAAABUAQAAcK6q4OHjZ0evXg8AAMD4tFm9TexLr4IXL4/2Hz0dYRgAAIAkaLN6m9iXWAUZBq0/2o0Jy7Isy7Isy7LGs9qUHkmwQBWcQwAAgCoAAACyCgAAAFUAAACoAgAAQBUAAACqAAAAUAUAAIAqAAAAVAEAAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUAQAAoAoAAABVAAAAqAIAAEAVTLcvff7FZ/+8Lm0/HwAAgHN3r+Dezc8ubx8OAACAKgAAAFTB8et46/Obk2E43L7y2Y0H7b/1oFF7Hcc/uO4BJAAA+LVUQY34V25NhzK5UYP+uyqIof/5rcv1+uckuH6vcywAALCaVXB8WyCn/NzYxCGdY90uAACAFa6C+N1ENye1vZVApkLu0w45voeQK3YDAABWswrqAaH2UNDkxuzRoJPuFcR2AABg5asgt1y59C+PFdXTRPFZgnwNAAD8mqqgZv36PHHeK9i+dbnzu4byX0OLcgAAAFaoClLnNxHFE0QAAMA5qYLJjfjQ8PmoAgAAUAX5z5Z9EQ8U/bqqAAAAVAEAAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUAQAAoApevDx6+PjZ/f1HlmVZlmVZlmWNZ7Upvc3qS6yCTIL9R0+PXr0eAACAMWlTepvVMwyWVQWtP0abBAAAIAzaxL70Kmg3JgYAAGBkcmL/pFUAAACoAgAAQBUAAACqAAAAUAUAAIAqAAAAVAEAAKAKAAAAVQAAAKiCva0LX16crY29Dzl082Icu7U3LGB/o3OGM3Swu1ZfvdbV3enwyUx31i9s7p/8dxQ7nOZbXr99EFsAAFAFNQrX6xjN9zdidkxZBWs7B7OJNo5daDzd263XZ14Fednz77ncKsiN2Sp7O/UaAIDxuvbV9fw/7+2Pq1IFWQILVEFzcPtq7b/Alw6qoPtDXh0AAEwe/JBV0P64MlWQU2k+V5N3EuJBoxxYsyIqD/KhoNpSh8z64f2Bea8g5dea7VAn2WmHvLuk/8ovnVeSX31zP7/H25uzK+/P+nG2OjbugcT3nm/Ftxk/hJ2tn3erP+61L5G75bFxSXPcKwjzXMB/x489/hai97p/rflYlyABADjl7YL2YsU+V5Bja2d2nL17sHs7qyCH1/fvbrSNMf3HvBuDeHz1nHrza2W01NnqdW7PE+ZXzBSpr1KvU/ZPDsHdATovO7/f+O5q/6iR+mNef3urXm/Wxu55SlZKXNvcF5Db4ycW31Tnr7XejTyoPQEAWPR2QXuxIlWQ43XnCaKYkjvTat5SSDmVxtlyY+yWU2/3waS8hu4JY3CPb622x/eY4pCQtxfySmLPzsXUW3FV/bLKy8jTdqsgVVTU2ea9gDh5/FRjnzxJ5yLrkuooAAAWuF3Q1op92jinwDk+Y5CDZmd7Pm+TO8eUn/J/Udf4m2u2vV7kpeYJ475HtspCVVAXnEflnvmMTT7p9AFVkJc6TxXkXZQ5LiC+i9lNj7z43Ln/VNLpf+sRAIDbBW2tWhXE7D7HvYLcub+x/wRLm63jy3UPrEE29a+hTpUnjNdhgSqoU21t5FfMPfttM18VxIsPuVeQJ5zzAuKGSf23meNewRIyAACA1X+CqAbWEz5X0Jvd40n6mKTXcgzd25q9zsfZ82H3/pnjhBub8YhLfK5g8SrI7z3f7X6uYIEqiOk/frAn/A6iejd+MnNeQDxctLH57x++OuFzBQAA+FfM6mGS/EhrPqySVZDihG1kjzE3ZtCYyE/80vkUUFZB74RZF3HOeargn/8ttoiZ+BLxZFS91XlQat4qyItc29w6+V5B/ijim53rAvqPQuU+nb/W/JnERgAAVq8KRiem3vMIAABUQTyedP4AAIAqqGdyxv+0OgAAqAIAAEAVAAAAqgAAAFAFAACAKgAAAFa8Ch4+fnb06vUwPgAAQJvV28S+9Cp48fJo/9HTEYYBAABIgjart4l9iVWQYdD6o92YGM+yLMuyLMuyLKtN6ZEEC1TBeQYAAPSrAAAAUAUAAIAqAAAAVAEAAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUAQAAoAoAAABV8Ne94bd/Hv7j2ohWu552VSXdvf/DH/70l//8/fo5X+2H0H4UAwAAnKYKMgl+89VYYiBXu6oKg0yCtWt/lAS12o/i44QBAACqYEx3CTp3DNIv7xK4YzAAAMCpq2CMMZAryYBfrgEAAFSBKgAAAFWgCgAAQBWoAgAAUAWqAAAAVIEqAAAAVaAKAABAFagCAABQBaoAAABUgSoAAIClVMFkaH56khuHrw9jy3iq4O7hEKZ355+w4wxvnnzzkcf37/7+5ueL+ebx2zy/KgAAYHWq4O3w0zB8feoq+N2TYThcYhXETF+FcHhnCVVw52B48/i7xargpFXNcDAZaRUAAKAKvn83Y69UFfx+Mh3e/v1vqgAAgI9EFfzu2vDjMPw46VfB92+Hcjz0187x7uG7Q2bqraVVQUzYMZeXuIFQI35sjzPUW7FznKdUctQhM/UV+1XQucL40nkltfP4qgAAAFXQXjRfRxXMhv54fTzxf1sPHcXhZ3OvYCYH+r89mT7+bjagz/5P/52DmuNrRn+SVdDeqhcn3Suo/SsP4uTzVEG7pDezK7w7ueNeAQAAq1AFGQP1Iqb/3Pkw7ye8u2nw/bdn/gRRjd2dJ4hi8q65vHeGO/mZ4JOqIF7nBcxbBXl5qgAAgBWpgmqA77+NKpgMoamdZ88R1W5nWwUxZOf4ns/55M69uw1ZC/0q6HxgoFcasVu3W5p6a/xVAACAKsjJvn34OO8VxLu52p4/HcadhLOsghjf48WH3CvIt+a8V1DnnOteQb47mVYYqAIAAFaiCvKzxb3PFXSOyhL4NE8QxVBer2vyjtedzxV8E2GwjM8VtBd5SaoAAIDVqYJ4jihL4Mchf79Q7fAvv4Mo9oy3zuZfMYvtb6cH/d9NVMP6L34HUZwkbwj0fwdRJME8nyvoHDWZjuB3EAEAoApGsOarAmsAAABVoAoAAEAVqAIAAFAFqgAAAFSBKgAAAFWgCgAAQBWoAgAAUAWqYBEAAKiC3/55vEnQri394U9/kQG52g9kAACA01fBX/eG33w1xiRoV9WuLd29/8PatT+KgVrtR9F+IAMAAJymCjIMxnbHoF1PJkGGgTsGdZdAEgAA8EFVAAAAqAIAAEAVAAAAqgAAAFAFAACAKgAAAFQBAACgCgAAAFUAAACoAgAAQBUAAACqAAAAUAUAAIAqAAAAVMH//O//jXlZlmVZlmVZluVeQQ8AAKAKAAAAVQAAAKgCAABAFQAAAKoAAABQBQAAgCoAAABUAQAAoAoAAABVAAAAqAIAAEAVAAAAqgAAAFAFAACAKgAAAFQBAADw/z4lNZUNoEtYAAAAAElFTkSuQmCC"},563:function(A,e,t){A.exports=t.p+"assets/img/SIN_PairingCode.cd005782.jpg"},564:function(A,e,t){A.exports=t.p+"assets/img/ExternalService_Add.f82f2998.png"},565:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABGAAAAEHCAIAAABupae7AAAZRElEQVR4AezXAQkAAAACoP6fLmiHvjCFAwAABAkAAECQAAAABAkAAECQAAAABAkAAECQAAAABAkAAECQAAAABAkAAECQAAAABAkAAECQAAAABAkAAECQAAAAxt4ZeDaytXH4bykuWTABA7QuRNEobS235SPrIrFIFONevpWykZIKBkEIRQhCWDGsKlWhcoNE0AirQjWlpJQJ4WCYb9N23jQnObl5e7P3i+3vMdjY9MyZeQ/Ok/ec9/ykggTAffH3dyu/DK8PpXv356L313EsFI2Xmrbjvm0AAAAAACBIjripl9JGKLiuP05/h5e2vr1nHOWtds9x3wbNpPfsiuuo4b4GCJK4bRZzicjWhkYvU98IbkXjhcrNwF0Krgs7Xt9iX/suAAAAAAB4s4LUu8ju6TOsIFy8c18JBAmC5HTL/932qd9qsr4kwTepkx++3LtvEQAAAAAACJJzf35Ik9elF6RBt3U2THMFMs0fJ0iUPQtuTV7HrxYkcd0+L5mx0Eam/pYEyekWw/6Xw8m3+vwyA/qSCZLTPTnY1b6HPnTcGrhvEAAAAAAACJJopDZGk1dtO5arXN0JlxD9m0srZyTKyyFIjZTX1dQPF6Rk/Ye1/JYEqVcK0wAL/FlqPbhjPHTOc0au6f7/AQAAAAAAEKTelzDljny/ZRu2u1AgSBCk+3LYC9n7wpXjAgAAAAAAsKyCNKjENW/yun7UGLiLBoIEQaKnppABAAAAAACwlIJ0U9j11j4FMpfuvNSPxsoV9GqZ8OowDaVnhx8J0a0WEpHNVZ+3nyeSKjXu3Ck8dKrDnTm0I8Wvb4aGK/1saZ497/4o+9JKG6Hn1rTVYMjInXVsZ7EaI6qHAW9donHyoDJP/3CvP72xyev3Us9ldH6+EMgCY7et5McN7TkQ0aTVpgb5geAKUrf4H+XDzsLpt6zhfi3N27a0Zxyfd/pT1+9R4+JbKf5eH34/ag0/XiS8BOlu/tqdpJUNjPdtVvRpQeDecFR7AfqYyFe6wiUYg3+pAAAAAACAINE0l2aHfEF6OI1pU8q7icvj6TXxtO1k5X7MB84+aSp50KPlW6YgOd0TRbU0LVq4GixMkKT8WyDbHp92b9CLvXHcOQWJ0Xl1CCYEqXtTCk+2qT36AzMQfEGSJOQX/052vvOFbk//2PRP64weKXSEQpBu2tmA9GKdZlKb0dVOfuv5fyNW/++iL1q5kDYjiIzBv4QAAAAAAECQRCXuTd2C+Y77GkFKxD/7J+tfi/qRN0/1B/fN4lmtahXiIX2FfsvvTExw9Y3IgZm3atWzUnp/JAm+/VPbS0ScmGbaNGPvaUOL8f3j41Vo2BPV0vRQvGBVLypF0whqXmsHFbHQhXD2V8PrarRMSaS70gfpSa9PH/tp0Bk7O4b53PlC03b5nVeHQBKkYDgcGKZfdmOHZvogrI9Uyh+/oPYYgeALEpkklbALZy66wplhR6UP3ve1UGKiM/54RUwTpET8/RRpaWU8PYtatuxHheDz940TWxl9qZYJJY7Sppk0dnWN7sUY/MsEAAAAAAAEiebxNBf8y+UKEl2Bz+OnfIpmet1bXVbqTp1i+v4czbZ7Xz79UZJXfN0Uw5QdKvfUe5BUBSdoP5U84d7IfWMI0t+f2ON0SRXWUk3xtPTus19OK6nVi995dQgkgaH/TdVGr7dnjdJN5DzMQDAEibi1IrqUlQopVvrdlz1RDDy+UmKUCls/vpIFyRty+XZPkuDL7Nq4BRFX+e3nAfm5JmbGSFQSvlEhPutKjFfJL1Z6vMG/5AAAAAAAQJDqrxQkX3i4hOwlthVV/mD/YEUmp6qOOwX7NKbom1KQnHbmV+V+KkojrGXbixIkykLsvFzpRx/Xsy1n7twUt/PqEJDAqArHkRWsaGbDJViB4AgSYbeLEwsIfZufytcKn/mVXuC0t9SWBImEahL6q3exr/1p6+v89GiKGHXz7ymTZvWoVwR/8AMAAAAAgJ9NkBSz+f7J/mgyqnYPf7o5l6UwBKn9YmI94yiesNX7ZwfF5iZ6TjuO1lJWcd//lO1JN8X8D8XuvDoEJDC0eHJ2jQ2CEwi2IBHDchEhXdqZk66LFy9TobLSfb/cyy+HVjkSk074cpnidWFHNjHF89JKPLnSwwIG/zICAAAAAABBoukmdw/SuVD+Wr/CycMIu9u6qJULZvrQ2NuiKmoMQbK/GvJd1PvpF1yMe1BLjj/12mFNcFpmd14dArXAqAWJHQi5fS7itpZ5qUlauHgrO4bqovvKgrRVuHIVkAtpiaqQSjiSiSljJCqJFaW+LmDwAwAAAACAJali10xr76Rf1tlV7BQOwJgjXltPdZnliylINFH+NwWJsE/JcGgNFaNldufVIeALEj8Q6vZZ9M4SVHTO25lDLXMFSR1ZWiNHq+noRpQUUsSIcQvm4F9CAAAAAAAgSOL84J28PIkvSCrpihzXqhfK6+phvAKBV2ktV6pUL9o3D5U4V5C+UCbhqKy+b7XZFQsXJKfzNP+mayffYbXM6PziBYkRiAUKEm2vos5UnacKDd7iwENrxvhp3AqWvdDXfKkmpU/pr1QxYiSpmIN/CQEAAAAAgCDRMZrqEtg8QaIJ7hxTZyr45q1Js51/tgepaXpndx41HPf18AXpKr/rFQkw45pXsOGW0TKj8wsXJEYgFi9I5B50mFXD9I+ZjBqGIFGNBG/HEf1VxOqrYyRHR/4dgTX4lx8AAAAAAAgSpT6oWnSPPztXboin+mmE+pjO5F+K6ewMQSKjk491onNy/hVB6oz2t5wPSJa8I2IVLVMP+Z1fvCDxA8ESpGZeOhxWnUGiDT/0PvmCpKJfjlIFPPo3LYacGX1RU5wIzBj8yw0AAAAAAARJXltFZZeN3FmnN3BHDPo3l1bOSJTv1DNseUO82ricfqv0KdeU5+VrZtMl6MjUCUuhOSilAqR8FG36z7f7rsRdLZOyeosVJDJMUgXRTP46eRLOxPNSmWp+5xcvSKxA8AUpSeNKyCNB2oMk2YgvXGjZE0Z0kU1a9xxBkithBDPZOB1/NEf0qVAhHbU05nuiS+cgMQb/sgEAAAAAAEEixGV2hxxJeYWL8wkSzSafL30jcmCmzcfrIBrQaeo5bgW/+IP7R49fS+x9/876RkBhKZRheNwtE46bZpLk7eE0NnoQv/6bkTSfbn0U+23Vp55Ds8p8U6VvWlxHpx7RRNznqU75TrXpy6+HE8OOHXjaw+r8ggWJGQi+IK1Ir3Rz+ETTqtjRC6T/Wt0xjp7Hz6Gxs+qnmzIESUrTfe8AFWyYT5DoBFga1XuPvUoau7pGt2YM/mUFAAAAAACCRAmKkP6PBYkQreyuT9mUnmnSfa0IFZIemy7XZp2puq7u2+3pH+vKp/BFeRkkdRUyWlwnr4uT0kq+/VN7/LyjgKIwHa/zCxYkTiD4gpSRW5bPii1+E+44N18puTR5+SPcDJLsgZSB5OQPB+1cSFdXF2QM/qUGAAAAAACCRNidSv7Q2Hvx675vdTv4MZErUd2t+QSJWjuIBlf99Gt6MGSkqSnCbpdT0YDu/eKeslq2Yp5KDDrlFLWsB0Jm1XZHOPeNkhkLbWiUjdncjhwUypdd4bgKuILkWZBiai7qR2ve3aUzQ8U3K/lxW9e8RES6Zrv8zi9ckHiBYBZpcPpXdWs4tLaeHpye67hYVwflrlk0jb11nVJJwa1ovGC1bgV/D5JclYSOP+IusOzVS2kjFNDpKUKxXIWGNHvw/6+9O+Cw69z3OH4BnDdxFEFfSoACARBB4II5biDmqEMOyXEAYdABDoRRnMyhgwJXIZ1ml9E6kdzqxd1mSlupNoDnPtO/3fu7q2vHyulkZ+3M5+OvVtesvWbNBuvrWXtnzgAABBIAAIBAAgAAEEgAAAACCQAAQCABAAAIJAAAAIEEAAAgkAAAAAQSAACAQAIAABBIAAAAAgkAAACBBAAAIJAAAAAEEgAAgEACAAAQSAAAAAIJAABAIG0FAABAIAEAAAgkAAAAgQQAACCQAAAABBIAAIBAAgAAEEgAAAACaXlw/cq779x93MLZwc3aAwAAcMkC6cbN61duPlgKJAAAQCBdufegF9GNgzOBBAAACKTj9s2DG+9eP/hmLJAe3+nP4NX8ElGf3uvbx/2wvrNWn/qeOibL6ufTxv75AwAABFJtVOpEIFUL3fn0/0qptiuHKqjOD67+yZN0EV21Xa+dOQAAQCBFF8XGwPHdCp5aQarVpEEURQjFmesldU4AAICZB1KuEUUgxWNyNcNAqlf1M8TBucqUUy8BAADYikCqqrn3oAIpgidWkKYFUp1ZEQEAANsbSFVB8Z0KPX7q8bnanh5I+RkkAACA7QykCqFVIK2+g+F87t2ZvoKUp1pN7QcAAJhRIAEAAAgkAAAAgQQAACCQAAAABBIAAIBAAgAAEEgAAAAIJAAAAIEEAAAgkAAAAAQSAACAQAIAANhAIH37/fMvn3792cmT+YwxxhhjjDGm36X3e/XGxgKp6ujkyVfPf/ixzQkAANDv0vu9ukbaaCD1KlVHAAAw20bqd+yNjQVSX7lrAADAhrhjF0gAAIA7doEEAAAIJIEEAAAIJIEEAAAIJIEEAAAIJIEEAAAIJIEEAAAIJIEEAAAIJIEEAAAIJIG02L/63rX7ixbKyf33rl3dO2kTLPauXX1vMPv9lMvD3au3jpZtKH7F7sPT9hvVn7CaKdc84c+pk+QVAgCAQLoUgXRrd2eQMdU2rxwbpw9vjbXWxQTS+oMX+5VhF08gAQAgkC5jIGUGrMLg/t6uQBJIAAAIpMsWSEeLw2qh2Ll3slzt7I+c7RyeDp9AmxJIlS7xwnwAL/Ijn/Sr/XXY6veeHu2s9uQJ1wdS/F39JfVbVk/iDf/S/F0/qz98EEi1P64/CupwP08LAAACabsDaRklsOqc6IQskDxyciBFVlVpHGUgnR9WG7UzSyn2x/b6zyDVa2tnNU8+LlitFedZ7FXq1PG1PRpI8Xmq4QHSCAAAgfSWBVIuE9WezIAsn4yliYFUWVL5kSo/Flks8ZJVitRVvfIjdrkzoyguMuX5xwIpX1X7h4tgAAAgkN6WQIqGqVLKTujycbusi2mBFBuDJsk1n3yMLSdb5dUDKXtm5CLz4b31gZRP/eXBAgkAAIH0lgZSxc9hZVJ0Qql8ytK4wBWkaqT4+FMbeE2BVFc1dQWpNpJAAgBAIL29gZSf2xkGUq0s3aoH3l45kOpHaz+DdFqNlJ9B2kQgDf/2Ov+EzyAJJAAABNIlCKRcJxkGUibEKwVSnjy+iW7kW+yqoMYee4un78ZbqA7Ok08JpLykvf2XriBVIk548G+LAQAgkARSmp5SAACAQLrEgZRPvgEAAALpsgbSYi/+HdW3FAAACCSBBAAACCSBBAAACCSBBAAACCSBBAAACCSBBAAACCSB9OXTr5//8GMDAADmp9+r9zv2tjEC6dvvn588+UojAQDADOuo36v3O/a2MQKpGqlXaV+5M8YYY4wxxsxn+l365utIIAEAAAgkAAAAgQQAACCQAAAABBIAAIBAAgAAEEgAAAACCQAAQCABAAAgkAAAAAQSAACAQAIAABBIAAAAAgkAAEAgAQAACCQAAACBBAAAIJAAAAAEEgAAgEACAAAQSAAAADMLpOXB9SvvvvP/5/rBNw0AAODyriB9eu+dGwdnDQAAYEAgAQAACKTYjh9duXfc2tnBzXfuPu7/rSfx+na8/vGdt+4JPQAAQCBV7dx8sGzl+G41z3kgRf988+BGbbeqozufDl+7/QAAAIG0WiyK4Imdw5eMvLbCaasBAAACKb/d7t5x7e9RlNWUx/SXrFaWcuKwLQcAAAikeoKuPzV3fPf8v+UlK0hvcREBAAACqfbcvD547q4et4vPHeX22wkAABBIlT3xaaJaQTp4cGPs2+riH5ytiNpaAACAQEpj32WXj9gBAABcokCqb/euHBJIAADApQ2k+pdh360n7gQSAABgBekVAAAACCQAAACBBAAAIJAAAAAEEgAAgEACAAAQSAAAAAIJAABAIAEAAAikb79//uXTrz87eWKMMcYYY4yZz/S79H6v3jZGIFUdnTz56vkPPzYAAGBO+l16v1ffaCMJpF6l6ggAAGbbSP2OvW2MQOordw0AANgMd+wCCQAAcMcukAAAAIEkkAAAAIGUBBIAACCQBBIAACCQBBIAACCQBBIAACCQBBIAACCQBBIAACCQBNLycPfqe9dqdg5P27nTh7euXb11tBw/ePfhaR1Tr4qplyz2c+f9RRvKY2r2TtobUn/Iuou8sCust67eHwAABBLzDKTFXt76nz48PFk1w+7OSDac3O+pUIGUO2tPdsUvJXB6tBONNHbMy9UZ9hcbD6RBzywOJ10tAADcfv9OLgb0/92WQBJI2QbD/Tu3dqOdVs2wt39/YiDFq2phaosCqdIxLxsAACY6fvx5BlL/3y0NJCtIg2bI8qmd/X9PpgfS+tLIY/I8FSr1u36+sOFDbvWj3BPXcLhfO1v97+Jopw6LvsrnCe8vJq8gpThJnDkv4D/jhHH+X70tYyeJZx23HwCARaS+sS2P2AmkSJGqhWEg1ZLRScukyRya+Ihd/TSNfk4pF4vyDLUzLqzHQ1xkpEX2Un0gKlurtvdqZ/RPnGekHrNVhi/M9ycvYOx9i406cxx8tIg+zLd02wEAWETqG1sVSAIpi6I6JJuh4iT3TAqkjJ/80XhElVhuOsoTZiDldp0k+iRekv87/rtG/7T1AVlni4PjF9VJTsauORbQ4jLyp9OfSwQAYOsWkfps55c0CKT1iyp1fx/39NNXkNLEQKqzVVEMYiPTK6ZOMj2Q8gwTAimSb/Xn12uHBVi/MUuvzlkFNb6UNP7YXj5SCADANi8i9dnWQBJI44sqtfPW0cPKpNcdSLVysrdflzG+gjT2qmmBFBvTV5CGJ6wPYr30AmJ1K9a4JqwgKSIAAF/zzZsLpPhMzvoVpNqu9ZPXHki1Mz/Ds/4zSK8eSHHa2n5pIC326qe5gpTvUlj7tuzf36sz52XUb1z/GSQAAAQSb/Jb7IaPq2UzxOLGRQfS8Em5+BeTIiHiIvPrEGrq+MmBlK+Ndar132KXD+Ote9OGH4LKw+ItjcsYfhdfLmoNntzbJAAABJJAAgAABJJAAgAABJJAAgAABJJAAgAABJJAAgAABJJAAgAABFIQSAAAgEASSAAAgEASSF8+/fr5Dz+2+QEAAPq9er9jbxsjkL79/vnJk680EgAAzLCO+r16v2NvGyOQqpF6lfaVO2OMMcYYY8x8pt+lb6COBNLmAQAACCQAAACBBAAAIJAAAAAEEgAAgEACAAAQSAAAAAIJAABAIAEAAAgkAAAAgQQAACCQAAAABBIAAIBAAgAAEEh/W7Tf/6X92+0ZTb+eflUlPfrs8z/++a///h+7l3z6m9DfigYAAFxgIFUd/e79edVRTb+qaqSso53bf1JHNf2tuNhGAgAAgTS7taPBOlKydvTrdaQGAABcYCDNto5q0q8LwbQCAAAIJNMKAAAgkEwrAACAQDKtAAAAAsm0AgAACCTTCgAAIJBMKwAAgEAyrQAAAALJtAIAAAgk0zYNAAAE0nHrvnuWO9sHZ7VnZoH06KyF5aPpsRFn+OnZhxdcMh/986dWF/Ph0xd1/q0NJAAAEEgv2netffCbA+kPz1o7e32BlHlTsXT2yWsIpE9O209PP/rXAullU/l0eiyQAABg7oH08XlubFEg9Tlethf//LtAAgCAiyaQ/nC7fdHaF8fjgfTxi1ZW/VMHx0/Pzl+yUj96vYFUsZGJUmpZKWsn9scZ6kdx8PA8VV/1kpXMm9FAGl5h/Oq4kjpYIAEAwIwDqW90H2Qgrfontlfx8496Ki9evpkVpDIIob8/Wz79aNUqtf5TCVRJU7nyLAOp/6g2XraCVMdXKeXJJwRSv6SffrnCR8efWEECAICtCqTsotrIEIqDz3KV6Xwp6eN/bPwRuyqQ4SN2GSGZKMMzfJJfpfDSQMrtvIBpgRSXt22BBAAAAqlyqAdPBNJxG6qDVw/a1WGbD6TqjSyZ4YNweXCeIVef1gfS+IeLKrqmBFIdHA/UbVcgAQCAQKrIqe9siBWk+GlOP/K7s1pf2nggZcnExvQVpGikyStIdc5JK0j50+NlNdJ2BRIAAAik/EqG4WeQxl9VUfQmH7HLPqntipDYHvkM0ofVSK/tM0h9Iy5pawMJAAAEUj1ol1H0RctvqKsDht9il0fWjzb2D8XG/hfL0/Fvt6tuGX6LXZ4kl4nGv8Uu6mjKZ5BGXnW89C12AAAw60Da/EwLJNMKAAAgkEwrAACAQDKtAAAAAsm0AgAACCTTCgAAIJBMKwAAgEAyrQAAAALJNAAA4AID6fd/mW8d9WtLf/zzXxVRTn9DGgAAcIGB9LdF+937c6yjflX92tKjzz7fuf0nXVTT34r+hjQAAODiAqkaaXbrSP16so6ykWodydqROgIAgOmBBAAAIJAAAAAEEgAAAAIJAABAIAEAAAgkAAAAgQQAACCQAAAABBIAAIBAAgAAEEgAAAACCQAAQCABAAAIJAAAgPkE0n/99/8YY4wxxhhj5jyNiwokAAAAgQQAACCQAAAABBIAAAD/C76ESSiiPNgkAAAAAElFTkSuQmCC"},566:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA/oAAACaCAIAAACWmKQxAAAR1klEQVR4AezWgYUEMBQFwOu/ySB+B08E/FwPWWysmSrm7/woAADgq90HAAB0HwAA0H0AAED3AQBA95NU1XgJAABQVUk+6n6SOedaq7sPAADwhu5ea805k9x3v6r23gcAAHjP3ruq7rs/xjgAAMAbLsau+wAAoPsAAIDuAwAAug8AAOg+AACg+wAAcE/3AQAA3QcAAHQfAADQfQAAQPcBAOCe7gMAALoPAADoPgAAoPsAAIDuAwDAW3QfAAD4Z+8MPBtp+jj+txRHCjYgQOsggkRpolzKS+KwcUgc1vPilXCR0ggWQQhFCEI4EU6VxymVBo2gFapCpeVIOTYciyXvzn6TeSedtnN7b9zz9PH7CCrZnZ2dmePzm/nN3D9W9y/KG282Nw6H87+CweGm+/TSxfwfBDEsvXG7tTyY/yQPrffu9Xrr2/wVYY1HN9Zv/EdEEARBEATp/uAw6DrHdm30yOYDzL2MY0tUlZMc+7L41SbdJ0j3/TOqbbvvqJkDWfedh0G7nNnZCrALthLGUW86XwMEQRAEQZDu26dF5hzv26Jd3DTi7Ms3wRWlHprMRT6eWH+f2X3CvvvaLGYitRcs2bpsV4xk7vPDa9Z9e3LazH+IVi9es+5/62ZCm1q2O5V1/1s7/SYY2onHduPh0Cb7PmIO7PmvQRAEQRAE6b40Zy9O5EOk3oa3V2f9EQPst+4omefvAjQRlqxqrnT7Ves+5H6z9Gp1X5ERZ416o9kcOOP6nvey52t4CEEQBEEQlLs/buxiIn8lANguFHMrs/6z44/uZeHqiHL31wvpPun+012W+zKbSxAEQRAEQbrvm6ta2HWLWGMspvfkT0eNXWHW3+kzG9PKA2fVVG67+XdewnEomW+PbTH94rpb+hDVmMOFwqlii09eSvcGtpL5L3fz55me1TKR0Mbyyt5j3bcnf9YWec8sIyJbPXtabe2zYuBx5pLd+xRkYczlfJFC3Szus2dJ1fZlnLDwt7UrcW0EqyU8puKZUc7sqmvmUmirTS2SrZ4/COWwCk+sYR2NGYpm6iNbkELhI9UEt4sfLpfTYaOQQt6IW+Z+oX1lvdD+R7l3y+Z9Z/b4lc5Dr24ktoJe18Qz1f7UeRySTbpFdgG7sXh8P1+Ae6tZrwL4qS/p/qoW8w9CF97497NBfVmOXkPKu7J6Msrhal+383sh1kF7xda17d5x1TQS0nN/pjenL+u+M6pG1hXJEARBEARBus835urdKd+8yywfYcBy1h+7DAuntmgq7/V0aCtdMEsf454LhksXi9/ti3LYdawdo2SaFbO4z6woWh09ujeeO8C9wq8S08+6d0EoYZQrB65gRcMRUbvtwWHUc9akW1qloIc0ZmCx+lPF2f28tipS9mkeXu6KoHPX0qGGet40S0YS8vfHycyv7mPNRPjpruGmZ3DVQ0wFbYUF4u1M033BmCa0BgRxV09HQvsF9+1SXpWCmPednJiVT/o2+yaZY+3cHDxSdmvYMM2c9+htvcjKP/HCqvt2WoOnul+Wc3shrwH/c/x9LmN9MbxwLpX3ujK9hZfizeVVzFz0YwABDF9S0HWNjYFybifo5aOzdkbTdfQg7zXW1JFo+Dndvz1hz33LCkwY7FmNi9my8eNpPartGSWMMd7CqupxfAzXLbeqy7bSitVqMrAjPVfVm2rddx6+fmLjOYzIkCAIgiCINUC6D+XFkTvzUfXtwkgQBmBCetrWkV2wOuGa5EsCvYMwE2XTcxd7WPIKmfDJ1EseLeBezMvOwVU1jJnv5wU9Wb2058Dqs8Kh3XzCPlIe/MDP3GWzHVle8Sx4tqDdiSaT4EkzyV5B59WGBSIY8Kv7mM5Hi8Hzgom9OOIorKiw1rvFG42vhBImrdSiNXAj4qhze/H23ewGlgV+PZkHsUcw3WZvLYZM29BS+XYxj9yZWawuGBKoGJh1ssy/G2N+lzAGHG9cIRmM99pe7WrZa9ZZedt/Mg/rLx6C3qMp9M5UXT2O7+HqjFnriUPuezfDn6voTYXu844IH/YtZ04QBEEQxJog3Rfz8sfNGBJ7FmEA7MT+WnAvSHFBh6lgQUD0ZrjL4gwf+QPRwb1wKXAue498HNDTufsDMyhnOfcOnk99vm0m3AKzXWvx4ggMMN/MfZRz1/oXvvSt+1gPCRwOMUG+oZV75+UAVktQ7G7zhl/8bdRpmiUjFUNK0sqBLatX3rf30ZK/rPvTrpBoJBQrfQkWUdCOUf9zLDgomkv+LNoHD82f2mKnyL32f+fuBytDeUVFXT0R9XDFCBTbU0h+Q2/iucreVOj+9VGYB5wEQRAEQawL0n1MheLUHe8PKCmMCun7w4rGXVAyFfkb/J096p31Vz7DO1t1r4D8k6z7/G/pdSC4EpjlheIjgR7qL7m79Cy/uu8MS2g0BEuFU5uFT2yilz0Xf/A1BCTlF8x6+7RzEH9OEKVv/Ou+XILCtpFkjxQpdiR8uj60HP7u8VK3/6iXb76L7abutfVt1eXfqKvH8TFcpfaUnuuvN+WSMW4RIxEEQRAEsU5I9zGpv/Gx2fiIrB4xIyVYahzFMFHtQ/eh0RJ+dV9eCoA9r4qjPLv/gjYhkyTTnbFJ9zfB/JktSJs8u48MEMk4pQR9CWwCTrVuXe9nNcRiAksaOS8LMRUKidevBef7Dbovz+6LywgyzuzmrPlHZHWnLLY4y6h1X+ogFgutWfdRPQWK4epL9330plSytKODIAiCIIg1QboPMH8fDWvIW1jJSIntxkU5Uyk7P8s/ip27wBqe9Kb+dR+GhMxpITVfnbuvGfLGU3E/AGIb5OWD53L3scGURxGJxlj8Vdb9R/aWKxS3cc1C/ox8IYwzjoRZbSRK8Q2mvnW/57yk+1i6UeTuP709dDa5FUKpsyLqhu0HYnOh8p2TsVr3uQQL6fKTth74Gd0//yndV1aPoxiu/nTfR2/+5tNsCYIgCIIg3ceUuegxQkaK+P9wqXVftLfFESV5fSsAH/Kl+zBRM7pIIyl4B++E9PTKRO9DJxuSTuYJZT5zl312w+7jzan2sLojncyjxSsXtrgsgJdiD9rR09LsvuyRAS24NDysogQDmrheMTv+N3sojoXJp7bCkbAP3V92kJYqVgrljlwT7tZanB0sczT0XrQWk07mCeyYCJkkz8Zl/Mia4CLw+zEsRTZ5c3mHJqHaCt1HU1f4vd7w0HT9xWUKHBiFA4KKpe6DQvdV1eP4G64K3ffVm3LJ6Jdg7ODUmq8PgiAIgiBI94GX2SJlsyD/BGkePhNypmcrZ+GXuiPL8a378gHtrWt7VSVx0nk5ww/L/1DujGZzCXnDLj8bRz6pHQFGwjjqrQi0fdMuJv53VPydZJyyK4vbOmHnUvbRjxHO1Mf/XXDjI5mHYV8epRdHyxvH0ycb8O64kNTQOPXhspx+3UiGNAhxMld/+kx6nC4v/EcERh2nyANr1BIP70dzKXUfTPtV963RzoX2zY8Xc/fRSszC2fW5LwrdV1ZPRj1c1brvszf/y94dWAAIRlEY3aolWqQtftAGbdIATRKAVgiQcAOIknjOmeLD8+5XuQ8AyH3W6z9PKQAAyH32pZ07r9nPAgCAArnPNo8tp+oZDQAAALlfQI6nu36YcqoOAAByHwAAkPsAAIDcBwCA9+Q+AAAg9wEAALkPAADIfQAAQO4DAMA9uQ8AAMh9AABA7gMAAHIfAACQ+wAA8BO5DwAAyH0AAEDuAwAAch8AAB6S+wd7Z4PiNgwG0bMsECDHWgLkJAaSmwR0FAcfI5AcosUwVfPoCCFwF2LmsZRWK+v7MT9PtpJ67pfj12V5G1imw3Gaf1We5bxOqH/5j7xuJ4Qe4FG+D8evPz/f5bUOztc6oh+VpsLrYK0Lg4frnUHGUzrfHhzcfsFPYZl+OPkQQgghhOi+nPhUnu//rPorA5Y9b677WHMD3ZedQ4sRBVsa1ni9s1hdNWD8O7ZwtCW6H0IIIYQPIroPOZbYnc7aAMDSPkf3uY6NYuUVXquZn2yo0f0QQgghhOg+5FiCKzPjs39Jcz3uUv0Px2bqhVp2mThOieQZm/Yliu7P2FD3mTN1nzPbXktDVWKMzpk8E8XLfeuYCRJjsTYflcnuIU8kg5T+LosTUOoYK8WI7ojfofGGov9IfuDmIrQWRNX/pLFMdVzX9gP5tEMIIYQQ9qD7tGEZ52o8qwBNM38lVVrHZV3vWwKodhVHyLHGW6Hbl2gadx1O92GlJgoy7Og+gj7KtA7yzQDWoYhzsNU6urJC4xARPkqBBdHzR7nNyA0r++pe9/llMreV4sKW7nNnOC9G9yXZzL95c5lAKU+0ztSrBRVI07QNawfyaYcQQggh7EL3+VzZfCoX1ug9r3kARhMYgvg1eQnHJY5cipOpyEO6zxcOvf2JN12v+75MjXMyi+3PMR1QStwUdV9B+EqHdJ/3xQfihf7m2pYyDbQdi7BMP4eBmHYIIYQQwo50nyqmh/rVHSHW8Dzqmv32m410X+kxBMSxL7vjh3mA+RofLqu+jes+pJNOb6RWv8IcTGOXoMsspPlegpUO6D5yYG7tQNPcurmI4mP5DaEyVLbong1k0t4RIYQQQojuQ3OL1LPKWamq1PY8L7ubP91vqxgnc9l+lL7ue9n1m6Jh3Vf39KdJDzuB3tN9+r0Fx1qwpq90TPftNyP1n+5rHPSe7rPkvu77QC7t/RBCCCGE6D7sSg998RU90qbxUxxb6j70lIwc5mGxEEfzRZwoBC6upXyXBnVfNn/FW5TO2X3MMWf3AQu5lKd/Y9CuFG3h7eZnEp7lqnWan2RoH6P3R6EGzu73dd8HMmnviBBCCCFE96HLlEWolXVWCBbOkPR0H1bXP//jD5n0/5stZm7jcr7VfXzv0HThUuzSmO4brzX91EwuiDkaRFG40PQQuwvdtValai8//6q+Ldj12dB8X4QEOjd3mTDIKGhaX/d9oH7av9u5A81GoigAw88XoEDfIwissLDYByiBPkUKfYh2ZxlKlCqqDVSlLbRq9sSRdVdF14A7me9z1GRyGxT895oGAGD4ud8fZU0CAIDcPxDFkzYHBQAAuc/Fz/J5kuEDAEDuAwAAch8AAJD7AADQj9wHAADkPgAAIPcBAAC5DwAAyH0AAOhB7gMAAHL/8WlzdX172a6MMcYYY4wx+yaaOcp5SLmfrd+ubjbPrx0AALBfNHOUc/TzkHI/9ij/2foAAKD4o5+HlPuX7aoDAAD697PcBwCAmsl9AABA7gMAQP3kPgAAIPcBAKBWcn/kAABA7gMAAHIfAAAqIvcBAAC5vz6fHh1PFm1XuD+b552BAwAAuT+bT4/my7XcBwDgAH37/mNydPx34uXYTvdPl9H3s/N7uQ8AwMG5+PW7zP14Obrcb7r1cnY8PVt/zv18ufvrxMqtZlEsLrcKzWleA1QIAAf8ebQ/wtzPi/lyXeZ+WfPl/TLrt/uESfGLuQ0AoEIADvjjYpS5X9R8eZE1f9J0O+1JLi4vZufLRa6Jxdn9AFQHwAF/Hu2PNvcz4iPcy9zf3pn8MxH0xTagOY3j/Pi5XR8f5UmeWgEAOOCPGXfuhwj3/M/dzP39B/a5JWgW8e7usD+jHwAAajX23A/NYnuK/+nZ/T3f4Ll7K7p/muf9AABQK7mfR/WZ++UGIKe4//nLfPJzAACgBnIfAACQ+wAAUD+5DwAAyH0AAKiV3AcAAEae+wAAgNwHAID6yX0AAEDuAwBAjeT+1fXt5vm1AwAAvhLlHP08pNx/fNq0q5svix8AALR+lHP085ByP4s/9iiX7coYY4wxxhizb6KZs/Vrzv3+AAAAuQ8AAMj9HgAAQO4DAAByHwAAkPsAAIDcBwAA5H4fAAAg9wEAALkPAADIfQAAQO4DAAByvz8AAJD7AACA3AcAAOQ+AAAg9wEAALnfHwAAyH0AAEDuAwAAch8AAJD7AACA3AcAALkv9wEAQO4DAAByHwAAkPsAAIDcBwAA5D4AAMh9uQ8AAHL/7u7u/f29AwAA6vP29hbF3j/3X15eHh4ePj4+OgAAoCZR6dHqUez9cz+LP3YMNwAAQE2i0rP1++c+AABQP7kPAAByHwAAOCB/AMAZOz6GwTbrAAAAAElFTkSuQmCC"},567:function(A,e){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA+8AAAC7CAIAAACb7zgOAAAVsUlEQVR4AezWAYaDMRQGwL3/JR/i3eATAckCUP6iINWZU8zfAQAAvpPNfwgAAGweAACweQAAsPkk3V03AQAAujvJu80nGWPMOffe5w4AAMDee845xkjyuPnuXmud+wAAAGut7n7cfFUdAADgVlVl8wAAYPMAAIDNAwAANg8AADYPAADYPAAAYPMAAPDDbB4AAGweAACweQAAwOYBAMDmAQAAmwcAAGweAACweQAAsHkAAMDmAQAAmwcAAJt/9c/eGXg2snUB/G8pliyYgAFahSgSpanyWh6JxcQiUcT7sBJepHQEgyCUIARhWDVUlWeVygaNYCtUhEqWJWFJKYPQb86c9jS3t9d0vn1d+vX8BPvSyb13zr3hd0/O3PcynJtL794v7fderINe2Wv/ndm9Zf5/mNiGt2zS9vT2mfyw094y+GBPXtdtfutP5rdId/+9d8vl85fpiWEYhmEYtvnuftSzjZVa/5GsR0Cm88ezhTdnJzl4s/TFZZt/GoZtfnaUh6+G4UxewuZvxl8O8jtrOnShxzP7zuDm9k3DMAzDMGzz7mlpSRKmQSMJb76LChbSs0Dxd09mnJv/zfzst6z85q6jllp3dNosfIxXz1+zzbvjL81SZq3Wfc027/ZqCS2aqPZc2ebDzKz6NzE9tpFMbCR1DVqO4LbhzcIwDMMwbPOYcRfT8NPWh/dLq7EVzNmLir/TGnOlzW8Go62WWpwytMbXbPPo7u/M12vzMmTzYWZWzVWv/YO+uacFEPpU6/stwzAMwzBvuW5+2NgQ0vDo9yvFUk7wjOvjXe+yWLXPdfO/HbZ5tnnlpONXkmEYhmGYN/wU7EUt5ilFojFcrL0pnPbB8ilnP++AXmtmdy7a/JVT+GMZKnD07YI9dBdLDq5Oqx/v6wGWk5lqZwKfVTCftqvZmA77Cv2P0vH3Dtk8XdBtlrBiGIoNUqVW//rJSof239HHyuh2IIu5WrvAAUx6jWLK6wuLj3eK9sXs0S7CaP0I2FdgEKj0CLv5UoQ2c0f3A+vXHn7f+NFpFLOJ5Sh0qi1vFm2qeJaDGVneLhyNFzWdXvJI8OMLL7p3d/RPLbMODUJU17PVs6k6/tcXjpmh8H60Rw8O3jnIb+va40ZItUez3sHHuIaV3Af9xTUw69t4R/ingdLm0XrphVMgdwGhS4sLyb10yvgnWhVK3AHdI8274NzuwC5t6tDU3QTd9Bv5balfuLFDC+vXMVy19kSaTbXNq2dWvT5lfp7kYFWbXfeWYZg3DMMwbPNopcJze1GUeM/yMWdPYrpUPHWFnKKR1pfTRau8m/SVMeb50J03nZsxX3Q282bFKqV9i42s19GnJaaHhq+5+nZuzyp7/rQWjy36zXzcMvwWlo2CBRegvf118oS6uWeliJjvxP3JCuYwv9tpFFOjVLHM3Ba63afjn+FsHtst0A6H9gzeIPd7VJuEAUSrw8FXLKuQ0uEy3AYIwUzm9iiYcX+8192mVclvwwWr+PGT0ePqixOI8Cp0vZmH9hvnXljc7n6cQlopGqjjiYO+YkcX9ycoX/a62Mtv6v79Urj0lN+1mVuPeo3AdoVsfsNIr+k7Ra+LFEwK/RUqyC2YRAw1rAE9thZT2fzoxKr8bazA9ds56KvZnQldwELCLrAFWmY0bKu0o1PcZDAg0cSutyDvR7sGGzxy7rRh6Fv5Mty+P4/FWnULrhf6pR8ZMLAWzhc2FcLmFTMbtD6Jm2HDoLlgGIZ54zAM2zxaKR5Wc9uvrqIKo+VjahlrJCjrTPngbUrot/diIEBWb8Fr4yT3pOMZR+3fW7WLm1tkdmauLDj0qLkNjRv2CISJNI7S7SJzuAU0ckqZw1CvvH+PG1ugSml7LEoeun4om6eWsdQBw7W9ueWPimqTtFLbj8Hksj+jocIPHfS7BwXToALoi2oMDxoKX2kjhnTN7N6FlDQxe/hT8fHFCuzZtUvvr5ptauSnkwG9bg7Q5nEL99W9+5CTXbr/sYJCnXOmtAYa0EvYShtopHC/ixy1jIcTY9xe2V+rIwrsN9pzErRgYEWl4akPIcjYMjr3Q1PD5qav77H9nku3hv3ifw7xDEpk3PpTWYQWstImYH2K36Yo3A7DMAzDMGzzQk38sJnAqhu0fFQN1FayPbIQwxHz3ygx4uk3xFeTVO8RXStKWwXJoTFzT7akUCiC7B93DvSYb9aBfidO+h3Z9oPm7uCbYW0ejyNEPcWCpQ921zbw46jsaJZYyjI4sw+sUmYjGdOpmISCSVdSrDCYoW1eDinR3hMLgaTyJC1lts7HLnoqhUt+YTRQtdHsKZI0Tgr1r9fNaxa9A+sTu6BlJr3kQFFApBcOBp2bIkOTnmwM5VujQ+WdhmXmUkmsnsLg/6rNB69PXNGfIrTTYBiGYRiGbR41C8+rgX9QdQ04IqaQexWNfEJSFvkd+nfw2eEq4yGHxmGg+wZ+Skgho8GjcKPZK8ZAfYW1eWwQtyjwMDHsgkA3wQuxNgkFkZKp+h/5stU8PKtnqJfAYIa3eTk4wTJ9M2wVsX7JfwTCGS/U0piHZ5228BrO5GCK78h/DW3zgV1gWLL19qPh9cauYo1l6p1HF3e/u1K4pGUg9kv5cm0tW7DqrX+c8sa/ZPPB65PapJ0GwzAMwzBs85Ty3G02dqnkZqHyu1FPYDl4CJtX5OaLpyrTwpoHsfiHbF6Vm1c4DSaboaqEyl3Ilp7MfVKOmTROHokMlUaYba+OBUcIpUoQq1ErRe3c/XDxH7xD6uWlbV7OzVOcFbjjC8fa1O4egaBwSeVMwaotZ+5xOb2AzTuz550toyr0Cm3z+GXZqA/mFPx/1ebV61N+HoNhGIZhGLZ5BLPv8ZgmWDgmmBMbSbLAYJtX180rHtrDlK1QAD2yjcgz6ubp0UNVLX6u2cxhzXFQXXKs1qdNAhVqSyORQbWKFYp5ehwWHiNeLRV20dIWbnCvIww+rM3/aY8Cbf5rUN28lj9+qm5+dCXWKaFz40MUFC7kyjm+fIZqz3tljarqfW565bVn1c2358+yeayhomWGzHon7YmyJkoIyPy6e9SZhLV5aTowsL9k89hU8PpkGIZhGIZtXglWxkuyhU5Gj2wSQQI6cbKadKaNlnVIxwXcXmXtPR1ZUzCWNcOgNC1eUF2XzrTRkpUFjVM8C+sn9b+J/6tO6cyQyLqFkkcuCycSFqEjXRyJDG54Ilo0AvdOmfhoRPMLb5DLuq/v/tkve/nEejyUzaNK4nks5d26NBI6iQgPnymVnSk8bJDVpTNt9MznseJ0f5wpf3gaPt9MGw8KF0Ye3DRItYHJZyNCawAOiomnDUVuXlxsWqpUKZqHP4K7GNkLXfgrJ4JRlcD9JAUE1yS2E9rmZyd/aTgdsLZ3luOx1dA2r5jZwPVJXy59p8mlNgzDMAzDNi8lL7GgRXpAViyZCBJQZNang8Chwrjs4KEuCiadKlxMZ7H35PPm2wf5TTqvPV9vo2mpIC/fao4eKxQdoA4nu+cO6BxxOvn+zn1jH+sX0khUDkrpfFA0KZKjoxIMHiyt1p50wlXa4Md1jCTavMRN/wBcFoKTO5o+dYS8eag8i336Zf/hLPyEd+WlK5wZn6J5TGG4gmwecQc23jUsgOrX6UhdN4+43+p3h5ku548nAV0gkzPhTH31MsOZFW4TAxLW5nGcGFhtq9S6HP7vlTbSzKrX5xuzeYZhGIZhm2cGDTrZ5hXBMAzDMAzDsM0zN6dQu699wgKhVwDDMAzDMAzDNs9MHLNw97/zjKY/Tzkg/2XXDiwohqEAio77l/sAFI/MEQQhBI3OkAIVChS0nDPFxQUAQM1/xv7/XaP2BAAANQ8AAKh5AAB4Ss0DAABqHgAAUPMAAKDmAQAANQ8AAKh5AABAzQMAgJoHAADUPAAAoOYBAEDNAwAAah4AAFDzAACAmgcAADW/6L1HxHaTUhpjTOC1AAA1HxG11mORc26tlXKyc8Y8kRxBFP4tBA7ubywhOfkKSydiUlKQdiP+gyOkhgAhIN0UzbLJigRrZKKzzpJJEZFX5Rv7k59Lavdq5LX1ni4YmuquV1U94k1P3fy4WCyallydffdp79u/+bI9Xi74+fLL+An+UqaDo6/l895spSY7GgtDSHK+nH2alt17PAO9ioTvcjlGcNHNv91H8e+sGxI1jMhd9svl0R+DUW4Z3DsqX9tjiftCV/gXFzQMwzAMq/nb29ufgb7vvw+s1+vNr7YQxIGuxPWuSy4F1Xw7E8poq/l27P7D1TgV7+ahdIdrVjY0euh7lh5+NwazmEvL4Gb1/L+CYRiGYTV/dXX1E3BycrK/v394ePj8/Hx9fb2V/tgeVvNW81bzug40OrzgR0ItsUP+8zAMwzAMq/lSSt/3PwQuLi4mk8nBwcFisdgMboT+VmfzIsjQGACB0pUpx6VnYFqK6CFpRQgDaJeh22e2ihHaSDuQCibKR4YmU0AgfAGMAt41ZKWksjvhLONnBWqeOT8ql39KzOBQ5uAsrhnvIBNlRAV3iXiRwzTMMOuCrej15Qxh4kf4VcI5gYathblwkZRvvIpDzTM/qtFpmat5Pu/JdqIlJoIYHPFGQ7A0EHvNjNiz1kGyKkuGYRiGYTV/f38/ATayvg9UqnmVINAH0EbQJRCRVBIhLiEj8AdeJRd7D1Q0UK/EXHZmhz11Ia5TNU8DEIgfyTk/qU1DTmgQylmuEbvkPKhSzQ9+U9cUdqtl93cjKn9BO6l4wpY2lLDdiivkhCsIVG0tzA1i6k7LN2rFpTleNXq+XdWSd4FuJ65D3U/ojcYGHsZC1ww8u3PBLZiUZZYlhWEYhmH4bP709HQSOD8/7wOtap56KDRN/q4/LvSUTmUEzBLNFC7CJtMuXD9dp1LN68TK9fOQOTe8Y4qAa3IiUoc8pGEGMtfycKIjADOWVjxly+mUerJ4TriKQO3W4lx6h/34FYcx33o1qnl5g9RwC4BSduSP1TCICyWf3vV5rRWGYRiGYTX/u6A/Pj7ugVY1L728fKfPV+1VQkfMRKOgDYNCgX/+ub5Ob1PzcERB06Tt2NeRqy7lTJ7goI4yNZ+4hjswkZFEcGcVT9mqXh+myOIJ4ToCNVtLBzErKd9YFc+1bHunTb6dSB6Px/9Uzcf1EKM+c6aPoxpCTZYMwzAMw2r+5ubm6empD6zX637A4+Pjw8NDM9cKZVB1Nq+nklxcNUqdmqfN9mfz4LnFSa24y+NSMaTdR3kPtHDIXcv7DR3Jz+aTDhZlq9PzD4aScAOBmq3F1IlHLd94FYexLguS6gVQy3w70alu5io1z+SjBPjt4LHmbL4iS4ZhGIZhNf/y8nJ3d3cl2Ej519fXhqZ5/c4GZVyNmo/x6r75BjUPv/A1dt98HjJylSDlHBooJuatzANVDZNlEncRPlIhI4AOasVTtpgeF3OEKeUQwpUEOLepbz4v3ygVr++0AWcsKF+orNhO0OJTnVKl5nHfzeZ4Hqjom4eN9s2nMAzDMAyr+ff397e3t18Fm8GPj4+mb9qw9YUSR1+X59qI32npVjUfHom5lWqeE+dnlWfzmEiVrL0KSU7y5iJNncSbceZEfCVGcj5bJZ02ietIoyaWI7mYzivOjIEtp8PgL2fPGFHCNQQatpbS0PKNVnGmgjREzed3n1rm20keZprUPJgoYfkfvXn/22/s3aENADAMA8H9tw40CreluxGKHljN/0oAoOahQEqOqd/9AQA1Dxl4VCGTHgBAzcN3AEvKd8nQxU4dANQ8AACg5gEAQM0DAABqHgAAUPMAADBOzQMAgJoHAADUPAAAoOYBAAA1DwAAah4AAFDzAACAmgcAADUPAACoeQAAQM0DAABqHgAA1DwAAKDmAQAANQ8AAGoeAABQ8wAAgJoHAADUPAAAqHkAAEDNAwAAah4AANQ8AACg5gEAgP6aP3bOAEOWGIqia2k0elmlMSsJUjspspRELaPp2cSnH//KXJHfpvwx5RyD8qSSl2o4lbnqc7vfLtf4+9geB/Ta8m0pn1Y+nD1db6m+Lut6uZfnkZPr4aQ6XvqojQye/LN8XPJuZQAAAADA5t1KH2Wrv8XmhWz+gE4k0GbzDjb/gwAAAABg84+yXNdmZWwem/9VAAAAAHA2b35s8ZtQ2z31dXln1O9lGzr033s1IIS15aivLSoa43GgtaloSZthgkgN2Dwi2oi/VIdb1tK+KSO2ozmtvaWUsHl78usmm3+tWMryesLPfgYZvzfjFQAAAAA4g83reN7Utq6q1LXTx6iH+EY9hDWuY7yJo705xGm0ZDfqLUs6ux4eJb2K0UMMkFLPzubVgBpTz5Ozed+ylo6i+mlVu9YM2Z5St4vYdTwN7Vo/jWxeD1wzTJqxykkAAAAAwOb9JD7vJsEhi+GaYY2e0lHdb7cwjKQ5xsie5bLj/InGv2vzPmY6/3zLsYTGj9HturBO1LA1M+hEW8u7N6PKiQEAAADA5rvjXkU4LHbiQmla7EpqgRPlQzphjTkl3Jr2SwbmfZt3Tdft37N59eYNSLX7eM/4vULTjm3e59Tq1oxVTgoAAAAANi93bNk1d6q2/lYgdH5szG1eUn7Q2bz6/PbZvLDoji/qZ/Oq+077k3XvxNYS3owqpwEAAAAAm1ceXRauxMvc5j1QPs/Nv2/zWjeuY/z/yc1PbF6xeO9Bs+la/83w3LzGDHLz01cmb8YrpwAAAAAAm7dvvFhiu0txjNTWkjB596SNbtFy8teZzXcf2El5cjZvK9o3bbQpR2NS/efcvFI0jlZc8rpojOqpaqdfvg7UBkkb++0GzVjltAAAAACQtPnTbh1gWAxDARTd/+YKQohQ2UDEqwLoGIMB1Q/1H85xF3F/AQAAbh4AAHDzAADg5gEAADcPAAC4eQAAcPMAAICbBwAA3DwAAODmAQDAzQMAAG7+2wAAwM3PFbWPrTRJkiRJd9U+5opcNz9XlLbHcV4AAMC9OM7S9rki0c3XPj5ceQAAMPS1j0Q3v5V2AQAAL/+zmwcAgGduHgAAcPMAAPA+Nw8AALh5AABIxM0DAABuHgAA3LybBwAANw8AALh5AADIyM0DAABuHgAA3LybBwAANw8AALh5AADIx80DAABuHgAA3LybBwAANw8AALh5AADIx80DAABuHgAA3LybBwAANw8AALh5AADIxM0DAABuHgAA3LybBwAAN1/7iOO8AACAJ3GctY9ENz9XlLYbegAAeFz50va5ItHN/w197WMr7S5JkiRJtY//lc9z8wAAwHvcPAAAuHkAAMDNAwAAbh4AANw8AADg5gEAADcPAAC4eQAAcPMAAICbBwAA3DwAALh5AADAzQMAAG4eAABw8wAA4OYBAAA3DwAAuHkAAHDzAACAm88NAADcPAAA4OYBAAA3DwAAbh4AAHDzAACAmwcAADf/AzdqrTUOa7yAAAAAAElFTkSuQmCC"},568:function(A,e,t){A.exports=t.p+"assets/img/CustomerEmailBody.d9e6d6a4.png"},569:function(A,e,t){A.exports=t.p+"assets/img/EmployeeEmail.f299755f.png"},570:function(A,e,t){A.exports=t.p+"assets/img/FinalRecipeView.863abe31.png"},571:function(A,e,t){A.exports=t.p+"assets/img/ReceivedCustomerEmailBody.7466a15a.png"},572:function(A,e,t){A.exports=t.p+"assets/img/EmployeeEmailBody.ea00b163.jpg"},790:function(A,e,t){"use strict";t.r(e);var i=t(9),a=Object(i.a)({},(function(){var A=this,e=A._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":A.$parent.slotKey}},[e("h1",{attrs:{id:"btcpay-email-receipts-ticket-sale-guide"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-email-receipts-ticket-sale-guide"}},[A._v("#")]),A._v(" BTCPay Email Receipts - Ticket Sale Guide")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(558),alt:"FrontPage",title:"FrontPage"}})]),A._v(" "),e("p",[A._v("This guide shows how to setup a simple event ticket sale system, using the "),e("strong",[A._v("BTCPay Email Receipts")]),A._v(" preset in Transmuter.")]),A._v(" "),e("p",[A._v("Transmuter is currently in "),e("em",[A._v("alpha state")]),A._v(", but this preset relies mainly on sending emails, so it's fairly easy to use with your BTCPay, even if you are not a developer. What you will need in addition to Transmuter is, a BTCPayServer instance with at least one store and a few email accounts for testing your ticketing setup. This guide is using Gmail for simplicity, although other email clients can be used.")]),A._v(" "),e("h2",{attrs:{id:"how-the-ticket-sale-system-works"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-the-ticket-sale-system-works"}},[A._v("#")]),A._v(" How the Ticket Sale System Works")]),A._v(" "),e("p",[A._v("Create a simple BTCPay Point Of Sale App that sells tickets for a future event with limited quantity.\nWhen someone purchases a ticket in the connected BTCPayServer POS App, send the customer an email receipt containing their QR code event ticket and send an email receipt to the event organizer, alerting of the ticket sale and the payment details.")]),A._v(" "),e("h2",{attrs:{id:"btcpay-pos-app-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-pos-app-setup"}},[A._v("#")]),A._v(" BTCPay POS App Setup")]),A._v(" "),e("p",[A._v('First create a Point of Sale App in BTCPayServer called "Ticket App" with one product (our event ticket), which has an inventory limit of quantity 30.')]),A._v(" "),e("figure",[e("img",{attrs:{src:t(559),alt:"TicketApp",title:"TicketApp"}})]),A._v(" "),e("h2",{attrs:{id:"transmuter-email-receipts-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transmuter-email-receipts-setup"}},[A._v("#")]),A._v(" Transmuter Email Receipts Setup")]),A._v(" "),e("p",[A._v("In our Transmuter create a Preset > BTCPay Email Receipts.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(560),alt:"Presets",title:"Presets"}})]),A._v(" "),e("figure",[e("img",{attrs:{src:t(561),alt:"ExternalService_Setup",title:"ExternalService_Setup"}})]),A._v(" "),e("p",[A._v("Next, connect our BTCPay as an external service to Transmuter.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(562),alt:"CreateBTCPayService",title:"CreateBTCPayService"}})]),A._v(" "),e("p",[A._v("Next obtain a pairing code from our BTCPay. So Transmuter can send emails when BTCPay POS invoices are paid.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(563),alt:"SIN_PairingCode",title:"SIN_PairingCode"}})]),A._v(" "),e("p",[A._v("Once pairing is successful shows in your BTCPay, go back to Transmuter press Save to authorize your BTCPay client connection.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(564),alt:"ExternalService_Add",title:"ExternalService_Add"}})]),A._v(" "),e("p",[A._v("Next create an email sending SMTP service.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(565),alt:"CreateExternalService_SMTP",title:"CreateExternalService_SMTP"}})]),A._v(" "),e("p",[A._v("See this "),e("RouterLink",{attrs:{to:"/FAQ/FAQ-ServerSettings/#how-to-configure-smtp-settings-in-btcpay"}},[A._v("SMTP settings example")]),A._v(" for setup. Save after data is updated, and return to preset of Email Forwarder.")],1),A._v(" "),e("figure",[e("img",{attrs:{src:t(566),alt:"InvoiceStatusTrigger",title:"InvoiceStatusTrigger"}})]),A._v(" "),e("p",[A._v("Choose the invoice status to send ticket email receipts on. During testing, use the "),e("strong",[A._v("New")]),A._v(" invoice status, so that payment is not required to send emails. Once everything is setup correctly and working properly, choose a status like "),e("RouterLink",{attrs:{to:"/Invoices/"}},[A._v("Paid or Confirmed")]),A._v(".")],1),A._v(" "),e("figure",[e("img",{attrs:{src:t(567),alt:"SendEmailToCustomerEmail",title:"SendEmailToCustomerEmail"}})]),A._v(" "),e("p",[A._v("Select send email to the address registered on the BTCPay Invoice. Be sure that the refund email setting has not been "),e("RouterLink",{attrs:{to:"/FAQ/FAQ-Stores/#how-to-disable-email-on-invoices"}},[A._v("disabled")]),A._v(" in your BTCPay store, in order to prompt customers to provide their email before paying the invoice.")],1),A._v(" "),e("p",[A._v("Next supply the sending email address, email subject and email body. Note the highlighted line in the picture below, it uses http://goqr.me/api to create a QR code of the invoice payment which will be used as the event ticket inside the customer's receipt email.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(568),alt:"CustomerEmailBody",title:"CustomerEmailBody"}})]),A._v(" "),e("p",[A._v("After saving, there will be a recipe which has been generated by the preset. In the action group, there will be one email for the customer. Next, add a second email to notify the owner of the ticket sale. This is also important in case the customer provides an incorrect email, the event organizer will still receive their payment information.")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(569),alt:"EmployeeEmail",title:"EmployeeEmail"}})]),A._v(" "),e("p",[A._v("Add your second email account details, email subject and HTML email body. Note some of the purchase data you can insert into the event organizer email receipt. Press save.")]),A._v(" "),e("p",[A._v("Be sure to enable your recipe (checkbox).")]),A._v(" "),e("figure",[e("img",{attrs:{src:t(570),alt:"FinalRecipeView",title:"FinalRecipeView"}})]),A._v(" "),e("p",[A._v("Once the recipe is "),e("strong",[A._v("enabled")]),A._v(", start creating invoices in the BTCPay POS Ticket App and see the emails sent. Providing a valid email in the POS invoice creation process will send an event ticket email receipt to the customer and a payment email to the event organizer.")]),A._v(" "),e("p",[A._v("When the QR code contained in the customer email is scanned (with phone camera for example), it will lead to the BTCPay invoice page to verify the ticket at your event.")]),A._v(" "),e("p",[A._v("Below is a basic HTML email template that the customer would receive and a basic HTML email template that the event organizer would receive, with some invoice data from the time of purchase. Feel free to improve these demo "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcTransmuter/tree/master/docs/templates",target:"_blank",rel:"noopener noreferrer"}},[A._v("templates"),e("OutboundLink")],1),A._v(".")]),A._v(" "),e("p",[e("img",{attrs:{src:t(571),alt:"ReceivedCustomerEmailBody",title:"ReceivedCustomerEmailBody"}}),A._v(" "),e("img",{attrs:{src:t(572),alt:"EmployeeEmailBody",title:"EmployeeEmailBody"}})])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/100.170ae5ee.js b/assets/js/100.614d6cec.js similarity index 99% rename from assets/js/100.170ae5ee.js rename to assets/js/100.614d6cec.js index 0a545395da..0cffbee07b 100644 --- a/assets/js/100.170ae5ee.js +++ b/assets/js/100.614d6cec.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{715:function(e,t,r){"use strict";r.r(t);var s=r(9),a=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"third-party-hosting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#third-party-hosting"}},[e._v("#")]),e._v(" Third-party hosting")]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("third-party host")]),e._v(" is an individual or a business which "),t("strong",[e._v("self-hosts a BTCPay Server instance and enables other users to register and use the server")]),e._v(". On a self-hosted server, the owner can add an unlimited amount of users and stores and allow those users to manage their stores independently and receive payments to their own wallets.")]),e._v(" "),t("p",[e._v("While this feature in BTCPay Server exists for complex multi-store business management, community enthusiasts use it to help other users (mostly beginners), sometimes skip an overwhelming step of "),t("strong",[e._v("deploying a self-hosted BTCPay server")]),e._v(". Users who want to test or develop applications on top of BTCPay Server also use "),t("strong",[e._v("instances hosted by third-parties")]),e._v(". Some hosts try to spread the adoption of cryptocurrencies by allowing their local merchants to receive payments for free or for a small sign-up fee.")]),e._v(" "),t("p",[e._v("In layman words, think of this feature as a payment processor factory which allows anyone to deploy a server and help others receive payments which are validated via the server owners' "),t("a",{attrs:{href:"https://en.bitcoin.it/wiki/Full_node",target:"_blank",rel:"noopener noreferrer"}},[e._v("full Bitcoin node"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[t("strong",[e._v("Third-party hosts")]),e._v(" play an important role in the ecosystem since they provide an easy and cost-effective "),t("strong",[e._v("way for users to try and use BTCPay Server")]),e._v(". The role of honest hosts who provide free service to others is essential in the early phase of BTCPay Server adoption. However, users should be familiar with the pros, cons and potential risks involved when using a trusted third-party. Find the optimal balance between your use-case, cost, and privacy/security trade-offs.")]),e._v(" "),t("p",[e._v("Some of the hosts are entirely free to use and maintain the server cost from donations of their users. If you've been using a reliable free host for a while, you should consider donating to them to support them.")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#third-party-hosting"}},[e._v("Third-party hosting")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#advantages-and-disadvantages"}},[e._v("Advantages and disadvantages")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#pros"}},[e._v("Pros")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#cons"}},[e._v("Cons")])])])]),e._v(" "),t("li",[t("a",{attrs:{href:"#concerns-for-use"}},[e._v("Concerns For Use")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#security-concerns"}},[e._v("Security Concerns")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#privacy-concerns"}},[e._v("Privacy Concerns")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#trust-concerns"}},[e._v("Trust Concerns")])])])]),e._v(" "),t("li",[t("a",{attrs:{href:"#third-party-hosting-faq"}},[e._v("Third Party Hosting FAQ")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#where-is-the-list-of-btcpay-third-party-hosts"}},[e._v("Where is the list of BTCPay third-party hosts?")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#how-can-one-become-a-third-party-host"}},[e._v("How can one become a third-party host?")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#are-there-any-limitations-in-features-when-using-a-third-party-host"}},[e._v("Are there any limitations in features when using a third-party host?")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#can-i-enable-the-use-of-my-lightning-network-node-to-others"}},[e._v("Can I enable the use of my Lightning Network node to others?")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#what-does-the-trusted-third-party-host-know-about-their-users"}},[e._v("What does the trusted third-party host know about their users?")])])])])]),e._v(" "),t("h2",{attrs:{id:"advantages-and-disadvantages"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advantages-and-disadvantages"}},[e._v("#")]),e._v(" Advantages and disadvantages")]),e._v(" "),t("h3",{attrs:{id:"pros"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pros"}},[e._v("#")]),e._v(" Pros")]),e._v(" "),t("ul",[t("li",[e._v("Easy and quicker setup")]),e._v(" "),t("li",[e._v("Cheaper and in most cases free (depending if the host is premium or free)")]),e._v(" "),t("li",[e._v("Receive payments directly to your wallet")]),e._v(" "),t("li",[e._v("Private key never required (if it is, it's a scam!)")])]),e._v(" "),t("h3",{attrs:{id:"cons"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cons"}},[e._v("#")]),e._v(" Cons")]),e._v(" "),t("ul",[t("li",[e._v("Security concerns")]),e._v(" "),t("li",[e._v("Privacy concerns")]),e._v(" "),t("li",[e._v("Limitation of features")]),e._v(" "),t("li",[e._v("No control over a server")]),e._v(" "),t("li",[e._v("Have to trust the owner of the server")])]),e._v(" "),t("h2",{attrs:{id:"concerns-for-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#concerns-for-use"}},[e._v("#")]),e._v(" Concerns For Use")]),e._v(" "),t("h3",{attrs:{id:"security-concerns"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#security-concerns"}},[e._v("#")]),e._v(" Security Concerns")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://nakamotoinstitute.org/trusted-third-parties/#selection-7.6-6.2",target:"_blank",rel:"noopener noreferrer"}},[e._v("Trusted third parties are security holes"),t("OutboundLink")],1),e._v(". By relying on someone else to manage a server for you, you are potentially exposing yourself to a certain attack vector.")]),e._v(" "),t("p",[e._v("The most significant attack vector when using a third-party host is the chance that this host will gain access to the management of your funds. This can occur in two ways.")]),e._v(" "),t("p",[e._v("First, a host may allow you to create "),t("a",{attrs:{href:"https://en.bitcoin.it/wiki/Hot_wallet",target:"_blank",rel:"noopener noreferrer"}},[e._v("hot wallets"),t("OutboundLink")],1),e._v(" on their server. This gives the host complete access to your funds. They will act as a custodian of your private keys and thus your funds. This means you must trust they will not spend your funds. This type of wallet is NOT recommended for use with third-party hosts.")]),e._v(" "),t("p",[e._v("Secondly, a malicious and technically skilled host can create a forked version of BTCPay Server and modify it to be able to either spy on your transactions or replace your "),t("a",{attrs:{href:"https://en.bitcoin.it/wiki/Deterministic_wallet_tools#Risks_of_Sharing_an_Extended_Public_Key_.28xpub.29",target:"_blank",rel:"noopener noreferrer"}},[e._v("extended public key"),t("OutboundLink")],1),e._v(" with their own. This means that future payments made to you may end up in this malicious party's wallet.")]),e._v(" "),t("p",[e._v("While a wallet connected with an extended public key IS recommended for use with third-party hosts, It's impossible to know for certain, if the third party host is using a malicious fork. If you don't trust the third party host it is best to do the following:")]),e._v(" "),t("ul",[t("li",[e._v("Do not use hot wallet on the third party server, use an extended public key")]),e._v(" "),t("li",[e._v("Use it mainly for testing, learning and getting started with BTCPay")]),e._v(" "),t("li",[e._v("Do not use it with high volume payments or extremely valuable transactions")])]),e._v(" "),t("p",[e._v("In BTCPay Server, a private key is never "),t("em",[e._v("required")]),e._v(". This means that funds are safe even if the server is hacked, but a malicious host can intercept future payments and steal those funds. If you follow your transactions via a watch-only wallet, you should be able to detect such attack quickly and notice that your orders are being marked as paid, whereas you don't see the transactions in your wallet.")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("If a third-party host asks for your private key or pre-generates one for you, be sure it's a scam. Never share your private key with anyone. It's called private for a reason.")])]),e._v(" "),t("p",[e._v("An extended public key replacement attack applies to a self-hosted server as well. A malicious hacker can try to hack your server and try to replace an extended public key.")]),e._v(" "),t("h3",{attrs:{id:"privacy-concerns"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#privacy-concerns"}},[e._v("#")]),e._v(" Privacy Concerns")]),e._v(" "),t("p",[e._v("BTCPay Server does not allow server hosts to view the stores of other users nor have access to any personal data (except for registration email address). The extended public key and even balances of other users can't be seen. However, as mentioned, a malicious third-party could modify that by creating a fork that can look like BTCPay Server on the front but be something completely different in reality.")]),e._v(" "),t("p",[e._v("The biggest concern, which happens when using a third-party host (even if the owner of a self-hosted server is not malicious) comes from the nature of the Bitcoin itself. If a user is not running a full node but instead relies on someone else's node, his transactions can be listened to by the owner of that node. Running a full node is not just a convenience that gives you features and enables privacy, it gives you better security and the right to \"vote\" and validate all the transactions yourself. Don't trust, verify.")]),e._v(" "),t("p",[e._v("Here are some good resources where you learn more about the importance of full nodes")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://en.bitcoin.it/wiki/Why_Your_Business_Should_Use_a_Full_Node_to_Accept_Bitcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Why Your Business Should Use a Full Node to Accept Bitcoin"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://en.bitcoin.it/wiki/Clearing_Up_Misconceptions_About_Full_Nodes",target:"_blank",rel:"noopener noreferrer"}},[e._v("Clearing Up Misconceptions About Full Nodes"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"trust-concerns"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#trust-concerns"}},[e._v("#")]),e._v(" Trust Concerns")]),e._v(" "),t("p",[e._v("Third-party hosts have the ability to enable specific features for their non-admin users which require users to place some level of trust in the third-party host, if such features are used.")]),e._v(" "),t("p",[e._v("Specifically, third-party hosts should not enable the following policies without understanding that users will be using hot wallets on the server. These features are disabled by default for non-admins to reduce the risk considerations for both third-party hosts and their users:")]),e._v(" "),t("ul",[t("li",[e._v("Allow non-admins to create hot wallets for their stores")]),e._v(" "),t("li",[e._v("Allow non-admins to import their hot wallets to the node wallet")]),e._v(" "),t("li",[e._v("Allow non-admins to use the internal lightning node in their stores")])]),e._v(" "),t("p",[e._v("Third-party users who are granted access to an internal lightning node or hot wallet functionality to enable features such as Payjoin, should understand the risk and trust associated with "),t("RouterLink",{attrs:{to:"/CreateWallet/#hot-wallet"}},[e._v("using hot wallets")]),e._v(" before choosing to use it. Use one of the "),t("RouterLink",{attrs:{to:"/WalletSetup/"}},[e._v("recommended wallets")]),e._v(" which provide an extended public key to use in your store, if you are unsure which wallet type to use.")],1),e._v(" "),t("h2",{attrs:{id:"third-party-hosting-faq"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#third-party-hosting-faq"}},[e._v("#")]),e._v(" Third Party Hosting FAQ")]),e._v(" "),t("h2",{attrs:{id:"where-is-the-list-of-btcpay-third-party-hosts"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#where-is-the-list-of-btcpay-third-party-hosts"}},[e._v("#")]),e._v(" Where is the list of BTCPay third-party hosts?")]),e._v(" "),t("p",[e._v("Feel free to chat with the "),t("RouterLink",{attrs:{to:"/Community/"}},[e._v("Community")]),e._v(" to find the appropriate host for your needs, but also make sure to choose one that is trustworthy. Read the rest of this document to better understand the pros and cons of using a third-party host.")],1),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("The BTCPay Server "),t("a",{attrs:{href:"https://directory.btcpayserver.org/filter/hosts",target:"_blank",rel:"noopener noreferrer"}},[e._v("Directory"),t("OutboundLink")],1),e._v(" lists multiple free or paid third-party hosts that you can register to, to start exploring BTCPay Server.")])]),e._v(" "),t("h2",{attrs:{id:"how-can-one-become-a-third-party-host"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-one-become-a-third-party-host"}},[e._v("#")]),e._v(" How can one become a third-party host?")]),e._v(" "),t("p",[e._v("To become a third-party host, you need to self-host a BTCPay Server and enable registration for other users.\nGo to Server Settings > Policies > Disable registration, unmark the checkbox. You may also want to configure the "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-configure-smtp-settings-in-btcpay"}},[e._v("SMTP settings")]),e._v(" to allow them to reset their password if they forget it.")],1),e._v(" "),t("p",[e._v("Alternatively you may keep public registration disabled on your homepage and only invite specific users to create a new account by "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-add-a-new-user-by-invite"}},[e._v("invitation link")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"are-there-any-limitations-in-features-when-using-a-third-party-host"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#are-there-any-limitations-in-features-when-using-a-third-party-host"}},[e._v("#")]),e._v(" Are there any limitations in features when using a third-party host?")]),e._v(" "),t("p",[e._v("Yes. Here are some restrictions.")]),e._v(" "),t("ul",[t("li",[e._v("No "),t("RouterLink",{attrs:{to:"/LightningNetwork/"}},[e._v("Lightning Network")]),e._v(" by default. Can be enabled by the third-party host but at the cost of a security risk for registrants using that third-party. "),t("a",{attrs:{href:"#can-i-enable-the-use-of-my-lightning-network-node-to-others"}},[e._v("More information")])],1),e._v(" "),t("li",[e._v("No "),t("RouterLink",{attrs:{to:"/FAQ/Wallet/#what-is-wallet-re-scan-in-btcpay"}},[e._v("wallet re-scan")])],1),e._v(" "),t("li",[e._v("No "),t("RouterLink",{attrs:{to:"/Walkthrough/#server-settings"}},[e._v("Server Settings")]),e._v(" access")],1)]),e._v(" "),t("p",[e._v("The limitations happen for technical reasons, mostly because these features require a user to run a full node to use them.")]),e._v(" "),t("h2",{attrs:{id:"can-i-enable-the-use-of-my-lightning-network-node-to-others"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#can-i-enable-the-use-of-my-lightning-network-node-to-others"}},[e._v("#")]),e._v(" Can I enable the use of my Lightning Network node to others?")]),e._v(" "),t("p",[e._v("Yes, you can enable users that have registered on your BTCPay Server instance to use your Lightning Network node.\n"),t("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-many-users-can-use-lightning-network-in-btcpay"}},[e._v("See how")])],1),e._v(" "),t("h2",{attrs:{id:"what-does-the-trusted-third-party-host-know-about-their-users"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-does-the-trusted-third-party-host-know-about-their-users"}},[e._v("#")]),e._v(" What does the trusted third-party host know about their users?")]),e._v(" "),t("p",[e._v("Third party hosts (non-malicious) can see the following:")]),e._v(" "),t("ul",[t("li",[e._v("Total number of users")]),e._v(" "),t("li",[e._v("The email and username of those users")])]),e._v(" "),t("p",[e._v("Note: If additional features are enabled such as non-admin lightning wallet, hot wallets or transmuter, the server admin can see additional information related to those features. Since it's impossible to know if the third party host is using a malicious fork, it's best to assume they may know all details about your BTCPay Server usage.")]),e._v(" "),t("p",[e._v("If you are worried about the information a third party host knows about you, please consider "),t("RouterLink",{attrs:{to:"/Deployment/"}},[e._v("deploying your own")]),e._v(" self-hosted server.")],1)])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[100],{714:function(e,t,r){"use strict";r.r(t);var s=r(9),a=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"third-party-hosting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#third-party-hosting"}},[e._v("#")]),e._v(" Third-party hosting")]),e._v(" "),t("p",[e._v("A "),t("strong",[e._v("third-party host")]),e._v(" is an individual or a business which "),t("strong",[e._v("self-hosts a BTCPay Server instance and enables other users to register and use the server")]),e._v(". On a self-hosted server, the owner can add an unlimited amount of users and stores and allow those users to manage their stores independently and receive payments to their own wallets.")]),e._v(" "),t("p",[e._v("While this feature in BTCPay Server exists for complex multi-store business management, community enthusiasts use it to help other users (mostly beginners), sometimes skip an overwhelming step of "),t("strong",[e._v("deploying a self-hosted BTCPay server")]),e._v(". Users who want to test or develop applications on top of BTCPay Server also use "),t("strong",[e._v("instances hosted by third-parties")]),e._v(". Some hosts try to spread the adoption of cryptocurrencies by allowing their local merchants to receive payments for free or for a small sign-up fee.")]),e._v(" "),t("p",[e._v("In layman words, think of this feature as a payment processor factory which allows anyone to deploy a server and help others receive payments which are validated via the server owners' "),t("a",{attrs:{href:"https://en.bitcoin.it/wiki/Full_node",target:"_blank",rel:"noopener noreferrer"}},[e._v("full Bitcoin node"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[t("strong",[e._v("Third-party hosts")]),e._v(" play an important role in the ecosystem since they provide an easy and cost-effective "),t("strong",[e._v("way for users to try and use BTCPay Server")]),e._v(". The role of honest hosts who provide free service to others is essential in the early phase of BTCPay Server adoption. However, users should be familiar with the pros, cons and potential risks involved when using a trusted third-party. Find the optimal balance between your use-case, cost, and privacy/security trade-offs.")]),e._v(" "),t("p",[e._v("Some of the hosts are entirely free to use and maintain the server cost from donations of their users. If you've been using a reliable free host for a while, you should consider donating to them to support them.")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#third-party-hosting"}},[e._v("Third-party hosting")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#advantages-and-disadvantages"}},[e._v("Advantages and disadvantages")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#pros"}},[e._v("Pros")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#cons"}},[e._v("Cons")])])])]),e._v(" "),t("li",[t("a",{attrs:{href:"#concerns-for-use"}},[e._v("Concerns For Use")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#security-concerns"}},[e._v("Security Concerns")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#privacy-concerns"}},[e._v("Privacy Concerns")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#trust-concerns"}},[e._v("Trust Concerns")])])])]),e._v(" "),t("li",[t("a",{attrs:{href:"#third-party-hosting-faq"}},[e._v("Third Party Hosting FAQ")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#where-is-the-list-of-btcpay-third-party-hosts"}},[e._v("Where is the list of BTCPay third-party hosts?")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#how-can-one-become-a-third-party-host"}},[e._v("How can one become a third-party host?")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#are-there-any-limitations-in-features-when-using-a-third-party-host"}},[e._v("Are there any limitations in features when using a third-party host?")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#can-i-enable-the-use-of-my-lightning-network-node-to-others"}},[e._v("Can I enable the use of my Lightning Network node to others?")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#what-does-the-trusted-third-party-host-know-about-their-users"}},[e._v("What does the trusted third-party host know about their users?")])])])])]),e._v(" "),t("h2",{attrs:{id:"advantages-and-disadvantages"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advantages-and-disadvantages"}},[e._v("#")]),e._v(" Advantages and disadvantages")]),e._v(" "),t("h3",{attrs:{id:"pros"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pros"}},[e._v("#")]),e._v(" Pros")]),e._v(" "),t("ul",[t("li",[e._v("Easy and quicker setup")]),e._v(" "),t("li",[e._v("Cheaper and in most cases free (depending if the host is premium or free)")]),e._v(" "),t("li",[e._v("Receive payments directly to your wallet")]),e._v(" "),t("li",[e._v("Private key never required (if it is, it's a scam!)")])]),e._v(" "),t("h3",{attrs:{id:"cons"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#cons"}},[e._v("#")]),e._v(" Cons")]),e._v(" "),t("ul",[t("li",[e._v("Security concerns")]),e._v(" "),t("li",[e._v("Privacy concerns")]),e._v(" "),t("li",[e._v("Limitation of features")]),e._v(" "),t("li",[e._v("No control over a server")]),e._v(" "),t("li",[e._v("Have to trust the owner of the server")])]),e._v(" "),t("h2",{attrs:{id:"concerns-for-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#concerns-for-use"}},[e._v("#")]),e._v(" Concerns For Use")]),e._v(" "),t("h3",{attrs:{id:"security-concerns"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#security-concerns"}},[e._v("#")]),e._v(" Security Concerns")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://nakamotoinstitute.org/trusted-third-parties/#selection-7.6-6.2",target:"_blank",rel:"noopener noreferrer"}},[e._v("Trusted third parties are security holes"),t("OutboundLink")],1),e._v(". By relying on someone else to manage a server for you, you are potentially exposing yourself to a certain attack vector.")]),e._v(" "),t("p",[e._v("The most significant attack vector when using a third-party host is the chance that this host will gain access to the management of your funds. This can occur in two ways.")]),e._v(" "),t("p",[e._v("First, a host may allow you to create "),t("a",{attrs:{href:"https://en.bitcoin.it/wiki/Hot_wallet",target:"_blank",rel:"noopener noreferrer"}},[e._v("hot wallets"),t("OutboundLink")],1),e._v(" on their server. This gives the host complete access to your funds. They will act as a custodian of your private keys and thus your funds. This means you must trust they will not spend your funds. This type of wallet is NOT recommended for use with third-party hosts.")]),e._v(" "),t("p",[e._v("Secondly, a malicious and technically skilled host can create a forked version of BTCPay Server and modify it to be able to either spy on your transactions or replace your "),t("a",{attrs:{href:"https://en.bitcoin.it/wiki/Deterministic_wallet_tools#Risks_of_Sharing_an_Extended_Public_Key_.28xpub.29",target:"_blank",rel:"noopener noreferrer"}},[e._v("extended public key"),t("OutboundLink")],1),e._v(" with their own. This means that future payments made to you may end up in this malicious party's wallet.")]),e._v(" "),t("p",[e._v("While a wallet connected with an extended public key IS recommended for use with third-party hosts, It's impossible to know for certain, if the third party host is using a malicious fork. If you don't trust the third party host it is best to do the following:")]),e._v(" "),t("ul",[t("li",[e._v("Do not use hot wallet on the third party server, use an extended public key")]),e._v(" "),t("li",[e._v("Use it mainly for testing, learning and getting started with BTCPay")]),e._v(" "),t("li",[e._v("Do not use it with high volume payments or extremely valuable transactions")])]),e._v(" "),t("p",[e._v("In BTCPay Server, a private key is never "),t("em",[e._v("required")]),e._v(". This means that funds are safe even if the server is hacked, but a malicious host can intercept future payments and steal those funds. If you follow your transactions via a watch-only wallet, you should be able to detect such attack quickly and notice that your orders are being marked as paid, whereas you don't see the transactions in your wallet.")]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("If a third-party host asks for your private key or pre-generates one for you, be sure it's a scam. Never share your private key with anyone. It's called private for a reason.")])]),e._v(" "),t("p",[e._v("An extended public key replacement attack applies to a self-hosted server as well. A malicious hacker can try to hack your server and try to replace an extended public key.")]),e._v(" "),t("h3",{attrs:{id:"privacy-concerns"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#privacy-concerns"}},[e._v("#")]),e._v(" Privacy Concerns")]),e._v(" "),t("p",[e._v("BTCPay Server does not allow server hosts to view the stores of other users nor have access to any personal data (except for registration email address). The extended public key and even balances of other users can't be seen. However, as mentioned, a malicious third-party could modify that by creating a fork that can look like BTCPay Server on the front but be something completely different in reality.")]),e._v(" "),t("p",[e._v("The biggest concern, which happens when using a third-party host (even if the owner of a self-hosted server is not malicious) comes from the nature of the Bitcoin itself. If a user is not running a full node but instead relies on someone else's node, his transactions can be listened to by the owner of that node. Running a full node is not just a convenience that gives you features and enables privacy, it gives you better security and the right to \"vote\" and validate all the transactions yourself. Don't trust, verify.")]),e._v(" "),t("p",[e._v("Here are some good resources where you learn more about the importance of full nodes")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://en.bitcoin.it/wiki/Why_Your_Business_Should_Use_a_Full_Node_to_Accept_Bitcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Why Your Business Should Use a Full Node to Accept Bitcoin"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://en.bitcoin.it/wiki/Clearing_Up_Misconceptions_About_Full_Nodes",target:"_blank",rel:"noopener noreferrer"}},[e._v("Clearing Up Misconceptions About Full Nodes"),t("OutboundLink")],1)])]),e._v(" "),t("h3",{attrs:{id:"trust-concerns"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#trust-concerns"}},[e._v("#")]),e._v(" Trust Concerns")]),e._v(" "),t("p",[e._v("Third-party hosts have the ability to enable specific features for their non-admin users which require users to place some level of trust in the third-party host, if such features are used.")]),e._v(" "),t("p",[e._v("Specifically, third-party hosts should not enable the following policies without understanding that users will be using hot wallets on the server. These features are disabled by default for non-admins to reduce the risk considerations for both third-party hosts and their users:")]),e._v(" "),t("ul",[t("li",[e._v("Allow non-admins to create hot wallets for their stores")]),e._v(" "),t("li",[e._v("Allow non-admins to import their hot wallets to the node wallet")]),e._v(" "),t("li",[e._v("Allow non-admins to use the internal lightning node in their stores")])]),e._v(" "),t("p",[e._v("Third-party users who are granted access to an internal lightning node or hot wallet functionality to enable features such as Payjoin, should understand the risk and trust associated with "),t("RouterLink",{attrs:{to:"/CreateWallet/#hot-wallet"}},[e._v("using hot wallets")]),e._v(" before choosing to use it. Use one of the "),t("RouterLink",{attrs:{to:"/WalletSetup/"}},[e._v("recommended wallets")]),e._v(" which provide an extended public key to use in your store, if you are unsure which wallet type to use.")],1),e._v(" "),t("h2",{attrs:{id:"third-party-hosting-faq"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#third-party-hosting-faq"}},[e._v("#")]),e._v(" Third Party Hosting FAQ")]),e._v(" "),t("h2",{attrs:{id:"where-is-the-list-of-btcpay-third-party-hosts"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#where-is-the-list-of-btcpay-third-party-hosts"}},[e._v("#")]),e._v(" Where is the list of BTCPay third-party hosts?")]),e._v(" "),t("p",[e._v("Feel free to chat with the "),t("RouterLink",{attrs:{to:"/Community/"}},[e._v("Community")]),e._v(" to find the appropriate host for your needs, but also make sure to choose one that is trustworthy. Read the rest of this document to better understand the pros and cons of using a third-party host.")],1),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("The BTCPay Server "),t("a",{attrs:{href:"https://directory.btcpayserver.org/filter/hosts",target:"_blank",rel:"noopener noreferrer"}},[e._v("Directory"),t("OutboundLink")],1),e._v(" lists multiple free or paid third-party hosts that you can register to, to start exploring BTCPay Server.")])]),e._v(" "),t("h2",{attrs:{id:"how-can-one-become-a-third-party-host"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-one-become-a-third-party-host"}},[e._v("#")]),e._v(" How can one become a third-party host?")]),e._v(" "),t("p",[e._v("To become a third-party host, you need to self-host a BTCPay Server and enable registration for other users.\nGo to Server Settings > Policies > Disable registration, unmark the checkbox. You may also want to configure the "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-configure-smtp-settings-in-btcpay"}},[e._v("SMTP settings")]),e._v(" to allow them to reset their password if they forget it.")],1),e._v(" "),t("p",[e._v("Alternatively you may keep public registration disabled on your homepage and only invite specific users to create a new account by "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-add-a-new-user-by-invite"}},[e._v("invitation link")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"are-there-any-limitations-in-features-when-using-a-third-party-host"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#are-there-any-limitations-in-features-when-using-a-third-party-host"}},[e._v("#")]),e._v(" Are there any limitations in features when using a third-party host?")]),e._v(" "),t("p",[e._v("Yes. Here are some restrictions.")]),e._v(" "),t("ul",[t("li",[e._v("No "),t("RouterLink",{attrs:{to:"/LightningNetwork/"}},[e._v("Lightning Network")]),e._v(" by default. Can be enabled by the third-party host but at the cost of a security risk for registrants using that third-party. "),t("a",{attrs:{href:"#can-i-enable-the-use-of-my-lightning-network-node-to-others"}},[e._v("More information")])],1),e._v(" "),t("li",[e._v("No "),t("RouterLink",{attrs:{to:"/FAQ/Wallet/#what-is-wallet-re-scan-in-btcpay"}},[e._v("wallet re-scan")])],1),e._v(" "),t("li",[e._v("No "),t("RouterLink",{attrs:{to:"/Walkthrough/#server-settings"}},[e._v("Server Settings")]),e._v(" access")],1)]),e._v(" "),t("p",[e._v("The limitations happen for technical reasons, mostly because these features require a user to run a full node to use them.")]),e._v(" "),t("h2",{attrs:{id:"can-i-enable-the-use-of-my-lightning-network-node-to-others"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#can-i-enable-the-use-of-my-lightning-network-node-to-others"}},[e._v("#")]),e._v(" Can I enable the use of my Lightning Network node to others?")]),e._v(" "),t("p",[e._v("Yes, you can enable users that have registered on your BTCPay Server instance to use your Lightning Network node.\n"),t("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-many-users-can-use-lightning-network-in-btcpay"}},[e._v("See how")])],1),e._v(" "),t("h2",{attrs:{id:"what-does-the-trusted-third-party-host-know-about-their-users"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-does-the-trusted-third-party-host-know-about-their-users"}},[e._v("#")]),e._v(" What does the trusted third-party host know about their users?")]),e._v(" "),t("p",[e._v("Third party hosts (non-malicious) can see the following:")]),e._v(" "),t("ul",[t("li",[e._v("Total number of users")]),e._v(" "),t("li",[e._v("The email and username of those users")])]),e._v(" "),t("p",[e._v("Note: If additional features are enabled such as non-admin lightning wallet, hot wallets or transmuter, the server admin can see additional information related to those features. Since it's impossible to know if the third party host is using a malicious fork, it's best to assume they may know all details about your BTCPay Server usage.")]),e._v(" "),t("p",[e._v("If you are worried about the information a third party host knows about you, please consider "),t("RouterLink",{attrs:{to:"/Deployment/"}},[e._v("deploying your own")]),e._v(" self-hosted server.")],1)])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/101.a2e1f892.js b/assets/js/101.2f52e777.js similarity index 98% rename from assets/js/101.a2e1f892.js rename to assets/js/101.2f52e777.js index db0870cf1c..dd810f67bd 100644 --- a/assets/js/101.a2e1f892.js +++ b/assets/js/101.2f52e777.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[101],{717:function(e,t,o){"use strict";o.r(t);var r=o(9),a=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"introduction-to-web-deployments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction-to-web-deployments"}},[e._v("#")]),e._v(" Introduction to Web Deployments")]),e._v(" "),t("p",[e._v("We will take you through possible "),t("code",[e._v("Web Deployments")]),e._v(" on this page and update the list as more providers offer BTCPay Server as a service.\nBut what is a "),t("code",[e._v("Web deployment")]),e._v("?\nIn short, a third-party hosted environment.")]),e._v(" "),t("p",[e._v("What do they do? They offer you the user, storage space, and compute power.\nAnd in particular, for this page, they offer hosted Bitcoin nodes.")]),e._v(" "),t("p",[e._v("Now you don't have to buy, host and maintain your own hardware. The service provider takes care of this.\nThis comes with the risk factor of trusting someone to host your bitcoin node and BTCPay Server on top of that.\nEvery hoster comes with its own pros and cons. One might be cheaper, and the other maybe has better support levels.\nHowever, we will guide you through the ones we've listed and offer BTCPay Server solutions.")]),e._v(" "),t("p",[e._v("Below you will find a short introduction to each service and a detailed guide on each of them.")]),e._v(" "),t("h2",{attrs:{id:"known-web-deployments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#known-web-deployments"}},[e._v("#")]),e._v(" Known web deployments.")]),e._v(" "),t("h3",{attrs:{id:"lunanode-web-wizard"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#lunanode-web-wizard"}},[e._v("#")]),e._v(" LunaNode web-wizard.")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.lunanode.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("LunaNode"),t("OutboundLink")],1),e._v(" is a Canadian-based hosting provider that accepts Bitcoin payments and requires no personal identification except for a phone number verification.")]),e._v(" "),t("p",[e._v("Their web wizard is one of the easiest ways to "),t("strong",[e._v("deploy BTCPay Servers from a very user-friendly interface")]),e._v(".\nLunaNode will provide you with a generic domain for your server to get you started.")]),e._v(" "),t("p",[e._v("For more details on "),t("code",[e._v("LunaNode")]),e._v(" click "),t("RouterLink",{attrs:{to:"/Deployment/LunaNode/"}},[e._v("here")])],1),e._v(" "),t("h3",{attrs:{id:"voltage-cloud"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#voltage-cloud"}},[e._v("#")]),e._v(" Voltage Cloud")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.voltage.cloud",target:"_blank",rel:"noopener noreferrer"}},[e._v("Voltage"),t("OutboundLink")],1),e._v(" is an infrastructure provider for Bitcoin.\nBy focusing on Bitcoin exclusively, they can offer quality services to their clients.\nAutomatically connect your Voltage Lightning node.")]),e._v(" "),t("p",[e._v("For more details on "),t("code",[e._v("Voltage Cloud")]),e._v(" click "),t("RouterLink",{attrs:{to:"/Deployment/voltagecloud/"}},[e._v("here")])],1),e._v(" "),t("h3",{attrs:{id:"dreamlab-network-solutions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dreamlab-network-solutions"}},[e._v("#")]),e._v(" DreamLab Network Solutions")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://dreamlabnetwork.solutions",target:"_blank",rel:"noopener noreferrer"}},[e._v("DreamLab Network Solutions"),t("OutboundLink")],1),e._v(" has datacenters around the globe.\nNow out of their North American location, they have started hosting BTCPay Server as a service.\nWith 24/7 support and a future of multiple locations of hosting check "),t("code",[e._v("Dreamlab Networks")]),e._v(" BTCPay Server setup guide "),t("RouterLink",{attrs:{to:"/Deployment/DreamlabNetwork/"}},[e._v("here")])],1),e._v(" "),t("h3",{attrs:{id:"clovyr"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#clovyr"}},[e._v("#")]),e._v(" Clovyr")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://clovyr.app/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Clovyr"),t("OutboundLink")],1),e._v(" is an application deployment service.\nThey allow deploying services, including BTCPay Server, either to their own servers, or to a variety of other VPS providers, such as Digital Ocean, AWS, and Linode.\nFor more details on "),t("code",[e._v("Clovyr")]),e._v(" click "),t("RouterLink",{attrs:{to:"/Deployment/Clovyr/"}},[e._v("here")])],1),e._v(" "),t("h2",{attrs:{id:"missing-deployments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#missing-deployments"}},[e._v("#")]),e._v(" Missing deployments?")]),e._v(" "),t("p",[e._v("As we are a FOSS project, we might miss certain deployments.\nFound a deployment that is missing, and do you want it added or notified us?\nJoin the "),t("a",{attrs:{href:"https://chat.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("community chat"),t("OutboundLink")],1),e._v(" on Mattermost by downloading "),t("a",{attrs:{href:"https://mattermost.com/download/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mattermost app"),t("OutboundLink")],1),e._v(", or on "),t("a",{attrs:{href:"https://t.me/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Telegram"),t("OutboundLink")],1),e._v(" and tell us about it.\nYou can also create an issue in the BTCPay server Documents on "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-doc/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(".")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[101],{716:function(e,t,o){"use strict";o.r(t);var r=o(9),a=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"introduction-to-web-deployments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction-to-web-deployments"}},[e._v("#")]),e._v(" Introduction to Web Deployments")]),e._v(" "),t("p",[e._v("We will take you through possible "),t("code",[e._v("Web Deployments")]),e._v(" on this page and update the list as more providers offer BTCPay Server as a service.\nBut what is a "),t("code",[e._v("Web deployment")]),e._v("?\nIn short, a third-party hosted environment.")]),e._v(" "),t("p",[e._v("What do they do? They offer you the user, storage space, and compute power.\nAnd in particular, for this page, they offer hosted Bitcoin nodes.")]),e._v(" "),t("p",[e._v("Now you don't have to buy, host and maintain your own hardware. The service provider takes care of this.\nThis comes with the risk factor of trusting someone to host your bitcoin node and BTCPay Server on top of that.\nEvery hoster comes with its own pros and cons. One might be cheaper, and the other maybe has better support levels.\nHowever, we will guide you through the ones we've listed and offer BTCPay Server solutions.")]),e._v(" "),t("p",[e._v("Below you will find a short introduction to each service and a detailed guide on each of them.")]),e._v(" "),t("h2",{attrs:{id:"known-web-deployments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#known-web-deployments"}},[e._v("#")]),e._v(" Known web deployments.")]),e._v(" "),t("h3",{attrs:{id:"lunanode-web-wizard"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#lunanode-web-wizard"}},[e._v("#")]),e._v(" LunaNode web-wizard.")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.lunanode.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("LunaNode"),t("OutboundLink")],1),e._v(" is a Canadian-based hosting provider that accepts Bitcoin payments and requires no personal identification except for a phone number verification.")]),e._v(" "),t("p",[e._v("Their web wizard is one of the easiest ways to "),t("strong",[e._v("deploy BTCPay Servers from a very user-friendly interface")]),e._v(".\nLunaNode will provide you with a generic domain for your server to get you started.")]),e._v(" "),t("p",[e._v("For more details on "),t("code",[e._v("LunaNode")]),e._v(" click "),t("RouterLink",{attrs:{to:"/Deployment/LunaNode/"}},[e._v("here")])],1),e._v(" "),t("h3",{attrs:{id:"voltage-cloud"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#voltage-cloud"}},[e._v("#")]),e._v(" Voltage Cloud")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.voltage.cloud",target:"_blank",rel:"noopener noreferrer"}},[e._v("Voltage"),t("OutboundLink")],1),e._v(" is an infrastructure provider for Bitcoin.\nBy focusing on Bitcoin exclusively, they can offer quality services to their clients.\nAutomatically connect your Voltage Lightning node.")]),e._v(" "),t("p",[e._v("For more details on "),t("code",[e._v("Voltage Cloud")]),e._v(" click "),t("RouterLink",{attrs:{to:"/Deployment/voltagecloud/"}},[e._v("here")])],1),e._v(" "),t("h3",{attrs:{id:"dreamlab-network-solutions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dreamlab-network-solutions"}},[e._v("#")]),e._v(" DreamLab Network Solutions")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://dreamlabnetwork.solutions",target:"_blank",rel:"noopener noreferrer"}},[e._v("DreamLab Network Solutions"),t("OutboundLink")],1),e._v(" has datacenters around the globe.\nNow out of their North American location, they have started hosting BTCPay Server as a service.\nWith 24/7 support and a future of multiple locations of hosting check "),t("code",[e._v("Dreamlab Networks")]),e._v(" BTCPay Server setup guide "),t("RouterLink",{attrs:{to:"/Deployment/DreamlabNetwork/"}},[e._v("here")])],1),e._v(" "),t("h3",{attrs:{id:"clovyr"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#clovyr"}},[e._v("#")]),e._v(" Clovyr")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://clovyr.app/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Clovyr"),t("OutboundLink")],1),e._v(" is an application deployment service.\nThey allow deploying services, including BTCPay Server, either to their own servers, or to a variety of other VPS providers, such as Digital Ocean, AWS, and Linode.\nFor more details on "),t("code",[e._v("Clovyr")]),e._v(" click "),t("RouterLink",{attrs:{to:"/Deployment/Clovyr/"}},[e._v("here")])],1),e._v(" "),t("h2",{attrs:{id:"missing-deployments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#missing-deployments"}},[e._v("#")]),e._v(" Missing deployments?")]),e._v(" "),t("p",[e._v("As we are a FOSS project, we might miss certain deployments.\nFound a deployment that is missing, and do you want it added or notified us?\nJoin the "),t("a",{attrs:{href:"https://chat.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("community chat"),t("OutboundLink")],1),e._v(" on Mattermost by downloading "),t("a",{attrs:{href:"https://mattermost.com/download/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mattermost app"),t("OutboundLink")],1),e._v(", or on "),t("a",{attrs:{href:"https://t.me/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Telegram"),t("OutboundLink")],1),e._v(" and tell us about it.\nYou can also create an issue in the BTCPay server Documents on "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-doc/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(".")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/102.e981b360.js b/assets/js/102.64ff4c22.js similarity index 98% rename from assets/js/102.e981b360.js rename to assets/js/102.64ff4c22.js index 87288bf833..6b3f4d0444 100644 --- a/assets/js/102.e981b360.js +++ b/assets/js/102.64ff4c22.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{718:function(e,t,r){"use strict";r.r(t);var o=r(9),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"how-to-add-an-altcoin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-add-an-altcoin"}},[e._v("#")]),e._v(" How to add an Altcoin")]),e._v(" "),t("p",[e._v("Bitcoin is the only focus of the project and its core developers. However, opt-in integrations are available for several altcoins.")]),e._v(" "),t("p",[e._v("For more information and the full list of integrated altcoins, check the "),t("RouterLink",{attrs:{to:"/FAQ/Altcoin/"}},[e._v("Altcoin FAQ page")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"how-can-i-add-an-altcoin-to-btcpayserver"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-add-an-altcoin-to-btcpayserver"}},[e._v("#")]),e._v(" How can I add an altcoin to BTCPayServer?")]),e._v(" "),t("p",[e._v("The steps for having a coin added are:")]),e._v(" "),t("ol",[t("li",[e._v("Add support for your crypto to "),t("a",{attrs:{href:"https://github.com/MetacoSA/NBitcoin/tree/master/NBitcoin.Altcoins",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBitcoin"),t("OutboundLink")],1),e._v(", "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBxplorer"),t("OutboundLink")],1),e._v(", and "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer"),t("OutboundLink")],1),e._v(". (Use examples from other coins)")]),e._v(" "),t("li",[e._v("Create your own docker image ("),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/bitcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Create a docker-compose fragment ("),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/bitcoin.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Add your CryptoDefinition ("),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/src/CryptoDefinition.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")])]),e._v(" "),t("p",[e._v("When testing your coin, "),t("strong",[e._v("DO NOT USE "),t("code",[e._v("build.sh")])]),e._v(", since it uses a pre-built docker image.")]),e._v(" "),t("p",[e._v("Instead, install "),t("a",{attrs:{href:"https://dotnet.microsoft.com/en-us/download/dotnet/6.0",target:"_blank",rel:"noopener noreferrer"}},[e._v(".NET 6.0 SDK"),t("OutboundLink")],1),e._v(" and run:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO1")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"EXAMPLE-COIN"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_SUBNAME")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"test"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" docker-compose-generator/src\ndotnet run\n")])])]),t("p",[e._v("This will generate your docker-compose in the "),t("code",[e._v("Generated")]),e._v(" folder, which you can then run and test.")]),e._v(" "),t("p",[e._v("Note: BTCPay developers do not implement alternative coins on request. Adding a new coin explicitly depends on the community and developers of those coins. Furthermore, BTCPay developers do not spend excessive time testing nor maintaining the altcoins. If you're submitting a PR for a new coin, make sure that your image works. If the altcoin integration is not actively maintained it will be removed from BTCPay.")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[102],{717:function(e,t,r){"use strict";r.r(t);var o=r(9),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"how-to-add-an-altcoin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-add-an-altcoin"}},[e._v("#")]),e._v(" How to add an Altcoin")]),e._v(" "),t("p",[e._v("Bitcoin is the only focus of the project and its core developers. However, opt-in integrations are available for several altcoins.")]),e._v(" "),t("p",[e._v("For more information and the full list of integrated altcoins, check the "),t("RouterLink",{attrs:{to:"/FAQ/Altcoin/"}},[e._v("Altcoin FAQ page")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"how-can-i-add-an-altcoin-to-btcpayserver"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-add-an-altcoin-to-btcpayserver"}},[e._v("#")]),e._v(" How can I add an altcoin to BTCPayServer?")]),e._v(" "),t("p",[e._v("The steps for having a coin added are:")]),e._v(" "),t("ol",[t("li",[e._v("Add support for your crypto to "),t("a",{attrs:{href:"https://github.com/MetacoSA/NBitcoin/tree/master/NBitcoin.Altcoins",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBitcoin"),t("OutboundLink")],1),e._v(", "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBxplorer"),t("OutboundLink")],1),e._v(", and "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer"),t("OutboundLink")],1),e._v(". (Use examples from other coins)")]),e._v(" "),t("li",[e._v("Create your own docker image ("),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/bitcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Create a docker-compose fragment ("),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/bitcoin.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Add your CryptoDefinition ("),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/src/CryptoDefinition.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")])]),e._v(" "),t("p",[e._v("When testing your coin, "),t("strong",[e._v("DO NOT USE "),t("code",[e._v("build.sh")])]),e._v(", since it uses a pre-built docker image.")]),e._v(" "),t("p",[e._v("Instead, install "),t("a",{attrs:{href:"https://dotnet.microsoft.com/en-us/download/dotnet/6.0",target:"_blank",rel:"noopener noreferrer"}},[e._v(".NET 6.0 SDK"),t("OutboundLink")],1),e._v(" and run:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO1")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"EXAMPLE-COIN"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_SUBNAME")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"test"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" docker-compose-generator/src\ndotnet run\n")])])]),t("p",[e._v("This will generate your docker-compose in the "),t("code",[e._v("Generated")]),e._v(" folder, which you can then run and test.")]),e._v(" "),t("p",[e._v("Note: BTCPay developers do not implement alternative coins on request. Adding a new coin explicitly depends on the community and developers of those coins. Furthermore, BTCPay developers do not spend excessive time testing nor maintaining the altcoins. If you're submitting a PR for a new coin, make sure that your image works. If the altcoin integration is not actively maintained it will be removed from BTCPay.")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/103.59e687ab.js b/assets/js/103.f840bb7d.js similarity index 99% rename from assets/js/103.59e687ab.js rename to assets/js/103.f840bb7d.js index eefd44f07b..bd378cde21 100644 --- a/assets/js/103.59e687ab.js +++ b/assets/js/103.f840bb7d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[103],{719:function(t,s,a){"use strict";a.r(s);var n=a(9),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"greenfield-api-example-with-nodejs-javascript"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#greenfield-api-example-with-nodejs-javascript"}},[t._v("#")]),t._v(" Greenfield API example with Node.JS (JavaScript)")]),t._v(" "),s("p",[t._v("The "),s("strong",[s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Greenfield API"),s("OutboundLink")],1)]),t._v(" (also available on your instance on "),s("code",[t._v("/docs")]),t._v(") allows you to operate BTCPay Server via an easy-to-use REST API.")]),t._v(" "),s("p",[t._v("Note that you can partially generate clients in the language of your choice by using the "),s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/swagger.json",target:"_blank",rel:"noopener noreferrer"}},[t._v("Swagger file"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("p",[t._v("In this guide, we will give some examples how to use the Greenfield API with Node.JS.")]),t._v(" "),s("p",[t._v('You can generate your API key in the BTCPay Server UI under "Account" -> "Manage Account" -> "API Keys" (path '),s("code",[t._v("/account/apikeys")]),t._v("). Make sure that the API key you are using has the permissions to execute the needed requests.")]),t._v(" "),s("h2",{attrs:{id:"create-a-new-user"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-user"}},[t._v("#")]),t._v(" Create a new user")]),t._v(" "),s("p",[t._v("Creating a new user can be done by using "),s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Users_CreateUser",target:"_blank",rel:"noopener noreferrer"}},[t._v("this endpoint"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" btcpayserverurl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" apiendpoint "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/api/v1/users'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" token "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'APIKEYTOKEN'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" headers "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'Content-Type'")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'application/json'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Authorization")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'token '")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" token\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" user "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("email")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MyTestUser@gmail.com'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("password")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'NOTVERYSECURE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("isAdministrator")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("fetch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("btcpayserverurl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" apiendpoint"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("method")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'POST'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("headers")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" headers"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("body")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringify")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("user"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("response")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" response"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("json")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("data")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h2",{attrs:{id:"create-a-new-api-key"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-api-key"}},[t._v("#")]),t._v(" Create a new API key")]),t._v(" "),s("p",[t._v("While we can use basic authentication to access the greenfield API, it is recommended to use API Keys to limit the scope of the credentials.")]),t._v(" "),s("p",[t._v("For example: If we want to "),s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_CreateStore",target:"_blank",rel:"noopener noreferrer"}},[t._v("create a new store"),s("OutboundLink")],1),t._v(" we need the "),s("code",[t._v("btcpay.store.canmodifystoresettings")]),t._v(" permission for the API key.")]),t._v(" "),s("p",[t._v("As mentioned above, you can do through BTCPay Server UI of your instance, but let's do it through the API using "),s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/ApiKeys_CreateApiKey",target:"_blank",rel:"noopener noreferrer"}},[t._v("this endpoint"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" btcpayserverUrl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" apiEndpoint "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/api/v1/api-keys'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" permission "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'btcpay.store.canmodifystoresettings'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" token "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'APIKEYTOKEN'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" headers "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'Content-Type'")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'application/json'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Authorization")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'token '")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" token\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" apikey "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'LABELNAME'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("permissions")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("permission"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("fetch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("btcpayserverUrl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" apiEndpoint"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("method")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'POST'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("headers")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" headers"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("body")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringify")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("apikey"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("response")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" response"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("json")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("data")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h2",{attrs:{id:"create-a-new-store"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-store"}},[t._v("#")]),t._v(" Create a new store")]),t._v(" "),s("p",[t._v("Now, we can use the api key to "),s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_CreateStore",target:"_blank",rel:"noopener noreferrer"}},[t._v("create a new store"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" btcpayserverUrl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" apiEndpoint "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/api/v1/stores'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" token "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'APIKEYTOKEN'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" headers "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'Content-Type'")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'application/json'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Authorization")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'token '")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" token\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" store "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Name")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'STORENAME'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("fetch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("btcpayserverurl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" apiendpoint"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("method")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'POST'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("headers")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" headers"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("body")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringify")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("store"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("response")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" response"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("json")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("data")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h2",{attrs:{id:"webhook-implementation-with-nodejs-express"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#webhook-implementation-with-nodejs-express"}},[t._v("#")]),t._v(" Webhook implementation with Node.JS + Express")]),t._v(" "),s("p",[t._v("You can use your Node.JS Express web application to receive webhook requests from your BTCPay Server.")]),t._v(" "),s("p",[t._v("First you need a route so that your Node.JS application can receive POST requests.\nBased on how you set up the express server this should look somthing like underneath.")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("app"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("post")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/btcpayserverwebhook'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" res")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//do stuff here")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("What's important is that the webhook (as statet in the documentation) delivers an HTTP-Header "),s("code",[t._v("BTCPAY-SIG")]),t._v(".\nYou should in above function compare the "),s("code",[t._v("BTCPAY-SIG")]),t._v(" with the actual data from the request body (as bytes).\nIn your app.js (or similar) add following where you include requirements:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" bodyParser "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'body-parser'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("and add following")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("app"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("use")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n bodyParser"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("json")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("verify")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" res"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" buf")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rawBody "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" buf\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("This makes sure that in req.rawBody the correct content is parsed so that you can compare the hashed req.rawBody with the "),s("code",[t._v("BTCPAY-SIG")]),t._v(" header value.")]),t._v(" "),s("p",[t._v("Edit your router function like this: (Obviously change "),s("code",[t._v("webhookSecret")]),t._v(")")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("app"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("post")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/btcpayserverwebhook'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" res")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sigHashAlg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sha256'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sigHeaderName "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'BTCPAY-SIG'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" webhookSecret "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'VERYVERYSECRET'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rawBody"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("next")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Request body empty'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sig "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Buffer"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("from")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("get")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sigHeaderName"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'utf8'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hmac "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" crypto"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createHmac")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sigHashAlg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" webhookSecret"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" digest "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Buffer"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("from")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n sigHashAlg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'='")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" hmac"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rawBody"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("digest")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hex'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'utf8'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" checksum "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Buffer"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("from")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sig"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'utf8'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n checksum"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!==")]),t._v(" digest"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("crypto"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("timingSafeEqual")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("digest"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" checksum"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("Request body digest (")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("digest"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(") did not match ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("sigHeaderName"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(" (")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("checksum"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("next")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("Request body digest (")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("digest"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(") did not match ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("sigHeaderName"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(" (")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("checksum"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Do More Stuff here")]),t._v("\n res"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("status")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("200")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("send")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Request body was signed'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[103],{718:function(t,s,a){"use strict";a.r(s);var n=a(9),e=Object(n.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"greenfield-api-example-with-nodejs-javascript"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#greenfield-api-example-with-nodejs-javascript"}},[t._v("#")]),t._v(" Greenfield API example with Node.JS (JavaScript)")]),t._v(" "),s("p",[t._v("The "),s("strong",[s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Greenfield API"),s("OutboundLink")],1)]),t._v(" (also available on your instance on "),s("code",[t._v("/docs")]),t._v(") allows you to operate BTCPay Server via an easy-to-use REST API.")]),t._v(" "),s("p",[t._v("Note that you can partially generate clients in the language of your choice by using the "),s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/swagger.json",target:"_blank",rel:"noopener noreferrer"}},[t._v("Swagger file"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("p",[t._v("In this guide, we will give some examples how to use the Greenfield API with Node.JS.")]),t._v(" "),s("p",[t._v('You can generate your API key in the BTCPay Server UI under "Account" -> "Manage Account" -> "API Keys" (path '),s("code",[t._v("/account/apikeys")]),t._v("). Make sure that the API key you are using has the permissions to execute the needed requests.")]),t._v(" "),s("h2",{attrs:{id:"create-a-new-user"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-user"}},[t._v("#")]),t._v(" Create a new user")]),t._v(" "),s("p",[t._v("Creating a new user can be done by using "),s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Users_CreateUser",target:"_blank",rel:"noopener noreferrer"}},[t._v("this endpoint"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" btcpayserverurl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" apiendpoint "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/api/v1/users'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" token "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'APIKEYTOKEN'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" headers "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'Content-Type'")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'application/json'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Authorization")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'token '")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" token\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" user "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("email")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'MyTestUser@gmail.com'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("password")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'NOTVERYSECURE'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("isAdministrator")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("fetch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("btcpayserverurl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" apiendpoint"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("method")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'POST'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("headers")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" headers"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("body")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringify")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("user"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("response")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" response"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("json")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("data")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h2",{attrs:{id:"create-a-new-api-key"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-api-key"}},[t._v("#")]),t._v(" Create a new API key")]),t._v(" "),s("p",[t._v("While we can use basic authentication to access the greenfield API, it is recommended to use API Keys to limit the scope of the credentials.")]),t._v(" "),s("p",[t._v("For example: If we want to "),s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_CreateStore",target:"_blank",rel:"noopener noreferrer"}},[t._v("create a new store"),s("OutboundLink")],1),t._v(" we need the "),s("code",[t._v("btcpay.store.canmodifystoresettings")]),t._v(" permission for the API key.")]),t._v(" "),s("p",[t._v("As mentioned above, you can do through BTCPay Server UI of your instance, but let's do it through the API using "),s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/ApiKeys_CreateApiKey",target:"_blank",rel:"noopener noreferrer"}},[t._v("this endpoint"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" btcpayserverUrl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" apiEndpoint "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/api/v1/api-keys'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" permission "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'btcpay.store.canmodifystoresettings'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" token "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'APIKEYTOKEN'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" headers "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'Content-Type'")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'application/json'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Authorization")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'token '")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" token\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" apikey "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("label")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'LABELNAME'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("permissions")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("permission"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("fetch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("btcpayserverUrl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" apiEndpoint"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("method")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'POST'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("headers")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" headers"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("body")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringify")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("apikey"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("response")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" response"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("json")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("data")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h2",{attrs:{id:"create-a-new-store"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-store"}},[t._v("#")]),t._v(" Create a new store")]),t._v(" "),s("p",[t._v("Now, we can use the api key to "),s("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_CreateStore",target:"_blank",rel:"noopener noreferrer"}},[t._v("create a new store"),s("OutboundLink")],1),t._v(".")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" btcpayserverUrl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" apiEndpoint "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/api/v1/stores'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" token "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'APIKEYTOKEN'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" headers "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string-property property"}},[t._v("'Content-Type'")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'application/json'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Authorization")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'token '")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" token\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" store "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("Name")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'STORENAME'")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("fetch")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("btcpayserverurl "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" apiendpoint"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("method")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'POST'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("headers")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" headers"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token literal-property property"}},[t._v("body")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("stringify")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("store"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("response")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" response"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("json")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("then")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("data")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("data"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("h2",{attrs:{id:"webhook-implementation-with-nodejs-express"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#webhook-implementation-with-nodejs-express"}},[t._v("#")]),t._v(" Webhook implementation with Node.JS + Express")]),t._v(" "),s("p",[t._v("You can use your Node.JS Express web application to receive webhook requests from your BTCPay Server.")]),t._v(" "),s("p",[t._v("First you need a route so that your Node.JS application can receive POST requests.\nBased on how you set up the express server this should look somthing like underneath.")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("app"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("post")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/btcpayserverwebhook'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" res")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("//do stuff here")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("What's important is that the webhook (as statet in the documentation) delivers an HTTP-Header "),s("code",[t._v("BTCPAY-SIG")]),t._v(".\nYou should in above function compare the "),s("code",[t._v("BTCPAY-SIG")]),t._v(" with the actual data from the request body (as bytes).\nIn your app.js (or similar) add following where you include requirements:")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" bodyParser "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("require")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'body-parser'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("and add following")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("app"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("use")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n bodyParser"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("json")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token function-variable function"}},[t._v("verify")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" res"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" buf")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rawBody "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" buf\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])]),s("p",[t._v("This makes sure that in req.rawBody the correct content is parsed so that you can compare the hashed req.rawBody with the "),s("code",[t._v("BTCPAY-SIG")]),t._v(" header value.")]),t._v(" "),s("p",[t._v("Edit your router function like this: (Obviously change "),s("code",[t._v("webhookSecret")]),t._v(")")]),t._v(" "),s("div",{staticClass:"language-js extra-class"},[s("pre",{pre:!0,attrs:{class:"language-js"}},[s("code",[t._v("app"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("post")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'/btcpayserverwebhook'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token parameter"}},[t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" res")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sigHashAlg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'sha256'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sigHeaderName "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'BTCPAY-SIG'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" webhookSecret "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'VERYVERYSECRET'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rawBody"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("next")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Request body empty'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" sig "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Buffer"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("from")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("get")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sigHeaderName"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("''")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'utf8'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" hmac "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" crypto"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("createHmac")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sigHashAlg"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" webhookSecret"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" digest "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Buffer"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("from")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n sigHashAlg "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'='")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" hmac"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("update")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("req"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("rawBody"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("digest")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'hex'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'utf8'")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("const")]),t._v(" checksum "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" Buffer"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("from")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("sig"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'utf8'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n checksum"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!==")]),t._v(" digest"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),t._v("length "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("||")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),t._v("crypto"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("timingSafeEqual")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("digest"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" checksum"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n console"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("log")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("Request body digest (")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("digest"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(") did not match ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("sigHeaderName"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(" (")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("checksum"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("return")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("next")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token template-string"}},[s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("Request body digest (")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("digest"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(") did not match ")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("sigHeaderName"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(" (")]),s("span",{pre:!0,attrs:{class:"token interpolation"}},[s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("${")]),t._v("checksum"),s("span",{pre:!0,attrs:{class:"token interpolation-punctuation punctuation"}},[t._v("}")])]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token template-punctuation string"}},[t._v("`")])]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("else")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Do More Stuff here")]),t._v("\n res"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("status")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("200")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(".")]),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("send")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("'Request body was signed'")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=e.exports}}]); \ No newline at end of file diff --git a/assets/js/104.fb44f08a.js b/assets/js/104.227def50.js similarity index 99% rename from assets/js/104.fb44f08a.js rename to assets/js/104.227def50.js index fd67729357..4c27c0a031 100644 --- a/assets/js/104.fb44f08a.js +++ b/assets/js/104.227def50.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{720:function(s,a,t){"use strict";t.r(a);var e=t(9),r=Object(e.a)({},(function(){var s=this,a=s._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h1",{attrs:{id:"greenfield-api-example-with-curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#greenfield-api-example-with-curl"}},[s._v("#")]),s._v(" Greenfield API example with cURL")]),s._v(" "),a("p",[s._v("The "),a("strong",[a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/",target:"_blank",rel:"noopener noreferrer"}},[s._v("Greenfield API"),a("OutboundLink")],1)]),s._v(" (also available on your instance on "),a("code",[s._v("/docs")]),s._v(") allows you to operate BTCPay Server via an easy-to-use REST API.")]),s._v(" "),a("p",[s._v("Note that you can partially generate clients in the language of your choice by using the "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/swagger.json",target:"_blank",rel:"noopener noreferrer"}},[s._v("Swagger file"),a("OutboundLink")],1),s._v(".")]),s._v(" "),a("p",[s._v("In this guide, we will show you how to use it via command line on linux using "),a("code",[s._v("curl")]),s._v(" and "),a("code",[s._v("jq")]),s._v(".")]),s._v(" "),a("h2",{attrs:{id:"create-a-new-user"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-user"}},[s._v("#")]),s._v(" Create a new user")]),s._v(" "),a("p",[s._v("Creating a new user can be done by using "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Users/paths/~1api~1v1~1users/post",target:"_blank",rel:"noopener noreferrer"}},[s._v("this endpoint"),a("OutboundLink")],1),s._v(".")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("BTCPAY_INSTANCE")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"https://mainnet.demo.btcpayserver.org"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[a("span",{pre:!0,attrs:{class:"token environment constant"}},[s._v("USER")])]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"MyTestUser@gmail.com"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("PASSWORD")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"NOTVERYSECURE"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("body")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("echo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"{}"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq --arg "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"a"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token environment constant"}},[s._v("$USER")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'. + {email:$a}'")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq --arg "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"a"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$PASSWORD")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'. + {password:$a}'")]),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X POST "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -d "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$body")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v('/api/v1/users"')]),s._v("\n")])])]),a("h2",{attrs:{id:"create-a-new-api-key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-api-key"}},[s._v("#")]),s._v(" Create a new API key")]),s._v(" "),a("p",[s._v("While we can use basic authentication to access the greenfield API, it is recommended to use API Keys to limit the scope of the credentials.")]),s._v(" "),a("p",[s._v("For example: If we want to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Stores/paths/~1api~1v1~1stores/post",target:"_blank",rel:"noopener noreferrer"}},[s._v("create a new store"),a("OutboundLink")],1),s._v(" we need the "),a("code",[s._v("btcpay.store.canmodifystoresettings")]),s._v(" permission for the API key.")]),s._v(" "),a("p",[s._v("You can do it through BTCPay Server UI (by browsing "),a("code",[s._v("/account/apikeys")]),s._v(" of your instance), but let's do it via command line using "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys/post",target:"_blank",rel:"noopener noreferrer"}},[s._v("this endpoint"),a("OutboundLink")],1),s._v(".")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("permission")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"btcpay.store.canmodifystoresettings"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("body")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("echo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"{}"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq --arg "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"a"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$permission")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'. + {permissions:[$a]}'")]),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("apikey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n --user "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token environment constant"}},[s._v("$USER")]),s._v(":"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$PASSWORD")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X POST "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -d "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$body")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v('/api/v1/api-keys"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq -r .apiKey"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n")])])]),a("p",[s._v("You can then provide the API key via the "),a("code",[s._v("Authorization: token $apikey")]),s._v(" header, as shown in the examples below.")]),s._v(" "),a("h2",{attrs:{id:"create-a-new-store"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-store"}},[s._v("#")]),s._v(" Create a new store")]),s._v(" "),a("p",[s._v("Now, we can use the api key to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Stores/paths/~1api~1v1~1stores/post",target:"_blank",rel:"noopener noreferrer"}},[s._v("create a new store"),a("OutboundLink")],1),s._v(".")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("store_name")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"My awesome store"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("body")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("echo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"{}"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq --arg "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"a"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$store_name")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'. + {name:$a}'")]),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("store_id")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Authorization: token '),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$apikey")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X POST "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -d "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$body")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v('/api/v1/stores"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq -r .id"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n")])])]),a("h2",{attrs:{id:"create-a-new-api-key-with-limiting-permissions-on-the-new-store-for-example-read-only"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-api-key-with-limiting-permissions-on-the-new-store-for-example-read-only"}},[s._v("#")]),s._v(" Create a new API key with limiting permissions on the new store, for example read only")]),s._v(" "),a("p",[s._v("You can set specific permissions per user, for your new store:")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("old_apikey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$apikey")]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("permission")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"btcpay.store.canviewstoresettings:'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$store_id")]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("body")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("echo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"{}"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq --arg "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"a"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$permission")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'. + {permissions:[$a]}'")]),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("apikey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n --user "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token environment constant"}},[s._v("$USER")]),s._v(":"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$PASSWORD")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X POST "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -d "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$body")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v('/api/v1/api-keys"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq -r .apiKey"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n")])])]),a("p",[s._v("After creating the new API key, this is to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys~1current/delete",target:"_blank",rel:"noopener noreferrer"}},[s._v("revoke our old apikey"),a("OutboundLink")],1),s._v(".\nDon't forget this step!")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Authorization: token '),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$old_apikey")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X DELETE "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v('/api/v1/api-keys/current"')]),s._v("\n")])])]),a("h2",{attrs:{id:"read-store-information"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#read-store-information"}},[s._v("#")]),s._v(" Read store information")]),s._v(" "),a("p",[s._v("We can use the new apikey to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_GetStore",target:"_blank",rel:"noopener noreferrer"}},[s._v("read store"),a("OutboundLink")],1),s._v(" information:")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Authorization: token '),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$apikey")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X GET "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v("/api/v1/stores/"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$store_id")]),s._v('"')]),s._v("\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[104],{719:function(s,a,t){"use strict";t.r(a);var e=t(9),r=Object(e.a)({},(function(){var s=this,a=s._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[a("h1",{attrs:{id:"greenfield-api-example-with-curl"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#greenfield-api-example-with-curl"}},[s._v("#")]),s._v(" Greenfield API example with cURL")]),s._v(" "),a("p",[s._v("The "),a("strong",[a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/",target:"_blank",rel:"noopener noreferrer"}},[s._v("Greenfield API"),a("OutboundLink")],1)]),s._v(" (also available on your instance on "),a("code",[s._v("/docs")]),s._v(") allows you to operate BTCPay Server via an easy-to-use REST API.")]),s._v(" "),a("p",[s._v("Note that you can partially generate clients in the language of your choice by using the "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/swagger.json",target:"_blank",rel:"noopener noreferrer"}},[s._v("Swagger file"),a("OutboundLink")],1),s._v(".")]),s._v(" "),a("p",[s._v("In this guide, we will show you how to use it via command line on linux using "),a("code",[s._v("curl")]),s._v(" and "),a("code",[s._v("jq")]),s._v(".")]),s._v(" "),a("h2",{attrs:{id:"create-a-new-user"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-user"}},[s._v("#")]),s._v(" Create a new user")]),s._v(" "),a("p",[s._v("Creating a new user can be done by using "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Users/paths/~1api~1v1~1users/post",target:"_blank",rel:"noopener noreferrer"}},[s._v("this endpoint"),a("OutboundLink")],1),s._v(".")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("BTCPAY_INSTANCE")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"https://mainnet.demo.btcpayserver.org"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[a("span",{pre:!0,attrs:{class:"token environment constant"}},[s._v("USER")])]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"MyTestUser@gmail.com"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("PASSWORD")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"NOTVERYSECURE"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("body")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("echo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"{}"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq --arg "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"a"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token environment constant"}},[s._v("$USER")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'. + {email:$a}'")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq --arg "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"a"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$PASSWORD")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'. + {password:$a}'")]),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X POST "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -d "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$body")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v('/api/v1/users"')]),s._v("\n")])])]),a("h2",{attrs:{id:"create-a-new-api-key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-api-key"}},[s._v("#")]),s._v(" Create a new API key")]),s._v(" "),a("p",[s._v("While we can use basic authentication to access the greenfield API, it is recommended to use API Keys to limit the scope of the credentials.")]),s._v(" "),a("p",[s._v("For example: If we want to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Stores/paths/~1api~1v1~1stores/post",target:"_blank",rel:"noopener noreferrer"}},[s._v("create a new store"),a("OutboundLink")],1),s._v(" we need the "),a("code",[s._v("btcpay.store.canmodifystoresettings")]),s._v(" permission for the API key.")]),s._v(" "),a("p",[s._v("You can do it through BTCPay Server UI (by browsing "),a("code",[s._v("/account/apikeys")]),s._v(" of your instance), but let's do it via command line using "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys/post",target:"_blank",rel:"noopener noreferrer"}},[s._v("this endpoint"),a("OutboundLink")],1),s._v(".")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("permission")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"btcpay.store.canmodifystoresettings"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("body")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("echo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"{}"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq --arg "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"a"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$permission")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'. + {permissions:[$a]}'")]),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("apikey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n --user "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token environment constant"}},[s._v("$USER")]),s._v(":"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$PASSWORD")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X POST "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -d "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$body")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v('/api/v1/api-keys"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq -r .apiKey"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n")])])]),a("p",[s._v("You can then provide the API key via the "),a("code",[s._v("Authorization: token $apikey")]),s._v(" header, as shown in the examples below.")]),s._v(" "),a("h2",{attrs:{id:"create-a-new-store"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-store"}},[s._v("#")]),s._v(" Create a new store")]),s._v(" "),a("p",[s._v("Now, we can use the api key to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#tag/Stores/paths/~1api~1v1~1stores/post",target:"_blank",rel:"noopener noreferrer"}},[s._v("create a new store"),a("OutboundLink")],1),s._v(".")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("store_name")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"My awesome store"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("body")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("echo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"{}"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq --arg "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"a"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$store_name")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'. + {name:$a}'")]),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("store_id")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Authorization: token '),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$apikey")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X POST "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -d "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$body")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v('/api/v1/stores"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq -r .id"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n")])])]),a("h2",{attrs:{id:"create-a-new-api-key-with-limiting-permissions-on-the-new-store-for-example-read-only"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-api-key-with-limiting-permissions-on-the-new-store-for-example-read-only"}},[s._v("#")]),s._v(" Create a new API key with limiting permissions on the new store, for example read only")]),s._v(" "),a("p",[s._v("You can set specific permissions per user, for your new store:")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("old_apikey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$apikey")]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("permission")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"btcpay.store.canviewstoresettings:'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$store_id")]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("body")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v("echo")]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"{}"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq --arg "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"a"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$permission")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v("'. + {permissions:[$a]}'")]),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("apikey")]),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$(")]),a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n --user "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token environment constant"}},[s._v("$USER")]),s._v(":"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$PASSWORD")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X POST "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -d "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$body")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v('/api/v1/api-keys"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[s._v("|")]),s._v(" jq -r .apiKey"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v(")")])]),s._v('"')]),s._v("\n")])])]),a("p",[s._v("After creating the new API key, this is to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#tag/API-Keys/paths/~1api~1v1~1api-keys~1current/delete",target:"_blank",rel:"noopener noreferrer"}},[s._v("revoke our old apikey"),a("OutboundLink")],1),s._v(".\nDon't forget this step!")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Authorization: token '),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$old_apikey")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X DELETE "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v('/api/v1/api-keys/current"')]),s._v("\n")])])]),a("h2",{attrs:{id:"read-store-information"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#read-store-information"}},[s._v("#")]),s._v(" Read store information")]),s._v(" "),a("p",[s._v("We can use the new apikey to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_GetStore",target:"_blank",rel:"noopener noreferrer"}},[s._v("read store"),a("OutboundLink")],1),s._v(" information:")]),s._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[s._v("curl")]),s._v(" -s "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Content-Type: application/json"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -H "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"Authorization: token '),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$apikey")]),s._v('"')]),s._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n -X GET "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[s._v("\\")]),s._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAY_INSTANCE")]),s._v("/api/v1/stores/"),a("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$store_id")]),s._v('"')]),s._v("\n")])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/105.31e661db.js b/assets/js/105.787f5a00.js similarity index 99% rename from assets/js/105.31e661db.js rename to assets/js/105.787f5a00.js index b440423177..a725eeab2b 100644 --- a/assets/js/105.31e661db.js +++ b/assets/js/105.787f5a00.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{721:function(t,a,s){"use strict";s.r(a);var e=s(9),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"greenfield-api-examples-with-php"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#greenfield-api-examples-with-php"}},[t._v("#")]),t._v(" Greenfield API examples with PHP")]),t._v(" "),a("p",[t._v("The "),a("strong",[a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Greenfield API"),a("OutboundLink")],1)]),t._v(" (also available on your instance on "),a("code",[t._v("/docs")]),t._v(") allows you to operate BTCPay Server via an easy-to-use REST API.")]),t._v(" "),a("p",[t._v("For PHP we have a client library available which can be found "),a("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-greenfield-php",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),a("OutboundLink")],1),t._v(" and is also available for installation via Composer "),a("code",[t._v("composer require btcpayserver/btcpayserver-greenfield-php")])]),t._v(" "),a("p",[t._v("In this guide, we will give some examples how to use the Greenfield API with our PHP library. Additional examples can be found "),a("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-greenfield-php/tree/master/examples",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("p",[t._v('You can generate your API key in the BTCPay Server UI under "Account" -> "Manage Account" -> "API Keys" (path '),a("code",[t._v("/account/apikeys")]),t._v("). Make sure that the API key you are using has the permissions to execute the needed requests.")]),t._v(" "),a("h2",{attrs:{id:"create-a-new-user"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-user"}},[t._v("#")]),t._v(" Create a new user")]),t._v(" "),a("p",[t._v("Creating a new user can be done by using "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Users_CreateUser",target:"_blank",rel:"noopener noreferrer"}},[t._v("this endpoint"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("div",{staticClass:"language-php extra-class"},[a("pre",{pre:!0,attrs:{class:"language-php"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("__DIR__")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'./vendor/autoload.php'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'pQc2FYhYwNzhf4DF7Foo6YpQc2FYhYwNzhf4DF7Foo6Y'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$email")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'test@test.com'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$password")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'Testing##123'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$isAdministrator")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("BTCPayServer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Client"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("User")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("var_dump")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createUser")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$email")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$password")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$isAdministrator")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Throwable")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Error: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMessage")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"create-a-new-api-key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-api-key"}},[t._v("#")]),t._v(" Create a new API key")]),t._v(" "),a("p",[t._v("While we can use basic authentication to access the greenfield API, it is recommended to use API Keys to limit the scope of the credentials.")]),t._v(" "),a("p",[t._v("For example: If we want to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_CreateStore",target:"_blank",rel:"noopener noreferrer"}},[t._v("create a new store"),a("OutboundLink")],1),t._v(" we need the "),a("code",[t._v("btcpay.store.canmodifystoresettings")]),t._v(" permission for the API key. Warning: If you do not pass any permission then the API key will have unrestricted access.")]),t._v(" "),a("p",[t._v("As mentioned above, you can do this through the BTCPay Server UI of your instance, but let's do it through the API using "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/ApiKeys_CreateApiKey",target:"_blank",rel:"noopener noreferrer"}},[t._v("this endpoint"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("div",{staticClass:"language-php extra-class"},[a("pre",{pre:!0,attrs:{class:"language-php"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("__DIR__")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'./vendor/autoload.php'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'API_KEY'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("BTCPayServer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Client"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Apikey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("var_dump")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createApiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'api generated'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'btcpay.store.canmodifystoresettings'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Throwable")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Error: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMessage")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"create-a-new-store"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-store"}},[t._v("#")]),t._v(" Create a new store")]),t._v(" "),a("p",[t._v("Now, we can use the api key to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_CreateStore",target:"_blank",rel:"noopener noreferrer"}},[t._v("create a new store"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("div",{staticClass:"language-php extra-class"},[a("pre",{pre:!0,attrs:{class:"language-php"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("__DIR__")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'./vendor/autoload.php'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'API_KEY'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a new store.")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("BTCPayServer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Client"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Store")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("var_dump")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createStore")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'my new store'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Throwable")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Error: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMessage")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"create-a-simple-invoice"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-simple-invoice"}},[t._v("#")]),t._v(" Create a simple invoice")]),t._v(" "),a("div",{staticClass:"language-php extra-class"},[a("pre",{pre:!0,attrs:{class:"language-php"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("__DIR__")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'./vendor/autoload.php'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'API_KEY'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$storeId")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'STORE_ID'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$amount")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("5.15")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("mt_rand")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$currency")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'USD'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$orderId")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'Test39939'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("mt_rand")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$buyerEmail")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'john@example.com'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a basic invoice.")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("BTCPayServer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Client"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Invoice")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("var_dump")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createInvoice")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$storeId")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$currency")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token class-name static-context"}},[t._v("PreciseNumber")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("::")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("parseString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$amount")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$orderId")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$buyerEmail")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Throwable")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Error: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMessage")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("You can find a more advanced example with metadata and checkout options "),a("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-greenfield-php/blob/master/examples/create_invoice.php",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),a("OutboundLink")],1)]),t._v(" "),a("h2",{attrs:{id:"webhook-implementation-and-validation-with-php"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#webhook-implementation-and-validation-with-php"}},[t._v("#")]),t._v(" Webhook implementation and validation with PHP")]),t._v(" "),a("p",[t._v("You can register a webhook for "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Webhook_InvoiceCreated",target:"_blank",rel:"noopener noreferrer"}},[t._v("invoice events"),a("OutboundLink")],1),t._v(' through your Store settings UI ("Settings" -> "Webhooks") or via '),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Webhooks_CreateWebhook",target:"_blank",rel:"noopener noreferrer"}},[t._v("this endpoint"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("p",[t._v("The webhook payloads of BTCPay Server are signed, and therefore you can trust its content - but only after proper request validation. The validation of the provided "),a("code",[t._v("BTCPay-Sig")]),t._v(" HTTP-header and payload, is done by the library.")]),t._v(" "),a("p",[t._v("On webhook creation, you provide an "),a("code",[t._v("url")]),t._v(" that points to an endpoint route on your PHP site. e.g. "),a("code",[t._v("https://example.com/mywebhookcallback")]),t._v(". If you did not provide the "),a("code",[t._v("secret")]),t._v(" yourself it will be autogenerated for you.")]),t._v(" "),a("p",[t._v("On that endpoint you can read and validate the webhook payload of your BTCPay Server instance like this:")]),t._v(" "),a("div",{staticClass:"language-php extra-class"},[a("pre",{pre:!0,attrs:{class:"language-php"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("__DIR__")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'./vendor/autoload.php'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'API_KEY'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$storeId")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'STORE_ID'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$webhookSecret")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'WEBHOOK_SECRET'")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$raw_post_data")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("file_get_contents")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'php://input'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$payload")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("json_decode")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$raw_post_data")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("512")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON_THROW_ON_ERROR")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Get the BTCPay signature header.")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$headers")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getallheaders")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("foreach")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$headers")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("as")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$key")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$value")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("strtolower")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$key")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'btcpay-sig'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$sig")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$value")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$webhookClient")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("BTCPayServer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Client"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Webhook")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Validate the webhook request.")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$webhookClient")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIncomingWebhookRequestValid")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$raw_post_data")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$sig")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$secret")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("throw")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("RuntimeException")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'Invalid BTCPayServer payment notification message received - signature did not match.'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Your own processing code goes here.")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'OK'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("You can find many more examples "),a("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-greenfield-php/blob/master/examples/",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),a("OutboundLink")],1)])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[105],{720:function(t,a,s){"use strict";s.r(a);var e=s(9),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"greenfield-api-examples-with-php"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#greenfield-api-examples-with-php"}},[t._v("#")]),t._v(" Greenfield API examples with PHP")]),t._v(" "),a("p",[t._v("The "),a("strong",[a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Greenfield API"),a("OutboundLink")],1)]),t._v(" (also available on your instance on "),a("code",[t._v("/docs")]),t._v(") allows you to operate BTCPay Server via an easy-to-use REST API.")]),t._v(" "),a("p",[t._v("For PHP we have a client library available which can be found "),a("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-greenfield-php",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),a("OutboundLink")],1),t._v(" and is also available for installation via Composer "),a("code",[t._v("composer require btcpayserver/btcpayserver-greenfield-php")])]),t._v(" "),a("p",[t._v("In this guide, we will give some examples how to use the Greenfield API with our PHP library. Additional examples can be found "),a("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-greenfield-php/tree/master/examples",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("p",[t._v('You can generate your API key in the BTCPay Server UI under "Account" -> "Manage Account" -> "API Keys" (path '),a("code",[t._v("/account/apikeys")]),t._v("). Make sure that the API key you are using has the permissions to execute the needed requests.")]),t._v(" "),a("h2",{attrs:{id:"create-a-new-user"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-user"}},[t._v("#")]),t._v(" Create a new user")]),t._v(" "),a("p",[t._v("Creating a new user can be done by using "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Users_CreateUser",target:"_blank",rel:"noopener noreferrer"}},[t._v("this endpoint"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("div",{staticClass:"language-php extra-class"},[a("pre",{pre:!0,attrs:{class:"language-php"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("__DIR__")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'./vendor/autoload.php'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'pQc2FYhYwNzhf4DF7Foo6YpQc2FYhYwNzhf4DF7Foo6Y'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$email")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'test@test.com'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$password")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'Testing##123'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$isAdministrator")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("BTCPayServer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Client"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("User")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("var_dump")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createUser")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$email")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$password")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$isAdministrator")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Throwable")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Error: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMessage")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"create-a-new-api-key"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-api-key"}},[t._v("#")]),t._v(" Create a new API key")]),t._v(" "),a("p",[t._v("While we can use basic authentication to access the greenfield API, it is recommended to use API Keys to limit the scope of the credentials.")]),t._v(" "),a("p",[t._v("For example: If we want to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_CreateStore",target:"_blank",rel:"noopener noreferrer"}},[t._v("create a new store"),a("OutboundLink")],1),t._v(" we need the "),a("code",[t._v("btcpay.store.canmodifystoresettings")]),t._v(" permission for the API key. Warning: If you do not pass any permission then the API key will have unrestricted access.")]),t._v(" "),a("p",[t._v("As mentioned above, you can do this through the BTCPay Server UI of your instance, but let's do it through the API using "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/ApiKeys_CreateApiKey",target:"_blank",rel:"noopener noreferrer"}},[t._v("this endpoint"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("div",{staticClass:"language-php extra-class"},[a("pre",{pre:!0,attrs:{class:"language-php"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("__DIR__")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'./vendor/autoload.php'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'API_KEY'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("BTCPayServer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Client"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Apikey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("var_dump")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createApiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'api generated'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'btcpay.store.canmodifystoresettings'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Throwable")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Error: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMessage")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"create-a-new-store"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-store"}},[t._v("#")]),t._v(" Create a new store")]),t._v(" "),a("p",[t._v("Now, we can use the api key to "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Stores_CreateStore",target:"_blank",rel:"noopener noreferrer"}},[t._v("create a new store"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("div",{staticClass:"language-php extra-class"},[a("pre",{pre:!0,attrs:{class:"language-php"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("__DIR__")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'./vendor/autoload.php'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'API_KEY'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a new store.")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("BTCPayServer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Client"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Store")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("var_dump")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createStore")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'my new store'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Throwable")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Error: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMessage")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"create-a-simple-invoice"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-a-simple-invoice"}},[t._v("#")]),t._v(" Create a simple invoice")]),t._v(" "),a("div",{staticClass:"language-php extra-class"},[a("pre",{pre:!0,attrs:{class:"language-php"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("__DIR__")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'./vendor/autoload.php'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'API_KEY'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$storeId")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'STORE_ID'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$amount")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("5.15")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("+")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("mt_rand")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("20")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$currency")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'USD'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$orderId")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'Test39939'")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("mt_rand")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$buyerEmail")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'john@example.com'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Create a basic invoice.")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("try")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("BTCPayServer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Client"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Invoice")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("var_dump")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$client")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("createInvoice")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$storeId")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$currency")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token class-name static-context"}},[t._v("PreciseNumber")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("::")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("parseString")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$amount")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$orderId")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$buyerEmail")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("catch")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Throwable")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string double-quoted-string"}},[t._v('"Error: "')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$e")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getMessage")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("You can find a more advanced example with metadata and checkout options "),a("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-greenfield-php/blob/master/examples/create_invoice.php",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),a("OutboundLink")],1)]),t._v(" "),a("h2",{attrs:{id:"webhook-implementation-and-validation-with-php"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#webhook-implementation-and-validation-with-php"}},[t._v("#")]),t._v(" Webhook implementation and validation with PHP")]),t._v(" "),a("p",[t._v("You can register a webhook for "),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Webhook_InvoiceCreated",target:"_blank",rel:"noopener noreferrer"}},[t._v("invoice events"),a("OutboundLink")],1),t._v(' through your Store settings UI ("Settings" -> "Webhooks") or via '),a("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/#operation/Webhooks_CreateWebhook",target:"_blank",rel:"noopener noreferrer"}},[t._v("this endpoint"),a("OutboundLink")],1),t._v(".")]),t._v(" "),a("p",[t._v("The webhook payloads of BTCPay Server are signed, and therefore you can trust its content - but only after proper request validation. The validation of the provided "),a("code",[t._v("BTCPay-Sig")]),t._v(" HTTP-header and payload, is done by the library.")]),t._v(" "),a("p",[t._v("On webhook creation, you provide an "),a("code",[t._v("url")]),t._v(" that points to an endpoint route on your PHP site. e.g. "),a("code",[t._v("https://example.com/mywebhookcallback")]),t._v(". If you did not provide the "),a("code",[t._v("secret")]),t._v(" yourself it will be autogenerated for you.")]),t._v(" "),a("p",[t._v("On that endpoint you can read and validate the webhook payload of your BTCPay Server instance like this:")]),t._v(" "),a("div",{staticClass:"language-php extra-class"},[a("pre",{pre:!0,attrs:{class:"language-php"}},[a("code",[a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("require")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("__DIR__")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(".")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'./vendor/autoload.php'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'https://mainnet.demo.btcpayserver.org'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'API_KEY'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$storeId")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'STORE_ID'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$webhookSecret")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'WEBHOOK_SECRET'")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$raw_post_data")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("file_get_contents")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'php://input'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$payload")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("json_decode")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$raw_post_data")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("512")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token constant"}},[t._v("JSON_THROW_ON_ERROR")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Get the BTCPay signature header.")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$headers")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("getallheaders")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("foreach")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$headers")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("as")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$key")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=>")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$value")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("strtolower")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$key")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("===")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'btcpay-sig'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$sig")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$value")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$webhookClient")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("BTCPayServer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Client"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("Webhook")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$host")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$apiKey")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Validate the webhook request.")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("if")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("!")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$webhookClient")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("->")]),a("span",{pre:!0,attrs:{class:"token function"}},[t._v("isIncomingWebhookRequestValid")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$raw_post_data")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$sig")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$secret")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("throw")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("new")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token class-name class-name-fully-qualified"}},[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("RuntimeException")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("(")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'Invalid BTCPayServer payment notification message received - signature did not match.'")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(")")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Your own processing code goes here.")]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token keyword"}},[t._v("echo")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string single-quoted-string"}},[t._v("'OK'")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(";")]),t._v("\n")])])]),a("p",[t._v("You can find many more examples "),a("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-greenfield-php/blob/master/examples/",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),a("OutboundLink")],1)])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/106.f077d3ba.js b/assets/js/106.a632902a.js similarity index 99% rename from assets/js/106.f077d3ba.js rename to assets/js/106.a632902a.js index 4ea3ca12d1..47e561b467 100644 --- a/assets/js/106.f077d3ba.js +++ b/assets/js/106.a632902a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{722:function(t,s,a){"use strict";a.r(s);var e=a(9),n=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"invoice-metadata"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#invoice-metadata"}},[t._v("#")]),t._v(" Invoice metadata")]),t._v(" "),s("p",[t._v("Each invoice contains metadata, which is a customizable JSON object that can be tailored through the API during the creation of an invoice. Although it lacks a fixed schema, certain properties within the metadata can be interpreted by the UI.")]),t._v(" "),s("p",[t._v("This page provides an overview of these properties and explains how they are utilized within the BTCPay Server.")]),t._v(" "),s("h2",{attrs:{id:"well-known-properties"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#well-known-properties"}},[t._v("#")]),t._v(" Well-known properties")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Property path")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v(".orderId")])]),t._v(" "),s("td",[t._v("Refers to the order ID from an external system, such as an e-commerce platform like WooCommerce. This property is indexed, allowing for efficient invoice searches using the "),s("code",[t._v("orderId")]),t._v(".")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".orderUrl")])]),t._v(" "),s("td",[t._v("Refers to a URL linking back to the order page of the external system. This link is displayed in the invoice details view.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".paymentRequestId")])]),t._v(" "),s("td",[t._v("In the invoice details view, a link is provided for navigating to the payment request page associated with the invoice.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".posData")])]),t._v(" "),s("td",[t._v("A custom JSON object that represents information displayed in the invoice details view.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".receiptData")])]),t._v(" "),s("td",[t._v("A custom JSON object that represents information displayed on the receipt page of an invoice.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerName")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerEmail")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerAddress1")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerAddress2")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerCity")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerState")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerZip")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerCountry")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerPhone")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".itemDesc")])]),t._v(" "),s("td",[t._v("When using the Point of Sale (except in keypad or cart view), this field is set to the item description of the purchased item. This information is included in the CSV invoice export feature and appears in the invoice details view.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".itemCode")])]),t._v(" "),s("td",[t._v("When using the Point of Sale (except in keypad or cart view), this field is set to the item code of the purchased item. This information is included in the CSV invoice export feature and appears in the invoice details view.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".physical")])]),t._v(" "),s("td",[t._v("Boolean value indicating whether this is a physical good; displayed in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".taxIncluded")])]),t._v(" "),s("td",[t._v("Number representing the tax amount in the invoice currency. This information will appear in the invoice details view. During invoice creation, the value is automatically rounded to significant digits and ensured not to be greater than the invoice's price.")])])])]),t._v(" "),s("h2",{attrs:{id:"examples"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[t._v("#")]),t._v(" Examples")]),t._v(" "),s("p",[t._v("Point of sale invoice (Product list view):")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderId"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pos-app_346KRC5BjXXXo8cRFKwTBmdR6ZJ4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"itemCode"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"green tea"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"itemDesc"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Green Tea"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderUrl"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://localhost:14142/apps/346KRC5BjXXXo8cRFKwTBmdR6ZJ4/pos"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"receiptData"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Title"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Green Tea"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Description"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("\"Lovely, fresh and tender, Meng Ding Gan Lu ('sweet dew') is grown in the lush Meng Ding Mountains of the southwestern province of Sichuan where it has been cultivated for over a thousand years.\"")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Point of sale invoice (Cart view):")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderId"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pos-app_346KRC5BjXXXo8cRFKwTBmdR6ZJ4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"posData"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"tip"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.48")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cart"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pu erh"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"count"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"image"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"~/img/pos-sample/pu-erh.jpg"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"price"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"formatted"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$2.00"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"title"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Pu Erh"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inventory"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"rooibos"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"count"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"image"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"~/img/pos-sample/rooibos.jpg"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"price"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1.2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"formatted"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$1.20"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"title"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Rooibos"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inventory"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"total"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3.68")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"subTotal"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3.2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"customAmount"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"discountAmount"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"discountPercentage"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"itemDesc"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Tea shop"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderUrl"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://localhost:14142/apps/346KRC5BjXXXo8cRFKwTBmdR6ZJ4/pos"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"receiptData"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Tip"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$0.48"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Cart"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Pu Erh"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$2.00 x 1 = $2.00"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Rooibos"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$1.20 x 1 = $1.20"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Point of sale invoice (Keypad view):")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderId"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pos-app_346KRC5BjXXXo8cRFKwTBmdR6ZJ4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"posData"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"total"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"12.00"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"subTotal"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"12.00"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"itemDesc"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Tea shop"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderUrl"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://localhost:14142/apps/346KRC5BjXXXo8cRFKwTBmdR6ZJ4/pos"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"receiptData"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[106],{721:function(t,s,a){"use strict";a.r(s);var e=a(9),n=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"invoice-metadata"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#invoice-metadata"}},[t._v("#")]),t._v(" Invoice metadata")]),t._v(" "),s("p",[t._v("Each invoice contains metadata, which is a customizable JSON object that can be tailored through the API during the creation of an invoice. Although it lacks a fixed schema, certain properties within the metadata can be interpreted by the UI.")]),t._v(" "),s("p",[t._v("This page provides an overview of these properties and explains how they are utilized within the BTCPay Server.")]),t._v(" "),s("h2",{attrs:{id:"well-known-properties"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#well-known-properties"}},[t._v("#")]),t._v(" Well-known properties")]),t._v(" "),s("table",[s("thead",[s("tr",[s("th",[t._v("Property path")]),t._v(" "),s("th",[t._v("Description")])])]),t._v(" "),s("tbody",[s("tr",[s("td",[s("code",[t._v(".orderId")])]),t._v(" "),s("td",[t._v("Refers to the order ID from an external system, such as an e-commerce platform like WooCommerce. This property is indexed, allowing for efficient invoice searches using the "),s("code",[t._v("orderId")]),t._v(".")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".orderUrl")])]),t._v(" "),s("td",[t._v("Refers to a URL linking back to the order page of the external system. This link is displayed in the invoice details view.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".paymentRequestId")])]),t._v(" "),s("td",[t._v("In the invoice details view, a link is provided for navigating to the payment request page associated with the invoice.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".posData")])]),t._v(" "),s("td",[t._v("A custom JSON object that represents information displayed in the invoice details view.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".receiptData")])]),t._v(" "),s("td",[t._v("A custom JSON object that represents information displayed on the receipt page of an invoice.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerName")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerEmail")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerAddress1")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerAddress2")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerCity")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerState")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerZip")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerCountry")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".buyerPhone")])]),t._v(" "),s("td",[t._v("Visible in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".itemDesc")])]),t._v(" "),s("td",[t._v("When using the Point of Sale (except in keypad or cart view), this field is set to the item description of the purchased item. This information is included in the CSV invoice export feature and appears in the invoice details view.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".itemCode")])]),t._v(" "),s("td",[t._v("When using the Point of Sale (except in keypad or cart view), this field is set to the item code of the purchased item. This information is included in the CSV invoice export feature and appears in the invoice details view.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".physical")])]),t._v(" "),s("td",[t._v("Boolean value indicating whether this is a physical good; displayed in the invoice details view and in the BitPay API-compatible endpoints.")])]),t._v(" "),s("tr",[s("td",[s("code",[t._v(".taxIncluded")])]),t._v(" "),s("td",[t._v("Number representing the tax amount in the invoice currency. This information will appear in the invoice details view. During invoice creation, the value is automatically rounded to significant digits and ensured not to be greater than the invoice's price.")])])])]),t._v(" "),s("h2",{attrs:{id:"examples"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#examples"}},[t._v("#")]),t._v(" Examples")]),t._v(" "),s("p",[t._v("Point of sale invoice (Product list view):")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderId"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pos-app_346KRC5BjXXXo8cRFKwTBmdR6ZJ4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"itemCode"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"green tea"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"itemDesc"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Green Tea"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderUrl"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://localhost:14142/apps/346KRC5BjXXXo8cRFKwTBmdR6ZJ4/pos"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"receiptData"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Title"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Green Tea"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Description"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("\"Lovely, fresh and tender, Meng Ding Gan Lu ('sweet dew') is grown in the lush Meng Ding Mountains of the southwestern province of Sichuan where it has been cultivated for over a thousand years.\"")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Point of sale invoice (Cart view):")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderId"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pos-app_346KRC5BjXXXo8cRFKwTBmdR6ZJ4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"posData"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"tip"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.48")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cart"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pu erh"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"count"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"image"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"~/img/pos-sample/pu-erh.jpg"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"price"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"formatted"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$2.00"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"title"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Pu Erh"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inventory"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"rooibos"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"count"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"image"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"~/img/pos-sample/rooibos.jpg"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"price"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("1.2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"formatted"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$1.20"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"title"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Rooibos"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inventory"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"total"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3.68")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"subTotal"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("3.2")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"customAmount"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"discountAmount"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"discountPercentage"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"itemDesc"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Tea shop"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderUrl"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://localhost:14142/apps/346KRC5BjXXXo8cRFKwTBmdR6ZJ4/pos"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"receiptData"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Tip"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$0.48"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Cart"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Pu Erh"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$2.00 x 1 = $2.00"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"Rooibos"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"$1.20 x 1 = $1.20"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),s("p",[t._v("Point of sale invoice (Keypad view):")]),t._v(" "),s("div",{staticClass:"language-json extra-class"},[s("pre",{pre:!0,attrs:{class:"language-json"}},[s("code",[s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderId"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"pos-app_346KRC5BjXXXo8cRFKwTBmdR6ZJ4"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"posData"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"total"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"12.00"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"subTotal"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"12.00"')]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"itemDesc"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Tea shop"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"orderUrl"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"https://localhost:14142/apps/346KRC5BjXXXo8cRFKwTBmdR6ZJ4/pos"')]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),s("span",{pre:!0,attrs:{class:"token property"}},[t._v('"receiptData"')]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])])])}),[],!1,null,null,null);s.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/107.0ebd091e.js b/assets/js/107.84a5327d.js similarity index 99% rename from assets/js/107.0ebd091e.js rename to assets/js/107.84a5327d.js index e93885f053..5b7be9f469 100644 --- a/assets/js/107.0ebd091e.js +++ b/assets/js/107.84a5327d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{723:function(e,t,o){"use strict";o.r(t);var r=o(9),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"local-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#local-development"}},[e._v("#")]),e._v(" Local development")]),e._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),t("p",[e._v("For the "),t("strong",[e._v("development environment")]),e._v(" you need to install these tools:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://dotnet.microsoft.com/en-us/download/dotnet/6.0",target:"_blank",rel:"noopener noreferrer"}},[e._v(".NET 6.0 SDK"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("Docker: "),t("a",{attrs:{href:"https://docs.docker.com/docker-for-windows/install/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Windows"),t("OutboundLink")],1),e._v(" | "),t("a",{attrs:{href:"https://docs.docker.com/docker-for-mac/install/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mac OS"),t("OutboundLink")],1),e._v(" | "),t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/ubuntu/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Linux"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("p",[e._v("To execute tests and run the project for debugging, you need to run a number of "),t("strong",[e._v("dependencies")]),e._v(".")]),e._v(" "),t("p",[e._v("We wrapped all our dependencies in a docker-compose file that you can use to bootstrap the development environment:\nThe file "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.yml"),t("OutboundLink")],1),e._v(" can be used to spin everything up:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" clone https://github.com/btcpayserver/btcpayserver.git\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver/BTCPayServer.Tests\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker-compose")]),e._v(" up dev\n")])])]),t("h2",{attrs:{id:"which-ide"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#which-ide"}},[e._v("#")]),e._v(" Which IDE?")]),e._v(" "),t("p",[e._v("We recommend using Visual Studio 2022 (Windows Only) or Rider (cross platform). Visual Studio Code (cross platform) should also be possible, but isn't as straightforward to setup for a comfortable development environment.\nYou can of course use VIM if you are hardcore, .NET Core is easy to use via command-line.")]),e._v(" "),t("p",[e._v("Visual Studio Code, Visual Studio and Rider will run the launch profile "),t("code",[e._v("Bitcoin")]),e._v(".\nThis will run a "),t("strong",[e._v("BTCPay Server instance connecting to the services in your Docker service")]),e._v(", so you can easily debug and step through the code.")]),e._v(" "),t("h2",{attrs:{id:"build-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-configuration"}},[e._v("#")]),e._v(" Build configuration")]),e._v(" "),t("p",[e._v("A build configuration defines how to "),t("strong",[e._v("build BTCPay Server")]),e._v(". For example, whether to include some source files, whether to optimize for debugging or performance.")]),e._v(" "),t("p",[e._v("There are several build configurations:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Debug")])]),e._v(" "),t("li",[t("code",[e._v("Release")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-Debug")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-Release")])])]),e._v(" "),t("p",[e._v("How to use a different one during your local development depends on your IDE.\nBy default "),t("code",[e._v("Debug")]),e._v(" is used, this is a Bitcoin only build excluding any altcoin dependencies. How to use a different one during your local development depends on your IDE.")]),e._v(" "),t("p",[e._v("You can select which build to use via the "),t("code",[e._v("-c")]),e._v(" switch in "),t("code",[e._v("dotnet")]),e._v(" command line. If you use command line and want to run a Release build:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet run -c Release\n")])])]),t("h2",{attrs:{id:"launch-profiles"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#launch-profiles"}},[e._v("#")]),e._v(" Launch profiles")]),e._v(" "),t("p",[e._v("When you "),t("strong",[e._v("start BTCPay Server locally for local development")]),e._v(", it needs the right parameter so it can connect to the development time dependencies in the docker-compose file.")]),e._v(" "),t("p",[e._v("Those parameters are wrapped into the dotnet concept of "),t("code",[e._v("launch profile")]),e._v(".")]),e._v(" "),t("p",[e._v("The launch profiles are specified in the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer/Properties/launchSettings.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("launchSettings.json"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("There are currently three launch profiles:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Bitcoin")])]),e._v(" "),t("li",[t("code",[e._v("Bitcoin-HTTPS")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-HTTPS")])])]),e._v(" "),t("p",[e._v("By default, "),t("code",[e._v("Bitcoin")]),e._v(" is used. How to use a different one during your local development depends on your IDE.")]),e._v(" "),t("p",[e._v("If you use command line, "),t("code",[e._v("dotnet run")]),e._v(" allows you to select the launch profile of your choice:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet run --launch-profile Bitcoin\n")])])]),t("h2",{attrs:{id:"running-tests"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#running-tests"}},[e._v("#")]),e._v(" Running tests")]),e._v(" "),t("p",[e._v("Running tests is functioning in the exact same way as running the development time BTCPay Server.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\ndotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v("\n")])])]),t("p",[e._v("The concept of "),t("code",[e._v("launch profile")]),e._v(" does not apply for tests, but the concept of build configuration does. For example, if I want to run tests on the Release build:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v(" -c Release\n")])])]),t("p",[e._v("The tests are already configured to use the development time dependencies in the docker-compose presented earlier.")]),e._v(" "),t("p",[e._v("You can use the "),t("code",[e._v("--f")]),e._v(" (filter) switch to run a specific test.")]),e._v(" "),t("p",[e._v("If you use an IDE, consult your IDE documentation to run tests or switch to different configurations.")]),e._v(" "),t("h2",{attrs:{id:"altcoin-support-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#altcoin-support-development"}},[e._v("#")]),e._v(" Altcoin support development")]),e._v(" "),t("p",[e._v("By default, your IDE or simple "),t("code",[e._v("dotnet run")]),e._v(" will use "),t("code",[e._v("Bitcoin")]),e._v(" launch profile on "),t("code",[e._v("Debug")]),e._v(" build.")]),e._v(" "),t("ul",[t("li",[e._v("This means that BTCPay Server will be hosted on a local HTTP port, building without altcoin support,")]),e._v(" "),t("li",[e._v("Run BTCPay Server to connect to Bitcoin only dependencies specified in "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.yml"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("p",[e._v("If you want to "),t("strong",[e._v("develop with altcoins support")]),e._v(" you need to use the "),t("code",[e._v("Altcoins-HTTPS")]),e._v(" launch profile, on the "),t("code",[e._v("Altcoins-Debug")]),e._v(" build, and run the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.altcoins.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.altcoins.yml"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("If using command line:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker-compose")]),e._v(" -f docker-compose.altcoins.yml up dev\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v("/BTCPayServer\ndotnet run -c Altcoins-Debug --launch-profile Altcoins-HTTPS\n")])])]),t("p",[e._v("For tests")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\ndotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v(" -c Altcoins-Debug\n")])])]),t("h2",{attrs:{id:"https-support-for-local-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#https-support-for-local-development"}},[e._v("#")]),e._v(" HTTPS support for local development")]),e._v(" "),t("p",[e._v("Some browser security features may require that you use "),t("strong",[e._v("HTTPS")]),e._v(" to be properly tested.")]),e._v(" "),t("p",[e._v("In this case, use "),t("code",[e._v("Bitcoin-HTTPS")]),e._v(" (or "),t("code",[e._v("Altcoin-HTTPS")]),e._v(") launch profile. This will create a self signed certificate for your development purpose.")]),e._v(" "),t("p",[e._v("However, your browser will not trust it, making it difficult to debug.")]),e._v(" "),t("p",[e._v("You can instruct your OS to trust this development time certificate by running:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet dev-certs https --trust\n")])])]),t("h2",{attrs:{id:"videos"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#videos"}},[e._v("#")]),e._v(" Videos")]),e._v(" "),t("p",[e._v("For more information check out these videos:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=ZePbMPSIvHM",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to contribute to BTCPay Server Development (Windows)"),t("OutboundLink")],1),e._v(" by Nicolas Dorier")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=j486T_Rk-yw",target:"_blank",rel:"noopener noreferrer"}},[e._v("Setting up BTCPayServer development environment on Linux (Ubuntu)"),t("OutboundLink")],1),e._v(" by RockStarDev")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=GWR_CcMsEV0",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay Server Development - Testing pull request, payments (MacOS)"),t("OutboundLink")],1),e._v(" by Pavlenex")])]),e._v(" "),t("p",[e._v("and these notes:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to get started with development"),t("OutboundLink")],1),e._v(" by Nicolas Dorier (covering relevant docker commands, paying regtest invoices)")])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[107],{722:function(e,t,o){"use strict";o.r(t);var r=o(9),s=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"local-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#local-development"}},[e._v("#")]),e._v(" Local development")]),e._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),t("p",[e._v("For the "),t("strong",[e._v("development environment")]),e._v(" you need to install these tools:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://dotnet.microsoft.com/en-us/download/dotnet/6.0",target:"_blank",rel:"noopener noreferrer"}},[e._v(".NET 6.0 SDK"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("Docker: "),t("a",{attrs:{href:"https://docs.docker.com/docker-for-windows/install/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Windows"),t("OutboundLink")],1),e._v(" | "),t("a",{attrs:{href:"https://docs.docker.com/docker-for-mac/install/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mac OS"),t("OutboundLink")],1),e._v(" | "),t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/ubuntu/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Linux"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("p",[e._v("To execute tests and run the project for debugging, you need to run a number of "),t("strong",[e._v("dependencies")]),e._v(".")]),e._v(" "),t("p",[e._v("We wrapped all our dependencies in a docker-compose file that you can use to bootstrap the development environment:\nThe file "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.yml"),t("OutboundLink")],1),e._v(" can be used to spin everything up:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" clone https://github.com/btcpayserver/btcpayserver.git\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver/BTCPayServer.Tests\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker-compose")]),e._v(" up dev\n")])])]),t("h2",{attrs:{id:"which-ide"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#which-ide"}},[e._v("#")]),e._v(" Which IDE?")]),e._v(" "),t("p",[e._v("We recommend using Visual Studio 2022 (Windows Only) or Rider (cross platform). Visual Studio Code (cross platform) should also be possible, but isn't as straightforward to setup for a comfortable development environment.\nYou can of course use VIM if you are hardcore, .NET Core is easy to use via command-line.")]),e._v(" "),t("p",[e._v("Visual Studio Code, Visual Studio and Rider will run the launch profile "),t("code",[e._v("Bitcoin")]),e._v(".\nThis will run a "),t("strong",[e._v("BTCPay Server instance connecting to the services in your Docker service")]),e._v(", so you can easily debug and step through the code.")]),e._v(" "),t("h2",{attrs:{id:"build-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-configuration"}},[e._v("#")]),e._v(" Build configuration")]),e._v(" "),t("p",[e._v("A build configuration defines how to "),t("strong",[e._v("build BTCPay Server")]),e._v(". For example, whether to include some source files, whether to optimize for debugging or performance.")]),e._v(" "),t("p",[e._v("There are several build configurations:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Debug")])]),e._v(" "),t("li",[t("code",[e._v("Release")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-Debug")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-Release")])])]),e._v(" "),t("p",[e._v("How to use a different one during your local development depends on your IDE.\nBy default "),t("code",[e._v("Debug")]),e._v(" is used, this is a Bitcoin only build excluding any altcoin dependencies. How to use a different one during your local development depends on your IDE.")]),e._v(" "),t("p",[e._v("You can select which build to use via the "),t("code",[e._v("-c")]),e._v(" switch in "),t("code",[e._v("dotnet")]),e._v(" command line. If you use command line and want to run a Release build:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet run -c Release\n")])])]),t("h2",{attrs:{id:"launch-profiles"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#launch-profiles"}},[e._v("#")]),e._v(" Launch profiles")]),e._v(" "),t("p",[e._v("When you "),t("strong",[e._v("start BTCPay Server locally for local development")]),e._v(", it needs the right parameter so it can connect to the development time dependencies in the docker-compose file.")]),e._v(" "),t("p",[e._v("Those parameters are wrapped into the dotnet concept of "),t("code",[e._v("launch profile")]),e._v(".")]),e._v(" "),t("p",[e._v("The launch profiles are specified in the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer/Properties/launchSettings.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("launchSettings.json"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("There are currently three launch profiles:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Bitcoin")])]),e._v(" "),t("li",[t("code",[e._v("Bitcoin-HTTPS")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-HTTPS")])])]),e._v(" "),t("p",[e._v("By default, "),t("code",[e._v("Bitcoin")]),e._v(" is used. How to use a different one during your local development depends on your IDE.")]),e._v(" "),t("p",[e._v("If you use command line, "),t("code",[e._v("dotnet run")]),e._v(" allows you to select the launch profile of your choice:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet run --launch-profile Bitcoin\n")])])]),t("h2",{attrs:{id:"running-tests"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#running-tests"}},[e._v("#")]),e._v(" Running tests")]),e._v(" "),t("p",[e._v("Running tests is functioning in the exact same way as running the development time BTCPay Server.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\ndotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v("\n")])])]),t("p",[e._v("The concept of "),t("code",[e._v("launch profile")]),e._v(" does not apply for tests, but the concept of build configuration does. For example, if I want to run tests on the Release build:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v(" -c Release\n")])])]),t("p",[e._v("The tests are already configured to use the development time dependencies in the docker-compose presented earlier.")]),e._v(" "),t("p",[e._v("You can use the "),t("code",[e._v("--f")]),e._v(" (filter) switch to run a specific test.")]),e._v(" "),t("p",[e._v("If you use an IDE, consult your IDE documentation to run tests or switch to different configurations.")]),e._v(" "),t("h2",{attrs:{id:"altcoin-support-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#altcoin-support-development"}},[e._v("#")]),e._v(" Altcoin support development")]),e._v(" "),t("p",[e._v("By default, your IDE or simple "),t("code",[e._v("dotnet run")]),e._v(" will use "),t("code",[e._v("Bitcoin")]),e._v(" launch profile on "),t("code",[e._v("Debug")]),e._v(" build.")]),e._v(" "),t("ul",[t("li",[e._v("This means that BTCPay Server will be hosted on a local HTTP port, building without altcoin support,")]),e._v(" "),t("li",[e._v("Run BTCPay Server to connect to Bitcoin only dependencies specified in "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.yml"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("p",[e._v("If you want to "),t("strong",[e._v("develop with altcoins support")]),e._v(" you need to use the "),t("code",[e._v("Altcoins-HTTPS")]),e._v(" launch profile, on the "),t("code",[e._v("Altcoins-Debug")]),e._v(" build, and run the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.altcoins.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.altcoins.yml"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("If using command line:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker-compose")]),e._v(" -f docker-compose.altcoins.yml up dev\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v("/BTCPayServer\ndotnet run -c Altcoins-Debug --launch-profile Altcoins-HTTPS\n")])])]),t("p",[e._v("For tests")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\ndotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v(" -c Altcoins-Debug\n")])])]),t("h2",{attrs:{id:"https-support-for-local-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#https-support-for-local-development"}},[e._v("#")]),e._v(" HTTPS support for local development")]),e._v(" "),t("p",[e._v("Some browser security features may require that you use "),t("strong",[e._v("HTTPS")]),e._v(" to be properly tested.")]),e._v(" "),t("p",[e._v("In this case, use "),t("code",[e._v("Bitcoin-HTTPS")]),e._v(" (or "),t("code",[e._v("Altcoin-HTTPS")]),e._v(") launch profile. This will create a self signed certificate for your development purpose.")]),e._v(" "),t("p",[e._v("However, your browser will not trust it, making it difficult to debug.")]),e._v(" "),t("p",[e._v("You can instruct your OS to trust this development time certificate by running:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet dev-certs https --trust\n")])])]),t("h2",{attrs:{id:"videos"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#videos"}},[e._v("#")]),e._v(" Videos")]),e._v(" "),t("p",[e._v("For more information check out these videos:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=ZePbMPSIvHM",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to contribute to BTCPay Server Development (Windows)"),t("OutboundLink")],1),e._v(" by Nicolas Dorier")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=j486T_Rk-yw",target:"_blank",rel:"noopener noreferrer"}},[e._v("Setting up BTCPayServer development environment on Linux (Ubuntu)"),t("OutboundLink")],1),e._v(" by RockStarDev")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=GWR_CcMsEV0",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay Server Development - Testing pull request, payments (MacOS)"),t("OutboundLink")],1),e._v(" by Pavlenex")])]),e._v(" "),t("p",[e._v("and these notes:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to get started with development"),t("OutboundLink")],1),e._v(" by Nicolas Dorier (covering relevant docker commands, paying regtest invoices)")])])])}),[],!1,null,null,null);t.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/108.a8b2c5af.js b/assets/js/108.1c65c1a0.js similarity index 99% rename from assets/js/108.a8b2c5af.js rename to assets/js/108.1c65c1a0.js index f27519583c..dbf9c3c0a0 100644 --- a/assets/js/108.a8b2c5af.js +++ b/assets/js/108.1c65c1a0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[108],{724:function(e,t,s){"use strict";s.r(t);var n=s(9),r=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"local-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#local-development"}},[e._v("#")]),e._v(" Local development")]),e._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),t("p",[e._v("For the "),t("strong",[e._v("development environment")]),e._v(" you need to install these tools:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://dotnet.microsoft.com/en-us/download/dotnet/6.0",target:"_blank",rel:"noopener noreferrer"}},[e._v(".NET 6.0 SDK"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("Docker: "),t("a",{attrs:{href:"https://docs.docker.com/docker-for-windows/install/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Windows"),t("OutboundLink")],1),e._v(" | "),t("a",{attrs:{href:"https://docs.docker.com/docker-for-mac/install/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mac OS"),t("OutboundLink")],1),e._v(" | "),t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/ubuntu/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Linux"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("p",[e._v("To execute tests and run the project for debugging, you need to run a number of "),t("strong",[e._v("dependencies")]),e._v(".")]),e._v(" "),t("p",[e._v("We wrapped all our dependencies in a docker-compose file that you can use to bootstrap the development environment:\nThe file "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.yml"),t("OutboundLink")],1),e._v(" can be used to spin everything up:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" clone https://github.com/btcpayserver/btcpayserver.git\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver/BTCPayServer.Tests\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker-compose")]),e._v(" up dev\n")])])]),t("h2",{attrs:{id:"which-ide"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#which-ide"}},[e._v("#")]),e._v(" Which IDE?")]),e._v(" "),t("p",[e._v("We recommend using Visual Studio 2022 (Windows Only) or Rider (cross platform). Visual Studio Code (cross platform) should also be possible, but isn't as straightforward to setup for a comfortable development environment.\nYou can of course use VIM if you are hardcore, .NET Core is easy to use via command-line.")]),e._v(" "),t("p",[e._v("Visual Studio Code, Visual Studio and Rider will run the launch profile "),t("code",[e._v("Bitcoin")]),e._v(".\nThis will run a "),t("strong",[e._v("BTCPay Server instance connecting to the services in your Docker service")]),e._v(", so you can easily debug and step through the code.")]),e._v(" "),t("h2",{attrs:{id:"build-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-configuration"}},[e._v("#")]),e._v(" Build configuration")]),e._v(" "),t("p",[e._v("A build configuration defines how to "),t("strong",[e._v("build BTCPay Server")]),e._v(". For example, whether to include some source files, whether to optimize for debugging or performance.")]),e._v(" "),t("p",[e._v("There are several build configurations:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Debug")])]),e._v(" "),t("li",[t("code",[e._v("Release")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-Debug")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-Release")])])]),e._v(" "),t("p",[e._v("How to use a different one during your local development depends on your IDE.\nBy default "),t("code",[e._v("Debug")]),e._v(" is used, this is a Bitcoin only build excluding any altcoin dependencies. How to use a different one during your local development depends on your IDE.")]),e._v(" "),t("p",[e._v("You can select which build to use via the "),t("code",[e._v("-c")]),e._v(" switch in "),t("code",[e._v("dotnet")]),e._v(" command line. If you use command line and want to run a Release build:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet run -c Release\n")])])]),t("h2",{attrs:{id:"launch-profiles"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#launch-profiles"}},[e._v("#")]),e._v(" Launch profiles")]),e._v(" "),t("p",[e._v("When you "),t("strong",[e._v("start BTCPay Server locally for local development")]),e._v(", it needs the right parameter so it can connect to the development time dependencies in the docker-compose file.")]),e._v(" "),t("p",[e._v("Those parameters are wrapped into the dotnet concept of "),t("code",[e._v("launch profile")]),e._v(".")]),e._v(" "),t("p",[e._v("The launch profiles are specified in the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer/Properties/launchSettings.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("launchSettings.json"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("There are currently three launch profiles:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Bitcoin")])]),e._v(" "),t("li",[t("code",[e._v("Bitcoin-HTTPS")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-HTTPS")])])]),e._v(" "),t("p",[e._v("By default, "),t("code",[e._v("Bitcoin")]),e._v(" is used. How to use a different one during your local development depends on your IDE.")]),e._v(" "),t("p",[e._v("If you use command line, "),t("code",[e._v("dotnet run")]),e._v(" allows you to select the launch profile of your choice:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet run --launch-profile Bitcoin\n")])])]),t("h2",{attrs:{id:"running-tests"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#running-tests"}},[e._v("#")]),e._v(" Running tests")]),e._v(" "),t("p",[e._v("Running tests is functioning in the exact same way as running the development time BTCPay Server.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\ndotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v("\n")])])]),t("p",[e._v("The concept of "),t("code",[e._v("launch profile")]),e._v(" does not apply for tests, but the concept of build configuration does. For example, if I want to run tests on the Release build:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v(" -c Release\n")])])]),t("p",[e._v("The tests are already configured to use the development time dependencies in the docker-compose presented earlier.")]),e._v(" "),t("p",[e._v("You can use the "),t("code",[e._v("--f")]),e._v(" (filter) switch to run a specific test.")]),e._v(" "),t("p",[e._v("If you use an IDE, consult your IDE documentation to run tests or switch to different configurations.")]),e._v(" "),t("h2",{attrs:{id:"altcoin-support-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#altcoin-support-development"}},[e._v("#")]),e._v(" Altcoin support development")]),e._v(" "),t("p",[e._v("By default, your IDE or simple "),t("code",[e._v("dotnet run")]),e._v(" will use "),t("code",[e._v("Bitcoin")]),e._v(" launch profile on "),t("code",[e._v("Debug")]),e._v(" build.")]),e._v(" "),t("ul",[t("li",[e._v("This means that BTCPay Server will be hosted on a local HTTP port, building without altcoin support,")]),e._v(" "),t("li",[e._v("Run BTCPay Server to connect to Bitcoin only dependencies specified in "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.yml"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("p",[e._v("If you want to "),t("strong",[e._v("develop with altcoins support")]),e._v(" you need to use the "),t("code",[e._v("Altcoins-HTTPS")]),e._v(" launch profile, on the "),t("code",[e._v("Altcoins-Debug")]),e._v(" build, and run the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.altcoins.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.altcoins.yml"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("If using command line:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker-compose")]),e._v(" -f docker-compose.altcoins.yml up dev\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v("/BTCPayServer\ndotnet run -c Altcoins-Debug --launch-profile Altcoins-HTTPS\n")])])]),t("p",[e._v("For tests")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\ndotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v(" -c Altcoins-Debug\n")])])]),t("h2",{attrs:{id:"https-support-for-local-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#https-support-for-local-development"}},[e._v("#")]),e._v(" HTTPS support for local development")]),e._v(" "),t("p",[e._v("Some browser security features may require that you use "),t("strong",[e._v("HTTPS")]),e._v(" to be properly tested.")]),e._v(" "),t("p",[e._v("In this case, use "),t("code",[e._v("Bitcoin-HTTPS")]),e._v(" (or "),t("code",[e._v("Altcoin-HTTPS")]),e._v(") launch profile. This will create a self signed certificate for your development purpose.")]),e._v(" "),t("p",[e._v("However, your browser will not trust it, making it difficult to debug.")]),e._v(" "),t("p",[e._v("You can instruct your OS to trust this development time certificate by running:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet dev-certs https --trust\n")])])]),t("h2",{attrs:{id:"videos"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#videos"}},[e._v("#")]),e._v(" Videos")]),e._v(" "),t("p",[e._v("For more information check out these videos:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=ZePbMPSIvHM",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to contribute to BTCPay Server Development (Windows)"),t("OutboundLink")],1),e._v(" by Nicolas Dorier")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=j486T_Rk-yw",target:"_blank",rel:"noopener noreferrer"}},[e._v("Setting up BTCPayServer development environment on Linux (Ubuntu)"),t("OutboundLink")],1),e._v(" by RockStarDev")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=GWR_CcMsEV0",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay Server Development - Testing pull request, payments (MacOS)"),t("OutboundLink")],1),e._v(" by Pavlenex")])]),e._v(" "),t("p",[e._v("and these notes:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to get started with development"),t("OutboundLink")],1),e._v(" by Nicolas Dorier (covering relevant docker commands, paying regtest invoices)")])]),e._v(" "),t("h2",{attrs:{id:"how-to-manually-test-payments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-manually-test-payments"}},[e._v("#")]),e._v(" How to manually test payments")]),e._v(" "),t("h3",{attrs:{id:"using-the-test-bitcoin-cli"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-the-test-bitcoin-cli"}},[e._v("#")]),e._v(" Using the test bitcoin-cli")]),e._v(" "),t("p",[e._v("You can call bitcoin-cli inside the container with "),t("code",[e._v("docker exec")]),e._v(".\nFor example, if you want to send "),t("code",[e._v("0.23111090")]),e._v(" to "),t("code",[e._v("mohu16LH66ptoWGEL1GtP6KHTBJYXMWhEf")]),e._v(":")]),e._v(" "),t("div",{staticClass:"language-sh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("./docker-bitcoin-cli.sh sendtoaddress "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"mohu16LH66ptoWGEL1GtP6KHTBJYXMWhEf"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("0.23111090")]),e._v("\n")])])]),t("p",[e._v("If you are using Powershell:")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("\\docker-bitcoin-"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cli")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("ps1 sendtoaddress "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"mohu16LH66ptoWGEL1GtP6KHTBJYXMWhEf"')]),e._v(" 0"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("23111090\n")])])]),t("p",[e._v("You can also generate blocks:")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("\\docker-bitcoin-generate"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("ps1 3\n")])])]),t("h3",{attrs:{id:"using-polar-to-test-lightning-payments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-polar-to-test-lightning-payments"}},[e._v("#")]),e._v(" Using Polar to test Lightning payments")]),e._v(" "),t("ul",[t("li",[e._v("Install and run "),t("a",{attrs:{href:"https://lightningpolar.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Polar"),t("OutboundLink")],1),e._v(". Setup a small network of nodes.")]),e._v(" "),t("li",[e._v("Go to your store's General Settings and enable Lightning.")]),e._v(" "),t("li",[e._v("Build your connection string using the Connect information in the Polar app.")])]),e._v(" "),t("p",[e._v('LND Connection string example:\ntype=lnd-rest;server=https://127.0.0.1:8084/;macaroonfilepath="local path to admin.macaroon on your computer, without these quotes";allowinsecure=true')]),e._v(" "),t("p",[e._v("Now you can create a Lightning invoice on BTCPay Server regtest and make a payment through Polar.")]),e._v(" "),t("p",[e._v('PLEASE NOTE: You may get an exception break in Visual Studio. You must quickly click "Continue" in VS so the invoice is generated.\nOr, uncheck the box that says, "Break when this exception type is thrown".')]),e._v(" "),t("h3",{attrs:{id:"using-the-test-litecoin-cli"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-the-test-litecoin-cli"}},[e._v("#")]),e._v(" Using the test litecoin-cli")]),e._v(" "),t("p",[e._v("Same as bitcoin-cli, but with "),t("code",[e._v(".\\docker-litecoin-cli.ps1")]),e._v(" and "),t("code",[e._v(".\\docker-litecoin-cli.sh")]),e._v(" instead.")]),e._v(" "),t("h3",{attrs:{id:"using-the-test-lightning-cli"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-the-test-lightning-cli"}},[e._v("#")]),e._v(" Using the test lightning-cli")]),e._v(" "),t("p",[e._v("If you are using Linux:")]),e._v(" "),t("div",{staticClass:"language-sh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("./docker-customer-lightning-cli.sh pay lnbcrt100u1pd2e6uspp5ajnadvhazjrz55twd5k6yeg9u87wpw0q2fdr7g960yl5asv5fmnqdq9d3hkccqpxmedyrk0ehw5ueqx5e0r4qrrv74cewddfcvsxaawqz7634cmjj39sqwy5tvhz0hasktkk6t9pqfdh3edmf3z09zst5y7khv3rvxh8ctqqw6mwhh\n")])])]),t("p",[e._v("If you are using Powershell:")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("\\docker-customer-lightning-"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cli")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("ps1 pay lnbcrt100u1pd2e6uspp5ajnadvhazjrz55twd5k6yeg9u87wpw0q2fdr7g960yl5asv5fmnqdq9d3hkccqpxmedyrk0ehw5ueqx5e0r4qrrv74cewddfcvsxaawqz7634cmjj39sqwy5tvhz0hasktkk6t9pqfdh3edmf3z09zst5y7khv3rvxh8ctqqw6mwhh\n")])])]),t("p",[e._v("If you get this message:")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"code"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("205")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"message"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Could not find a route"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"data"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"getroute_tries"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"sendpay_tries"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("Please, run the test "),t("code",[e._v("CanSetLightningServer")]),e._v(", this will establish a channel between the customer and the merchant, then, retry.")]),e._v(" "),t("p",[e._v("Alternatively you can run the "),t("code",[e._v("./docker-lightning-channel-setup.sh")]),e._v(" script to establish the channel connection.\nThe "),t("code",[e._v("./docker-lightning-channel-teardown.sh")]),e._v(" script closes any existing lightning channels.")]),e._v(" "),t("h3",{attrs:{id:"alternative-lightning-testing-using-polar-to-test-lightning-payments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#alternative-lightning-testing-using-polar-to-test-lightning-payments"}},[e._v("#")]),e._v(" Alternative Lightning testing: Using Polar to test Lightning payments")]),e._v(" "),t("ul",[t("li",[e._v("Install and run "),t("a",{attrs:{href:"https://lightningpolar.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Polar"),t("OutboundLink")],1),e._v(". Setup a small network of nodes.")]),e._v(" "),t("li",[e._v("Go to your store's General Settings and enable Lightning.")]),e._v(" "),t("li",[e._v("Build your connection string using the Connect information in the Polar app.")])]),e._v(" "),t("p",[e._v('LND Connection string example:\ntype=lnd-rest;server=https://127.0.0.1:8084/;macaroonfilepath="local path to admin.macaroon on your computer, without these quotes";allowinsecure=true')]),e._v(" "),t("p",[e._v("Now you can create a lightning invoice on BTCPay Server regtest and make a payment through Polar.")]),e._v(" "),t("p",[e._v('PLEASE NOTE: You may get an exception break in Visual Studio. You must quickly click "Continue" in VS so the invoice is generated.\nOr, uncheck the box that says, "Break when this exception type is thrown".')]),e._v(" "),t("h2",{attrs:{id:"faq"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#faq"}},[e._v("#")]),e._v(" FAQ")]),e._v(" "),t("h3",{attrs:{id:"docker-compose-up-dev-failed-or-tests-are-not-passing-what-should-i-do"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docker-compose-up-dev-failed-or-tests-are-not-passing-what-should-i-do"}},[e._v("#")]),e._v(" "),t("code",[e._v("docker-compose up dev")]),e._v(" failed or tests are not passing, what should I do?")]),e._v(" "),t("ol",[t("li",[e._v("Run "),t("code",[e._v("docker-compose down --volumes")]),e._v(" (this will reset your test environment)")]),e._v(" "),t("li",[e._v("Run "),t("code",[e._v("docker-compose pull")]),e._v(" (this will ensure you have the latest images)")]),e._v(" "),t("li",[e._v("Run again with "),t("code",[e._v("docker-compose up dev")])])]),e._v(" "),t("h3",{attrs:{id:"how-to-run-the-altcoin-environment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-run-the-altcoin-environment"}},[e._v("#")]),e._v(" How to run the Altcoin environment?")]),e._v(" "),t("p",[t("code",[e._v("docker-compose -f docker-compose.altcoins.yml up dev")])]),e._v(" "),t("p",[e._v("If you still have issues, try to restart docker.")]),e._v(" "),t("h3",{attrs:{id:"how-to-run-the-selenium-test-with-a-browser"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-run-the-selenium-test-with-a-browser"}},[e._v("#")]),e._v(" How to run the Selenium test with a browser?")]),e._v(" "),t("p",[e._v("Run "),t("code",[e._v("dotnet user-secrets set RunSeleniumInBrowser true")]),e._v(" to run tests in browser.")]),e._v(" "),t("p",[e._v("To switch back to headless mode (recommended) you can run "),t("code",[e._v("dotnet user-secrets remove RunSeleniumInBrowser")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"session-not-created-this-version-of-chromedriver-only-supports-chrome-version-88"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#session-not-created-this-version-of-chromedriver-only-supports-chrome-version-88"}},[e._v("#")]),e._v(" Session not created: This version of ChromeDriver only supports Chrome version 88")]),e._v(" "),t("p",[e._v("When you run tests for selenium, you may end up with this error.\nThis happen when we update the selenium packages on BTCPay Server while you did not update your chrome version.")]),e._v(" "),t("p",[e._v("If you want to use a older chrome driver on "),t("a",{attrs:{href:"https://chromedriver.chromium.org/downloads",target:"_blank",rel:"noopener noreferrer"}},[e._v("this page"),t("OutboundLink")],1),e._v(" then point to it with")]),e._v(" "),t("p",[t("code",[e._v('dotnet user-secrets set ChromeDriverDirectory "path/to/the/driver/directory"')])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[108],{723:function(e,t,s){"use strict";s.r(t);var n=s(9),r=Object(n.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"local-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#local-development"}},[e._v("#")]),e._v(" Local development")]),e._v(" "),t("h2",{attrs:{id:"prerequisites"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisites"}},[e._v("#")]),e._v(" Prerequisites")]),e._v(" "),t("p",[e._v("For the "),t("strong",[e._v("development environment")]),e._v(" you need to install these tools:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://dotnet.microsoft.com/en-us/download/dotnet/6.0",target:"_blank",rel:"noopener noreferrer"}},[e._v(".NET 6.0 SDK"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("Docker: "),t("a",{attrs:{href:"https://docs.docker.com/docker-for-windows/install/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Windows"),t("OutboundLink")],1),e._v(" | "),t("a",{attrs:{href:"https://docs.docker.com/docker-for-mac/install/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mac OS"),t("OutboundLink")],1),e._v(" | "),t("a",{attrs:{href:"https://docs.docker.com/install/linux/docker-ce/ubuntu/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Linux"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"dependencies"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dependencies"}},[e._v("#")]),e._v(" Dependencies")]),e._v(" "),t("p",[e._v("To execute tests and run the project for debugging, you need to run a number of "),t("strong",[e._v("dependencies")]),e._v(".")]),e._v(" "),t("p",[e._v("We wrapped all our dependencies in a docker-compose file that you can use to bootstrap the development environment:\nThe file "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.yml"),t("OutboundLink")],1),e._v(" can be used to spin everything up:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" clone https://github.com/btcpayserver/btcpayserver.git\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver/BTCPayServer.Tests\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker-compose")]),e._v(" up dev\n")])])]),t("h2",{attrs:{id:"which-ide"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#which-ide"}},[e._v("#")]),e._v(" Which IDE?")]),e._v(" "),t("p",[e._v("We recommend using Visual Studio 2022 (Windows Only) or Rider (cross platform). Visual Studio Code (cross platform) should also be possible, but isn't as straightforward to setup for a comfortable development environment.\nYou can of course use VIM if you are hardcore, .NET Core is easy to use via command-line.")]),e._v(" "),t("p",[e._v("Visual Studio Code, Visual Studio and Rider will run the launch profile "),t("code",[e._v("Bitcoin")]),e._v(".\nThis will run a "),t("strong",[e._v("BTCPay Server instance connecting to the services in your Docker service")]),e._v(", so you can easily debug and step through the code.")]),e._v(" "),t("h2",{attrs:{id:"build-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-configuration"}},[e._v("#")]),e._v(" Build configuration")]),e._v(" "),t("p",[e._v("A build configuration defines how to "),t("strong",[e._v("build BTCPay Server")]),e._v(". For example, whether to include some source files, whether to optimize for debugging or performance.")]),e._v(" "),t("p",[e._v("There are several build configurations:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Debug")])]),e._v(" "),t("li",[t("code",[e._v("Release")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-Debug")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-Release")])])]),e._v(" "),t("p",[e._v("How to use a different one during your local development depends on your IDE.\nBy default "),t("code",[e._v("Debug")]),e._v(" is used, this is a Bitcoin only build excluding any altcoin dependencies. How to use a different one during your local development depends on your IDE.")]),e._v(" "),t("p",[e._v("You can select which build to use via the "),t("code",[e._v("-c")]),e._v(" switch in "),t("code",[e._v("dotnet")]),e._v(" command line. If you use command line and want to run a Release build:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet run -c Release\n")])])]),t("h2",{attrs:{id:"launch-profiles"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#launch-profiles"}},[e._v("#")]),e._v(" Launch profiles")]),e._v(" "),t("p",[e._v("When you "),t("strong",[e._v("start BTCPay Server locally for local development")]),e._v(", it needs the right parameter so it can connect to the development time dependencies in the docker-compose file.")]),e._v(" "),t("p",[e._v("Those parameters are wrapped into the dotnet concept of "),t("code",[e._v("launch profile")]),e._v(".")]),e._v(" "),t("p",[e._v("The launch profiles are specified in the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer/Properties/launchSettings.json",target:"_blank",rel:"noopener noreferrer"}},[e._v("launchSettings.json"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("There are currently three launch profiles:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("Bitcoin")])]),e._v(" "),t("li",[t("code",[e._v("Bitcoin-HTTPS")])]),e._v(" "),t("li",[t("code",[e._v("Altcoins-HTTPS")])])]),e._v(" "),t("p",[e._v("By default, "),t("code",[e._v("Bitcoin")]),e._v(" is used. How to use a different one during your local development depends on your IDE.")]),e._v(" "),t("p",[e._v("If you use command line, "),t("code",[e._v("dotnet run")]),e._v(" allows you to select the launch profile of your choice:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet run --launch-profile Bitcoin\n")])])]),t("h2",{attrs:{id:"running-tests"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#running-tests"}},[e._v("#")]),e._v(" Running tests")]),e._v(" "),t("p",[e._v("Running tests is functioning in the exact same way as running the development time BTCPay Server.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\ndotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v("\n")])])]),t("p",[e._v("The concept of "),t("code",[e._v("launch profile")]),e._v(" does not apply for tests, but the concept of build configuration does. For example, if I want to run tests on the Release build:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v(" -c Release\n")])])]),t("p",[e._v("The tests are already configured to use the development time dependencies in the docker-compose presented earlier.")]),e._v(" "),t("p",[e._v("You can use the "),t("code",[e._v("--f")]),e._v(" (filter) switch to run a specific test.")]),e._v(" "),t("p",[e._v("If you use an IDE, consult your IDE documentation to run tests or switch to different configurations.")]),e._v(" "),t("h2",{attrs:{id:"altcoin-support-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#altcoin-support-development"}},[e._v("#")]),e._v(" Altcoin support development")]),e._v(" "),t("p",[e._v("By default, your IDE or simple "),t("code",[e._v("dotnet run")]),e._v(" will use "),t("code",[e._v("Bitcoin")]),e._v(" launch profile on "),t("code",[e._v("Debug")]),e._v(" build.")]),e._v(" "),t("ul",[t("li",[e._v("This means that BTCPay Server will be hosted on a local HTTP port, building without altcoin support,")]),e._v(" "),t("li",[e._v("Run BTCPay Server to connect to Bitcoin only dependencies specified in "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.yml"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("p",[e._v("If you want to "),t("strong",[e._v("develop with altcoins support")]),e._v(" you need to use the "),t("code",[e._v("Altcoins-HTTPS")]),e._v(" launch profile, on the "),t("code",[e._v("Altcoins-Debug")]),e._v(" build, and run the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/docker-compose.altcoins.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer.Tests/docker-compose.altcoins.yml"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("If using command line:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker-compose")]),e._v(" -f docker-compose.altcoins.yml up dev\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v("/BTCPayServer\ndotnet run -c Altcoins-Debug --launch-profile Altcoins-HTTPS\n")])])]),t("p",[e._v("For tests")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer.Tests\ndotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v(" -c Altcoins-Debug\n")])])]),t("h2",{attrs:{id:"https-support-for-local-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#https-support-for-local-development"}},[e._v("#")]),e._v(" HTTPS support for local development")]),e._v(" "),t("p",[e._v("Some browser security features may require that you use "),t("strong",[e._v("HTTPS")]),e._v(" to be properly tested.")]),e._v(" "),t("p",[e._v("In this case, use "),t("code",[e._v("Bitcoin-HTTPS")]),e._v(" (or "),t("code",[e._v("Altcoin-HTTPS")]),e._v(") launch profile. This will create a self signed certificate for your development purpose.")]),e._v(" "),t("p",[e._v("However, your browser will not trust it, making it difficult to debug.")]),e._v(" "),t("p",[e._v("You can instruct your OS to trust this development time certificate by running:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet dev-certs https --trust\n")])])]),t("h2",{attrs:{id:"videos"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#videos"}},[e._v("#")]),e._v(" Videos")]),e._v(" "),t("p",[e._v("For more information check out these videos:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=ZePbMPSIvHM",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to contribute to BTCPay Server Development (Windows)"),t("OutboundLink")],1),e._v(" by Nicolas Dorier")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=j486T_Rk-yw",target:"_blank",rel:"noopener noreferrer"}},[e._v("Setting up BTCPayServer development environment on Linux (Ubuntu)"),t("OutboundLink")],1),e._v(" by RockStarDev")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://youtube.com/watch?v=GWR_CcMsEV0",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay Server Development - Testing pull request, payments (MacOS)"),t("OutboundLink")],1),e._v(" by Pavlenex")])]),e._v(" "),t("p",[e._v("and these notes:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/BTCPayServer.Tests/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to get started with development"),t("OutboundLink")],1),e._v(" by Nicolas Dorier (covering relevant docker commands, paying regtest invoices)")])]),e._v(" "),t("h2",{attrs:{id:"how-to-manually-test-payments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-manually-test-payments"}},[e._v("#")]),e._v(" How to manually test payments")]),e._v(" "),t("h3",{attrs:{id:"using-the-test-bitcoin-cli"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-the-test-bitcoin-cli"}},[e._v("#")]),e._v(" Using the test bitcoin-cli")]),e._v(" "),t("p",[e._v("You can call bitcoin-cli inside the container with "),t("code",[e._v("docker exec")]),e._v(".\nFor example, if you want to send "),t("code",[e._v("0.23111090")]),e._v(" to "),t("code",[e._v("mohu16LH66ptoWGEL1GtP6KHTBJYXMWhEf")]),e._v(":")]),e._v(" "),t("div",{staticClass:"language-sh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("./docker-bitcoin-cli.sh sendtoaddress "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"mohu16LH66ptoWGEL1GtP6KHTBJYXMWhEf"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("0.23111090")]),e._v("\n")])])]),t("p",[e._v("If you are using Powershell:")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("\\docker-bitcoin-"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cli")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("ps1 sendtoaddress "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"mohu16LH66ptoWGEL1GtP6KHTBJYXMWhEf"')]),e._v(" 0"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("23111090\n")])])]),t("p",[e._v("You can also generate blocks:")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("\\docker-bitcoin-generate"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("ps1 3\n")])])]),t("h3",{attrs:{id:"using-polar-to-test-lightning-payments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-polar-to-test-lightning-payments"}},[e._v("#")]),e._v(" Using Polar to test Lightning payments")]),e._v(" "),t("ul",[t("li",[e._v("Install and run "),t("a",{attrs:{href:"https://lightningpolar.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Polar"),t("OutboundLink")],1),e._v(". Setup a small network of nodes.")]),e._v(" "),t("li",[e._v("Go to your store's General Settings and enable Lightning.")]),e._v(" "),t("li",[e._v("Build your connection string using the Connect information in the Polar app.")])]),e._v(" "),t("p",[e._v('LND Connection string example:\ntype=lnd-rest;server=https://127.0.0.1:8084/;macaroonfilepath="local path to admin.macaroon on your computer, without these quotes";allowinsecure=true')]),e._v(" "),t("p",[e._v("Now you can create a Lightning invoice on BTCPay Server regtest and make a payment through Polar.")]),e._v(" "),t("p",[e._v('PLEASE NOTE: You may get an exception break in Visual Studio. You must quickly click "Continue" in VS so the invoice is generated.\nOr, uncheck the box that says, "Break when this exception type is thrown".')]),e._v(" "),t("h3",{attrs:{id:"using-the-test-litecoin-cli"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-the-test-litecoin-cli"}},[e._v("#")]),e._v(" Using the test litecoin-cli")]),e._v(" "),t("p",[e._v("Same as bitcoin-cli, but with "),t("code",[e._v(".\\docker-litecoin-cli.ps1")]),e._v(" and "),t("code",[e._v(".\\docker-litecoin-cli.sh")]),e._v(" instead.")]),e._v(" "),t("h3",{attrs:{id:"using-the-test-lightning-cli"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-the-test-lightning-cli"}},[e._v("#")]),e._v(" Using the test lightning-cli")]),e._v(" "),t("p",[e._v("If you are using Linux:")]),e._v(" "),t("div",{staticClass:"language-sh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-sh"}},[t("code",[e._v("./docker-customer-lightning-cli.sh pay lnbcrt100u1pd2e6uspp5ajnadvhazjrz55twd5k6yeg9u87wpw0q2fdr7g960yl5asv5fmnqdq9d3hkccqpxmedyrk0ehw5ueqx5e0r4qrrv74cewddfcvsxaawqz7634cmjj39sqwy5tvhz0hasktkk6t9pqfdh3edmf3z09zst5y7khv3rvxh8ctqqw6mwhh\n")])])]),t("p",[e._v("If you are using Powershell:")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("\\docker-customer-lightning-"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cli")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("ps1 pay lnbcrt100u1pd2e6uspp5ajnadvhazjrz55twd5k6yeg9u87wpw0q2fdr7g960yl5asv5fmnqdq9d3hkccqpxmedyrk0ehw5ueqx5e0r4qrrv74cewddfcvsxaawqz7634cmjj39sqwy5tvhz0hasktkk6t9pqfdh3edmf3z09zst5y7khv3rvxh8ctqqw6mwhh\n")])])]),t("p",[e._v("If you get this message:")]),e._v(" "),t("div",{staticClass:"language-json extra-class"},[t("pre",{pre:!0,attrs:{class:"language-json"}},[t("code",[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"code"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("205")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"message"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Could not find a route"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"data"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"getroute_tries"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(",")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token property"}},[e._v('"sendpay_tries"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(":")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("Please, run the test "),t("code",[e._v("CanSetLightningServer")]),e._v(", this will establish a channel between the customer and the merchant, then, retry.")]),e._v(" "),t("p",[e._v("Alternatively you can run the "),t("code",[e._v("./docker-lightning-channel-setup.sh")]),e._v(" script to establish the channel connection.\nThe "),t("code",[e._v("./docker-lightning-channel-teardown.sh")]),e._v(" script closes any existing lightning channels.")]),e._v(" "),t("h3",{attrs:{id:"alternative-lightning-testing-using-polar-to-test-lightning-payments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#alternative-lightning-testing-using-polar-to-test-lightning-payments"}},[e._v("#")]),e._v(" Alternative Lightning testing: Using Polar to test Lightning payments")]),e._v(" "),t("ul",[t("li",[e._v("Install and run "),t("a",{attrs:{href:"https://lightningpolar.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Polar"),t("OutboundLink")],1),e._v(". Setup a small network of nodes.")]),e._v(" "),t("li",[e._v("Go to your store's General Settings and enable Lightning.")]),e._v(" "),t("li",[e._v("Build your connection string using the Connect information in the Polar app.")])]),e._v(" "),t("p",[e._v('LND Connection string example:\ntype=lnd-rest;server=https://127.0.0.1:8084/;macaroonfilepath="local path to admin.macaroon on your computer, without these quotes";allowinsecure=true')]),e._v(" "),t("p",[e._v("Now you can create a lightning invoice on BTCPay Server regtest and make a payment through Polar.")]),e._v(" "),t("p",[e._v('PLEASE NOTE: You may get an exception break in Visual Studio. You must quickly click "Continue" in VS so the invoice is generated.\nOr, uncheck the box that says, "Break when this exception type is thrown".')]),e._v(" "),t("h2",{attrs:{id:"faq"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#faq"}},[e._v("#")]),e._v(" FAQ")]),e._v(" "),t("h3",{attrs:{id:"docker-compose-up-dev-failed-or-tests-are-not-passing-what-should-i-do"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#docker-compose-up-dev-failed-or-tests-are-not-passing-what-should-i-do"}},[e._v("#")]),e._v(" "),t("code",[e._v("docker-compose up dev")]),e._v(" failed or tests are not passing, what should I do?")]),e._v(" "),t("ol",[t("li",[e._v("Run "),t("code",[e._v("docker-compose down --volumes")]),e._v(" (this will reset your test environment)")]),e._v(" "),t("li",[e._v("Run "),t("code",[e._v("docker-compose pull")]),e._v(" (this will ensure you have the latest images)")]),e._v(" "),t("li",[e._v("Run again with "),t("code",[e._v("docker-compose up dev")])])]),e._v(" "),t("h3",{attrs:{id:"how-to-run-the-altcoin-environment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-run-the-altcoin-environment"}},[e._v("#")]),e._v(" How to run the Altcoin environment?")]),e._v(" "),t("p",[t("code",[e._v("docker-compose -f docker-compose.altcoins.yml up dev")])]),e._v(" "),t("p",[e._v("If you still have issues, try to restart docker.")]),e._v(" "),t("h3",{attrs:{id:"how-to-run-the-selenium-test-with-a-browser"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-run-the-selenium-test-with-a-browser"}},[e._v("#")]),e._v(" How to run the Selenium test with a browser?")]),e._v(" "),t("p",[e._v("Run "),t("code",[e._v("dotnet user-secrets set RunSeleniumInBrowser true")]),e._v(" to run tests in browser.")]),e._v(" "),t("p",[e._v("To switch back to headless mode (recommended) you can run "),t("code",[e._v("dotnet user-secrets remove RunSeleniumInBrowser")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"session-not-created-this-version-of-chromedriver-only-supports-chrome-version-88"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#session-not-created-this-version-of-chromedriver-only-supports-chrome-version-88"}},[e._v("#")]),e._v(" Session not created: This version of ChromeDriver only supports Chrome version 88")]),e._v(" "),t("p",[e._v("When you run tests for selenium, you may end up with this error.\nThis happen when we update the selenium packages on BTCPay Server while you did not update your chrome version.")]),e._v(" "),t("p",[e._v("If you want to use a older chrome driver on "),t("a",{attrs:{href:"https://chromedriver.chromium.org/downloads",target:"_blank",rel:"noopener noreferrer"}},[e._v("this page"),t("OutboundLink")],1),e._v(" then point to it with")]),e._v(" "),t("p",[t("code",[e._v('dotnet user-secrets set ChromeDriverDirectory "path/to/the/driver/directory"')])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/109.d2fef907.js b/assets/js/109.cef8afd9.js similarity index 98% rename from assets/js/109.d2fef907.js rename to assets/js/109.cef8afd9.js index 4502521137..bd8a81fd83 100644 --- a/assets/js/109.d2fef907.js +++ b/assets/js/109.cef8afd9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[109],{727:function(e,t,r){"use strict";r.r(t);var o=r(9),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"testnet-demo"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#testnet-demo"}},[e._v("#")]),e._v(" Testnet demo")]),e._v(" "),t("p",[e._v("First let's create a new store:")]),e._v(" "),t("ol",[t("li",[e._v("Go to the "),t("a",{attrs:{href:"https://testnet.demo.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Testnet website"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("On the right side click on "),t("strong",[e._v("Create an account")]),e._v(" to "),t("a",{attrs:{href:"https://testnet.demo.btcpayserver.org/register",target:"_blank",rel:"noopener noreferrer"}},[e._v("create an account"),t("OutboundLink")],1),e._v(" or "),t("strong",[e._v("Sign In")]),e._v(" if you already have an account.")]),e._v(" "),t("li",[e._v("After having signed in, create a new store.")])]),e._v(" "),t("p",[e._v("Let's use Electrum to create a testnet wallet for your store:")]),e._v(" "),t("ol",[t("li",[e._v("Download "),t("a",{attrs:{href:"https://electrum.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Electrum"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("Run Electrum with parameter "),t("code",[e._v("--testnet")]),e._v(" (i.e. on Mac OS using "),t("code",[e._v("open -a Electrum.app --args --testnet")]),e._v(")")]),e._v(" "),t("li",[e._v("Click through the wizard and create a test wallet, using the default settings Electrum proposes")]),e._v(" "),t("li",[e._v('After the wallet is set up, go to "Wallet" > "Information" in the Electrum menu.')]),e._v(" "),t("li",[e._v('Copy the "Master Public Key" string (starting by '),t("code",[e._v("*pub...")]),e._v(")")])]),e._v(" "),t("p",[e._v("Let's configure the store so it uses your Electrum wallet:")]),e._v(" "),t("ol",[t("li",[e._v("Go to the Settings page of your store in BTCPay")]),e._v(" "),t("li",[e._v('On the "General Settings" page you will find the "Wallet" section - click the "Setup" button for configuring an on-chain wallet.')]),e._v(" "),t("li",[e._v('Paste the "Master Public Key" copied from Electrum into the "Derivation Scheme" text field and click "Continue"')]),e._v(" "),t("li",[e._v('Confirm the addresses by clicking on "Receive" in Electrum: The "Receiving address" should match the first address shown in BTCPay')]),e._v(" "),t("li",[e._v("After that your test wallet should appear on the "),t("a",{attrs:{href:"https://testnet.demo.btcpayserver.org/wallets",target:"_blank",rel:"noopener noreferrer"}},[e._v("Wallets page"),t("OutboundLink")],1),e._v(" of your BTCPay account")])]),e._v(" "),t("p",[e._v("Then you can create an invoice, either through")]),e._v(" "),t("ul",[t("li",[e._v('The "Invoice" menu on the website or')]),e._v(" "),t("li",[e._v("The process documented in the "),t("RouterLink",{attrs:{to:"/CustomIntegration/"}},[e._v("Custom integration")])],1)]),e._v(" "),t("h2",{attrs:{id:"questions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#questions"}},[e._v("#")]),e._v(" Questions")]),e._v(" "),t("p",[e._v("If you have questions about the BTCPay Server on Testnet, you can join the "),t("a",{attrs:{href:"https://chat.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("community chat"),t("OutboundLink")],1),e._v(".\nIf you have questions about any of the other tools or commands, etc. it's likely you can find answers to your questions by doing a search on the internet or on "),t("a",{attrs:{href:"https://stackoverflow.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("StackOverflow"),t("OutboundLink")],1),e._v(".")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[109],{726:function(e,t,r){"use strict";r.r(t);var o=r(9),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"testnet-demo"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#testnet-demo"}},[e._v("#")]),e._v(" Testnet demo")]),e._v(" "),t("p",[e._v("First let's create a new store:")]),e._v(" "),t("ol",[t("li",[e._v("Go to the "),t("a",{attrs:{href:"https://testnet.demo.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Testnet website"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("On the right side click on "),t("strong",[e._v("Create an account")]),e._v(" to "),t("a",{attrs:{href:"https://testnet.demo.btcpayserver.org/register",target:"_blank",rel:"noopener noreferrer"}},[e._v("create an account"),t("OutboundLink")],1),e._v(" or "),t("strong",[e._v("Sign In")]),e._v(" if you already have an account.")]),e._v(" "),t("li",[e._v("After having signed in, create a new store.")])]),e._v(" "),t("p",[e._v("Let's use Electrum to create a testnet wallet for your store:")]),e._v(" "),t("ol",[t("li",[e._v("Download "),t("a",{attrs:{href:"https://electrum.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("Electrum"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("Run Electrum with parameter "),t("code",[e._v("--testnet")]),e._v(" (i.e. on Mac OS using "),t("code",[e._v("open -a Electrum.app --args --testnet")]),e._v(")")]),e._v(" "),t("li",[e._v("Click through the wizard and create a test wallet, using the default settings Electrum proposes")]),e._v(" "),t("li",[e._v('After the wallet is set up, go to "Wallet" > "Information" in the Electrum menu.')]),e._v(" "),t("li",[e._v('Copy the "Master Public Key" string (starting by '),t("code",[e._v("*pub...")]),e._v(")")])]),e._v(" "),t("p",[e._v("Let's configure the store so it uses your Electrum wallet:")]),e._v(" "),t("ol",[t("li",[e._v("Go to the Settings page of your store in BTCPay")]),e._v(" "),t("li",[e._v('On the "General Settings" page you will find the "Wallet" section - click the "Setup" button for configuring an on-chain wallet.')]),e._v(" "),t("li",[e._v('Paste the "Master Public Key" copied from Electrum into the "Derivation Scheme" text field and click "Continue"')]),e._v(" "),t("li",[e._v('Confirm the addresses by clicking on "Receive" in Electrum: The "Receiving address" should match the first address shown in BTCPay')]),e._v(" "),t("li",[e._v("After that your test wallet should appear on the "),t("a",{attrs:{href:"https://testnet.demo.btcpayserver.org/wallets",target:"_blank",rel:"noopener noreferrer"}},[e._v("Wallets page"),t("OutboundLink")],1),e._v(" of your BTCPay account")])]),e._v(" "),t("p",[e._v("Then you can create an invoice, either through")]),e._v(" "),t("ul",[t("li",[e._v('The "Invoice" menu on the website or')]),e._v(" "),t("li",[e._v("The process documented in the "),t("RouterLink",{attrs:{to:"/CustomIntegration/"}},[e._v("Custom integration")])],1)]),e._v(" "),t("h2",{attrs:{id:"questions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#questions"}},[e._v("#")]),e._v(" Questions")]),e._v(" "),t("p",[e._v("If you have questions about the BTCPay Server on Testnet, you can join the "),t("a",{attrs:{href:"https://chat.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("community chat"),t("OutboundLink")],1),e._v(".\nIf you have questions about any of the other tools or commands, etc. it's likely you can find answers to your questions by doing a search on the internet or on "),t("a",{attrs:{href:"https://stackoverflow.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("StackOverflow"),t("OutboundLink")],1),e._v(".")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/11.57a3c01d.js b/assets/js/11.7173e92d.js similarity index 86% rename from assets/js/11.57a3c01d.js rename to assets/js/11.7173e92d.js index ff5b79d45c..3cbc54058f 100644 --- a/assets/js/11.57a3c01d.js +++ b/assets/js/11.7173e92d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{402:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet1.584fbbe1.png"},403:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet2.b93dd22b.png"},404:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet3.9838bf5a.png"},405:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet4.dec51a41.png"},406:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet9.474b2e7a.png"},407:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet10.6fd1db5f.png"},408:function(e,t,r){e.exports=r.p+"assets/img/btcpayWalletImport1.6c214d88.jpg"},409:function(e,t,r){e.exports=r.p+"assets/img/btcpayWalletImport2.d39a2fb0.jpg"},410:function(e,t,r){e.exports=r.p+"assets/img/btcpayWalletImport3.4ad4427f.jpg"},411:function(e,t,r){e.exports=r.p+"assets/img/SetupWalletXpub.195df229.png"},412:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet11.9ea45c82.png"},413:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet11a.05edcf6d.png"},414:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet12.139c7796.png"},742:function(e,t,r){"use strict";r.r(t);var a=r(9),l=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"connecting-electrum-wallet-to-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#connecting-electrum-wallet-to-btcpay-server"}},[e._v("#")]),e._v(" Connecting Electrum Wallet to BTCPay Server")]),e._v(" "),t("p",[e._v("This document explains "),t("strong",[e._v("how to connect a desktop "),t("a",{attrs:{href:"https://electrum.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Electrum Wallet"),t("OutboundLink")],1),e._v(" to a BTCPay Server")]),e._v(".")]),e._v(" "),t("p",[t("strong",[e._v("Word of caution")]),e._v(" Electrum wallet relies on Electrum servers that are controlled by third-parties. Information, like public addresses, balances and the transacted amount can "),t("em",[e._v("potentially")]),e._v(" be leaked.")]),e._v(" "),t("p",[e._v("To protect yourself against such leaks, set up "),t("RouterLink",{attrs:{to:"/ElectrumX/"}},[e._v("ElectrumX Server")]),e._v(" or "),t("a",{attrs:{href:"https://github.com/chris-belcher/electrum-personal-server",target:"_blank",rel:"noopener noreferrer"}},[e._v("Electrum Personal Server - EPS"),t("OutboundLink")],1),e._v(".")],1),e._v(" "),t("p",[e._v("You can read about the differences between EPS and ElectrumX "),t("a",{attrs:{href:"https://www.reddit.com/r/Electrum/comments/7xb0lz/whats_the_difference_between_electrumx_server_and/",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("ol",[t("li",[e._v("Create a Store in BTCPay Server")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://electrum.org/#download",target:"_blank",rel:"noopener noreferrer"}},[e._v("Download"),t("OutboundLink")],1),e._v(" and install Electrum Wallet")])]),e._v(" "),t("h2",{attrs:{id:"electrum-wallet-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#electrum-wallet-setup"}},[e._v("#")]),e._v(" Electrum Wallet Setup")]),e._v(" "),t("p",[e._v("After the installation, open "),t("strong",[e._v("Electrum Wallet")]),e._v(" by clicking on the icon on your desktop.")]),e._v(" "),t("h3",{attrs:{id:"quick-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#quick-setup"}},[e._v("#")]),e._v(" Quick Setup")]),e._v(" "),t("p",[e._v("The easiest way to setup your Electrum wallet with BTCPay is to import an a wallet file backup to your BTCPay Server.")]),e._v(" "),t("ol",[t("li",[e._v("Create a new Electrum Wallet")]),e._v(" "),t("li",[e._v("In Electrum, File > Save Backup > Save in folder")]),e._v(" "),t("li",[e._v("In BTCPay Server, Store > Settings > Setup > Import Wallet File > Choose File > Continue")]),e._v(" "),t("li",[e._v("Go to Receive tab in Electrum.")]),e._v(" "),t("li",[e._v("Compare the addresses in Electrum and BTCPay Server, they should match.")]),e._v(" "),t("li",[e._v("Confirm the address match in BTCPay.")])]),e._v(" "),t("h2",{attrs:{id:"step-by-step"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-by-step"}},[e._v("#")]),e._v(" Step by Step")]),e._v(" "),t("p",[e._v("The following setup guides you through setting up an entirely new Bech32(SegWit) Wallet in Electrum. If you already have a wallet skip to the Extended Public Key copying.")]),e._v(" "),t("p",[e._v("Firstly, give your wallet a name, for example, "),t("code",[e._v("BTCPay Server Wallet")]),e._v(" and click "),t("code",[e._v("Next")]),e._v(".")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(402),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Choose "),t("code",[e._v("Standard wallet")]),e._v(" and proceed by clicking the "),t("code",[e._v("Next")]),e._v("button.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(403),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Since we're creating a brand-new wallet,choose "),t("code",[e._v("Create a new seed")]),e._v(" and "),t("code",[e._v("Next")])]),e._v(" "),t("figure",[t("img",{attrs:{src:r(404),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("From the multiple choice menu, select "),t("code",[e._v("SegWit")]),e._v(" and "),t("code",[e._v("Next")])]),e._v(" "),t("figure",[t("img",{attrs:{src:r(405),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[t("strong",[e._v("IMPORTANT NOTE:")]),e._v(" If you're a merchant, instead of SegWit (Bech32), it's recommended to use SegWit wrapped (P2SH) format. "),t("a",{attrs:{href:"https://www.youtube.com/watch?v=-1DBJWwA2Cw",target:"_blank",rel:"noopener noreferrer"}},[e._v("This guide"),t("OutboundLink")],1),e._v(" explains how to create P2SH wallet in Electrum that's more suited for merchants, due to compatability with legacy wallets customers use.")]),e._v(" "),t("p",[t("strong",[e._v("IMPORTANT NOTE 2:")]),e._v(" Write down your recovery words in the order you see them on the screen. Write them down a piece of paper and store it somewhere secure. Take your time and triple check each word. Do not store your seed in a digital format (photograph, text document). Whoever has the access to your seed can access your funds. Confirm that the seed has been properly backed up by re-entering it in the same order. Once the seed is validated, proceed to the next step.")]),e._v(" "),t("p",[e._v("Copy and paste your seed words to complete your wallet creation in Electrum. Your wallet must be unencrypted to import it into your BTCPay Server. Once you have completed the setup of your wallet in BTCPay you can always add password encryption later in Electrum.")]),e._v(" "),t("p",[e._v("Follow along in the video below on how to import into BTCPay Server.")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/kf3BHaQWSAc/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=kf3BHaQWSAc",title:"BTCPay Server - How to import wallet file","data-id":"kf3BHaQWSAc"}},[t("iframe",{attrs:{title:"BTCPay Server - How to import wallet file","data-src":"https://www.youtube-nocookie.com/embed/kf3BHaQWSAc?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("h3",{attrs:{id:"alternative-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#alternative-setup"}},[e._v("#")]),e._v(" Alternative Setup")]),e._v(" "),t("p",[e._v("Instead of importing a wallet file you can instead transfer the public key to your BTCPay Server. This can be useful if your wallet is encrypted and you do not want to unencrypt it.")]),e._v(" "),t("ol",[t("li",[e._v("Create a new Electrum Wallet")]),e._v(" "),t("li",[e._v("In Electrum, Wallet > Wallet Information - copy the "),t("strong",[e._v("Master Public Key")]),e._v(".")]),e._v(" "),t("li",[e._v("In BTCPay Server, Store > Settings > Setup > Connect an existing wallet > Enter extended public key")]),e._v(" "),t("li",[e._v("Go to Receive tab in Electrum.")]),e._v(" "),t("li",[e._v("Compare the addresses in Electrum and BTCPay Server, they should match.")]),e._v(" "),t("li",[e._v("Confirm the address match in BTCPay.")])]),e._v(" "),t("p",[e._v("When the wallet loads (it may take few moments), in the top menu, click on the "),t("code",[e._v("Wallet")]),e._v(" and then"),t("code",[e._v("Information")]),e._v(" .")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(406),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Select and "),t("strong",[e._v("copy")]),e._v(" the "),t("code",[e._v("Master Public Key")]),e._v(". This is the "),t("strong",[e._v("public")]),e._v(" key from which BTCPay will derive addresses.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(407),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Return to your BTCPay Server. Click on the "),t("code",[e._v("Bitcoin")]),e._v(" in the left menu or "),t("code",[e._v("Set up a wallet")]),e._v(" on your new dashboard.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(408),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Click "),t("code",[e._v("Connect an existing wallet")])]),e._v(" "),t("figure",[t("img",{attrs:{src:r(409),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Now click on the "),t("code",[e._v("Enter extended public key")]),e._v(" option to import your key.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(410),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Paste the "),t("code",[e._v("Master Public Key")]),e._v(" into derivation scheme field as it is, without adding anything else. Make sure that "),t("code",[e._v("Enabled")]),e._v(" checkbox is ticked and click "),t("code",[e._v("Continue")]),e._v(".")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(411),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Return to the "),t("strong",[e._v("Electrum Wallet")]),e._v(". Go to "),t("code",[e._v("Receive tab")]),e._v(" which shows your wallet receiving address.")]),e._v(" "),t("p",[t("strong",[e._v("Compare the address you see in Electrum Wallet to Addresses shown in BTCPay Server")]),e._v(". If there's a match, "),t("code",[e._v("continue")]),e._v(". If there is no match, double-check that you're actually pasting "),t("code",[e._v("Master Public Key")]),e._v(".")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(412),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("h3",{attrs:{id:"configuring-the-gap-limit-in-electrum"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuring-the-gap-limit-in-electrum"}},[e._v("#")]),e._v(" Configuring the Gap Limit in Electrum")]),e._v(" "),t("p",[e._v("In the top menu, click on the "),t("code",[e._v("View")]),e._v(" and then"),t("code",[e._v("Show Console")]),e._v(" .")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(413),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Enter following commands in Electrum console and press "),t("code",[e._v("enter")]),e._v("on your keyboard.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" wallet.change_gap_limit(100)\n")])])]),t("p",[e._v("If you are running a version older than Electrum 4, also enter the following command and press 'enter'")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("wallet.storage.write()\n")])])]),t("figure",[t("img",{attrs:{src:r(414),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Restart your Electrum and verify that the newly set gap limit is correct by entering in the console:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("wallet.gap_limit\n")])])]),t("p",[e._v("There's no good answer to how much you should set the gap limit to. Most merchants set 100-200. If you're a big merchants with high transaction volume, you can try with even higher gap limit.")]),e._v(" "),t("p",[e._v("For more details about the "),t("RouterLink",{attrs:{to:"/FAQ/Wallet/#missing-payments-in-my-software-or-hardware-wallet"}},[e._v("Gap Limit, check the FAQ")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[e._v("Electrum and BTCPay Server are now connected")]),e._v(". Any payments received to your BTCPay will be visible in Electrum, where you can further spend them.")])])}),[],!1,null,null,null);t.default=l.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[11],{401:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet1.584fbbe1.png"},402:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet2.b93dd22b.png"},403:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet3.9838bf5a.png"},404:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet4.dec51a41.png"},405:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet9.474b2e7a.png"},406:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet10.6fd1db5f.png"},407:function(e,t,r){e.exports=r.p+"assets/img/btcpayWalletImport1.6c214d88.jpg"},408:function(e,t,r){e.exports=r.p+"assets/img/btcpayWalletImport2.d39a2fb0.jpg"},409:function(e,t,r){e.exports=r.p+"assets/img/btcpayWalletImport3.4ad4427f.jpg"},410:function(e,t,r){e.exports=r.p+"assets/img/SetupWalletXpub.195df229.png"},411:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet11.9ea45c82.png"},412:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet11a.05edcf6d.png"},413:function(e,t,r){e.exports=r.p+"assets/img/ElectrumWallet12.139c7796.png"},740:function(e,t,r){"use strict";r.r(t);var a=r(9),l=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"connecting-electrum-wallet-to-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#connecting-electrum-wallet-to-btcpay-server"}},[e._v("#")]),e._v(" Connecting Electrum Wallet to BTCPay Server")]),e._v(" "),t("p",[e._v("This document explains "),t("strong",[e._v("how to connect a desktop "),t("a",{attrs:{href:"https://electrum.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Electrum Wallet"),t("OutboundLink")],1),e._v(" to a BTCPay Server")]),e._v(".")]),e._v(" "),t("p",[t("strong",[e._v("Word of caution")]),e._v(" Electrum wallet relies on Electrum servers that are controlled by third-parties. Information, like public addresses, balances and the transacted amount can "),t("em",[e._v("potentially")]),e._v(" be leaked.")]),e._v(" "),t("p",[e._v("To protect yourself against such leaks, set up "),t("RouterLink",{attrs:{to:"/ElectrumX/"}},[e._v("ElectrumX Server")]),e._v(" or "),t("a",{attrs:{href:"https://github.com/chris-belcher/electrum-personal-server",target:"_blank",rel:"noopener noreferrer"}},[e._v("Electrum Personal Server - EPS"),t("OutboundLink")],1),e._v(".")],1),e._v(" "),t("p",[e._v("You can read about the differences between EPS and ElectrumX "),t("a",{attrs:{href:"https://www.reddit.com/r/Electrum/comments/7xb0lz/whats_the_difference_between_electrumx_server_and/",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("ol",[t("li",[e._v("Create a Store in BTCPay Server")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://electrum.org/#download",target:"_blank",rel:"noopener noreferrer"}},[e._v("Download"),t("OutboundLink")],1),e._v(" and install Electrum Wallet")])]),e._v(" "),t("h2",{attrs:{id:"electrum-wallet-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#electrum-wallet-setup"}},[e._v("#")]),e._v(" Electrum Wallet Setup")]),e._v(" "),t("p",[e._v("After the installation, open "),t("strong",[e._v("Electrum Wallet")]),e._v(" by clicking on the icon on your desktop.")]),e._v(" "),t("h3",{attrs:{id:"quick-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#quick-setup"}},[e._v("#")]),e._v(" Quick Setup")]),e._v(" "),t("p",[e._v("The easiest way to setup your Electrum wallet with BTCPay is to import an a wallet file backup to your BTCPay Server.")]),e._v(" "),t("ol",[t("li",[e._v("Create a new Electrum Wallet")]),e._v(" "),t("li",[e._v("In Electrum, File > Save Backup > Save in folder")]),e._v(" "),t("li",[e._v("In BTCPay Server, Store > Settings > Setup > Import Wallet File > Choose File > Continue")]),e._v(" "),t("li",[e._v("Go to Receive tab in Electrum.")]),e._v(" "),t("li",[e._v("Compare the addresses in Electrum and BTCPay Server, they should match.")]),e._v(" "),t("li",[e._v("Confirm the address match in BTCPay.")])]),e._v(" "),t("h2",{attrs:{id:"step-by-step"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#step-by-step"}},[e._v("#")]),e._v(" Step by Step")]),e._v(" "),t("p",[e._v("The following setup guides you through setting up an entirely new Bech32(SegWit) Wallet in Electrum. If you already have a wallet skip to the Extended Public Key copying.")]),e._v(" "),t("p",[e._v("Firstly, give your wallet a name, for example, "),t("code",[e._v("BTCPay Server Wallet")]),e._v(" and click "),t("code",[e._v("Next")]),e._v(".")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(401),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Choose "),t("code",[e._v("Standard wallet")]),e._v(" and proceed by clicking the "),t("code",[e._v("Next")]),e._v("button.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(402),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Since we're creating a brand-new wallet,choose "),t("code",[e._v("Create a new seed")]),e._v(" and "),t("code",[e._v("Next")])]),e._v(" "),t("figure",[t("img",{attrs:{src:r(403),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("From the multiple choice menu, select "),t("code",[e._v("SegWit")]),e._v(" and "),t("code",[e._v("Next")])]),e._v(" "),t("figure",[t("img",{attrs:{src:r(404),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[t("strong",[e._v("IMPORTANT NOTE:")]),e._v(" If you're a merchant, instead of SegWit (Bech32), it's recommended to use SegWit wrapped (P2SH) format. "),t("a",{attrs:{href:"https://www.youtube.com/watch?v=-1DBJWwA2Cw",target:"_blank",rel:"noopener noreferrer"}},[e._v("This guide"),t("OutboundLink")],1),e._v(" explains how to create P2SH wallet in Electrum that's more suited for merchants, due to compatability with legacy wallets customers use.")]),e._v(" "),t("p",[t("strong",[e._v("IMPORTANT NOTE 2:")]),e._v(" Write down your recovery words in the order you see them on the screen. Write them down a piece of paper and store it somewhere secure. Take your time and triple check each word. Do not store your seed in a digital format (photograph, text document). Whoever has the access to your seed can access your funds. Confirm that the seed has been properly backed up by re-entering it in the same order. Once the seed is validated, proceed to the next step.")]),e._v(" "),t("p",[e._v("Copy and paste your seed words to complete your wallet creation in Electrum. Your wallet must be unencrypted to import it into your BTCPay Server. Once you have completed the setup of your wallet in BTCPay you can always add password encryption later in Electrum.")]),e._v(" "),t("p",[e._v("Follow along in the video below on how to import into BTCPay Server.")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/kf3BHaQWSAc/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=kf3BHaQWSAc",title:"BTCPay Server - How to import wallet file","data-id":"kf3BHaQWSAc"}},[t("iframe",{attrs:{title:"BTCPay Server - How to import wallet file","data-src":"https://www.youtube-nocookie.com/embed/kf3BHaQWSAc?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("h3",{attrs:{id:"alternative-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#alternative-setup"}},[e._v("#")]),e._v(" Alternative Setup")]),e._v(" "),t("p",[e._v("Instead of importing a wallet file you can instead transfer the public key to your BTCPay Server. This can be useful if your wallet is encrypted and you do not want to unencrypt it.")]),e._v(" "),t("ol",[t("li",[e._v("Create a new Electrum Wallet")]),e._v(" "),t("li",[e._v("In Electrum, Wallet > Wallet Information - copy the "),t("strong",[e._v("Master Public Key")]),e._v(".")]),e._v(" "),t("li",[e._v("In BTCPay Server, Store > Settings > Setup > Connect an existing wallet > Enter extended public key")]),e._v(" "),t("li",[e._v("Go to Receive tab in Electrum.")]),e._v(" "),t("li",[e._v("Compare the addresses in Electrum and BTCPay Server, they should match.")]),e._v(" "),t("li",[e._v("Confirm the address match in BTCPay.")])]),e._v(" "),t("p",[e._v("When the wallet loads (it may take few moments), in the top menu, click on the "),t("code",[e._v("Wallet")]),e._v(" and then"),t("code",[e._v("Information")]),e._v(" .")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(405),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Select and "),t("strong",[e._v("copy")]),e._v(" the "),t("code",[e._v("Master Public Key")]),e._v(". This is the "),t("strong",[e._v("public")]),e._v(" key from which BTCPay will derive addresses.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(406),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Return to your BTCPay Server. Click on the "),t("code",[e._v("Bitcoin")]),e._v(" in the left menu or "),t("code",[e._v("Set up a wallet")]),e._v(" on your new dashboard.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(407),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Click "),t("code",[e._v("Connect an existing wallet")])]),e._v(" "),t("figure",[t("img",{attrs:{src:r(408),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Now click on the "),t("code",[e._v("Enter extended public key")]),e._v(" option to import your key.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(409),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Paste the "),t("code",[e._v("Master Public Key")]),e._v(" into derivation scheme field as it is, without adding anything else. Make sure that "),t("code",[e._v("Enabled")]),e._v(" checkbox is ticked and click "),t("code",[e._v("Continue")]),e._v(".")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(410),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Return to the "),t("strong",[e._v("Electrum Wallet")]),e._v(". Go to "),t("code",[e._v("Receive tab")]),e._v(" which shows your wallet receiving address.")]),e._v(" "),t("p",[t("strong",[e._v("Compare the address you see in Electrum Wallet to Addresses shown in BTCPay Server")]),e._v(". If there's a match, "),t("code",[e._v("continue")]),e._v(". If there is no match, double-check that you're actually pasting "),t("code",[e._v("Master Public Key")]),e._v(".")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(411),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("h3",{attrs:{id:"configuring-the-gap-limit-in-electrum"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuring-the-gap-limit-in-electrum"}},[e._v("#")]),e._v(" Configuring the Gap Limit in Electrum")]),e._v(" "),t("p",[e._v("In the top menu, click on the "),t("code",[e._v("View")]),e._v(" and then"),t("code",[e._v("Show Console")]),e._v(" .")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(412),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Enter following commands in Electrum console and press "),t("code",[e._v("enter")]),e._v("on your keyboard.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(" wallet.change_gap_limit(100)\n")])])]),t("p",[e._v("If you are running a version older than Electrum 4, also enter the following command and press 'enter'")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("wallet.storage.write()\n")])])]),t("figure",[t("img",{attrs:{src:r(413),alt:"ElectrumWallet",title:"ElectrumWallet"}})]),e._v(" "),t("p",[e._v("Restart your Electrum and verify that the newly set gap limit is correct by entering in the console:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("wallet.gap_limit\n")])])]),t("p",[e._v("There's no good answer to how much you should set the gap limit to. Most merchants set 100-200. If you're a big merchants with high transaction volume, you can try with even higher gap limit.")]),e._v(" "),t("p",[e._v("For more details about the "),t("RouterLink",{attrs:{to:"/FAQ/Wallet/#missing-payments-in-my-software-or-hardware-wallet"}},[e._v("Gap Limit, check the FAQ")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[e._v("Electrum and BTCPay Server are now connected")]),e._v(". Any payments received to your BTCPay will be visible in Electrum, where you can further spend them.")])])}),[],!1,null,null,null);t.default=l.exports}}]); \ No newline at end of file diff --git a/assets/js/110.3c2e39b6.js b/assets/js/110.3618dd65.js similarity index 60% rename from assets/js/110.3c2e39b6.js rename to assets/js/110.3618dd65.js index 4a164b78bd..8aebc91160 100644 --- a/assets/js/110.3c2e39b6.js +++ b/assets/js/110.3618dd65.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[110],{729:function(e,t,r){"use strict";r.r(t);var a=r(9),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"introduction"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),t("p",[e._v("While "),t("RouterLink",{attrs:{to:"/LunaNodeWebDeployment/"}},[e._v("our instructions")]),e._v(" cover how to install BTCPayServer in one click on Azure or Lunanode, BTCPay Server is not limited to those options.")],1),e._v(" "),t("p",[e._v("You will find below information about how you can install BTCPay Server easily in any environment having docker available.")]),e._v(" "),t("h1",{attrs:{id:"architecture"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#architecture"}},[e._v("#")]),e._v(" Architecture")]),e._v(" "),t("figure",[t("img",{attrs:{src:"https://github.com/btcpayserver/btcpayserver-doc/raw/master/docs/img/Architecture.png",alt:"Architecture",title:"Architecture"}})]),e._v(" "),t("p",[e._v("As you can see, BTCPay depends on several pieces of infrastructure, mainly:")]),e._v(" "),t("ul",[t("li",[e._v("A lightweight block explorer (NBXplorer),")]),e._v(" "),t("li",[e._v("A database (PostgreSQL),")]),e._v(" "),t("li",[e._v("A full node (eg. Bitcoin Core)")])]),e._v(" "),t("p",[e._v("There can be more dependencies if you support more than just standard Bitcoin transactions, including:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/ElementsProject/lightning",target:"_blank",rel:"noopener noreferrer"}},[e._v("Core Lightning (CLN)"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/litecoin-project/litecoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("LitecoinD"),t("OutboundLink")],1),e._v(" and other coin daemons")]),e._v(" "),t("li",[e._v("And more...")])]),e._v(" "),t("p",[e._v("Note: The setup process can be time consuming, but is heavily automated to make it a fun and easy experience.")]),e._v(" "),t("p",[e._v("Take a look at how BTCPay works in a video below.")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/nr0UNbz3AoQ/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=nr0UNbz3AoQ",title:"YouTube","data-id":"nr0UNbz3AoQ"}},[t("iframe",{attrs:{title:"YouTube","data-src":"https://www.youtube-nocookie.com/embed/nr0UNbz3AoQ?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("p",[e._v("Here is a presentation of the global architecture at Advancing Bitcoin conference.")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/Up0dvorzSNM/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=Up0dvorzSNM",title:"BTCPay - Architecture overview","data-id":"Up0dvorzSNM"}},[t("iframe",{attrs:{title:"BTCPay - Architecture overview","data-src":"https://www.youtube-nocookie.com/embed/Up0dvorzSNM?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("h1",{attrs:{id:"full-installation-for-technical-users"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#full-installation-for-technical-users"}},[e._v("#")]),e._v(" Full installation (for technical users)")]),e._v(" "),t("p",[e._v("You can also install BTCPay Server on your own machine or VPS instance.")]),e._v(" "),t("p",[e._v("The officially supported setup is driven by Docker (and Docker-Compose).")]),e._v(" "),t("p",[e._v("First, make sure you have a domain name pointing to your host "),t("code",[e._v("A record")]),e._v(", with ports "),t("code",[e._v("443")]),e._v(" and "),t("code",[e._v("80")]),e._v(" externally accessible. For Lightning Network, port "),t("code",[e._v("9735")]),e._v(" is required ("),t("code",[e._v("9736")]),e._v(" if you use Litecoin Lightning). Otherwise, you will have to set a domain manually by running "),t("code",[e._v("changedomain.sh")]),e._v(".")]),e._v(" "),t("p",[e._v("Let's assume your domain is "),t("code",[e._v("btcpay.EXAMPLE.com")]),e._v(".")]),e._v(" "),t("p",[e._v("The setup below assumes you want to support Bitcoin, Core Lightning (CLN), HTTPS automatically configured by Nginx. It also enables node pruning, which you can "),t("a",{attrs:{href:"#generated-docker-compose"}},[e._v("modify")]),e._v(" or ignore if you have enough disk space for a full node. Finally, your domain is "),t("code",[e._v("btcpay.EXAMPLE.com")]),e._v(" should reflect your actual domain name.")]),e._v(" "),t("p",[t("a",{attrs:{href:"#environment-variables"}},[e._v("Environment variables")]),e._v(" can be tailored to your needs. Some variables require additional storage space.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Login as root")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Create a folder for BTCPay")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" BTCPayServer\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Clone this repository")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" clone https://github.com/btcpayserver/btcpayserver-docker\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Run btcpay-setup.sh with the right parameters")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_HOST")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btcpay.EXAMPLE.com"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("NBITCOIN_NETWORK")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"mainnet"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO1")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btc"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"opt-save-storage-s"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_REVERSEPROXY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"nginx"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_LIGHTNING")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"clightning"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_ENABLE_SSH")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("true\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("exit")]),e._v("\n")])])]),t("p",[t("code",[e._v("btcpay-setup.sh")]),e._v(" will then:")]),e._v(" "),t("ul",[t("li",[e._v("Install Docker")]),e._v(" "),t("li",[e._v("Install Docker-Compose")]),e._v(" "),t("li",[e._v("Make sure BTCPay starts at reboot via upstart or systemd")]),e._v(" "),t("li",[e._v("Setup environment variables to use BTCPay utilities")]),e._v(" "),t("li",[e._v("Add BTCPay utilities in /usr/bin")]),e._v(" "),t("li",[e._v("Start BTCPay Server")])]),e._v(" "),t("p",[e._v("Video below guides you step by step on how to set up BTCPay Server on a VPS with Docker.")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/x6hqTFgHqhA/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=x6hqTFgHqhA",title:"YouTube","data-id":"x6hqTFgHqhA"}},[t("iframe",{attrs:{title:"YouTube","data-src":"https://www.youtube-nocookie.com/embed/x6hqTFgHqhA?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("p",[e._v("Check out this video if you're interested in learning more about setting up "),t("a",{attrs:{href:"https://www.youtube.com/playlist?list=PLH4m2oS2ratfaprAFx9E3ZDjwxNKvCk4e",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay with Docker Compose"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("figure",[t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/btcpayserver/",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.shields.io/docker/automated/btcpayserver/btcpayserver.svg",alt:"Docker automated build",title:"Docker automated build"}}),t("OutboundLink")],1)]),e._v(" "),t("h1",{attrs:{id:"environment-variables"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#environment-variables"}},[e._v("#")]),e._v(" Environment variables")]),e._v(" "),t("p",[t("code",[e._v("btcpay-setup.sh")]),e._v(" will use the following environment variables:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("BTCPAY_HOST")]),e._v(": The hostname of your website (eg. "),t("code",[e._v("btcpay.example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAY_ADDITIONAL_HOSTS")]),e._v(": Optional, specify additional domains to your BTCPayServer with https support if enabled. (eg. example2.com,example3.com)")]),e._v(" "),t("li",[t("code",[e._v("REVERSEPROXY_HTTP_PORT")]),e._v(": The public port the reverse proxy binds to for HTTP traffic (default: 80)")]),e._v(" "),t("li",[t("code",[e._v("REVERSEPROXY_HTTPS_PORT")]),e._v(": The public port the reverse proxy binds to for HTTPS traffic (default: 443)")]),e._v(" "),t("li",[t("code",[e._v("REVERSEPROXY_DEFAULT_HOST")]),e._v(": Optional, if using a reverse proxy nginx, specify which website should be presented if the server is accessed by its IP or by an unrecognized domain name.")]),e._v(" "),t("li",[t("code",[e._v("NOREVERSEPROXY_HTTP_PORT")]),e._v(": Optional, if not using a reverse proxy, specify which port should be opened for HTTP traffic. (default: 80)")]),e._v(" "),t("li",[t("code",[e._v("NBITCOIN_NETWORK")]),e._v(": The type of network to use (eg. "),t("code",[e._v("mainnet")]),e._v(", "),t("code",[e._v("testnet")]),e._v(", or "),t("code",[e._v("regtest")]),e._v(". Default: "),t("code",[e._v("mainnet")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("LIGHTNING_ALIAS")]),e._v(": An alias for your lightning network node, if used")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_CRYPTO1")]),e._v(": First supported crypto currency (eg. "),t("code",[e._v("btc")]),e._v(", "),t("code",[e._v("ltc")]),e._v(". Default: "),t("code",[e._v("btc")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_CRYPTO2")]),e._v(": Second supported crypto currency (eg. "),t("code",[e._v("btc")]),e._v(", "),t("code",[e._v("ltc")]),e._v(". Default: "),t("code",[e._v("(empty)")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_CRYPTON")]),e._v(": N'th supported crypto currency where N is 9 at maximum. (eg. "),t("code",[e._v("btc")]),e._v(", "),t("code",[e._v("ltc")]),e._v(". Default: "),t("code",[e._v("(empty)")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_REVERSEPROXY")]),e._v(": Specify reverse proxy to use; NGinx has HTTPS support. (eg. "),t("code",[e._v("nginx")]),e._v(", "),t("code",[e._v("traefik")]),e._v(", "),t("code",[e._v("(empty)")]),e._v(". Default: "),t("code",[e._v("nginx")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_LIGHTNING")]),e._v(": Lightning network implementation to use (eg. "),t("code",[e._v("clightning")]),e._v(", "),t("code",[e._v("lnd")]),e._v(", Default: "),t("code",[e._v("(empty)")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_SUBNAME")]),e._v(": The subname of the generated docker-compose file, where the full name is "),t("code",[e._v("Generated/docker-compose.SUBNAME.yml")]),e._v(" (Default: "),t("code",[e._v("generated")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(": Semicolon-separated list of additional fragments you want to use (eg. "),t("code",[e._v("opt-save-storage")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("LETSENCRYPT_EMAIL")]),e._v(": An email will be sent to this address if certificate expires and fails to renew automatically (eg. "),t("code",[e._v("me@example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("ACME_CA_URI")]),e._v(": The API endpoint to ask for HTTPS certificate (Default: "),t("code",[e._v("production")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAY_ENABLE_SSH")]),e._v(": Optional, gives BTCPay Server SSH access to the host by allowing it to edit authorized_keys of the host, it can be used for managing the authorized_keys or updating BTCPay Server directly through the website. (Default: false)")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_DOCKER_IMAGE")]),e._v(": Optional, Specify which generator image to use if you have customized the C# generator. Set to "),t("code",[e._v("btcpayserver/docker-compose-generator:local")]),e._v(" to build the generator locally at runtime.")]),e._v(" "),t("li",[t("code",[e._v("BTCPAY_IMAGE")]),e._v(": Optional, Specify which btcpayserver image to use if you have a customized btcpayserver.")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_EXCLUDE_FRAGMENTS")]),e._v(": Semicolon-separated list of fragments you want to forcefully exclude (eg. "),t("code",[e._v("litecoin-clightning")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("TOR_RELAY_NICKNAME")]),e._v(": If tor relay is activated with opt-add-tor-relay, the relay nickname")]),e._v(" "),t("li",[t("code",[e._v("TOR_RELAY_EMAIL")]),e._v(": If tor relay is activated with opt-add-tor-relay, the email for Tor to contact you regarding your relay")])]),e._v(" "),t("p",[e._v("Additionally, there are specific environment variables for some addons:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("LIBREPATRON_HOST")]),e._v(": If libre patron is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-librepatron.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-librepatron"),t("OutboundLink")],1),e._v(", the hostname of your libre patron website (eg. "),t("code",[e._v("librepatron.example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("ZAMMAD_HOST")]),e._v(": If zammad is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-zammad.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-zammad"),t("OutboundLink")],1),e._v(", the hostname of your zammad website (eg. "),t("code",[e._v("zammad.example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("WOOCOMMERCE_HOST")]),e._v(": If woocommerce is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-woocommerce.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-woocommerce"),t("OutboundLink")],1),e._v(", the hostname of your woocommerce website (eg. "),t("code",[e._v("store.example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("EPS_XPUB")]),e._v(": If Electrum Personal Server (EPS) is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-electrum-ps.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-electrum-ps"),t("OutboundLink")],1),e._v(", you must set the Extended Public Key (XPUB, YPUB or ZPUB) of the wallet you want to use, before first run of the EPS server. If you accidently start EPS without this, it will not work properly as the model of EPS is to monitor only specified wallets.")]),e._v(" "),t("li",[e._v("If Bitcoin Wallet Tracker is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-bwt.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-bwt"),t("OutboundLink")],1),e._v(", you can use "),t("code",[e._v("BWT_XPUB")]),e._v("/"),t("code",[e._v("BWT_XPUB_*")]),e._v(" (to set your XPUB/YPUB/ZPUB), "),t("code",[e._v("BWT_DESCRIPTOR")]),e._v("/"),t("code",[e._v("BWT_DESCRIPTOR_*")]),e._v(" (for script descriptors), "),t("code",[e._v("BWT_RESCAN_SINCE")]),e._v(" (set to the wallet creation date in YYYY-MM-DD to speed up the rescan), "),t("code",[e._v("BWT_BITCOIND_WALLET")]),e._v(" and "),t("code",[e._v("BWT_GAP_LIMIT")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("LND_WTCLIENT_SWEEP_FEE")]),e._v(": If LND watchtower is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-wtclient.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-wtclient"),t("OutboundLink")],1),e._v(", you can use "),t("code",[e._v("LND_WTCLIENT_SWEEP_FEE")]),e._v(" to change the sweep fee used in constructing the justice transaction (default is 10 sat/byte)")]),e._v(" "),t("li",[t("code",[e._v("FIREFLY_HOST")]),e._v(": If fireflyiii is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-fireflyiii.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-fireflyiii"),t("OutboundLink")],1),e._v(", the hostname of your fireflyiii website (eg. "),t("code",[e._v("firefly.example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("CLOUDFLARE_TUNNEL_TOKEN")]),e._v(": Used to expose your instance to clearnet with a Cloudflare Argo Tunnel (if cloudflare tunnel is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-cloudflared.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-cloudflared"),t("OutboundLink")],1),e._v(", for setup instructions "),t("RouterLink",{attrs:{to:"/Docker/cloudflare-tunnel/"}},[e._v("see documentation")]),e._v(")")],1)]),e._v(" "),t("h1",{attrs:{id:"tooling"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tooling"}},[e._v("#")]),e._v(" Tooling")]),e._v(" "),t("p",[e._v("A wide variety of useful scripts are available once BTCPay is installed:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("bitcoin-cli.sh")]),e._v(": Access your Bitcoin node instance (for RPC)")]),e._v(" "),t("li",[t("code",[e._v("bitcoin-lightning-cli.sh")]),e._v(": Access your CLN node instance (for RPC)")]),e._v(" "),t("li",[t("code",[e._v("changedomain.sh")]),e._v(": Change the domain of your BTCPayServer (remember to disable 2FA/U2F first, as you risk being unable to log in to your account)")]),e._v(" "),t("li",[t("code",[e._v("btcpay-update.sh")]),e._v(": Update BTCPayServer to the latest version")]),e._v(" "),t("li",[t("code",[e._v("btcpay-up.sh")]),e._v(": Run "),t("code",[e._v("docker-compose up")])]),e._v(" "),t("li",[t("code",[e._v("btcpay-down.sh")]),e._v(": Run "),t("code",[e._v("docker-compose down")])]),e._v(" "),t("li",[t("code",[e._v("btcpay-setup.sh")]),e._v(": Change the settings of your server")]),e._v(" "),t("li",[t("code",[e._v("btcpay-clean.sh")]),e._v(": Purge any unused docker images")]),e._v(" "),t("li",[t("code",[e._v(". ./btcpay-setup.sh")]),e._v(": Information about additional parameters")]),e._v(" "),t("li",[t("code",[e._v(". ./btcpay-setup.sh -i")]),e._v(": Set up your BTCPayServer")]),e._v(" "),t("li",[t("code",[e._v("btcpay-restart.sh")]),e._v(": Restart your BTCPayServer")])]),e._v(" "),t("h1",{attrs:{id:"under-the-hood"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#under-the-hood"}},[e._v("#")]),e._v(" Under the hood")]),e._v(" "),t("h2",{attrs:{id:"generated-docker-compose"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#generated-docker-compose"}},[e._v("#")]),e._v(" Generated docker-compose")]),e._v(" "),t("p",[e._v("When you run "),t("code",[e._v("btcpay-setup.sh")]),e._v(", your environment variables are used by "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/build.sh",target:"_blank",rel:"noopener noreferrer"}},[e._v("build.sh"),t("OutboundLink")],1),e._v(" (or "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/build.ps1",target:"_blank",rel:"noopener noreferrer"}},[e._v("build.ps1"),t("OutboundLink")],1),e._v(") to generate a docker-compose adapted for your needs. For the full list of options, see: "),t("a",{attrs:{href:"#environment-variables"}},[e._v("Environment variables")])]),e._v(" "),t("p",[e._v("By default, the generated file is "),t("code",[e._v("Generated/docker-compose.generated.yml")]),e._v(", constructed from the relevant "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments",target:"_blank",rel:"noopener noreferrer"}},[e._v("Docker fragments"),t("OutboundLink")],1),e._v(" for your setup.")]),e._v(" "),t("p",[e._v("Available "),t("code",[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(" currently are:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-storage.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-storage"),t("OutboundLink")],1),e._v(" will keep around 1 year of blocks (prune BTC for 100 GB)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-storage-s.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-storage-s"),t("OutboundLink")],1),e._v(" will keep around 6 months of blocks (prune BTC for 50 GB)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-storage-xs.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-storage-xs"),t("OutboundLink")],1),e._v(" will keep around 3 months of blocks (prune BTC for 25 GB)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-storage-xxs.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-storage-xxs"),t("OutboundLink")],1),e._v(" will keep around 2 weeks of blocks (prune BTC for 5 GB) (lightning not supported)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-autocompact",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-autocompact"),t("OutboundLink")],1),e._v(" will activate auto compacting of LND database.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-autopilot.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-autopilot"),t("OutboundLink")],1),e._v(" will activate auto pilot on LND. (5 channels, 60% of allocation)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-keysend.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-keysend"),t("OutboundLink")],1),e._v(" will activate keysend on LND.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-wtclient.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-wtclient"),t("OutboundLink")],1),e._v(" will activate the watchtower client on LND. "),t("code",[e._v("LND_WTCLIENT_SWEEP_FEE")]),e._v(" can be used to override the default 10 sat/byte justice transaction fee")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-watchtower.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-watchtower"),t("OutboundLink")],1),e._v(" will activate the LND watchtower RPC")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-memory.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-memory"),t("OutboundLink")],1),e._v(" will decrease the default dbcache at the expense of longer synchronization time. (Useful if your machine is less than 2GB)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-more-memory.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-more-memory"),t("OutboundLink")],1),e._v(" will increase the default dbcache to make synchronization faster (Useful if your machine is has around 4GB)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-btcqbo.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-btcqbo"),t("OutboundLink")],1),e._v(" will allow you to create an invoice on Quickbooks which include a way for your customer to pay on BTCPay Server (More information on this "),t("a",{attrs:{href:"https://github.com/JeffVandrewJr/btcqbo/",target:"_blank",rel:"noopener noreferrer"}},[e._v("github repository"),t("OutboundLink")],1),e._v(", this add-on is maintained by "),t("a",{attrs:{href:"https://github.com/JeffVandrewJr",target:"_blank",rel:"noopener noreferrer"}},[e._v("JeffVandrewJr"),t("OutboundLink")],1),e._v(", see more on "),t("a",{attrs:{href:"https://www.youtube.com/watch?v=srgwL9ozg6c",target:"_blank",rel:"noopener noreferrer"}},[e._v("this video"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-librepatron.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-librepatron"),t("OutboundLink")],1),e._v(", for a self-hosted Patreon alternative backed by BTCPay (More information on this "),t("a",{attrs:{href:"https://github.com/JeffVandrewJr/patron",target:"_blank",rel:"noopener noreferrer"}},[e._v("github repository"),t("OutboundLink")],1),e._v(", this add-on is maintained by "),t("a",{attrs:{href:"https://github.com/JeffVandrewJr",target:"_blank",rel:"noopener noreferrer"}},[e._v("JeffVandrewJr"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-woocommerce.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-woocommerce"),t("OutboundLink")],1),e._v(", for a self-hosted woocommerce with BTCPay Server plugin pre installed.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-tor.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-tor"),t("OutboundLink")],1),e._v(", for exposing BTCPayServer, Woocommerce, your lightning nodes as hidden services and accept onion peers for your full node. Warning: This options is for working around NAT and firewall problems as well as to help protect your customer's privacy. This will not protect your privacy against a targeted attack against you.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-btctransmuter.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-btctransmuter"),t("OutboundLink")],1),e._v(", for a self-hosted IFTTT style service for crypto services such as fiat settlement. (More information on this "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcTransmuter/",target:"_blank",rel:"noopener noreferrer"}},[e._v("github repository"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-txindex.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-txindex"),t("OutboundLink")],1),e._v(", to enable txindex=1 in bitcoin.conf if you require txindexing for Bisq, DOJO, etc.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-expose-unsafe.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-expose-unsafe"),t("OutboundLink")],1),e._v(", to unsafely expose bitcoind P2P port 8333 if you require P2P for Bisq, DOJO, Esplora, etc. WARNING: ONLY USE ON TRUSTED LAN OR WITH FIREWALL RULES WHITELISTING SPECIFIC HOSTS")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-tor-relay.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-tor-relay"),t("OutboundLink")],1),e._v(", for a non-exit tor relay. Make sure to have port 9001 accessible externally. "),t("a",{attrs:{href:"https://community.torproject.org/relay/community-resources/eff-tor-legal-faq",target:"_blank",rel:"noopener noreferrer"}},[e._v("Please read the legal implications of running a tor relay"),t("OutboundLink")],1),e._v(" and "),t("a",{attrs:{href:"https://trac.torproject.org/projects/tor/wiki/TorRelayGuide#RelayRequirements",target:"_blank",rel:"noopener noreferrer"}},[e._v("what resources are used to operate the relay"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-electrumx.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-electrumx"),t("OutboundLink")],1),e._v(", to integrate a full ElectrumX server (from official source) with BTCPay, using the BTCPay server's full bitcoin node for complete privacy when using your own Electrum wallet. You can also open port 50002 up to the internet on your router etc, to be part of the ElectrumX network, helping other Electrum wallet users to get connected. The bitcoin option "),t("code",[e._v("-txindex")]),e._v(" is mandatory for ElectrumX, and this fragment will enable it on your BTCPay server automatically - No need to use the fragment opt-txindex.yml.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-electrum-ps.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-electrum-ps"),t("OutboundLink")],1),e._v(", to integrate Electrum Personal Server (EPS) with BTCPay (EPS is a single-user alternative to the ElectrumX Server option above). EPS will also use the BTCPay server's full bitcoin node for complete privacy when using your own Electrum wallet, for your own personal use (i.e. other users cannot use your server to verify transactions). Also, the bitcoin option "),t("code",[e._v("-txindex")]),e._v(" is NOT mandatory for EPS, and it will run on a pruned node (unlike ElectrumX). You will need to add your XPUB/YPUB/ZPUB as environment variable "),t("code",[e._v("EPS_XPUB")]),e._v(" before enabling EPS for the first time (see above section on environment variables, and see "),t("RouterLink",{attrs:{to:"/ElectrumPersonalServer/"}},[e._v("full documentation")]),e._v(" for details).")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-bwt.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-electrum-bwt"),t("OutboundLink")],1),e._v(", to integrate the "),t("a",{attrs:{href:"https://github.com/bwt-dev/bwt",target:"_blank",rel:"noopener noreferrer"}},[e._v("Bitcoin Wallet Tracker"),t("OutboundLink")],1),e._v(" Electrum server, which uses a personal wallet index model similar to that of EPS. You will need to set "),t("code",[e._v("BWT_XPUB")]),e._v(" with your XPUB/YPUB/ZPUB (see environment variables section). The server will only be available locally and through an onion service.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-configurator.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-configurator"),t("OutboundLink")],1),e._v(", to integrate the "),t("a",{attrs:{href:"https://install.btcpayserver.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay Server Configurator"),t("OutboundLink")],1),e._v(" to manage your BTCPay deployment through a UI, and to allow new deployments elsewhere easily.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-pihole.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-pihole"),t("OutboundLink")],1),e._v(" ("),t("RouterLink",{attrs:{to:"/Docker/pihole/"}},[e._v("See the documentation")]),e._v(")")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-bluewallet-lndhub.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-bluewallet-lndhub"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/BlueWallet/LndHub",target:"_blank",rel:"noopener noreferrer"}},[e._v("Bluewallet LNDHub"),t("OutboundLink")],1),e._v(" - Use non-custodial LND Lightning directly from your Bluewallet, and freely let others open accounts on your node. Fragment maintained by "),t("a",{attrs:{href:"https://github.com/maltokyo",target:"_blank",rel:"noopener noreferrer"}},[e._v("maltokyo"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-ndlc.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-ndlc"),t("OutboundLink")],1),e._v(" ("),t("RouterLink",{attrs:{to:"/Docker/ndlc/"}},[e._v("See the documentation")]),e._v(")")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-lightning-terminal.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-lightning-terminal"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/lightninglabs/lightning-terminal",target:"_blank",rel:"noopener noreferrer"}},[e._v("Lightning Terminal/LiT"),t("OutboundLink")],1),e._v(". Maintained by "),t("a",{attrs:{href:"https://github.com/dennisreimann",target:"_blank",rel:"noopener noreferrer"}},[e._v("dennisreimann"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-mempool.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-mempool"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/mempool/mempool",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mempool"),t("OutboundLink")],1),e._v(". Maintained by "),t("a",{attrs:{href:"https://github.com/dennisreimann",target:"_blank",rel:"noopener noreferrer"}},[e._v("dennisreimann"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-sphinxrelay.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-sphinxrelay"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/stakwork/sphinx-relay",target:"_blank",rel:"noopener noreferrer"}},[e._v("Sphinx Relay"),t("OutboundLink")],1),e._v(". Maintained by "),t("a",{attrs:{href:"https://github.com/dennisreimann",target:"_blank",rel:"noopener noreferrer"}},[e._v("dennisreimann"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-tallycoin-connect.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-tallycoin-connect"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/djbooth007/tallycoin_connect",target:"_blank",rel:"noopener noreferrer"}},[e._v("Tallycoin Connect"),t("OutboundLink")],1),e._v(". Maintained by "),t("a",{attrs:{href:"https://github.com/dennisreimann",target:"_blank",rel:"noopener noreferrer"}},[e._v("dennisreimann"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-thunderhub.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-thunderhub"),t("OutboundLink")],1),e._v(" for a LND Lightning Node Manager in your Browser. Maintained by "),t("a",{attrs:{href:"https://github.com/apotdevin",target:"_blank",rel:"noopener noreferrer"}},[e._v("apotdevin"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-teos.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-teos"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/talaia-labs/python-teos",target:"_blank",rel:"noopener noreferrer"}},[e._v("The Eye Of Satoshi"),t("OutboundLink")],1),e._v(", a BOLT13 Lightning Watchtower. Use port 9814 on your server or Tor to connect.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-chatwoot.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-chatwoot"),t("OutboundLink")],1),e._v(" for open source chat support system. ("),t("RouterLink",{attrs:{to:"/Docker/chatwoot/"}},[e._v("See the documentation")]),e._v(")")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-zammad.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-zammad"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://zammad.com/features",target:"_blank",rel:"noopener noreferrer"}},[e._v("Zammad"),t("OutboundLink")],1),e._v(", a web based open source helpdesk/customer support system with many features to manage customer communication via several channels like telephone, facebook, twitter, chat and e-mails")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-monero-expose.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-monero-expose"),t("OutboundLink")],1),e._v(" to expose monero node's RPC port at 127.0.0.1:18081 to connect your own wallet. Use f.e. ssh port forwarding to forward to your own computer.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-fireflyiii.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-fireflyiii"),t("OutboundLink")],1),e._v(" ("),t("RouterLink",{attrs:{to:"/Docker/fireflyiii/"}},[e._v("See the documentation")]),e._v(")")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-joinmarket.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-joinmarket"),t("OutboundLink")],1),e._v(" ("),t("RouterLink",{attrs:{to:"/Docker/joinmarket/"}},[e._v("See the documentation")]),e._v(")")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-helipad.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-helipad"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/Podcastindex-org/helipad",target:"_blank",rel:"noopener noreferrer"}},[e._v("Podcastindex.org Helipad"),t("OutboundLink")],1),e._v(". Requires LND.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-nostr-relay.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-nostr-relay"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/kukks/Nnostr",target:"_blank",rel:"noopener noreferrer"}},[e._v("Nostr Relay"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-cloudflared.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-cloudflared"),t("OutboundLink")],1),e._v(" to expose your local server on clearnet painlessly ("),t("RouterLink",{attrs:{to:"/Docker/cloudflare-tunnel/"}},[e._v("see documentation")]),e._v(").")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-torq.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-torq"),t("OutboundLink")],1),e._v(" to install "),t("a",{attrs:{href:"https://github.com/lncapital/torq",target:"_blank",rel:"noopener noreferrer"}},[e._v("Torq"),t("OutboundLink")],1),e._v(" node management application. Requires LND.")])]),e._v(" "),t("p",[e._v("You can also create your own "),t("a",{attrs:{href:"#how-can-i-customize-the-generated-docker-compose-file"}},[e._v("custom fragments")]),e._v(".")]),e._v(" "),t("p",[e._v("If you want to add an option to "),t("code",[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(" and re-configure your install:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(';opt-lnd-autopilot"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" btcpay-setup.sh -i\n")])])]),t("p",[e._v("For example, if you want "),t("code",[e._v("btc")]),e._v(" and "),t("code",[e._v("ltc")]),e._v(" support with "),t("code",[e._v("nginx")]),e._v(" and "),t("code",[e._v("clightning")]),e._v(" inside "),t("code",[e._v("Generated/docker-compose.custom.yml")]),e._v(":")]),e._v(" "),t("p",[e._v("Note: The first run might take a while, but following runs are instantaneous.")]),e._v(" "),t("p",[e._v("On Windows (run in "),t("a",{attrs:{href:"https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell",target:"_blank",rel:"noopener noreferrer"}},[e._v("powershell"),t("OutboundLink")],1),e._v("):")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("Invoke-Command")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_CRYPTO1")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btc"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_CRYPTO2")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ltc"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_REVERSEPROXY")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"nginx"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_LIGHTNING")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"clightning"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_SUBNAME")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"custom"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("\\build"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("ps1\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("On Linux:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO1")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btc"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO2")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ltc"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_REVERSEPROXY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"nginx"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_LIGHTNING")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"clightning"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_SUBNAME")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"custom"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n./build.sh\n")])])]),t("p",[e._v("Next, you will need to configure the runtime environment variables for "),t("code",[e._v("Generated/docker-compose.custom.yml")]),e._v(":")]),e._v(" "),t("ul",[t("li",[e._v("If you are using NGinx, "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/Production/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("read this"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("If you are not using NGinx, "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/Production-NoReverseProxy/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("read this instead"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"again-what-does-btcpay-setupsh-do"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#again-what-does-btcpay-setupsh-do"}},[e._v("#")]),e._v(" Again, what does "),t("code",[e._v("btcpay-setup.sh")]),e._v(" do?")]),e._v(" "),t("p",[t("code",[e._v("btcpay-setup.sh")]),e._v(" is a utility which does the following:")]),e._v(" "),t("ol",[t("li",[e._v("Makes sure docker and docker-compose are installed on your system")]),e._v(" "),t("li",[e._v("Generates a docker-compose via "),t("code",[e._v("./build.sh")])]),e._v(" "),t("li",[e._v("Sets up an "),t("a",{attrs:{href:"https://docs.docker.com/compose/env-file/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Environment File"),t("OutboundLink")],1),e._v(" to configure your docker-compose")]),e._v(" "),t("li",[e._v("Sets up environment variables so the tools described in "),t("a",{attrs:{href:"#tooling"}},[e._v("Tooling")]),e._v(" can work")]),e._v(" "),t("li",[e._v("Adds symlinks of those tools into "),t("code",[e._v("/usr/bin")])]),e._v(" "),t("li",[e._v("Makes sure BTCPay restarts on reboot via upstart or systemd")]),e._v(" "),t("li",[e._v("Starts BTCPay via docker-compose")])]),e._v(" "),t("h2",{attrs:{id:"overview-of-files-generated-by-btcpay-setupsh"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview-of-files-generated-by-btcpay-setupsh"}},[e._v("#")]),e._v(" Overview of files generated by "),t("code",[e._v("btcpay-setup.sh")])]),e._v(" "),t("p",[t("code",[e._v("/etc/profile.d/btcpay-env.sh")]),e._v(" ensures that your environment variables are correctly setup when you login, so you can use the tools:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_OLD_PREGEN")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"false"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO1")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btc"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO2")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO3")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO4")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO5")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO6")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO7")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO8")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO9")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_LIGHTNING")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"clightning"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_REVERSEPROXY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"nginx"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_DOCKER_COMPOSE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/var/lib/waagent/custom-script/download/0/btcpayserver-docker/Production/docker-compose.generated.yml"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_BASE_DIRECTORY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/var/lib/waagent/custom-script/download/0"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_ENV_FILE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/var/lib/waagent/custom-script/download/0/.env"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_HOST_SSHKEYFILE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/root/.ssh/id_rsa_btcpay"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("if")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cat")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_ENV_FILE")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&>")]),e._v(" /dev/null"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("then")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" -v "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'^#'")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_ENV_FILE")]),e._v('"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("xargs")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("fi")]),e._v("\n")])])]),t("p",[t("code",[e._v("/etc/systemd/system/btcpayserver.service")]),e._v(" ensures that you can control btcpay via "),t("code",[e._v("systemctl")]),e._v(", and that BTCPayServer starts on reboot:")]),e._v(" "),t("div",{staticClass:"language-ini extra-class"},[t("pre",{pre:!0,attrs:{class:"language-ini"}},[t("code",[t("span",{pre:!0,attrs:{class:"token section"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token section-name selector"}},[e._v("Unit")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("Description")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("BTCPayServer service")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("After")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("docker.service network-online.target")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("Requires")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("docker.service network-online.target")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token section"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token section-name selector"}},[e._v("Service")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("oneshot")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("RemainAfterExit")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("yes")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("ExecStart")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("/bin/bash -c '. /etc/profile.d/btcpay-env.sh && cd \"$BTCPAY_BASE_DIRECTORY/btcpayserver-docker\" && . helpers.sh && btcpay_up'")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("ExecStop")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("/bin/bash -c '. /etc/profile.d/btcpay-env.sh && cd \"$BTCPAY_BASE_DIRECTORY/btcpayserver-docker\" && . helpers.sh && btcpay_down'")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("ExecReload")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("/bin/bash -c '. /etc/profile.d/btcpay-env.sh && cd \"$BTCPAY_BASE_DIRECTORY/btcpayserver-docker\" && . helpers.sh && btcpay_restart'")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token section"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token section-name selector"}},[e._v("Install")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("WantedBy")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("multi-user.target")]),e._v("\n")])])]),t("p",[t("code",[e._v(".env")]),e._v(" ("),t("code",[e._v("$BTCPAY_ENV_FILE")]),e._v(") contains environment variables passed to the containers managed by your docker-compose:")]),e._v(" "),t("div",{staticClass:"language-ini extra-class"},[t("pre",{pre:!0,attrs:{class:"language-ini"}},[t("code",[t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("BTCPAY_HOST")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("btcpay.EXAMPLE.com")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("ACME_CA_URI")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("production")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("NBITCOIN_NETWORK")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("mainnet")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("LETSENCRYPT_EMAIL")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("me@EXAMPLE.com")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("BTCPAY_SSHTRUSTEDFINGERPRINTS")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("SHA256:eSCD7NtQ/Q6IBl2iRB9caAQ3lDZd8s8iUL6SdeNnhpA")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("BTCPAY_SSHKEYFILE")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("/datadir/id_rsa")]),e._v("\n")])])]),t("h1",{attrs:{id:"how-can-i-add-an-altcoin-to-btcpayserver"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-add-an-altcoin-to-btcpayserver"}},[e._v("#")]),e._v(" How can I add an altcoin to BTCPayServer?")]),e._v(" "),t("ol",[t("li",[e._v("Add support for your crypto to "),t("a",{attrs:{href:"https://github.com/MetacoSA/NBitcoin/tree/master/NBitcoin.Altcoins",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBitcoin"),t("OutboundLink")],1),e._v(", "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBxplorer"),t("OutboundLink")],1),e._v(", and "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer"),t("OutboundLink")],1),e._v(". (Use examples from other coins)")]),e._v(" "),t("li",[e._v("Create your own docker image ("),t("a",{attrs:{href:"https://hub.docker.com/r/nicolasdorier/docker-bitcoin/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Create a docker-compose fragment ("),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/bitcoin.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Add your "),t("code",[e._v("CryptoDefinition")]),e._v(" ("),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/src/CryptoDefinition.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")])]),e._v(" "),t("p",[t("code",[e._v("build.sh")]),e._v(" is using a pre-built image of the "),t("code",[e._v("docker-compose generator")]),e._v(" on "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/docker-compose-generator/",target:"_blank",rel:"noopener noreferrer"}},[e._v("docker hub"),t("OutboundLink")],1),e._v(".\nIf you modify the code source of "),t("code",[e._v("docker-compose generator")]),e._v(" (for example, the "),t("code",[e._v("CryptoDefinition")]),e._v(" "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/src/CryptoDefinition.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v("), you need to configure "),t("code",[e._v("build.sh")]),e._v(" to use your own image by setting the environment variable "),t("code",[e._v("BTCPAYGEN_DOCKER_IMAGE")]),e._v(" to "),t("code",[e._v("btcpayserver/docker-compose-generator:local")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" docker-compose-generator\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_DOCKER_IMAGE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btcpayserver/docker-compose-generator:local"')]),e._v("\n")])])]),t("p",[e._v("Or on powershell:")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[e._v("cd docker-compose-generator\n"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_DOCKER_IMAGE")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btcpayserver/docker-compose-generator:local"')]),e._v("\n")])])]),t("p",[e._v("Then run "),t("code",[e._v("./build.sh")]),e._v(" or "),t("code",[e._v(". .\\build.ps1")]),e._v(".\nThis will generate your docker-compose in the "),t("code",[e._v("Generated")]),e._v(" folder, which you can then run and test.")]),e._v(" "),t("p",[e._v("Note that BTCPayServer developers will not spend excessive time testing your image, so make sure it works.")]),e._v(" "),t("h1",{attrs:{id:"support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#support"}},[e._v("#")]),e._v(" Support")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Image")]),e._v(" "),t("th",[e._v("Version")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("x64")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("arm32v7")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("arm64v8")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("links")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("btcpayserver/docker-compose-generator")]),e._v(" "),t("td",[e._v("latest")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-docker/dcg-latest/docker-compose-generator/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-docker/dcg-latest/docker-compose-generator/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-docker/dcg-latest/docker-compose-generator/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/docker-compose-generator",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/docker-compose")]),e._v(" "),t("td",[e._v("1.28.6")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/docker-compose/1.28.6/docker-compose/1.28.6/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/docker-compose/1.28.6/docker-compose/1.28.6/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/docker-compose/1.28.6/docker-compose/1.28.6/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/docker-compose",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/lightning")]),e._v(" "),t("td",[e._v("v23.08")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lightning/basedon-v23.08/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lightning/basedon-v23.08/contrib/docker/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lightning/basedon-v23.08/contrib/docker/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/lightning",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/lightning",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("saubyk/c-lightning-rest")]),e._v(" "),t("td",[e._v("0.10.6")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/c-lightning-REST/v0.10.6/amd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/c-lightning-REST/v0.10.6/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/c-lightning-REST/v0.10.6/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Ride-The-Lightning/c-lightning-REST",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/saubyk/c-lightning-rest",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("shahanafarooqui/rtl")]),e._v(" "),t("td",[e._v("0.14.1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/RTL/v0.14.1/dockerfiles/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/RTL/v0.14.1/dockerfiles/Dockerfile.arm32v7",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/RTL/v0.14.1/dockerfiles/Dockerfile.arm64v8",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Ride-The-Lightning/RTL",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/shahanafarooqui/rtl",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/lnd")]),e._v(" "),t("td",[e._v("v0.16.4-beta-1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lnd/basedon-v0.16.4-beta-1/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lnd/basedon-v0.16.4-beta-1/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lnd/basedon-v0.16.4-beta-1/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/lnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/lnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/bitcoin")]),e._v(" "),t("td",[e._v("25.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Bitcoin/25.0/Bitcoin/25.0/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Bitcoin/25.0/Bitcoin/25.0/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Bitcoin/25.0/Bitcoin/25.0/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/bitcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/btcpayserver")]),e._v(" "),t("td",[e._v("1.11.6$?")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver/v1.11.6/amd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver/v1.11.6/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver/v1.11.6/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/monero")]),e._v(" "),t("td",[e._v("0.18.2.2-4")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Monero/0.18.2.2-4/Monero/0.18.2.2/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Monero/0.18.2.2-4/Monero/0.18.2.2/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Monero/0.18.2.2-4/Monero/0.18.2.2/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/monero",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("nicolasdorier/nbxplorer")]),e._v(" "),t("td",[e._v("2.3.66")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/nbxplorer/v2.3.66/Dockerfile.linuxamd64",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/nbxplorer/v2.3.66/Dockerfile.linuxarm32v7",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/nbxplorer/v2.3.66/Dockerfile.linuxarm64v8",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/dgarage/nbxplorer",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/nicolasdorier/nbxplorer",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/letsencrypt-nginx-proxy-companion")]),e._v(" "),t("td",[e._v("1.12.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-letsencrypt-nginx-proxy-companion/v1.12.2/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-letsencrypt-nginx-proxy-companion/v1.12.2/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-letsencrypt-nginx-proxy-companion/v1.12.2/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/docker-letsencrypt-nginx-proxy-companion",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/letsencrypt-nginx-proxy-companion",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("nginx")]),e._v(" "),t("td",[e._v("1.23.3")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/nginxinc/docker-nginx/1.23.2/stable/debian/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/nginxinc/docker-nginx/1.23.2/stable/debian/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/nginxinc/docker-nginx/1.23.2/stable/debian/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/nginxinc/docker-nginx",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/_/nginx",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/docker-gen")]),e._v(" "),t("td",[e._v("0.7.8")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-gen/v0.7.8/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-gen/v0.7.8/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-gen/v0.7.8/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/docker-gen",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/docker-gen",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/btctransmuter")]),e._v(" "),t("td",[e._v("0.0.59")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btctransmuter/v0.0.59/Dockerfiles/amd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btctransmuter/v0.0.59/Dockerfiles/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btctransmuter/v0.0.59/Dockerfiles/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/btctransmuter",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/btctransmuter",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/cloudflared")]),e._v(" "),t("td",[e._v("2023.7.3")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Cloudflared/2023.7.3/Cloudflared/2023.7.3/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Cloudflared/2023.7.3/Cloudflared/2023.7.3/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Cloudflared/2023.7.3/Cloudflared/2023.7.3/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/cloudflared",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/btcpayserver-configurator")]),e._v(" "),t("td",[e._v("0.0.21")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-configurator/v0.0.21/Dockerfiles/amd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-configurator/v0.0.21/Dockerfiles/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-configurator/v0.0.21/Dockerfiles/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-configurator",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/btcpayserver-configurator",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/eps")]),e._v(" "),t("td",[e._v("0.2.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/EPS/0.2.2/EPS/0.2.2/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/EPS/0.2.2/EPS/0.2.2/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/EPS/0.2.2/EPS/0.2.2/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/eps",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/joinmarket")]),e._v(" "),t("td",[e._v("0.9.5")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/JoinMarket/0.9.5/JoinMarket/0.9.5/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/JoinMarket/0.9.5/JoinMarket/0.9.5/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/JoinMarket/0.9.5/JoinMarket/0.9.5/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/joinmarket",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("nicolasdorier/ndlc-cli")]),e._v(" "),t("td",[e._v("1.0.1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/ndlc/releases/1.0.1/amd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/ndlc/releases/1.0.1/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/ndlc/releases/1.0.1/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/dgarage/ndlc",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/nicolasdorier/ndlc-cli",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("pihole/pihole")]),e._v(" "),t("td",[e._v("2023.05.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/pi-hole/docker-pi-hole/2023.05.2/src/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/pi-hole/docker-pi-hole/2023.05.2/src/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/pi-hole/docker-pi-hole/2023.05.2/src/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/pi-hole/docker-pi-hole",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/pihole/pihole",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/tor")]),e._v(" "),t("td",[e._v("0.4.7.10")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Tor/0.4.7.10/Tor/0.4.7.10/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Tor/0.4.7.10/Tor/0.4.7.10/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Tor/0.4.7.10/Tor/0.4.7.10/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/tor",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/woocommerce")]),e._v(" "),t("td",[e._v("3.1.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/WooCommerce/3.1.0/WooCommerce/3.1.0/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/WooCommerce/3.1.0/WooCommerce/3.1.0/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/woocommerce",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/postgres")]),e._v(" "),t("td",[e._v("13.10")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Postgres/13.10/Postgres/13.10/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Postgres/13.10/Postgres/13.10/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Postgres/13.10/Postgres/13.10/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/postgres",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("kamigawabul/btglnd")]),e._v(" "),t("td",[e._v("latest")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/vutov/lnd/master/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/vutov/lnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/kamigawabul/btglnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("kamigawabul/docker-bitcoingold")]),e._v(" "),t("td",[e._v("0.15.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Vutov/docker-bitcoin/master/bitcoingold/0.15.2/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Vutov/docker-bitcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/kamigawabul/docker-bitcoingold",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("acinq/eclair")]),e._v(" "),t("td",[e._v("release-0.7.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/ACINQ/eclair/v0.7.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/ACINQ/eclair",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/acinq/eclair",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("chekaz/docker-bitcoinplus")]),e._v(" "),t("td",[e._v("2.7.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/ChekaZ/docker/master/bitcoinplus/2.7.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/ChekaZ/docker",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/chekaz/docker-bitcoinplus",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("dalijolijo/docker-bitcore")]),e._v(" "),t("td",[e._v("0.90.9.10")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dalijolijo/btcpayserver-docker-bitcore/master/docker-bitcored/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/dalijolijo/btcpayserver-docker-bitcore",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/dalijolijo/docker-bitcore",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/dash")]),e._v(" "),t("td",[e._v("19.2.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Dash/19.2.0/Dash/19.2.0/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Dash/19.2.0/Dash/19.2.0/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/dash",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/dogecoin")]),e._v(" "),t("td",[e._v("1.14.6")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Dogecoin/1.14.6/Dogecoin/1.14.6/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/dogecoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("chekaz/docker-feathercoin")]),e._v(" "),t("td",[e._v("0.16.3")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/ChekaZ/docker/master/feathercoin/0.16.3/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/ChekaZ/docker",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/chekaz/docker-feathercoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("groestlcoin/lightning")]),e._v(" "),t("td",[e._v("v23.05")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Groestlcoin/lightning/v23.05/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Groestlcoin/lightning",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/groestlcoin/lightning",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("groestlcoin/groestlcoin-lightning-charge")]),e._v(" "),t("td",[e._v("version-0.4.22")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Groestlcoin/groestlcoin-lightning-charge/v0.4.22/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Groestlcoin/groestlcoin-lightning-charge",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/groestlcoin/groestlcoin-lightning-charge",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("groestlcoin/groestlcoin-spark")]),e._v(" "),t("td",[e._v("version-0.2.16")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Groestlcoin/groestlcoin-spark/v0.2.16/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Groestlcoin/groestlcoin-spark",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/groestlcoin/groestlcoin-spark",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("groestlcoin/eclair")]),e._v(" "),t("td",[e._v("v0.6.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Groestlcoin/eclair/v0.6.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Groestlcoin/eclair",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/groestlcoin/eclair",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("groestlcoin/lnd")]),e._v(" "),t("td",[e._v("v0.10.0-grs")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Groestlcoin/lnd/v0.10.0-grs/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Groestlcoin/lnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/groestlcoin/lnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/groestlcoin")]),e._v(" "),t("td",[e._v("25.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Groestlcoin/25.0/Groestlcoin/25.0/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Groestlcoin/25.0/Groestlcoin/25.0/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Groestlcoin/25.0/Groestlcoin/25.0/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/groestlcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/elements")]),e._v(" "),t("td",[e._v("22.1.1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Elements/22.1.1/Elements/22.1.1/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Elements/22.1.1/Elements/22.1.1/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Elements/22.1.1/Elements/22.1.1/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/elements",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/litecoin")]),e._v(" "),t("td",[e._v("0.21.2.1-2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Litecoin/0.21.2.1-2/Litecoin/0.21.2.1/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Litecoin/0.21.2.1-2/Litecoin/0.21.2.1/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Litecoin/0.21.2.1-2/Litecoin/0.21.2.1/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/litecoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("wakiyamap/docker-monacoin")]),e._v(" "),t("td",[e._v("0.20.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/wakiyamap/docker-bitcoin/master/monacoin/0.20.2/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/wakiyamap/docker-bitcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/wakiyamap/docker-monacoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("redis")]),e._v(" "),t("td",[e._v("6.2.2-buster")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/docker-library/redis/f1a8498333ae3ab340b5b39fbac1d7e1dc0d628c/5.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/docker-library/redis",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/_/redis",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("bluewalletorganization/lndhub")]),e._v(" "),t("td",[e._v("v1.4.1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/BlueWallet/LndHub/v1.4.1/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/BlueWallet/LndHub/v1.4.1/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/BlueWallet/LndHub/v1.4.1/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/BlueWallet/LndHub",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/bluewalletorganization/lndhub",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("jvandrew/btcqbo")]),e._v(" "),t("td",[e._v("0.3.36")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/JeffVandrewJr/btcqbo/v0.3.36/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/JeffVandrewJr/btcqbo",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/jvandrew/btcqbo",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("shesek/bwt")]),e._v(" "),t("td",[e._v("0.2.2-electrum")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/bwt-dev/bwt/v0.2.2/docker/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/bwt-dev/bwt/v0.2.2/docker/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/bwt-dev/bwt/v0.2.2/docker/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/bwt-dev/bwt",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/shesek/bwt",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("chatwoot/chatwoot")]),e._v(" "),t("td",[e._v("v1.7.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/chatwoot/chatwoot/v1.7.0/docker/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/chatwoot/chatwoot/v1.7.0/docker/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/chatwoot/chatwoot/v1.7.0/docker/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/chatwoot/chatwoot",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/chatwoot/chatwoot",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("lukechilds/electrumx")]),e._v(" "),t("td",[e._v("latest")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lukechilds/docker-electrumx/master/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/lukechilds/docker-electrumx",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/lukechilds/electrumx",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("fireflyiii/core")]),e._v(" "),t("td",[e._v("latest")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://dev.azure.com/Firefly-III/66fb773b-063e-42d7-b6a5-e7729a22e8b3/_apis/git/repositories/e9c3dcf8-4533-4ef1-83cc-75527cab3377/items?path=%2FDockerfile&versionDescriptor%5BversionOptions%5D=0&versionDescriptor%5BversionType%5D=0&versionDescriptor%5Bversion%5D=main&resolveLfs=true&%24format=octetStream&api-version=5.0&download=true",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://dev.azure.com/Firefly-III/66fb773b-063e-42d7-b6a5-e7729a22e8b3/_apis/git/repositories/e9c3dcf8-4533-4ef1-83cc-75527cab3377/items?path=%2FDockerfile&versionDescriptor%5BversionOptions%5D=0&versionDescriptor%5BversionType%5D=0&versionDescriptor%5Bversion%5D=main&resolveLfs=true&%24format=octetStream&api-version=5.0&download=true",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://dev.azure.com/Firefly-III/66fb773b-063e-42d7-b6a5-e7729a22e8b3/_apis/git/repositories/e9c3dcf8-4533-4ef1-83cc-75527cab3377/items?path=%2FDockerfile&versionDescriptor%5BversionOptions%5D=0&versionDescriptor%5BversionType%5D=0&versionDescriptor%5Bversion%5D=main&resolveLfs=true&%24format=octetStream&api-version=5.0&download=true",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://dev.azure.com/Firefly-III/_git/MainImage",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/fireflyiii/core",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("podcastindexorg/podcasting20-helipad")]),e._v(" "),t("td",[e._v("v0.1.10")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Podcastindex-org/helipad/v0.1.10/umbrel/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Podcastindex-org/helipad/v0.1.10/umbrel/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Podcastindex-org/helipad/v0.1.10/umbrel/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Podcastindex-org/helipad",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/podcastindexorg/podcasting20-helipad",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("jvandrew/librepatron")]),e._v(" "),t("td",[e._v("0.7.39")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/JeffVandrewJr/patron/v0.7.39/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/JeffVandrewJr/patron",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/jvandrew/librepatron",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("jvandrew/isso")]),e._v(" "),t("td",[e._v("atron.22")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/JeffVandrewJr/isso/patron.22/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/JeffVandrewJr/isso",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/jvandrew/isso",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("lightninglabs/lightning-terminal")]),e._v(" "),t("td",[e._v("v0.9.2-alpha-path-prefix")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lightninglabs/lightning-terminal/v0.9.2-alpha/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lightninglabs/lightning-terminal/v0.9.2-alpha/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/lightninglabs/lightning-terminal",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/lightninglabs/lightning-terminal",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("mempool/frontend")]),e._v(" "),t("td",[e._v("v2.5.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/frontend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/frontend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/frontend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/mempool/mempool",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/mempool/frontend",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("mempool/backend")]),e._v(" "),t("td",[e._v("v2.5.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/backend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/backend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/backend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/mempool/mempool",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/mempool/backend",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("mariadb")]),e._v(" "),t("td",[e._v("10.11")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/docker-library/mariadb/master/10.11/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/docker-library/mariadb",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/_/mariadb",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("kukks/nnostr-relay")]),e._v(" "),t("td",[e._v("v0.0.17")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/kukks/nnostr/Relay/v0.0.17/Relay/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/kukks/nnostr/Relay/v0.0.17/Relay/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/kukks/nnostr/Relay/v0.0.17/Relay/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/kukks/nnostr",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/kukks/nnostr-relay",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("sphinxlightning/sphinx-relay")]),e._v(" "),t("td",[e._v("v2.2.9")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/stakwork/sphinx-relay/v2.2.9/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/stakwork/sphinx-relay/v2.2.9/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/stakwork/sphinx-relay/v2.2.9/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/stakwork/sphinx-relay",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/sphinxlightning/sphinx-relay",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("djbooth007/tallycoin_connect")]),e._v(" "),t("td",[e._v("v1.8.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/djbooth007/tallycoin_connect/v1.8.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/djbooth007/tallycoin_connect/v1.8.0/Dockerfile.arm32v7",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/djbooth007/tallycoin_connect/v1.8.0/Dockerfile.arm64v8",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/djbooth007/tallycoin_connect",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/djbooth007/tallycoin_connect",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("talaia/python-teos")]),e._v(" "),t("td",[e._v("latest")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/talaia-labs/python-teos/master/docker/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/talaia-labs/python-teos/master/docker/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/talaia-labs/python-teos/master/docker/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/talaia-labs/python-teos",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/talaia/python-teos",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("apotdevin/thunderhub")]),e._v(" "),t("td",[e._v("base-v0.13.21")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/apotdevin/thunderhub/v0.13.21/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/apotdevin/thunderhub/v0.13.21/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/apotdevin/thunderhub/v0.13.21/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/apotdevin/thunderhub",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/apotdevin/thunderhub",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("lncapital/torq")]),e._v(" "),t("td",[e._v("0.20.3")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lncapital/torq/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lncapital/torq/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lncapital/torq/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/lncapital/torq",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/lncapital/torq",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("timescale/timescaledb")]),e._v(" "),t("td",[e._v("latest-pg14")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/timescale/timescaledb-docker/main/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/timescale/timescaledb-docker/main/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/timescale/timescaledb-docker/main/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/timescale/timescaledb-docker",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/timescale/timescaledb",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("zammad/zammad-docker-compose")]),e._v(" "),t("td",[e._v("zammad-postgresql-3.4.0-4")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/zammad/zammad-docker-compose/ff20084ce2829486076e9781fe27407ca6cc09bb/containers/zammad-postgresql/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/zammad/zammad-docker-compose",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/zammad/zammad-docker-compose",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("memcached")]),e._v(" "),t("td",[e._v("1.5.22-alpine")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/docker-library/memcached/master/alpine/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/docker-library/memcached",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/_/memcached",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("traefik")]),e._v(" "),t("td",[e._v("v2.6")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/containous/traefik-library-image/master/scratch/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/containous/traefik-library-image",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/_/traefik",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("chekaz/docker-trezarcoin")]),e._v(" "),t("td",[e._v("0.13.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/ChekaZ/docker/master/trezarcoin/1.2.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/ChekaZ/docker",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/chekaz/docker-trezarcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("romanornr/docker-viacoin")]),e._v(" "),t("td",[e._v("0.15.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/viacoin/docker-viacoin/master/viacoin/0.15.2/docker-viacoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/viacoin/docker-viacoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/romanornr/docker-viacoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])])])]),e._v(" "),t("h1",{attrs:{id:"faq"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#faq"}},[e._v("#")]),e._v(" FAQ")]),e._v(" "),t("h2",{attrs:{id:"how-can-i-modify-my-environment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-modify-my-environment"}},[e._v("#")]),e._v(" How can I modify my environment?")]),e._v(" "),t("p",[e._v("As root, run "),t("code",[e._v(". btcpay-setup.sh")]),e._v("; this will show you the environment variable it is expecting.\nFor example, if you support "),t("code",[e._v("btc")]),e._v(" and "),t("code",[e._v("ltc")]),e._v(" already, and want to add "),t("code",[e._v("btg")]),e._v(":")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO3")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'btg'")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" btcpay-setup.sh -i\n")])])]),t("h2",{attrs:{id:"i-deployed-before-btcpay-setupsh-existed-before-may-17-2018-can-i-migrate-to-this-new-system"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#i-deployed-before-btcpay-setupsh-existed-before-may-17-2018-can-i-migrate-to-this-new-system"}},[e._v("#")]),e._v(" I deployed before "),t("code",[e._v("btcpay-setup.sh")]),e._v(" existed (before May 17, 2018), can I migrate to this new system?")]),e._v(" "),t("p",[e._v("Yes, run the following commands to update:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$DOWNLOAD_ROOT")]),e._v("/btcpayserver-docker\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" checkout master\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" pull\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" checkout 9acb5d8067cb5c46f59858137feb699b41ac9f19\nbtcpay-update.sh\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" checkout master\nbtcpay-update.sh\n\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("exit")]),e._v("\n")])])]),t("h2",{attrs:{id:"im-getting-an-error-on-windows-cannot-create-container-for-service-docker-mount-denied"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#im-getting-an-error-on-windows-cannot-create-container-for-service-docker-mount-denied"}},[e._v("#")]),e._v(" I'm getting an error on Windows: "),t("code",[e._v("Cannot create container for service docker: Mount denied")]),e._v("?")]),e._v(" "),t("p",[e._v("If you see this error:")]),e._v(" "),t("p",[t("code",[e._v("Cannot create container for service docker: b'Mount denied:\\nThe source path \"\\\\\\\\var\\\\\\\\run\\\\\\\\docker.sock:/var/run/docker.sock\"\\nis not a valid Windows path'")]),e._v(".")]),e._v(" "),t("p",[e._v("Run this in "),t("a",{attrs:{href:"https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell",target:"_blank",rel:"noopener noreferrer"}},[e._v("powershell"),t("OutboundLink")],1),e._v(":")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$Env")]),e._v(":COMPOSE_CONVERT_WINDOWS_PATHS=1\n")])])]),t("p",[e._v("Then, run "),t("code",[e._v("docker-compose -f EXAMPLE.yml up")]),e._v(".")]),e._v(" "),t("p",[e._v("This bug comes from Docker for Windows and is "),t("a",{attrs:{href:"https://github.com/docker/for-win/issues/1829",target:"_blank",rel:"noopener noreferrer"}},[e._v("tracked on Github"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"how-i-can-prune-my-nodes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-i-can-prune-my-nodes"}},[e._v("#")]),e._v(" How I can prune my node(s)?")]),e._v(" "),t("p",[e._v("This will prune your Bitcoin full node to a maximum of 100GB (of blocks):")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"opt-save-storage"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n")])])]),t("p",[e._v("Other options are "),t("a",{attrs:{href:"#generated-docker-compose"}},[e._v("documented here")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"how-can-i-customize-the-generated-docker-compose-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-customize-the-generated-docker-compose-file"}},[e._v("#")]),e._v(" How can I customize the generated docker-compose file?")]),e._v(" "),t("p",[e._v("In some instances, you might want to customize your environment in more detail. While you could modify "),t("code",[e._v("Generated/docker-compose.generated.yml")]),e._v(" manually, your changes would be overwritten the next time you run "),t("code",[e._v("btcpay-update.sh")]),e._v(".")]),e._v(" "),t("p",[e._v("Luckily, you can leverage "),t("code",[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(" for this!")]),e._v(" "),t("p",[e._v("Let's enable "),t("strong",[e._v("pruning to 60 GB")]),e._v(", for example:")]),e._v(" "),t("p",[e._v("First, copy "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-storage.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-storage"),t("OutboundLink")],1),e._v(" into the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments",target:"_blank",rel:"noopener noreferrer"}},[e._v("the docker fragment folder"),t("OutboundLink")],1),e._v(" as "),t("code",[e._v("opt-save-storage.custom.yml")]),e._v(". "),t("strong",[e._v("Important:")]),e._v(" the file must end with "),t("code",[e._v(".custom.yml")]),e._v(", or there will be git conflicts whenever you run "),t("code",[e._v("btcpay-update.sh")]),e._v(".")]),e._v(" "),t("p",[e._v("Modify the new "),t("code",[e._v("opt-save-storage.custom.yml")]),e._v(" file to your taste:")]),e._v(" "),t("div",{staticClass:"language-diff extra-class"},[t("pre",{pre:!0,attrs:{class:"language-diff"}},[t("code",[e._v('@@ -14,8 +14,7 @@ version: "3"\n'),t("span",{pre:!0,attrs:{class:"token unchanged"}},[t("span",{pre:!0,attrs:{class:"token prefix unchanged"}},[e._v(" ")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v("services:\n")]),t("span",{pre:!0,attrs:{class:"token prefix unchanged"}},[e._v(" ")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(" bitcoind:\n")]),t("span",{pre:!0,attrs:{class:"token prefix unchanged"}},[e._v(" ")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(" environment:\n")])]),t("span",{pre:!0,attrs:{class:"token deleted-sign deleted"}},[t("span",{pre:!0,attrs:{class:"token prefix deleted"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(" BITCOIN_EXTRA_ARGS: prune=100000\n")])]),t("span",{pre:!0,attrs:{class:"token inserted-sign inserted"}},[t("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(" BITCOIN_EXTRA_ARGS: prune=60000\n")])])])])]),t("p",[e._v("Then set it up:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(';opt-save-storage.custom"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n")])])]),t("h2",{attrs:{id:"can-i-run-btcpay-server-on-ports-other-than-80-and-443"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#can-i-run-btcpay-server-on-ports-other-than-80-and-443"}},[e._v("#")]),e._v(" Can I run BTCPay Server on ports other than 80 and 443?")]),e._v(" "),t("p",[e._v("You can change the ports for HTTP and HTTPS by setting the environment variables "),t("code",[e._v("REVERSEPROXY_HTTP_PORT")]),e._v(" and "),t("code",[e._v("REVERSEPROXY_HTTPS_PORT")]),e._v(". This is handy when ports 80 and 443 are already in use on your host, or you want to offload SSL termination with an existing web proxy.")]),e._v(" "),t("p",[e._v("When you set "),t("code",[e._v("REVERSEPROXY_HTTP_PORT")]),e._v(" to another value than 80, the built-in Let's Encrypt certificate will not work, as Let's Encrypt will try to validate your SSL certificate request by connecting from the internet to your domain on port 80. This validation request should be able to reach BTCPay Server in order to receive the certificate.")]),e._v(" "),t("p",[e._v("If you need to run on a different port, it's best to terminate SSL using another web proxy and forward your traffic.")]),e._v(" "),t("h2",{attrs:{id:"can-i-offload-https-termination"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#can-i-offload-https-termination"}},[e._v("#")]),e._v(" Can I offload HTTPS termination?")]),e._v(" "),t("p",[e._v("Yes. Please "),t("RouterLink",{attrs:{to:"/FAQ/FAQ-Deployment/#can-i-use-an-existing-nginx-server-as-a-reverse-proxy-with-ssl-termination"}},[e._v("see the documentation")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"how-can-i-back-up-my-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-back-up-my-btcpay-server"}},[e._v("#")]),e._v(" How can I back up my BTCPay Server?")]),e._v(" "),t("p",[e._v("See the "),t("RouterLink",{attrs:{to:"/Docker/backup-restore/"}},[e._v("Backup & Restore")]),e._v(" guide in our documentation.")],1),e._v(" "),t("details",[t("summary",[e._v("For backwards compatibility: Click here for the description of the old backup.sh process")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Please consider switching to the "),t("RouterLink",{attrs:{to:"/Docker/backup-restore/"}},[e._v("new Backup & Restore process")]),e._v(", because the "),t("code",[e._v("backup.sh")]),e._v(" will not be maintained anymore.")],1)]),e._v(" "),t("p",[e._v("We provide a backup script that dumps the database and saves the important files:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v('/btcpayserver-docker"')]),e._v("\n./backup.sh\n")])])]),t("p",[e._v("This will save the backup locally as "),t("code",[e._v("/var/lib/docker/volumes/backup_datadir/_data/backup.tar.gz")]),e._v(".\nThese are the options to customize the backup name and location:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("BACKUP_TIMESTAMP=true")]),e._v(" saves the backup with datetime as part of the file name, so that backups do not get overwritten.")]),e._v(" "),t("li",[t("code",[e._v("BACKUP_PROVIDER=SCP")]),e._v(" saves the backup remotely, requires additional "),t("code",[e._v("SCP_TARGET")]),e._v(" environment variable (see below).")]),e._v(" "),t("li",[t("code",[e._v("BACKUP_PROVIDER=Dropbox")]),e._v(" saves the backup to Dropbox, requires additional "),t("code",[e._v("DROPBOX_TOKEN")]),e._v(" environment variable (see below).")])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v('/btcpayserver-docker"')]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Backup with custom file name and timestamp:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BACKUP_TIMESTAMP")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("true ./backup.sh\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Backup via SCP:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BACKUP_PROVIDER")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("SCP "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("SCP_TARGET")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("myhost:backups/btcpay ./backup.sh\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Backup to Dropbox:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BACKUP_PROVIDER")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("Dropbox "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("DROPBOX_TOKEN")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("myDropboxToken ./backup.sh\n")])])]),t("p",[e._v("You can also choose to only dump the database.\nThis option does not need to stop and restart the docker-containers:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v('/btcpayserver-docker"')]),e._v("\n./backup.sh --only-db\n")])])])]),e._v(" "),t("h2",{attrs:{id:"how-can-i-connect-to-the-database"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-connect-to-the-database"}},[e._v("#")]),e._v(" How can I connect to the database?")]),e._v(" "),t("p",[e._v("On the server you can open a database session by connecting via "),t("code",[e._v("psql")]),e._v(" as the postgres user:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("exec")]),e._v(" -ti "),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("ps")]),e._v(" -a -q -f "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"name=postgres_1"')]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(" psql -U postgres\n")])])]),t("p",[e._v("Then, inside "),t("code",[e._v("psql")]),e._v(" you can select a database and interact with the tables:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# list databases")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("l\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# connect to database")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("c btcpayservermainnet\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# list tables")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("dt\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# list users")]),e._v("\nSELECT "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Id"')]),e._v(", "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Email"')]),e._v(" FROM "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"AspNetUsers"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# end session")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("q\n")])])]),t("p",[e._v("The main BTCPay Server database tables are part of the "),t("code",[e._v("public")]),e._v(" schema.\nPlugins have their own schema, named after the plugin.")]),e._v(" "),t("p",[e._v("By default, only the tables of the "),t("code",[e._v("public")]),e._v(" schema are shown.\nIf you want to also see and select the plugin tables, you need to extend the search path:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# list plugin schemas")]),e._v("\nSELECT * FROM pg_catalog.pg_namespace WHERE nspname LIKE "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'BTCPayServer.%'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# extend search path")]),e._v("\nSET search_path TO "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"BTCPayServer.Plugins.MyPlugin"')]),e._v(", public"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# table list now also shows the MyPlugin tables")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("dt\n")])])]),t("h2",{attrs:{id:"how-do-i-upgrade-my-btcpay-server-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-do-i-upgrade-my-btcpay-server-docker"}},[e._v("#")]),e._v(" How do I upgrade my BTCPay Server docker?")]),e._v(" "),t("p",[e._v("Run the script "),t("code",[e._v("./btcpay-update.sh")]),e._v(" and patiently wait for your server to be upgraded.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[110],{728:function(e,t,r){"use strict";r.r(t);var a=r(9),n=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"introduction"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),t("p",[e._v("While "),t("RouterLink",{attrs:{to:"/LunaNodeWebDeployment/"}},[e._v("our instructions")]),e._v(" cover how to install BTCPayServer in one click on Azure or Lunanode, BTCPay Server is not limited to those options.")],1),e._v(" "),t("p",[e._v("You will find below information about how you can install BTCPay Server easily in any environment having docker available.")]),e._v(" "),t("h1",{attrs:{id:"architecture"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#architecture"}},[e._v("#")]),e._v(" Architecture")]),e._v(" "),t("figure",[t("img",{attrs:{src:"https://github.com/btcpayserver/btcpayserver-doc/raw/master/docs/img/Architecture.png",alt:"Architecture",title:"Architecture"}})]),e._v(" "),t("p",[e._v("As you can see, BTCPay depends on several pieces of infrastructure, mainly:")]),e._v(" "),t("ul",[t("li",[e._v("A lightweight block explorer (NBXplorer),")]),e._v(" "),t("li",[e._v("A database (PostgreSQL),")]),e._v(" "),t("li",[e._v("A full node (eg. Bitcoin Core)")])]),e._v(" "),t("p",[e._v("There can be more dependencies if you support more than just standard Bitcoin transactions, including:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/ElementsProject/lightning",target:"_blank",rel:"noopener noreferrer"}},[e._v("Core Lightning (CLN)"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/litecoin-project/litecoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("LitecoinD"),t("OutboundLink")],1),e._v(" and other coin daemons")]),e._v(" "),t("li",[e._v("And more...")])]),e._v(" "),t("p",[e._v("Note: The setup process can be time consuming, but is heavily automated to make it a fun and easy experience.")]),e._v(" "),t("p",[e._v("Take a look at how BTCPay works in a video below.")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/nr0UNbz3AoQ/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=nr0UNbz3AoQ",title:"YouTube","data-id":"nr0UNbz3AoQ"}},[t("iframe",{attrs:{title:"YouTube","data-src":"https://www.youtube-nocookie.com/embed/nr0UNbz3AoQ?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("p",[e._v("Here is a presentation of the global architecture at Advancing Bitcoin conference.")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/Up0dvorzSNM/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=Up0dvorzSNM",title:"BTCPay - Architecture overview","data-id":"Up0dvorzSNM"}},[t("iframe",{attrs:{title:"BTCPay - Architecture overview","data-src":"https://www.youtube-nocookie.com/embed/Up0dvorzSNM?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("h1",{attrs:{id:"full-installation-for-technical-users"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#full-installation-for-technical-users"}},[e._v("#")]),e._v(" Full installation (for technical users)")]),e._v(" "),t("p",[e._v("You can also install BTCPay Server on your own machine or VPS instance.")]),e._v(" "),t("p",[e._v("The officially supported setup is driven by Docker (and Docker-Compose).")]),e._v(" "),t("p",[e._v("First, make sure you have a domain name pointing to your host "),t("code",[e._v("A record")]),e._v(", with ports "),t("code",[e._v("443")]),e._v(" and "),t("code",[e._v("80")]),e._v(" externally accessible. For Lightning Network, port "),t("code",[e._v("9735")]),e._v(" is required ("),t("code",[e._v("9736")]),e._v(" if you use Litecoin Lightning). Otherwise, you will have to set a domain manually by running "),t("code",[e._v("changedomain.sh")]),e._v(".")]),e._v(" "),t("p",[e._v("Let's assume your domain is "),t("code",[e._v("btcpay.EXAMPLE.com")]),e._v(".")]),e._v(" "),t("p",[e._v("The setup below assumes you want to support Bitcoin, Core Lightning (CLN), HTTPS automatically configured by Nginx. It also enables node pruning, which you can "),t("a",{attrs:{href:"#generated-docker-compose"}},[e._v("modify")]),e._v(" or ignore if you have enough disk space for a full node. Finally, your domain is "),t("code",[e._v("btcpay.EXAMPLE.com")]),e._v(" should reflect your actual domain name.")]),e._v(" "),t("p",[t("a",{attrs:{href:"#environment-variables"}},[e._v("Environment variables")]),e._v(" can be tailored to your needs. Some variables require additional storage space.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Login as root")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Create a folder for BTCPay")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkdir")]),e._v(" BTCPayServer\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" BTCPayServer\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Clone this repository")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" clone https://github.com/btcpayserver/btcpayserver-docker\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Run btcpay-setup.sh with the right parameters")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_HOST")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btcpay.EXAMPLE.com"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("NBITCOIN_NETWORK")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"mainnet"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO1")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btc"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"opt-save-storage-s"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_REVERSEPROXY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"nginx"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_LIGHTNING")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"clightning"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_ENABLE_SSH")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("true\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("exit")]),e._v("\n")])])]),t("p",[t("code",[e._v("btcpay-setup.sh")]),e._v(" will then:")]),e._v(" "),t("ul",[t("li",[e._v("Install Docker")]),e._v(" "),t("li",[e._v("Install Docker-Compose")]),e._v(" "),t("li",[e._v("Make sure BTCPay starts at reboot via upstart or systemd")]),e._v(" "),t("li",[e._v("Setup environment variables to use BTCPay utilities")]),e._v(" "),t("li",[e._v("Add BTCPay utilities in /usr/bin")]),e._v(" "),t("li",[e._v("Start BTCPay Server")])]),e._v(" "),t("p",[e._v("Video below guides you step by step on how to set up BTCPay Server on a VPS with Docker.")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/x6hqTFgHqhA/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=x6hqTFgHqhA",title:"YouTube","data-id":"x6hqTFgHqhA"}},[t("iframe",{attrs:{title:"YouTube","data-src":"https://www.youtube-nocookie.com/embed/x6hqTFgHqhA?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("p",[e._v("Check out this video if you're interested in learning more about setting up "),t("a",{attrs:{href:"https://www.youtube.com/playlist?list=PLH4m2oS2ratfaprAFx9E3ZDjwxNKvCk4e",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay with Docker Compose"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("figure",[t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/btcpayserver/",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.shields.io/docker/automated/btcpayserver/btcpayserver.svg",alt:"Docker automated build",title:"Docker automated build"}}),t("OutboundLink")],1)]),e._v(" "),t("h1",{attrs:{id:"environment-variables"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#environment-variables"}},[e._v("#")]),e._v(" Environment variables")]),e._v(" "),t("p",[t("code",[e._v("btcpay-setup.sh")]),e._v(" will use the following environment variables:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("BTCPAY_HOST")]),e._v(": The hostname of your website (eg. "),t("code",[e._v("btcpay.example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAY_ADDITIONAL_HOSTS")]),e._v(": Optional, specify additional domains to your BTCPayServer with https support if enabled. (eg. example2.com,example3.com)")]),e._v(" "),t("li",[t("code",[e._v("REVERSEPROXY_HTTP_PORT")]),e._v(": The public port the reverse proxy binds to for HTTP traffic (default: 80)")]),e._v(" "),t("li",[t("code",[e._v("REVERSEPROXY_HTTPS_PORT")]),e._v(": The public port the reverse proxy binds to for HTTPS traffic (default: 443)")]),e._v(" "),t("li",[t("code",[e._v("REVERSEPROXY_DEFAULT_HOST")]),e._v(": Optional, if using a reverse proxy nginx, specify which website should be presented if the server is accessed by its IP or by an unrecognized domain name.")]),e._v(" "),t("li",[t("code",[e._v("NOREVERSEPROXY_HTTP_PORT")]),e._v(": Optional, if not using a reverse proxy, specify which port should be opened for HTTP traffic. (default: 80)")]),e._v(" "),t("li",[t("code",[e._v("NBITCOIN_NETWORK")]),e._v(": The type of network to use (eg. "),t("code",[e._v("mainnet")]),e._v(", "),t("code",[e._v("testnet")]),e._v(", or "),t("code",[e._v("regtest")]),e._v(". Default: "),t("code",[e._v("mainnet")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("LIGHTNING_ALIAS")]),e._v(": An alias for your lightning network node, if used")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_CRYPTO1")]),e._v(": First supported crypto currency (eg. "),t("code",[e._v("btc")]),e._v(", "),t("code",[e._v("ltc")]),e._v(". Default: "),t("code",[e._v("btc")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_CRYPTO2")]),e._v(": Second supported crypto currency (eg. "),t("code",[e._v("btc")]),e._v(", "),t("code",[e._v("ltc")]),e._v(". Default: "),t("code",[e._v("(empty)")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_CRYPTON")]),e._v(": N'th supported crypto currency where N is 9 at maximum. (eg. "),t("code",[e._v("btc")]),e._v(", "),t("code",[e._v("ltc")]),e._v(". Default: "),t("code",[e._v("(empty)")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_REVERSEPROXY")]),e._v(": Specify reverse proxy to use; NGinx has HTTPS support. (eg. "),t("code",[e._v("nginx")]),e._v(", "),t("code",[e._v("traefik")]),e._v(", "),t("code",[e._v("(empty)")]),e._v(". Default: "),t("code",[e._v("nginx")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_LIGHTNING")]),e._v(": Lightning network implementation to use (eg. "),t("code",[e._v("clightning")]),e._v(", "),t("code",[e._v("lnd")]),e._v(", Default: "),t("code",[e._v("(empty)")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_SUBNAME")]),e._v(": The subname of the generated docker-compose file, where the full name is "),t("code",[e._v("Generated/docker-compose.SUBNAME.yml")]),e._v(" (Default: "),t("code",[e._v("generated")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(": Semicolon-separated list of additional fragments you want to use (eg. "),t("code",[e._v("opt-save-storage")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("LETSENCRYPT_EMAIL")]),e._v(": An email will be sent to this address if certificate expires and fails to renew automatically (eg. "),t("code",[e._v("me@example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("ACME_CA_URI")]),e._v(": The API endpoint to ask for HTTPS certificate (Default: "),t("code",[e._v("production")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("BTCPAY_ENABLE_SSH")]),e._v(": Optional, gives BTCPay Server SSH access to the host by allowing it to edit authorized_keys of the host, it can be used for managing the authorized_keys or updating BTCPay Server directly through the website. (Default: false)")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_DOCKER_IMAGE")]),e._v(": Optional, Specify which generator image to use if you have customized the C# generator. Set to "),t("code",[e._v("btcpayserver/docker-compose-generator:local")]),e._v(" to build the generator locally at runtime.")]),e._v(" "),t("li",[t("code",[e._v("BTCPAY_IMAGE")]),e._v(": Optional, Specify which btcpayserver image to use if you have a customized btcpayserver.")]),e._v(" "),t("li",[t("code",[e._v("BTCPAYGEN_EXCLUDE_FRAGMENTS")]),e._v(": Semicolon-separated list of fragments you want to forcefully exclude (eg. "),t("code",[e._v("litecoin-clightning")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("TOR_RELAY_NICKNAME")]),e._v(": If tor relay is activated with opt-add-tor-relay, the relay nickname")]),e._v(" "),t("li",[t("code",[e._v("TOR_RELAY_EMAIL")]),e._v(": If tor relay is activated with opt-add-tor-relay, the email for Tor to contact you regarding your relay")])]),e._v(" "),t("p",[e._v("Additionally, there are specific environment variables for some addons:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("LIBREPATRON_HOST")]),e._v(": If libre patron is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-librepatron.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-librepatron"),t("OutboundLink")],1),e._v(", the hostname of your libre patron website (eg. "),t("code",[e._v("librepatron.example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("ZAMMAD_HOST")]),e._v(": If zammad is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-zammad.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-zammad"),t("OutboundLink")],1),e._v(", the hostname of your zammad website (eg. "),t("code",[e._v("zammad.example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("WOOCOMMERCE_HOST")]),e._v(": If woocommerce is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-woocommerce.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-woocommerce"),t("OutboundLink")],1),e._v(", the hostname of your woocommerce website (eg. "),t("code",[e._v("store.example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("EPS_XPUB")]),e._v(": If Electrum Personal Server (EPS) is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-electrum-ps.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-electrum-ps"),t("OutboundLink")],1),e._v(", you must set the Extended Public Key (XPUB, YPUB or ZPUB) of the wallet you want to use, before first run of the EPS server. If you accidently start EPS without this, it will not work properly as the model of EPS is to monitor only specified wallets.")]),e._v(" "),t("li",[e._v("If Bitcoin Wallet Tracker is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-bwt.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-bwt"),t("OutboundLink")],1),e._v(", you can use "),t("code",[e._v("BWT_XPUB")]),e._v("/"),t("code",[e._v("BWT_XPUB_*")]),e._v(" (to set your XPUB/YPUB/ZPUB), "),t("code",[e._v("BWT_DESCRIPTOR")]),e._v("/"),t("code",[e._v("BWT_DESCRIPTOR_*")]),e._v(" (for script descriptors), "),t("code",[e._v("BWT_RESCAN_SINCE")]),e._v(" (set to the wallet creation date in YYYY-MM-DD to speed up the rescan), "),t("code",[e._v("BWT_BITCOIND_WALLET")]),e._v(" and "),t("code",[e._v("BWT_GAP_LIMIT")]),e._v(".")]),e._v(" "),t("li",[t("code",[e._v("LND_WTCLIENT_SWEEP_FEE")]),e._v(": If LND watchtower is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-wtclient.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-wtclient"),t("OutboundLink")],1),e._v(", you can use "),t("code",[e._v("LND_WTCLIENT_SWEEP_FEE")]),e._v(" to change the sweep fee used in constructing the justice transaction (default is 10 sat/byte)")]),e._v(" "),t("li",[t("code",[e._v("FIREFLY_HOST")]),e._v(": If fireflyiii is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-fireflyiii.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-fireflyiii"),t("OutboundLink")],1),e._v(", the hostname of your fireflyiii website (eg. "),t("code",[e._v("firefly.example.com")]),e._v(")")]),e._v(" "),t("li",[t("code",[e._v("CLOUDFLARE_TUNNEL_TOKEN")]),e._v(": Used to expose your instance to clearnet with a Cloudflare Argo Tunnel (if cloudflare tunnel is activated with "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-cloudflared.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-cloudflared"),t("OutboundLink")],1),e._v(", for setup instructions "),t("RouterLink",{attrs:{to:"/Docker/cloudflare-tunnel/"}},[e._v("see documentation")]),e._v(")")],1)]),e._v(" "),t("h1",{attrs:{id:"tooling"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tooling"}},[e._v("#")]),e._v(" Tooling")]),e._v(" "),t("p",[e._v("A wide variety of useful scripts are available once BTCPay is installed:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("bitcoin-cli.sh")]),e._v(": Access your Bitcoin node instance (for RPC)")]),e._v(" "),t("li",[t("code",[e._v("bitcoin-lightning-cli.sh")]),e._v(": Access your CLN node instance (for RPC)")]),e._v(" "),t("li",[t("code",[e._v("changedomain.sh")]),e._v(": Change the domain of your BTCPayServer (remember to disable 2FA/U2F first, as you risk being unable to log in to your account)")]),e._v(" "),t("li",[t("code",[e._v("btcpay-update.sh")]),e._v(": Update BTCPayServer to the latest version")]),e._v(" "),t("li",[t("code",[e._v("btcpay-up.sh")]),e._v(": Run "),t("code",[e._v("docker-compose up")])]),e._v(" "),t("li",[t("code",[e._v("btcpay-down.sh")]),e._v(": Run "),t("code",[e._v("docker-compose down")])]),e._v(" "),t("li",[t("code",[e._v("btcpay-setup.sh")]),e._v(": Change the settings of your server")]),e._v(" "),t("li",[t("code",[e._v("btcpay-clean.sh")]),e._v(": Purge any unused docker images")]),e._v(" "),t("li",[t("code",[e._v(". ./btcpay-setup.sh")]),e._v(": Information about additional parameters")]),e._v(" "),t("li",[t("code",[e._v(". ./btcpay-setup.sh -i")]),e._v(": Set up your BTCPayServer")]),e._v(" "),t("li",[t("code",[e._v("btcpay-restart.sh")]),e._v(": Restart your BTCPayServer")])]),e._v(" "),t("h1",{attrs:{id:"under-the-hood"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#under-the-hood"}},[e._v("#")]),e._v(" Under the hood")]),e._v(" "),t("h2",{attrs:{id:"generated-docker-compose"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#generated-docker-compose"}},[e._v("#")]),e._v(" Generated docker-compose")]),e._v(" "),t("p",[e._v("When you run "),t("code",[e._v("btcpay-setup.sh")]),e._v(", your environment variables are used by "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/build.sh",target:"_blank",rel:"noopener noreferrer"}},[e._v("build.sh"),t("OutboundLink")],1),e._v(" (or "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/build.ps1",target:"_blank",rel:"noopener noreferrer"}},[e._v("build.ps1"),t("OutboundLink")],1),e._v(") to generate a docker-compose adapted for your needs. For the full list of options, see: "),t("a",{attrs:{href:"#environment-variables"}},[e._v("Environment variables")])]),e._v(" "),t("p",[e._v("By default, the generated file is "),t("code",[e._v("Generated/docker-compose.generated.yml")]),e._v(", constructed from the relevant "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments",target:"_blank",rel:"noopener noreferrer"}},[e._v("Docker fragments"),t("OutboundLink")],1),e._v(" for your setup.")]),e._v(" "),t("p",[e._v("Available "),t("code",[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(" currently are:")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-storage.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-storage"),t("OutboundLink")],1),e._v(" will keep around 1 year of blocks (prune BTC for 100 GB)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-storage-s.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-storage-s"),t("OutboundLink")],1),e._v(" will keep around 6 months of blocks (prune BTC for 50 GB)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-storage-xs.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-storage-xs"),t("OutboundLink")],1),e._v(" will keep around 3 months of blocks (prune BTC for 25 GB)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-storage-xxs.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-storage-xxs"),t("OutboundLink")],1),e._v(" will keep around 2 weeks of blocks (prune BTC for 5 GB) (lightning not supported)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-autocompact",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-autocompact"),t("OutboundLink")],1),e._v(" will activate auto compacting of LND database.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-autopilot.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-autopilot"),t("OutboundLink")],1),e._v(" will activate auto pilot on LND. (5 channels, 60% of allocation)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-keysend.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-keysend"),t("OutboundLink")],1),e._v(" will activate keysend on LND.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-wtclient.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-wtclient"),t("OutboundLink")],1),e._v(" will activate the watchtower client on LND. "),t("code",[e._v("LND_WTCLIENT_SWEEP_FEE")]),e._v(" can be used to override the default 10 sat/byte justice transaction fee")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-lnd-watchtower.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-lnd-watchtower"),t("OutboundLink")],1),e._v(" will activate the LND watchtower RPC")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-memory.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-memory"),t("OutboundLink")],1),e._v(" will decrease the default dbcache at the expense of longer synchronization time. (Useful if your machine is less than 2GB)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-more-memory.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-more-memory"),t("OutboundLink")],1),e._v(" will increase the default dbcache to make synchronization faster (Useful if your machine is has around 4GB)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-btcqbo.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-btcqbo"),t("OutboundLink")],1),e._v(" will allow you to create an invoice on Quickbooks which include a way for your customer to pay on BTCPay Server (More information on this "),t("a",{attrs:{href:"https://github.com/JeffVandrewJr/btcqbo/",target:"_blank",rel:"noopener noreferrer"}},[e._v("github repository"),t("OutboundLink")],1),e._v(", this add-on is maintained by "),t("a",{attrs:{href:"https://github.com/JeffVandrewJr",target:"_blank",rel:"noopener noreferrer"}},[e._v("JeffVandrewJr"),t("OutboundLink")],1),e._v(", see more on "),t("a",{attrs:{href:"https://www.youtube.com/watch?v=srgwL9ozg6c",target:"_blank",rel:"noopener noreferrer"}},[e._v("this video"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-librepatron.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-librepatron"),t("OutboundLink")],1),e._v(", for a self-hosted Patreon alternative backed by BTCPay (More information on this "),t("a",{attrs:{href:"https://github.com/JeffVandrewJr/patron",target:"_blank",rel:"noopener noreferrer"}},[e._v("github repository"),t("OutboundLink")],1),e._v(", this add-on is maintained by "),t("a",{attrs:{href:"https://github.com/JeffVandrewJr",target:"_blank",rel:"noopener noreferrer"}},[e._v("JeffVandrewJr"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-woocommerce.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-woocommerce"),t("OutboundLink")],1),e._v(", for a self-hosted woocommerce with BTCPay Server plugin pre installed.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-tor.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-tor"),t("OutboundLink")],1),e._v(", for exposing BTCPayServer, Woocommerce, your lightning nodes as hidden services and accept onion peers for your full node. Warning: This options is for working around NAT and firewall problems as well as to help protect your customer's privacy. This will not protect your privacy against a targeted attack against you.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-btctransmuter.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-btctransmuter"),t("OutboundLink")],1),e._v(", for a self-hosted IFTTT style service for crypto services such as fiat settlement. (More information on this "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcTransmuter/",target:"_blank",rel:"noopener noreferrer"}},[e._v("github repository"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-txindex.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-txindex"),t("OutboundLink")],1),e._v(", to enable txindex=1 in bitcoin.conf if you require txindexing for Bisq, DOJO, etc.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-expose-unsafe.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-expose-unsafe"),t("OutboundLink")],1),e._v(", to unsafely expose bitcoind P2P port 8333 if you require P2P for Bisq, DOJO, Esplora, etc. WARNING: ONLY USE ON TRUSTED LAN OR WITH FIREWALL RULES WHITELISTING SPECIFIC HOSTS")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-tor-relay.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-tor-relay"),t("OutboundLink")],1),e._v(", for a non-exit tor relay. Make sure to have port 9001 accessible externally. "),t("a",{attrs:{href:"https://community.torproject.org/relay/community-resources/eff-tor-legal-faq",target:"_blank",rel:"noopener noreferrer"}},[e._v("Please read the legal implications of running a tor relay"),t("OutboundLink")],1),e._v(" and "),t("a",{attrs:{href:"https://trac.torproject.org/projects/tor/wiki/TorRelayGuide#RelayRequirements",target:"_blank",rel:"noopener noreferrer"}},[e._v("what resources are used to operate the relay"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-electrumx.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-electrumx"),t("OutboundLink")],1),e._v(", to integrate a full ElectrumX server (from official source) with BTCPay, using the BTCPay server's full bitcoin node for complete privacy when using your own Electrum wallet. You can also open port 50002 up to the internet on your router etc, to be part of the ElectrumX network, helping other Electrum wallet users to get connected. The bitcoin option "),t("code",[e._v("-txindex")]),e._v(" is mandatory for ElectrumX, and this fragment will enable it on your BTCPay server automatically - No need to use the fragment opt-txindex.yml.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-electrum-ps.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-electrum-ps"),t("OutboundLink")],1),e._v(", to integrate Electrum Personal Server (EPS) with BTCPay (EPS is a single-user alternative to the ElectrumX Server option above). EPS will also use the BTCPay server's full bitcoin node for complete privacy when using your own Electrum wallet, for your own personal use (i.e. other users cannot use your server to verify transactions). Also, the bitcoin option "),t("code",[e._v("-txindex")]),e._v(" is NOT mandatory for EPS, and it will run on a pruned node (unlike ElectrumX). You will need to add your XPUB/YPUB/ZPUB as environment variable "),t("code",[e._v("EPS_XPUB")]),e._v(" before enabling EPS for the first time (see above section on environment variables, and see "),t("RouterLink",{attrs:{to:"/ElectrumPersonalServer/"}},[e._v("full documentation")]),e._v(" for details).")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-bwt.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-electrum-bwt"),t("OutboundLink")],1),e._v(", to integrate the "),t("a",{attrs:{href:"https://github.com/bwt-dev/bwt",target:"_blank",rel:"noopener noreferrer"}},[e._v("Bitcoin Wallet Tracker"),t("OutboundLink")],1),e._v(" Electrum server, which uses a personal wallet index model similar to that of EPS. You will need to set "),t("code",[e._v("BWT_XPUB")]),e._v(" with your XPUB/YPUB/ZPUB (see environment variables section). The server will only be available locally and through an onion service.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-configurator.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-configurator"),t("OutboundLink")],1),e._v(", to integrate the "),t("a",{attrs:{href:"https://install.btcpayserver.org",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay Server Configurator"),t("OutboundLink")],1),e._v(" to manage your BTCPay deployment through a UI, and to allow new deployments elsewhere easily.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-pihole.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-pihole"),t("OutboundLink")],1),e._v(" ("),t("RouterLink",{attrs:{to:"/Docker/pihole/"}},[e._v("See the documentation")]),e._v(")")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-bluewallet-lndhub.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-bluewallet-lndhub"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/BlueWallet/LndHub",target:"_blank",rel:"noopener noreferrer"}},[e._v("Bluewallet LNDHub"),t("OutboundLink")],1),e._v(" - Use non-custodial LND Lightning directly from your Bluewallet, and freely let others open accounts on your node. Fragment maintained by "),t("a",{attrs:{href:"https://github.com/maltokyo",target:"_blank",rel:"noopener noreferrer"}},[e._v("maltokyo"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-ndlc.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-ndlc"),t("OutboundLink")],1),e._v(" ("),t("RouterLink",{attrs:{to:"/Docker/ndlc/"}},[e._v("See the documentation")]),e._v(")")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-lightning-terminal.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-lightning-terminal"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/lightninglabs/lightning-terminal",target:"_blank",rel:"noopener noreferrer"}},[e._v("Lightning Terminal/LiT"),t("OutboundLink")],1),e._v(". Maintained by "),t("a",{attrs:{href:"https://github.com/dennisreimann",target:"_blank",rel:"noopener noreferrer"}},[e._v("dennisreimann"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-mempool.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-mempool"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/mempool/mempool",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mempool"),t("OutboundLink")],1),e._v(". Maintained by "),t("a",{attrs:{href:"https://github.com/dennisreimann",target:"_blank",rel:"noopener noreferrer"}},[e._v("dennisreimann"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-sphinxrelay.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-sphinxrelay"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/stakwork/sphinx-relay",target:"_blank",rel:"noopener noreferrer"}},[e._v("Sphinx Relay"),t("OutboundLink")],1),e._v(". Maintained by "),t("a",{attrs:{href:"https://github.com/dennisreimann",target:"_blank",rel:"noopener noreferrer"}},[e._v("dennisreimann"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-tallycoin-connect.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-tallycoin-connect"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/djbooth007/tallycoin_connect",target:"_blank",rel:"noopener noreferrer"}},[e._v("Tallycoin Connect"),t("OutboundLink")],1),e._v(". Maintained by "),t("a",{attrs:{href:"https://github.com/dennisreimann",target:"_blank",rel:"noopener noreferrer"}},[e._v("dennisreimann"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-thunderhub.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-thunderhub"),t("OutboundLink")],1),e._v(" for a LND Lightning Node Manager in your Browser. Maintained by "),t("a",{attrs:{href:"https://github.com/apotdevin",target:"_blank",rel:"noopener noreferrer"}},[e._v("apotdevin"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-teos.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-teos"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/talaia-labs/python-teos",target:"_blank",rel:"noopener noreferrer"}},[e._v("The Eye Of Satoshi"),t("OutboundLink")],1),e._v(", a BOLT13 Lightning Watchtower. Use port 9814 on your server or Tor to connect.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-chatwoot.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-chatwoot"),t("OutboundLink")],1),e._v(" for open source chat support system. ("),t("RouterLink",{attrs:{to:"/Docker/chatwoot/"}},[e._v("See the documentation")]),e._v(")")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-zammad.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-zammad"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://zammad.com/features",target:"_blank",rel:"noopener noreferrer"}},[e._v("Zammad"),t("OutboundLink")],1),e._v(", a web based open source helpdesk/customer support system with many features to manage customer communication via several channels like telephone, facebook, twitter, chat and e-mails")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-monero-expose.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-monero-expose"),t("OutboundLink")],1),e._v(" to expose monero node's RPC port at 127.0.0.1:18081 to connect your own wallet. Use f.e. ssh port forwarding to forward to your own computer.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-fireflyiii.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-fireflyiii"),t("OutboundLink")],1),e._v(" ("),t("RouterLink",{attrs:{to:"/Docker/fireflyiii/"}},[e._v("See the documentation")]),e._v(")")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-joinmarket.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-joinmarket"),t("OutboundLink")],1),e._v(" ("),t("RouterLink",{attrs:{to:"/Docker/joinmarket/"}},[e._v("See the documentation")]),e._v(")")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-helipad.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-helipad"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/Podcastindex-org/helipad",target:"_blank",rel:"noopener noreferrer"}},[e._v("Podcastindex.org Helipad"),t("OutboundLink")],1),e._v(". Requires LND.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-nostr-relay.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-nostr-relay"),t("OutboundLink")],1),e._v(" for "),t("a",{attrs:{href:"https://github.com/kukks/Nnostr",target:"_blank",rel:"noopener noreferrer"}},[e._v("Nostr Relay"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-cloudflared.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-cloudflared"),t("OutboundLink")],1),e._v(" to expose your local server on clearnet painlessly ("),t("RouterLink",{attrs:{to:"/Docker/cloudflare-tunnel/"}},[e._v("see documentation")]),e._v(").")],1),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-torq.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-torq"),t("OutboundLink")],1),e._v(" to install "),t("a",{attrs:{href:"https://github.com/lncapital/torq",target:"_blank",rel:"noopener noreferrer"}},[e._v("Torq"),t("OutboundLink")],1),e._v(" node management application. Requires LND.")])]),e._v(" "),t("p",[e._v("You can also create your own "),t("a",{attrs:{href:"#how-can-i-customize-the-generated-docker-compose-file"}},[e._v("custom fragments")]),e._v(".")]),e._v(" "),t("p",[e._v("If you want to add an option to "),t("code",[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(" and re-configure your install:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(';opt-lnd-autopilot"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" btcpay-setup.sh -i\n")])])]),t("p",[e._v("For example, if you want "),t("code",[e._v("btc")]),e._v(" and "),t("code",[e._v("ltc")]),e._v(" support with "),t("code",[e._v("nginx")]),e._v(" and "),t("code",[e._v("clightning")]),e._v(" inside "),t("code",[e._v("Generated/docker-compose.custom.yml")]),e._v(":")]),e._v(" "),t("p",[e._v("Note: The first run might take a while, but following runs are instantaneous.")]),e._v(" "),t("p",[e._v("On Windows (run in "),t("a",{attrs:{href:"https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell",target:"_blank",rel:"noopener noreferrer"}},[e._v("powershell"),t("OutboundLink")],1),e._v("):")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("Invoke-Command")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("{")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_CRYPTO1")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btc"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_CRYPTO2")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ltc"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_REVERSEPROXY")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"nginx"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_LIGHTNING")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"clightning"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_SUBNAME")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"custom"')]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("\\build"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("ps1\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("}")]),e._v("\n")])])]),t("p",[e._v("On Linux:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO1")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btc"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO2")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"ltc"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_REVERSEPROXY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"nginx"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_LIGHTNING")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"clightning"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_SUBNAME")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"custom"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("\n./build.sh\n")])])]),t("p",[e._v("Next, you will need to configure the runtime environment variables for "),t("code",[e._v("Generated/docker-compose.custom.yml")]),e._v(":")]),e._v(" "),t("ul",[t("li",[e._v("If you are using NGinx, "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/Production/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("read this"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("li",[e._v("If you are not using NGinx, "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/Production-NoReverseProxy/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("read this instead"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("h2",{attrs:{id:"again-what-does-btcpay-setupsh-do"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#again-what-does-btcpay-setupsh-do"}},[e._v("#")]),e._v(" Again, what does "),t("code",[e._v("btcpay-setup.sh")]),e._v(" do?")]),e._v(" "),t("p",[t("code",[e._v("btcpay-setup.sh")]),e._v(" is a utility which does the following:")]),e._v(" "),t("ol",[t("li",[e._v("Makes sure docker and docker-compose are installed on your system")]),e._v(" "),t("li",[e._v("Generates a docker-compose via "),t("code",[e._v("./build.sh")])]),e._v(" "),t("li",[e._v("Sets up an "),t("a",{attrs:{href:"https://docs.docker.com/compose/env-file/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Environment File"),t("OutboundLink")],1),e._v(" to configure your docker-compose")]),e._v(" "),t("li",[e._v("Sets up environment variables so the tools described in "),t("a",{attrs:{href:"#tooling"}},[e._v("Tooling")]),e._v(" can work")]),e._v(" "),t("li",[e._v("Adds symlinks of those tools into "),t("code",[e._v("/usr/bin")])]),e._v(" "),t("li",[e._v("Makes sure BTCPay restarts on reboot via upstart or systemd")]),e._v(" "),t("li",[e._v("Starts BTCPay via docker-compose")])]),e._v(" "),t("h2",{attrs:{id:"overview-of-files-generated-by-btcpay-setupsh"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#overview-of-files-generated-by-btcpay-setupsh"}},[e._v("#")]),e._v(" Overview of files generated by "),t("code",[e._v("btcpay-setup.sh")])]),e._v(" "),t("p",[t("code",[e._v("/etc/profile.d/btcpay-env.sh")]),e._v(" ensures that your environment variables are correctly setup when you login, so you can use the tools:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_OLD_PREGEN")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"false"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO1")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btc"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO2")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO3")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO4")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO5")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO6")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO7")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO8")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO9")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_LIGHTNING")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"clightning"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_REVERSEPROXY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"nginx"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_DOCKER_COMPOSE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/var/lib/waagent/custom-script/download/0/btcpayserver-docker/Production/docker-compose.generated.yml"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_BASE_DIRECTORY")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/var/lib/waagent/custom-script/download/0"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_ENV_FILE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/var/lib/waagent/custom-script/download/0/.env"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAY_HOST_SSHKEYFILE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/root/.ssh/id_rsa_btcpay"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("if")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cat")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_ENV_FILE")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("&>")]),e._v(" /dev/null"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("then")]),e._v("\n "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" -v "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'^#'")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_ENV_FILE")]),e._v('"')]),e._v(" "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("xargs")]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("fi")]),e._v("\n")])])]),t("p",[t("code",[e._v("/etc/systemd/system/btcpayserver.service")]),e._v(" ensures that you can control btcpay via "),t("code",[e._v("systemctl")]),e._v(", and that BTCPayServer starts on reboot:")]),e._v(" "),t("div",{staticClass:"language-ini extra-class"},[t("pre",{pre:!0,attrs:{class:"language-ini"}},[t("code",[t("span",{pre:!0,attrs:{class:"token section"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token section-name selector"}},[e._v("Unit")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("Description")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("BTCPayServer service")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("After")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("docker.service network-online.target")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("Requires")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("docker.service network-online.target")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token section"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token section-name selector"}},[e._v("Service")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("Type")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("oneshot")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("RemainAfterExit")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("yes")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("ExecStart")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("/bin/bash -c '. /etc/profile.d/btcpay-env.sh && cd \"$BTCPAY_BASE_DIRECTORY/btcpayserver-docker\" && . helpers.sh && btcpay_up'")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("ExecStop")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("/bin/bash -c '. /etc/profile.d/btcpay-env.sh && cd \"$BTCPAY_BASE_DIRECTORY/btcpayserver-docker\" && . helpers.sh && btcpay_down'")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("ExecReload")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("/bin/bash -c '. /etc/profile.d/btcpay-env.sh && cd \"$BTCPAY_BASE_DIRECTORY/btcpayserver-docker\" && . helpers.sh && btcpay_restart'")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token section"}},[t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("[")]),t("span",{pre:!0,attrs:{class:"token section-name selector"}},[e._v("Install")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("]")])]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("WantedBy")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("multi-user.target")]),e._v("\n")])])]),t("p",[t("code",[e._v(".env")]),e._v(" ("),t("code",[e._v("$BTCPAY_ENV_FILE")]),e._v(") contains environment variables passed to the containers managed by your docker-compose:")]),e._v(" "),t("div",{staticClass:"language-ini extra-class"},[t("pre",{pre:!0,attrs:{class:"language-ini"}},[t("code",[t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("BTCPAY_HOST")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("btcpay.EXAMPLE.com")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("ACME_CA_URI")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("production")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("NBITCOIN_NETWORK")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("mainnet")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("LETSENCRYPT_EMAIL")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("me@EXAMPLE.com")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("BTCPAY_SSHTRUSTEDFINGERPRINTS")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("SHA256:eSCD7NtQ/Q6IBl2iRB9caAQ3lDZd8s8iUL6SdeNnhpA")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("BTCPAY_SSHKEYFILE")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("/datadir/id_rsa")]),e._v("\n")])])]),t("h1",{attrs:{id:"how-can-i-add-an-altcoin-to-btcpayserver"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-add-an-altcoin-to-btcpayserver"}},[e._v("#")]),e._v(" How can I add an altcoin to BTCPayServer?")]),e._v(" "),t("ol",[t("li",[e._v("Add support for your crypto to "),t("a",{attrs:{href:"https://github.com/MetacoSA/NBitcoin/tree/master/NBitcoin.Altcoins",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBitcoin"),t("OutboundLink")],1),e._v(", "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBxplorer"),t("OutboundLink")],1),e._v(", and "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPayServer"),t("OutboundLink")],1),e._v(". (Use examples from other coins)")]),e._v(" "),t("li",[e._v("Create your own docker image ("),t("a",{attrs:{href:"https://hub.docker.com/r/nicolasdorier/docker-bitcoin/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Create a docker-compose fragment ("),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/bitcoin.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Add your "),t("code",[e._v("CryptoDefinition")]),e._v(" ("),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/src/CryptoDefinition.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v(")")])]),e._v(" "),t("p",[t("code",[e._v("build.sh")]),e._v(" is using a pre-built image of the "),t("code",[e._v("docker-compose generator")]),e._v(" on "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/docker-compose-generator/",target:"_blank",rel:"noopener noreferrer"}},[e._v("docker hub"),t("OutboundLink")],1),e._v(".\nIf you modify the code source of "),t("code",[e._v("docker-compose generator")]),e._v(" (for example, the "),t("code",[e._v("CryptoDefinition")]),e._v(" "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/src/CryptoDefinition.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("Example for BTC"),t("OutboundLink")],1),e._v("), you need to configure "),t("code",[e._v("build.sh")]),e._v(" to use your own image by setting the environment variable "),t("code",[e._v("BTCPAYGEN_DOCKER_IMAGE")]),e._v(" to "),t("code",[e._v("btcpayserver/docker-compose-generator:local")]),e._v(".")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" docker-compose-generator\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_DOCKER_IMAGE")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btcpayserver/docker-compose-generator:local"')]),e._v("\n")])])]),t("p",[e._v("Or on powershell:")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[e._v("cd docker-compose-generator\n"),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_DOCKER_IMAGE")]),e._v("="),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"btcpayserver/docker-compose-generator:local"')]),e._v("\n")])])]),t("p",[e._v("Then run "),t("code",[e._v("./build.sh")]),e._v(" or "),t("code",[e._v(". .\\build.ps1")]),e._v(".\nThis will generate your docker-compose in the "),t("code",[e._v("Generated")]),e._v(" folder, which you can then run and test.")]),e._v(" "),t("p",[e._v("Note that BTCPayServer developers will not spend excessive time testing your image, so make sure it works.")]),e._v(" "),t("h1",{attrs:{id:"support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#support"}},[e._v("#")]),e._v(" Support")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Image")]),e._v(" "),t("th",[e._v("Version")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("x64")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("arm32v7")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("arm64v8")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("links")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("btcpayserver/docker-compose-generator")]),e._v(" "),t("td",[e._v("latest")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-docker/dcg-latest/docker-compose-generator/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-docker/dcg-latest/docker-compose-generator/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-docker/dcg-latest/docker-compose-generator/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/docker-compose-generator",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/docker-compose")]),e._v(" "),t("td",[e._v("1.28.6")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/docker-compose/1.28.6/docker-compose/1.28.6/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/docker-compose/1.28.6/docker-compose/1.28.6/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/docker-compose/1.28.6/docker-compose/1.28.6/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/docker-compose",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/lightning")]),e._v(" "),t("td",[e._v("v23.08")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lightning/basedon-v23.08/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lightning/basedon-v23.08/contrib/docker/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lightning/basedon-v23.08/contrib/docker/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/lightning",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/lightning",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("saubyk/c-lightning-rest")]),e._v(" "),t("td",[e._v("0.10.6")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/c-lightning-REST/v0.10.6/amd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/c-lightning-REST/v0.10.6/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/c-lightning-REST/v0.10.6/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Ride-The-Lightning/c-lightning-REST",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/saubyk/c-lightning-rest",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("shahanafarooqui/rtl")]),e._v(" "),t("td",[e._v("0.14.1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/RTL/v0.14.1/dockerfiles/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/RTL/v0.14.1/dockerfiles/Dockerfile.arm32v7",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Ride-The-Lightning/RTL/v0.14.1/dockerfiles/Dockerfile.arm64v8",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Ride-The-Lightning/RTL",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/shahanafarooqui/rtl",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/lnd")]),e._v(" "),t("td",[e._v("v0.16.4-beta-1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lnd/basedon-v0.16.4-beta-1/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lnd/basedon-v0.16.4-beta-1/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/lnd/basedon-v0.16.4-beta-1/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/lnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/lnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/bitcoin")]),e._v(" "),t("td",[e._v("25.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Bitcoin/25.0/Bitcoin/25.0/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Bitcoin/25.0/Bitcoin/25.0/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Bitcoin/25.0/Bitcoin/25.0/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/bitcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/btcpayserver")]),e._v(" "),t("td",[e._v("1.11.7$?")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver/v1.11.7/amd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver/v1.11.7/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver/v1.11.7/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/monero")]),e._v(" "),t("td",[e._v("0.18.3.1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Monero/0.18.3.1/Monero/0.18.3.1/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Monero/0.18.3.1/Monero/0.18.3.1/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Monero/0.18.3.1/Monero/0.18.3.1/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/monero",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("nicolasdorier/nbxplorer")]),e._v(" "),t("td",[e._v("2.3.66")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/nbxplorer/v2.3.66/Dockerfile.linuxamd64",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/nbxplorer/v2.3.66/Dockerfile.linuxarm32v7",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/nbxplorer/v2.3.66/Dockerfile.linuxarm64v8",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/dgarage/nbxplorer",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/nicolasdorier/nbxplorer",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/letsencrypt-nginx-proxy-companion")]),e._v(" "),t("td",[e._v("1.12.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-letsencrypt-nginx-proxy-companion/v1.12.2/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-letsencrypt-nginx-proxy-companion/v1.12.2/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-letsencrypt-nginx-proxy-companion/v1.12.2/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/docker-letsencrypt-nginx-proxy-companion",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/letsencrypt-nginx-proxy-companion",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("nginx")]),e._v(" "),t("td",[e._v("1.23.3")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/nginxinc/docker-nginx/1.23.2/stable/debian/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/nginxinc/docker-nginx/1.23.2/stable/debian/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/nginxinc/docker-nginx/1.23.2/stable/debian/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/nginxinc/docker-nginx",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/_/nginx",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/docker-gen")]),e._v(" "),t("td",[e._v("0.7.8")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-gen/v0.7.8/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-gen/v0.7.8/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/docker-gen/v0.7.8/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/docker-gen",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/docker-gen",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/btctransmuter")]),e._v(" "),t("td",[e._v("0.0.59")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btctransmuter/v0.0.59/Dockerfiles/amd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btctransmuter/v0.0.59/Dockerfiles/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btctransmuter/v0.0.59/Dockerfiles/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/btctransmuter",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/btctransmuter",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/cloudflared")]),e._v(" "),t("td",[e._v("2023.7.3")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Cloudflared/2023.7.3/Cloudflared/2023.7.3/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Cloudflared/2023.7.3/Cloudflared/2023.7.3/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Cloudflared/2023.7.3/Cloudflared/2023.7.3/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/cloudflared",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/btcpayserver-configurator")]),e._v(" "),t("td",[e._v("0.0.21")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-configurator/v0.0.21/Dockerfiles/amd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-configurator/v0.0.21/Dockerfiles/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/btcpayserver-configurator/v0.0.21/Dockerfiles/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-configurator",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/btcpayserver-configurator",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/eps")]),e._v(" "),t("td",[e._v("0.2.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/EPS/0.2.2/EPS/0.2.2/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/EPS/0.2.2/EPS/0.2.2/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/EPS/0.2.2/EPS/0.2.2/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/eps",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/joinmarket")]),e._v(" "),t("td",[e._v("0.9.5")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/JoinMarket/0.9.5/JoinMarket/0.9.5/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/JoinMarket/0.9.5/JoinMarket/0.9.5/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/JoinMarket/0.9.5/JoinMarket/0.9.5/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/joinmarket",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("nicolasdorier/ndlc-cli")]),e._v(" "),t("td",[e._v("1.0.1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/ndlc/releases/1.0.1/amd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/ndlc/releases/1.0.1/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dgarage/ndlc/releases/1.0.1/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/dgarage/ndlc",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/nicolasdorier/ndlc-cli",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("pihole/pihole")]),e._v(" "),t("td",[e._v("2023.05.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/pi-hole/docker-pi-hole/2023.05.2/src/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/pi-hole/docker-pi-hole/2023.05.2/src/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/pi-hole/docker-pi-hole/2023.05.2/src/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/pi-hole/docker-pi-hole",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/pihole/pihole",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/tor")]),e._v(" "),t("td",[e._v("0.4.7.10")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Tor/0.4.7.10/Tor/0.4.7.10/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Tor/0.4.7.10/Tor/0.4.7.10/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Tor/0.4.7.10/Tor/0.4.7.10/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/tor",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/woocommerce")]),e._v(" "),t("td",[e._v("3.1.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/WooCommerce/3.1.0/WooCommerce/3.1.0/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/WooCommerce/3.1.0/WooCommerce/3.1.0/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/woocommerce",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/postgres")]),e._v(" "),t("td",[e._v("13.10")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Postgres/13.10/Postgres/13.10/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Postgres/13.10/Postgres/13.10/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Postgres/13.10/Postgres/13.10/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/postgres",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("kamigawabul/btglnd")]),e._v(" "),t("td",[e._v("latest")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/vutov/lnd/master/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/vutov/lnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/kamigawabul/btglnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("kamigawabul/docker-bitcoingold")]),e._v(" "),t("td",[e._v("0.15.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Vutov/docker-bitcoin/master/bitcoingold/0.15.2/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Vutov/docker-bitcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/kamigawabul/docker-bitcoingold",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("acinq/eclair")]),e._v(" "),t("td",[e._v("release-0.7.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/ACINQ/eclair/v0.7.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/ACINQ/eclair",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/acinq/eclair",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("chekaz/docker-bitcoinplus")]),e._v(" "),t("td",[e._v("2.7.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/ChekaZ/docker/master/bitcoinplus/2.7.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/ChekaZ/docker",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/chekaz/docker-bitcoinplus",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("dalijolijo/docker-bitcore")]),e._v(" "),t("td",[e._v("0.90.9.10")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/dalijolijo/btcpayserver-docker-bitcore/master/docker-bitcored/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/dalijolijo/btcpayserver-docker-bitcore",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/dalijolijo/docker-bitcore",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/dash")]),e._v(" "),t("td",[e._v("19.2.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Dash/19.2.0/Dash/19.2.0/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Dash/19.2.0/Dash/19.2.0/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/dash",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/dogecoin")]),e._v(" "),t("td",[e._v("1.14.6")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Dogecoin/1.14.6/Dogecoin/1.14.6/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/dogecoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("chekaz/docker-feathercoin")]),e._v(" "),t("td",[e._v("0.16.3")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/ChekaZ/docker/master/feathercoin/0.16.3/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/ChekaZ/docker",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/chekaz/docker-feathercoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("groestlcoin/lightning")]),e._v(" "),t("td",[e._v("v23.05")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Groestlcoin/lightning/v23.05/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Groestlcoin/lightning",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/groestlcoin/lightning",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("groestlcoin/groestlcoin-lightning-charge")]),e._v(" "),t("td",[e._v("version-0.4.22")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Groestlcoin/groestlcoin-lightning-charge/v0.4.22/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Groestlcoin/groestlcoin-lightning-charge",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/groestlcoin/groestlcoin-lightning-charge",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("groestlcoin/groestlcoin-spark")]),e._v(" "),t("td",[e._v("version-0.2.16")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Groestlcoin/groestlcoin-spark/v0.2.16/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Groestlcoin/groestlcoin-spark",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/groestlcoin/groestlcoin-spark",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("groestlcoin/eclair")]),e._v(" "),t("td",[e._v("v0.6.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Groestlcoin/eclair/v0.6.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Groestlcoin/eclair",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/groestlcoin/eclair",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("groestlcoin/lnd")]),e._v(" "),t("td",[e._v("v0.10.0-grs")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Groestlcoin/lnd/v0.10.0-grs/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Groestlcoin/lnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/groestlcoin/lnd",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/groestlcoin")]),e._v(" "),t("td",[e._v("25.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Groestlcoin/25.0/Groestlcoin/25.0/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Groestlcoin/25.0/Groestlcoin/25.0/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Groestlcoin/25.0/Groestlcoin/25.0/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/groestlcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/elements")]),e._v(" "),t("td",[e._v("22.1.1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Elements/22.1.1/Elements/22.1.1/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Elements/22.1.1/Elements/22.1.1/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Elements/22.1.1/Elements/22.1.1/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/elements",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("btcpayserver/litecoin")]),e._v(" "),t("td",[e._v("0.21.2.1-2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Litecoin/0.21.2.1-2/Litecoin/0.21.2.1/linuxamd64.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Litecoin/0.21.2.1-2/Litecoin/0.21.2.1/linuxarm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/btcpayserver/dockerfile-deps/Litecoin/0.21.2.1-2/Litecoin/0.21.2.1/linuxarm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/btcpayserver/dockerfile-deps",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/btcpayserver/litecoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("wakiyamap/docker-monacoin")]),e._v(" "),t("td",[e._v("0.20.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/wakiyamap/docker-bitcoin/master/monacoin/0.20.2/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/wakiyamap/docker-bitcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/wakiyamap/docker-monacoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("redis")]),e._v(" "),t("td",[e._v("6.2.2-buster")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/docker-library/redis/f1a8498333ae3ab340b5b39fbac1d7e1dc0d628c/5.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/docker-library/redis",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/_/redis",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("bluewalletorganization/lndhub")]),e._v(" "),t("td",[e._v("v1.4.1")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/BlueWallet/LndHub/v1.4.1/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/BlueWallet/LndHub/v1.4.1/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/BlueWallet/LndHub/v1.4.1/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/BlueWallet/LndHub",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/bluewalletorganization/lndhub",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("jvandrew/btcqbo")]),e._v(" "),t("td",[e._v("0.3.36")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/JeffVandrewJr/btcqbo/v0.3.36/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/JeffVandrewJr/btcqbo",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/jvandrew/btcqbo",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("shesek/bwt")]),e._v(" "),t("td",[e._v("0.2.2-electrum")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/bwt-dev/bwt/v0.2.2/docker/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/bwt-dev/bwt/v0.2.2/docker/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/bwt-dev/bwt/v0.2.2/docker/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/bwt-dev/bwt",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/shesek/bwt",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("chatwoot/chatwoot")]),e._v(" "),t("td",[e._v("v1.7.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/chatwoot/chatwoot/v1.7.0/docker/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/chatwoot/chatwoot/v1.7.0/docker/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/chatwoot/chatwoot/v1.7.0/docker/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/chatwoot/chatwoot",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/chatwoot/chatwoot",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("lukechilds/electrumx")]),e._v(" "),t("td",[e._v("latest")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lukechilds/docker-electrumx/master/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/lukechilds/docker-electrumx",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/lukechilds/electrumx",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("fireflyiii/core")]),e._v(" "),t("td",[e._v("latest")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://dev.azure.com/Firefly-III/66fb773b-063e-42d7-b6a5-e7729a22e8b3/_apis/git/repositories/e9c3dcf8-4533-4ef1-83cc-75527cab3377/items?path=%2FDockerfile&versionDescriptor%5BversionOptions%5D=0&versionDescriptor%5BversionType%5D=0&versionDescriptor%5Bversion%5D=main&resolveLfs=true&%24format=octetStream&api-version=5.0&download=true",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://dev.azure.com/Firefly-III/66fb773b-063e-42d7-b6a5-e7729a22e8b3/_apis/git/repositories/e9c3dcf8-4533-4ef1-83cc-75527cab3377/items?path=%2FDockerfile&versionDescriptor%5BversionOptions%5D=0&versionDescriptor%5BversionType%5D=0&versionDescriptor%5Bversion%5D=main&resolveLfs=true&%24format=octetStream&api-version=5.0&download=true",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://dev.azure.com/Firefly-III/66fb773b-063e-42d7-b6a5-e7729a22e8b3/_apis/git/repositories/e9c3dcf8-4533-4ef1-83cc-75527cab3377/items?path=%2FDockerfile&versionDescriptor%5BversionOptions%5D=0&versionDescriptor%5BversionType%5D=0&versionDescriptor%5Bversion%5D=main&resolveLfs=true&%24format=octetStream&api-version=5.0&download=true",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://dev.azure.com/Firefly-III/_git/MainImage",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/fireflyiii/core",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("podcastindexorg/podcasting20-helipad")]),e._v(" "),t("td",[e._v("v0.1.10")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Podcastindex-org/helipad/v0.1.10/umbrel/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Podcastindex-org/helipad/v0.1.10/umbrel/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/Podcastindex-org/helipad/v0.1.10/umbrel/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/Podcastindex-org/helipad",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/podcastindexorg/podcasting20-helipad",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("jvandrew/librepatron")]),e._v(" "),t("td",[e._v("0.7.39")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/JeffVandrewJr/patron/v0.7.39/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/JeffVandrewJr/patron",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/jvandrew/librepatron",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("jvandrew/isso")]),e._v(" "),t("td",[e._v("atron.22")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/JeffVandrewJr/isso/patron.22/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/JeffVandrewJr/isso",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/jvandrew/isso",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("lightninglabs/lightning-terminal")]),e._v(" "),t("td",[e._v("v0.9.2-alpha-path-prefix")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lightninglabs/lightning-terminal/v0.9.2-alpha/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lightninglabs/lightning-terminal/v0.9.2-alpha/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/lightninglabs/lightning-terminal",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/lightninglabs/lightning-terminal",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("mempool/frontend")]),e._v(" "),t("td",[e._v("v2.5.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/frontend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/frontend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/frontend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/mempool/mempool",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/mempool/frontend",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("mempool/backend")]),e._v(" "),t("td",[e._v("v2.5.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/backend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/backend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/mempool/mempool/v2.5.0/docker/backend/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/mempool/mempool",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/mempool/backend",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("mariadb")]),e._v(" "),t("td",[e._v("10.11")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/docker-library/mariadb/master/10.11/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/docker-library/mariadb",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/_/mariadb",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("kukks/nnostr-relay")]),e._v(" "),t("td",[e._v("v0.0.17")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/kukks/nnostr/Relay/v0.0.17/Relay/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/kukks/nnostr/Relay/v0.0.17/Relay/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/kukks/nnostr/Relay/v0.0.17/Relay/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/kukks/nnostr",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/kukks/nnostr-relay",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("sphinxlightning/sphinx-relay")]),e._v(" "),t("td",[e._v("v2.2.9")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/stakwork/sphinx-relay/v2.2.9/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/stakwork/sphinx-relay/v2.2.9/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/stakwork/sphinx-relay/v2.2.9/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/stakwork/sphinx-relay",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/sphinxlightning/sphinx-relay",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("djbooth007/tallycoin_connect")]),e._v(" "),t("td",[e._v("v1.8.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/djbooth007/tallycoin_connect/v1.8.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/djbooth007/tallycoin_connect/v1.8.0/Dockerfile.arm32v7",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/djbooth007/tallycoin_connect/v1.8.0/Dockerfile.arm64v8",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/djbooth007/tallycoin_connect",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/djbooth007/tallycoin_connect",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("talaia/python-teos")]),e._v(" "),t("td",[e._v("latest")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/talaia-labs/python-teos/master/docker/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/talaia-labs/python-teos/master/docker/arm32v7.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/talaia-labs/python-teos/master/docker/arm64v8.Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/talaia-labs/python-teos",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/talaia/python-teos",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("apotdevin/thunderhub")]),e._v(" "),t("td",[e._v("base-v0.13.21")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/apotdevin/thunderhub/v0.13.21/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/apotdevin/thunderhub/v0.13.21/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/apotdevin/thunderhub/v0.13.21/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/apotdevin/thunderhub",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/apotdevin/thunderhub",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("lncapital/torq")]),e._v(" "),t("td",[e._v("0.20.3")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lncapital/torq/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lncapital/torq/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/lncapital/torq/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/lncapital/torq",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/lncapital/torq",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("timescale/timescaledb")]),e._v(" "),t("td",[e._v("latest-pg14")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/timescale/timescaledb-docker/main/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/timescale/timescaledb-docker/main/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/timescale/timescaledb-docker/main/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/timescale/timescaledb-docker",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/timescale/timescaledb",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("zammad/zammad-docker-compose")]),e._v(" "),t("td",[e._v("zammad-postgresql-3.4.0-4")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/zammad/zammad-docker-compose/ff20084ce2829486076e9781fe27407ca6cc09bb/containers/zammad-postgresql/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/zammad/zammad-docker-compose",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/zammad/zammad-docker-compose",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("memcached")]),e._v(" "),t("td",[e._v("1.5.22-alpine")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/docker-library/memcached/eb38bf28263b8e5bb7367797cb7b181b65d769bd/alpine/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/docker-library/memcached",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/_/memcached",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("traefik")]),e._v(" "),t("td",[e._v("v2.6")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/containous/traefik-library-image/master/scratch/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/containous/traefik-library-image",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/_/traefik",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("chekaz/docker-trezarcoin")]),e._v(" "),t("td",[e._v("0.13.0")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/ChekaZ/docker/master/trezarcoin/1.2.0/Dockerfile",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/ChekaZ/docker",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/chekaz/docker-trezarcoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])]),e._v(" "),t("tr",[t("td",[e._v("romanornr/docker-viacoin")]),e._v(" "),t("td",[e._v("0.15.2")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://raw.githubusercontent.com/viacoin/docker-viacoin/master/viacoin/0.15.2/docker-viacoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("✔️"),t("OutboundLink")],1)]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("️❌")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[t("a",{attrs:{href:"https://github.com/viacoin/docker-viacoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github"),t("OutboundLink")],1),e._v(" - "),t("a",{attrs:{href:"https://hub.docker.com/r/romanornr/docker-viacoin",target:"_blank",rel:"noopener noreferrer"}},[e._v("DockerHub"),t("OutboundLink")],1)])])])]),e._v(" "),t("h1",{attrs:{id:"faq"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#faq"}},[e._v("#")]),e._v(" FAQ")]),e._v(" "),t("h2",{attrs:{id:"how-can-i-modify-my-environment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-modify-my-environment"}},[e._v("#")]),e._v(" How can I modify my environment?")]),e._v(" "),t("p",[e._v("As root, run "),t("code",[e._v(". btcpay-setup.sh")]),e._v("; this will show you the environment variable it is expecting.\nFor example, if you support "),t("code",[e._v("btc")]),e._v(" and "),t("code",[e._v("ltc")]),e._v(" already, and want to add "),t("code",[e._v("btg")]),e._v(":")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_CRYPTO3")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'btg'")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" btcpay-setup.sh -i\n")])])]),t("h2",{attrs:{id:"i-deployed-before-btcpay-setupsh-existed-before-may-17-2018-can-i-migrate-to-this-new-system"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#i-deployed-before-btcpay-setupsh-existed-before-may-17-2018-can-i-migrate-to-this-new-system"}},[e._v("#")]),e._v(" I deployed before "),t("code",[e._v("btcpay-setup.sh")]),e._v(" existed (before May 17, 2018), can I migrate to this new system?")]),e._v(" "),t("p",[e._v("Yes, run the following commands to update:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$DOWNLOAD_ROOT")]),e._v("/btcpayserver-docker\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" checkout master\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" pull\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" checkout 9acb5d8067cb5c46f59858137feb699b41ac9f19\nbtcpay-update.sh\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" checkout master\nbtcpay-update.sh\n\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("exit")]),e._v("\n")])])]),t("h2",{attrs:{id:"im-getting-an-error-on-windows-cannot-create-container-for-service-docker-mount-denied"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#im-getting-an-error-on-windows-cannot-create-container-for-service-docker-mount-denied"}},[e._v("#")]),e._v(" I'm getting an error on Windows: "),t("code",[e._v("Cannot create container for service docker: Mount denied")]),e._v("?")]),e._v(" "),t("p",[e._v("If you see this error:")]),e._v(" "),t("p",[t("code",[e._v("Cannot create container for service docker: b'Mount denied:\\nThe source path \"\\\\\\\\var\\\\\\\\run\\\\\\\\docker.sock:/var/run/docker.sock\"\\nis not a valid Windows path'")]),e._v(".")]),e._v(" "),t("p",[e._v("Run this in "),t("a",{attrs:{href:"https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell",target:"_blank",rel:"noopener noreferrer"}},[e._v("powershell"),t("OutboundLink")],1),e._v(":")]),e._v(" "),t("div",{staticClass:"language-powershell extra-class"},[t("pre",{pre:!0,attrs:{class:"language-powershell"}},[t("code",[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$Env")]),e._v(":COMPOSE_CONVERT_WINDOWS_PATHS=1\n")])])]),t("p",[e._v("Then, run "),t("code",[e._v("docker-compose -f EXAMPLE.yml up")]),e._v(".")]),e._v(" "),t("p",[e._v("This bug comes from Docker for Windows and is "),t("a",{attrs:{href:"https://github.com/docker/for-win/issues/1829",target:"_blank",rel:"noopener noreferrer"}},[e._v("tracked on Github"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"how-i-can-prune-my-nodes"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-i-can-prune-my-nodes"}},[e._v("#")]),e._v(" How I can prune my node(s)?")]),e._v(" "),t("p",[e._v("This will prune your Bitcoin full node to a maximum of 100GB (of blocks):")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"opt-save-storage"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n")])])]),t("p",[e._v("Other options are "),t("a",{attrs:{href:"#generated-docker-compose"}},[e._v("documented here")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"how-can-i-customize-the-generated-docker-compose-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-customize-the-generated-docker-compose-file"}},[e._v("#")]),e._v(" How can I customize the generated docker-compose file?")]),e._v(" "),t("p",[e._v("In some instances, you might want to customize your environment in more detail. While you could modify "),t("code",[e._v("Generated/docker-compose.generated.yml")]),e._v(" manually, your changes would be overwritten the next time you run "),t("code",[e._v("btcpay-update.sh")]),e._v(".")]),e._v(" "),t("p",[e._v("Luckily, you can leverage "),t("code",[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(" for this!")]),e._v(" "),t("p",[e._v("Let's enable "),t("strong",[e._v("pruning to 60 GB")]),e._v(", for example:")]),e._v(" "),t("p",[e._v("First, copy "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-save-storage.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-save-storage"),t("OutboundLink")],1),e._v(" into the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments",target:"_blank",rel:"noopener noreferrer"}},[e._v("the docker fragment folder"),t("OutboundLink")],1),e._v(" as "),t("code",[e._v("opt-save-storage.custom.yml")]),e._v(". "),t("strong",[e._v("Important:")]),e._v(" the file must end with "),t("code",[e._v(".custom.yml")]),e._v(", or there will be git conflicts whenever you run "),t("code",[e._v("btcpay-update.sh")]),e._v(".")]),e._v(" "),t("p",[e._v("Modify the new "),t("code",[e._v("opt-save-storage.custom.yml")]),e._v(" file to your taste:")]),e._v(" "),t("div",{staticClass:"language-diff extra-class"},[t("pre",{pre:!0,attrs:{class:"language-diff"}},[t("code",[e._v('@@ -14,8 +14,7 @@ version: "3"\n'),t("span",{pre:!0,attrs:{class:"token unchanged"}},[t("span",{pre:!0,attrs:{class:"token prefix unchanged"}},[e._v(" ")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v("services:\n")]),t("span",{pre:!0,attrs:{class:"token prefix unchanged"}},[e._v(" ")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(" bitcoind:\n")]),t("span",{pre:!0,attrs:{class:"token prefix unchanged"}},[e._v(" ")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(" environment:\n")])]),t("span",{pre:!0,attrs:{class:"token deleted-sign deleted"}},[t("span",{pre:!0,attrs:{class:"token prefix deleted"}},[e._v("-")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(" BITCOIN_EXTRA_ARGS: prune=100000\n")])]),t("span",{pre:!0,attrs:{class:"token inserted-sign inserted"}},[t("span",{pre:!0,attrs:{class:"token prefix inserted"}},[e._v("+")]),t("span",{pre:!0,attrs:{class:"token line"}},[e._v(" BITCOIN_EXTRA_ARGS: prune=60000\n")])])])])]),t("p",[e._v("Then set it up:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(';opt-save-storage.custom"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n")])])]),t("h2",{attrs:{id:"can-i-run-btcpay-server-on-ports-other-than-80-and-443"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#can-i-run-btcpay-server-on-ports-other-than-80-and-443"}},[e._v("#")]),e._v(" Can I run BTCPay Server on ports other than 80 and 443?")]),e._v(" "),t("p",[e._v("You can change the ports for HTTP and HTTPS by setting the environment variables "),t("code",[e._v("REVERSEPROXY_HTTP_PORT")]),e._v(" and "),t("code",[e._v("REVERSEPROXY_HTTPS_PORT")]),e._v(". This is handy when ports 80 and 443 are already in use on your host, or you want to offload SSL termination with an existing web proxy.")]),e._v(" "),t("p",[e._v("When you set "),t("code",[e._v("REVERSEPROXY_HTTP_PORT")]),e._v(" to another value than 80, the built-in Let's Encrypt certificate will not work, as Let's Encrypt will try to validate your SSL certificate request by connecting from the internet to your domain on port 80. This validation request should be able to reach BTCPay Server in order to receive the certificate.")]),e._v(" "),t("p",[e._v("If you need to run on a different port, it's best to terminate SSL using another web proxy and forward your traffic.")]),e._v(" "),t("h2",{attrs:{id:"can-i-offload-https-termination"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#can-i-offload-https-termination"}},[e._v("#")]),e._v(" Can I offload HTTPS termination?")]),e._v(" "),t("p",[e._v("Yes. Please "),t("RouterLink",{attrs:{to:"/FAQ/FAQ-Deployment/#can-i-use-an-existing-nginx-server-as-a-reverse-proxy-with-ssl-termination"}},[e._v("see the documentation")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"how-can-i-back-up-my-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-back-up-my-btcpay-server"}},[e._v("#")]),e._v(" How can I back up my BTCPay Server?")]),e._v(" "),t("p",[e._v("See the "),t("RouterLink",{attrs:{to:"/Docker/backup-restore/"}},[e._v("Backup & Restore")]),e._v(" guide in our documentation.")],1),e._v(" "),t("details",[t("summary",[e._v("For backwards compatibility: Click here for the description of the old backup.sh process")]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Please consider switching to the "),t("RouterLink",{attrs:{to:"/Docker/backup-restore/"}},[e._v("new Backup & Restore process")]),e._v(", because the "),t("code",[e._v("backup.sh")]),e._v(" will not be maintained anymore.")],1)]),e._v(" "),t("p",[e._v("We provide a backup script that dumps the database and saves the important files:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v('/btcpayserver-docker"')]),e._v("\n./backup.sh\n")])])]),t("p",[e._v("This will save the backup locally as "),t("code",[e._v("/var/lib/docker/volumes/backup_datadir/_data/backup.tar.gz")]),e._v(".\nThese are the options to customize the backup name and location:")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("BACKUP_TIMESTAMP=true")]),e._v(" saves the backup with datetime as part of the file name, so that backups do not get overwritten.")]),e._v(" "),t("li",[t("code",[e._v("BACKUP_PROVIDER=SCP")]),e._v(" saves the backup remotely, requires additional "),t("code",[e._v("SCP_TARGET")]),e._v(" environment variable (see below).")]),e._v(" "),t("li",[t("code",[e._v("BACKUP_PROVIDER=Dropbox")]),e._v(" saves the backup to Dropbox, requires additional "),t("code",[e._v("DROPBOX_TOKEN")]),e._v(" environment variable (see below).")])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v('/btcpayserver-docker"')]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Backup with custom file name and timestamp:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BACKUP_TIMESTAMP")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("true ./backup.sh\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Backup via SCP:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BACKUP_PROVIDER")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("SCP "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("SCP_TARGET")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("myhost:backups/btcpay ./backup.sh\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Backup to Dropbox:")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BACKUP_PROVIDER")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("Dropbox "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("DROPBOX_TOKEN")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("myDropboxToken ./backup.sh\n")])])]),t("p",[e._v("You can also choose to only dump the database.\nThis option does not need to stop and restart the docker-containers:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v('/btcpayserver-docker"')]),e._v("\n./backup.sh --only-db\n")])])])]),e._v(" "),t("h2",{attrs:{id:"how-can-i-connect-to-the-database"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-connect-to-the-database"}},[e._v("#")]),e._v(" How can I connect to the database?")]),e._v(" "),t("p",[e._v("On the server you can open a database session by connecting via "),t("code",[e._v("psql")]),e._v(" as the postgres user:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("exec")]),e._v(" -ti "),t("span",{pre:!0,attrs:{class:"token variable"}},[t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$(")]),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("ps")]),e._v(" -a -q -f "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"name=postgres_1"')]),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v(")")])]),e._v(" psql -U postgres\n")])])]),t("p",[e._v("Then, inside "),t("code",[e._v("psql")]),e._v(" you can select a database and interact with the tables:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# list databases")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("l\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# connect to database")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("c btcpayservermainnet\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# list tables")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("dt\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# list users")]),e._v("\nSELECT "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Id"')]),e._v(", "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Email"')]),e._v(" FROM "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"AspNetUsers"')]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# end session")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("q\n")])])]),t("p",[e._v("The main BTCPay Server database tables are part of the "),t("code",[e._v("public")]),e._v(" schema.\nPlugins have their own schema, named after the plugin.")]),e._v(" "),t("p",[e._v("By default, only the tables of the "),t("code",[e._v("public")]),e._v(" schema are shown.\nIf you want to also see and select the plugin tables, you need to extend the search path:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# list plugin schemas")]),e._v("\nSELECT * FROM pg_catalog.pg_namespace WHERE nspname LIKE "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v("'BTCPayServer.%'")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# extend search path")]),e._v("\nSET search_path TO "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"BTCPayServer.Plugins.MyPlugin"')]),e._v(", public"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(";")]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# table list now also shows the MyPlugin tables")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("\\")]),e._v("dt\n")])])]),t("h2",{attrs:{id:"how-do-i-upgrade-my-btcpay-server-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-do-i-upgrade-my-btcpay-server-docker"}},[e._v("#")]),e._v(" How do I upgrade my BTCPay Server docker?")]),e._v(" "),t("p",[e._v("Run the script "),t("code",[e._v("./btcpay-update.sh")]),e._v(" and patiently wait for your server to be upgraded.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/111.fe1f8b63.js b/assets/js/111.7ff5c256.js similarity index 99% rename from assets/js/111.fe1f8b63.js rename to assets/js/111.7ff5c256.js index 3e530bad50..f5e3c62f1c 100644 --- a/assets/js/111.fe1f8b63.js +++ b/assets/js/111.7ff5c256.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{730:function(e,t,a){"use strict";a.r(t);var s=a(9),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"backup-restore"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#backup-restore"}},[e._v("#")]),e._v(" Backup & Restore")]),e._v(" "),t("p",[e._v("This guide gets you up to speed with the "),t("RouterLink",{attrs:{to:"/Docker/"}},[e._v("Docker deployment")]),e._v("'s Backup & Restore process.\nYou will learn about what to keep in mind when doing a backup and how to restore a backup.")],1),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#remarks-and-considerations"}},[e._v("Remarks and Considerations")]),t("ul",[t("li",[t("a",{attrs:{href:"#lightning-channel-backup"}},[e._v("Lightning channel backup")])])])]),t("li",[t("a",{attrs:{href:"#how-does-the-backup-work"}},[e._v("How does the backup work?")]),t("ul",[t("li",[t("a",{attrs:{href:"#set-a-backup-passphrase"}},[e._v("Set a backup passphrase")])]),t("li",[t("a",{attrs:{href:"#automation-by-crontab"}},[e._v("Automation by crontab")])])])]),t("li",[t("a",{attrs:{href:"#how-to-restore"}},[e._v("How to restore?")])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"remarks-and-considerations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#remarks-and-considerations"}},[e._v("#")]),e._v(" Remarks and Considerations")]),e._v(" "),t("p",[e._v("The original backups strategy in BTCPay Server still exists and can be found "),t("RouterLink",{attrs:{to:"/Docker/#how-can-i-back-up-my-btcpay-server"}},[e._v("here")]),e._v(".\nWhile this documentation covers the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/pull/641",target:"_blank",rel:"noopener noreferrer"}},[e._v("new process"),t("OutboundLink")],1),e._v(", the old "),t("code",[e._v("backup.sh")]),e._v(" script still works.")],1),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("BTCPay Server is and will never be responsible for your backup.\nPlease make sure the backup includes the files and data you want to store.\nAlso, test the restore process before starting to rely on it.")])]),e._v(" "),t("h3",{attrs:{id:"lightning-channel-backup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#lightning-channel-backup"}},[e._v("#")]),e._v(" Lightning channel backup")]),e._v(" "),t("p",[e._v("Please be aware of this important issue:\nOld Lightning channel state is toxic!\nYou can lose all your funds if you close a channel based on an outdated state — and the state changes often!\nIf you publish an old state (say from yesterday's backup), you will most likely lose all your funds in the channel because the counterparty might publish a "),t("a",{attrs:{href:"https://www.d11n.net/lightning-network-payment-channel-lifecycle.html#what-happens-in-case-of-a-false-close%3F",target:"_blank",rel:"noopener noreferrer"}},[e._v("revocation transaction"),t("OutboundLink")],1),e._v("!")]),e._v(" "),t("p",[e._v("There is a high chance of failure in a disaster recovery scenario, where you may do a backup once per night and need to restore that one backup.")]),e._v(" "),t("p",[e._v("The Lightning channel backup from the "),t("code",[e._v("btcpay-backup.sh")]),e._v(" script will be sufficient in a migration case, where the shutdown of the old server happens cleanly.\nThe old server should not be started after the restoration and start of the new server.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("The Lightning static channel backup should be watched by a script and copied over to a remote server to ensure you always have the latest state available.\nWe will provide such a script with a future update.\nFor now, keep the above in mind when restoring from the backup!")])]),e._v(" "),t("h2",{attrs:{id:"how-does-the-backup-work"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-does-the-backup-work"}},[e._v("#")]),e._v(" How does the backup work?")]),e._v(" "),t("p",[e._v("The backup process is run with the "),t("code",[e._v("btcpay-backup.sh")]),e._v(" script.")]),e._v(" "),t("p",[e._v("Log in to your server, switch to the "),t("code",[e._v("root")]),e._v(" user and type the following:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# The backup script needs to be run as the root user")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# As the other scripts, it is inside the BTCPay base directory")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v("/btcpayserver-docker\n./btcpay-backup.sh\n")])])]),t("p",[e._v("The backup process needs to be run as "),t("code",[e._v("root")]),e._v(".\nIt will check for and let you know if you have to switch users.")]),e._v(" "),t("p",[e._v("The script will do the following steps:")]),e._v(" "),t("ul",[t("li",[e._v("Ensure the database container is running")]),e._v(" "),t("li",[e._v("Make a dump of the database")]),e._v(" "),t("li",[e._v("Stop BTCPay Server")]),e._v(" "),t("li",[e._v("Archive the Docker volumes and database dump\n"),t("ul",[t("li",[e._v("Excluding the blockchains "),t("code",[e._v("blocks")]),e._v(" and "),t("code",[e._v("chainstate")]),e._v(" directories")]),e._v(" "),t("li",[e._v("Optional: "),t("a",{attrs:{href:"#set-a-backup-passphrase"}},[e._v("Encrypt the archive")])])])]),e._v(" "),t("li",[e._v("Restart BTCPay Server")]),e._v(" "),t("li",[e._v("Cleanup: Remove temporary files like the database dump")])]),e._v(" "),t("p",[e._v("If the backup directory doesn't exist yet, the script will create it.\nWith these preparations taken, the backup process is now starting.")]),e._v(" "),t("p",[e._v("The script has checks to ensure it either works or fails with a comprehensive error message at every step of the way.\nIf there are errors, you will be notified like this:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("🚨 Database container could not be started or found.\n")])])]),t("p",[e._v("If everything works smoothly, you will see multiple completed marks in your console.\nWhenever the backup has completed successfully, it will state:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("✅ Backup done => /var/lib/docker/volumes/backup_datadir/_data/backup.tar.gz\n")])])]),t("p",[e._v("Your BTCPay Server has now finished the backup process.\nYou must store these backups safely, for instance, by copying them to a remote server.")]),e._v(" "),t("p",[e._v("After making a backup the first time, it is always wise to at least test your backup in a restore scenario.\nWe will go over the extra options you can set with your backup in the next topic.")]),e._v(" "),t("h3",{attrs:{id:"set-a-backup-passphrase"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-a-backup-passphrase"}},[e._v("#")]),e._v(" Set a backup passphrase")]),e._v(" "),t("p",[e._v("You can set the "),t("code",[e._v("BTCPAY_BACKUP_PASSPHRASE")]),e._v(" environment variable for encrypting the backup.\nThis passphrase will be used by the backup and restore scripts to encrypt and decrypt the backup file.\nFor the backup script, this would look like the following:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Set the passphrase without adding it to the shell history")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("read")]),e._v(" -s -p "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Enter passphrase: "')]),e._v(" BTCPAY_BACKUP_PASSPHRASE\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" BTCPAY_BACKUP_PASSPHRASE\n\n./btcpay-backup.sh\n")])])]),t("p",[e._v("This "),t("code",[e._v("BTCPAY_BACKUP_PASSPHRASE")]),e._v(" if set, is necessary to be in the "),t("a",{attrs:{href:"#how-to-restore"}},[e._v("restore process")]),e._v(" as well.")]),e._v(" "),t("h3",{attrs:{id:"automation-by-crontab"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#automation-by-crontab"}},[e._v("#")]),e._v(" Automation by crontab")]),e._v(" "),t("p",[e._v("Here is an example of a crontab script that does a nightly backup at 4:15 AM:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("SHELL=/bin/bash\nPATH=/bin:/usr/sbin:/usr/bin:/usr/local/bin\n15 4 * * * /root/BTCPayServer/btcpayserver-docker/btcpay-backup.sh >/dev/null 2>&1\n")])])]),t("p",[e._v("You need to set the right "),t("code",[e._v("SHELL")]),e._v(" and "),t("code",[e._v("PATH")]),e._v(", so that the script can run with the correct context.\nYou might also want to set the "),t("code",[e._v("BTCPAY_BACKUP_PASSPHRASE")]),e._v(" environment variable.")]),e._v(" "),t("p",[e._v("Also ensure the base path (here "),t("code",[e._v("/root/BTCPayServer")]),e._v(") matches the output of "),t("code",[e._v("echo $BTCPAY_BASE_DIRECTORY")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"how-to-restore"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-restore"}},[e._v("#")]),e._v(" How to restore?")]),e._v(" "),t("p",[e._v("It's very similar to the "),t("code",[e._v("btcpay-backup.sh")]),e._v(" process but in reverse.\nThe "),t("code",[e._v("btcpay-restore.sh")]),e._v(" script needs to be run with the path to your "),t("code",[e._v("backup.tar.gz")]),e._v(" file.")]),e._v(" "),t("p",[e._v("First off, open a terminal and type the following as root.\nRemember that if you set "),t("code",[e._v("BTCPAY_BACKUP_PASSPHRASE")]),e._v(" on the backup, you also need to provide it for decryption :")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# The restore script needs to be run as the root user")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# As the other scripts, it is inside the BTCPay base directory")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v("/btcpayserver-docker\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Optional: Set the passphrase if you have used one for the backup")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("read")]),e._v(" -s -p "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Enter passphrase: "')]),e._v(" BTCPAY_BACKUP_PASSPHRASE\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" BTCPAY_BACKUP_PASSPHRASE\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Run the restore script with the full path to the backup file")]),e._v("\n./btcpay-restore.sh /var/backups/backup.tar.gz.gpg\n")])])]),t("p",[e._v("The script will do the following steps:")]),e._v(" "),t("ul",[t("li",[e._v("Extract (and decrypt) the backup archive")]),e._v(" "),t("li",[e._v("Stop BTCPay Server")]),e._v(" "),t("li",[e._v("Restore the Docker volumes")]),e._v(" "),t("li",[e._v("Start the database container")]),e._v(" "),t("li",[e._v("Import the database dump")]),e._v(" "),t("li",[e._v("Restart BTCPay Server")]),e._v(" "),t("li",[e._v("Cleanup: Remove the temporary restore directory")])]),e._v(" "),t("p",[e._v("If the backup file cannot be found in the provided path, the script will exit with an error.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("🚨 /var/backups/backup.tar.gz.gpg does not exist.\n")])])]),t("p",[e._v("Just as the "),t("code",[e._v("btcpay-backup.sh")]),e._v(" script, the restore will stop at ANY error it may encounter.\nIf the backup file was created while the "),t("code",[e._v("BTCPAY_BACKUP_PASSPHRASE")]),e._v(" was set but not used on restoring, the following error would occur:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("🚨 Decryption failed. Please check the error message above.\n")])])]),t("p",[e._v("When the restore has completed, you get the message:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("✅ Restore done\n")])])]),t("p",[e._v("Everything should be up and running again when the restore is complete.\nYou've successfully restored your BTCPay Server. Congratulations!")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("Always make sure your backup strategy is tested and fits your needs.\nNo one solution fits all, and we tried to cover the basic cases.\nFor the latest updates, always feel free to ask on the BTCPay Server community channels.")])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[111],{729:function(e,t,a){"use strict";a.r(t);var s=a(9),r=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"backup-restore"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#backup-restore"}},[e._v("#")]),e._v(" Backup & Restore")]),e._v(" "),t("p",[e._v("This guide gets you up to speed with the "),t("RouterLink",{attrs:{to:"/Docker/"}},[e._v("Docker deployment")]),e._v("'s Backup & Restore process.\nYou will learn about what to keep in mind when doing a backup and how to restore a backup.")],1),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#remarks-and-considerations"}},[e._v("Remarks and Considerations")]),t("ul",[t("li",[t("a",{attrs:{href:"#lightning-channel-backup"}},[e._v("Lightning channel backup")])])])]),t("li",[t("a",{attrs:{href:"#how-does-the-backup-work"}},[e._v("How does the backup work?")]),t("ul",[t("li",[t("a",{attrs:{href:"#set-a-backup-passphrase"}},[e._v("Set a backup passphrase")])]),t("li",[t("a",{attrs:{href:"#automation-by-crontab"}},[e._v("Automation by crontab")])])])]),t("li",[t("a",{attrs:{href:"#how-to-restore"}},[e._v("How to restore?")])])])]),t("p"),e._v(" "),t("h2",{attrs:{id:"remarks-and-considerations"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#remarks-and-considerations"}},[e._v("#")]),e._v(" Remarks and Considerations")]),e._v(" "),t("p",[e._v("The original backups strategy in BTCPay Server still exists and can be found "),t("RouterLink",{attrs:{to:"/Docker/#how-can-i-back-up-my-btcpay-server"}},[e._v("here")]),e._v(".\nWhile this documentation covers the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/pull/641",target:"_blank",rel:"noopener noreferrer"}},[e._v("new process"),t("OutboundLink")],1),e._v(", the old "),t("code",[e._v("backup.sh")]),e._v(" script still works.")],1),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("BTCPay Server is and will never be responsible for your backup.\nPlease make sure the backup includes the files and data you want to store.\nAlso, test the restore process before starting to rely on it.")])]),e._v(" "),t("h3",{attrs:{id:"lightning-channel-backup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#lightning-channel-backup"}},[e._v("#")]),e._v(" Lightning channel backup")]),e._v(" "),t("p",[e._v("Please be aware of this important issue:\nOld Lightning channel state is toxic!\nYou can lose all your funds if you close a channel based on an outdated state — and the state changes often!\nIf you publish an old state (say from yesterday's backup), you will most likely lose all your funds in the channel because the counterparty might publish a "),t("a",{attrs:{href:"https://www.d11n.net/lightning-network-payment-channel-lifecycle.html#what-happens-in-case-of-a-false-close%3F",target:"_blank",rel:"noopener noreferrer"}},[e._v("revocation transaction"),t("OutboundLink")],1),e._v("!")]),e._v(" "),t("p",[e._v("There is a high chance of failure in a disaster recovery scenario, where you may do a backup once per night and need to restore that one backup.")]),e._v(" "),t("p",[e._v("The Lightning channel backup from the "),t("code",[e._v("btcpay-backup.sh")]),e._v(" script will be sufficient in a migration case, where the shutdown of the old server happens cleanly.\nThe old server should not be started after the restoration and start of the new server.")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("The Lightning static channel backup should be watched by a script and copied over to a remote server to ensure you always have the latest state available.\nWe will provide such a script with a future update.\nFor now, keep the above in mind when restoring from the backup!")])]),e._v(" "),t("h2",{attrs:{id:"how-does-the-backup-work"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-does-the-backup-work"}},[e._v("#")]),e._v(" How does the backup work?")]),e._v(" "),t("p",[e._v("The backup process is run with the "),t("code",[e._v("btcpay-backup.sh")]),e._v(" script.")]),e._v(" "),t("p",[e._v("Log in to your server, switch to the "),t("code",[e._v("root")]),e._v(" user and type the following:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# The backup script needs to be run as the root user")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# As the other scripts, it is inside the BTCPay base directory")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v("/btcpayserver-docker\n./btcpay-backup.sh\n")])])]),t("p",[e._v("The backup process needs to be run as "),t("code",[e._v("root")]),e._v(".\nIt will check for and let you know if you have to switch users.")]),e._v(" "),t("p",[e._v("The script will do the following steps:")]),e._v(" "),t("ul",[t("li",[e._v("Ensure the database container is running")]),e._v(" "),t("li",[e._v("Make a dump of the database")]),e._v(" "),t("li",[e._v("Stop BTCPay Server")]),e._v(" "),t("li",[e._v("Archive the Docker volumes and database dump\n"),t("ul",[t("li",[e._v("Excluding the blockchains "),t("code",[e._v("blocks")]),e._v(" and "),t("code",[e._v("chainstate")]),e._v(" directories")]),e._v(" "),t("li",[e._v("Optional: "),t("a",{attrs:{href:"#set-a-backup-passphrase"}},[e._v("Encrypt the archive")])])])]),e._v(" "),t("li",[e._v("Restart BTCPay Server")]),e._v(" "),t("li",[e._v("Cleanup: Remove temporary files like the database dump")])]),e._v(" "),t("p",[e._v("If the backup directory doesn't exist yet, the script will create it.\nWith these preparations taken, the backup process is now starting.")]),e._v(" "),t("p",[e._v("The script has checks to ensure it either works or fails with a comprehensive error message at every step of the way.\nIf there are errors, you will be notified like this:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("🚨 Database container could not be started or found.\n")])])]),t("p",[e._v("If everything works smoothly, you will see multiple completed marks in your console.\nWhenever the backup has completed successfully, it will state:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("✅ Backup done => /var/lib/docker/volumes/backup_datadir/_data/backup.tar.gz\n")])])]),t("p",[e._v("Your BTCPay Server has now finished the backup process.\nYou must store these backups safely, for instance, by copying them to a remote server.")]),e._v(" "),t("p",[e._v("After making a backup the first time, it is always wise to at least test your backup in a restore scenario.\nWe will go over the extra options you can set with your backup in the next topic.")]),e._v(" "),t("h3",{attrs:{id:"set-a-backup-passphrase"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#set-a-backup-passphrase"}},[e._v("#")]),e._v(" Set a backup passphrase")]),e._v(" "),t("p",[e._v("You can set the "),t("code",[e._v("BTCPAY_BACKUP_PASSPHRASE")]),e._v(" environment variable for encrypting the backup.\nThis passphrase will be used by the backup and restore scripts to encrypt and decrypt the backup file.\nFor the backup script, this would look like the following:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Set the passphrase without adding it to the shell history")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("read")]),e._v(" -s -p "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Enter passphrase: "')]),e._v(" BTCPAY_BACKUP_PASSPHRASE\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" BTCPAY_BACKUP_PASSPHRASE\n\n./btcpay-backup.sh\n")])])]),t("p",[e._v("This "),t("code",[e._v("BTCPAY_BACKUP_PASSPHRASE")]),e._v(" if set, is necessary to be in the "),t("a",{attrs:{href:"#how-to-restore"}},[e._v("restore process")]),e._v(" as well.")]),e._v(" "),t("h3",{attrs:{id:"automation-by-crontab"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#automation-by-crontab"}},[e._v("#")]),e._v(" Automation by crontab")]),e._v(" "),t("p",[e._v("Here is an example of a crontab script that does a nightly backup at 4:15 AM:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("SHELL=/bin/bash\nPATH=/bin:/usr/sbin:/usr/bin:/usr/local/bin\n15 4 * * * /root/BTCPayServer/btcpayserver-docker/btcpay-backup.sh >/dev/null 2>&1\n")])])]),t("p",[e._v("You need to set the right "),t("code",[e._v("SHELL")]),e._v(" and "),t("code",[e._v("PATH")]),e._v(", so that the script can run with the correct context.\nYou might also want to set the "),t("code",[e._v("BTCPAY_BACKUP_PASSPHRASE")]),e._v(" environment variable.")]),e._v(" "),t("p",[e._v("Also ensure the base path (here "),t("code",[e._v("/root/BTCPayServer")]),e._v(") matches the output of "),t("code",[e._v("echo $BTCPAY_BASE_DIRECTORY")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"how-to-restore"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-restore"}},[e._v("#")]),e._v(" How to restore?")]),e._v(" "),t("p",[e._v("It's very similar to the "),t("code",[e._v("btcpay-backup.sh")]),e._v(" process but in reverse.\nThe "),t("code",[e._v("btcpay-restore.sh")]),e._v(" script needs to be run with the path to your "),t("code",[e._v("backup.tar.gz")]),e._v(" file.")]),e._v(" "),t("p",[e._v("First off, open a terminal and type the following as root.\nRemember that if you set "),t("code",[e._v("BTCPAY_BACKUP_PASSPHRASE")]),e._v(" on the backup, you also need to provide it for decryption :")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# The restore script needs to be run as the root user")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# As the other scripts, it is inside the BTCPay base directory")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v("/btcpayserver-docker\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Optional: Set the passphrase if you have used one for the backup")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("read")]),e._v(" -s -p "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"Enter passphrase: "')]),e._v(" BTCPAY_BACKUP_PASSPHRASE\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" BTCPAY_BACKUP_PASSPHRASE\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Run the restore script with the full path to the backup file")]),e._v("\n./btcpay-restore.sh /var/backups/backup.tar.gz.gpg\n")])])]),t("p",[e._v("The script will do the following steps:")]),e._v(" "),t("ul",[t("li",[e._v("Extract (and decrypt) the backup archive")]),e._v(" "),t("li",[e._v("Stop BTCPay Server")]),e._v(" "),t("li",[e._v("Restore the Docker volumes")]),e._v(" "),t("li",[e._v("Start the database container")]),e._v(" "),t("li",[e._v("Import the database dump")]),e._v(" "),t("li",[e._v("Restart BTCPay Server")]),e._v(" "),t("li",[e._v("Cleanup: Remove the temporary restore directory")])]),e._v(" "),t("p",[e._v("If the backup file cannot be found in the provided path, the script will exit with an error.")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("🚨 /var/backups/backup.tar.gz.gpg does not exist.\n")])])]),t("p",[e._v("Just as the "),t("code",[e._v("btcpay-backup.sh")]),e._v(" script, the restore will stop at ANY error it may encounter.\nIf the backup file was created while the "),t("code",[e._v("BTCPAY_BACKUP_PASSPHRASE")]),e._v(" was set but not used on restoring, the following error would occur:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("🚨 Decryption failed. Please check the error message above.\n")])])]),t("p",[e._v("When the restore has completed, you get the message:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("✅ Restore done\n")])])]),t("p",[e._v("Everything should be up and running again when the restore is complete.\nYou've successfully restored your BTCPay Server. Congratulations!")]),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("Always make sure your backup strategy is tested and fits your needs.\nNo one solution fits all, and we tried to cover the basic cases.\nFor the latest updates, always feel free to ask on the BTCPay Server community channels.")])])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/112.90da28e4.js b/assets/js/112.ecc39745.js similarity index 98% rename from assets/js/112.90da28e4.js rename to assets/js/112.ecc39745.js index fc76601408..b045cd9b84 100644 --- a/assets/js/112.90da28e4.js +++ b/assets/js/112.ecc39745.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{731:function(t,s,a){"use strict";a.r(s);var e=a(9),r=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"chatwoot-support"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#chatwoot-support"}},[t._v("#")]),t._v(" Chatwoot support")]),t._v(" "),s("p",[s("a",{attrs:{href:"https://www.chatwoot.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Chatwoot"),s("OutboundLink")],1),t._v(" is a customer support tool for instant messaging channels which can help businesses provide exceptional customer support.")]),t._v(" "),s("h2",{attrs:{id:"how-to-use"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),s("ol",[s("li",[t._v("Connect as root to your server")]),t._v(" "),s("li",[t._v("create chatwoot configuration file where "),s("code",[t._v("{CONFIG DATA HERE}")]),t._v(" is replaced by settings from "),s("a",{attrs:{href:"https://www.chatwoot.com/docs/environment-variables",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),s("OutboundLink")],1)])]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\n"),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("cd")]),t._v(" btcpayserver-docker\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("cat")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">>")]),t._v(" Generated/chatwoot-config.env "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<<")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("EOL\n{CONFIG DATA HERE}\n{CONFIG DATA HERE}\nEOL")]),t._v("\n")])])]),s("ol",{attrs:{start:"3"}},[s("li",[t._v("Add chatwoot as an option to your BTCPay deployment and set the host to use (point DNS to server as well)")])]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("CHATWOOT_HOST")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"chatwoot.xpayserver.com"')]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"'),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t._v(';opt-add-chatwoot"')]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" btcpay-setup.sh -i\n\n")])])]),s("ol",{attrs:{start:"4"}},[s("li",[t._v("Wait for BTPay to be online and then create the database for chatwoot")])]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("docker")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("exec")]),t._v(" -ti chatwoot "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("sh")]),t._v(" -c "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"export DISABLE_DATABASE_ENVIRONMENT_CHECK=1 && bundle exec rails db:reset"')]),t._v("\n")])])]),s("ol",{attrs:{start:"4"}},[s("li",[t._v("Go to chatwoot website at https://chatwoot.xpayserver.com and set up.")])])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[112],{730:function(t,s,a){"use strict";a.r(s);var e=a(9),r=Object(e.a)({},(function(){var t=this,s=t._self._c;return s("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[s("h1",{attrs:{id:"chatwoot-support"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#chatwoot-support"}},[t._v("#")]),t._v(" Chatwoot support")]),t._v(" "),s("p",[s("a",{attrs:{href:"https://www.chatwoot.com/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Chatwoot"),s("OutboundLink")],1),t._v(" is a customer support tool for instant messaging channels which can help businesses provide exceptional customer support.")]),t._v(" "),s("h2",{attrs:{id:"how-to-use"}},[s("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),s("ol",[s("li",[t._v("Connect as root to your server")]),t._v(" "),s("li",[t._v("create chatwoot configuration file where "),s("code",[t._v("{CONFIG DATA HERE}")]),t._v(" is replaced by settings from "),s("a",{attrs:{href:"https://www.chatwoot.com/docs/environment-variables",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),s("OutboundLink")],1)])]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\n"),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("cd")]),t._v(" btcpayserver-docker\n"),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("cat")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">>")]),t._v(" Generated/chatwoot-config.env "),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<<")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v("EOL\n{CONFIG DATA HERE}\n{CONFIG DATA HERE}\nEOL")]),t._v("\n")])])]),s("ol",{attrs:{start:"3"}},[s("li",[t._v("Add chatwoot as an option to your BTCPay deployment and set the host to use (point DNS to server as well)")])]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("CHATWOOT_HOST")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"chatwoot.xpayserver.com"')]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),s("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"'),s("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t._v(';opt-add-chatwoot"')]),t._v("\n"),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" btcpay-setup.sh -i\n\n")])])]),s("ol",{attrs:{start:"4"}},[s("li",[t._v("Wait for BTPay to be online and then create the database for chatwoot")])]),t._v(" "),s("div",{staticClass:"language-bash extra-class"},[s("pre",{pre:!0,attrs:{class:"language-bash"}},[s("code",[s("span",{pre:!0,attrs:{class:"token function"}},[t._v("docker")]),t._v(" "),s("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("exec")]),t._v(" -ti chatwoot "),s("span",{pre:!0,attrs:{class:"token function"}},[t._v("sh")]),t._v(" -c "),s("span",{pre:!0,attrs:{class:"token string"}},[t._v('"export DISABLE_DATABASE_ENVIRONMENT_CHECK=1 && bundle exec rails db:reset"')]),t._v("\n")])])]),s("ol",{attrs:{start:"4"}},[s("li",[t._v("Go to chatwoot website at https://chatwoot.xpayserver.com and set up.")])])])}),[],!1,null,null,null);s.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/113.2e37be4c.js b/assets/js/113.27366d2f.js similarity index 97% rename from assets/js/113.2e37be4c.js rename to assets/js/113.27366d2f.js index 65fcfab4b1..39cb96bf09 100644 --- a/assets/js/113.2e37be4c.js +++ b/assets/js/113.27366d2f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[113],{734:function(s,e,t){"use strict";t.r(e);var r=t(9),a=Object(r.a)({},(function(){var s=this,e=s._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[e("h1",{attrs:{id:"firefly-iii-support"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#firefly-iii-support"}},[s._v("#")]),s._v(" Firefly III support")]),s._v(" "),e("p",[e("a",{attrs:{href:"https://www.firefly-iii.org/",target:"_blank",rel:"noopener noreferrer"}},[s._v("Firefly III"),e("OutboundLink")],1),s._v(" is a self-hosted financial manager.\nIt can help you keep track of expenses, income, budgets and everything in between. It supports credit cards, shared household accounts and savings accounts. It’s pretty fancy. You should use it to save and organise money.")]),s._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[s._v("#")]),s._v(" How to use")]),s._v(" "),e("ol",[e("li",[s._v("Connect as root to your server")]),s._v(" "),e("li",[s._v("Configure a domain's DNS to point to your server ip. e.g. "),e("code",[s._v("firefly.yourserver.org")])]),s._v(" "),e("li",[s._v("Add fireflyiii as an option to your docker deployment")])]),s._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),e("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),s._v(';opt-add-fireflyiii"')]),s._v("\n"),e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("FIREFLY_HOST")]),e("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[s._v('"firefly.yourserver.org"')]),s._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v(".")]),s._v(" btcpay-setup.sh -i\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v(".")]),s._v(" ./Tools/fireflyiii/init.sh\n")])])]),e("ol",{attrs:{start:"4"}},[e("li",[s._v("Access Firefly III at "),e("code",[s._v("firefly.yourserver.org")]),s._v(" and create your admin account.")])])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[113],{735:function(s,e,t){"use strict";t.r(e);var r=t(9),a=Object(r.a)({},(function(){var s=this,e=s._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":s.$parent.slotKey}},[e("h1",{attrs:{id:"firefly-iii-support"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#firefly-iii-support"}},[s._v("#")]),s._v(" Firefly III support")]),s._v(" "),e("p",[e("a",{attrs:{href:"https://www.firefly-iii.org/",target:"_blank",rel:"noopener noreferrer"}},[s._v("Firefly III"),e("OutboundLink")],1),s._v(" is a self-hosted financial manager.\nIt can help you keep track of expenses, income, budgets and everything in between. It supports credit cards, shared household accounts and savings accounts. It’s pretty fancy. You should use it to save and organise money.")]),s._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[s._v("#")]),s._v(" How to use")]),s._v(" "),e("ol",[e("li",[s._v("Connect as root to your server")]),s._v(" "),e("li",[s._v("Configure a domain's DNS to point to your server ip. e.g. "),e("code",[s._v("firefly.yourserver.org")])]),s._v(" "),e("li",[s._v("Add fireflyiii as an option to your docker deployment")])]),s._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[s._v('"'),e("span",{pre:!0,attrs:{class:"token variable"}},[s._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),s._v(';opt-add-fireflyiii"')]),s._v("\n"),e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[s._v("FIREFLY_HOST")]),e("span",{pre:!0,attrs:{class:"token operator"}},[s._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[s._v('"firefly.yourserver.org"')]),s._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v(".")]),s._v(" btcpay-setup.sh -i\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[s._v(".")]),s._v(" ./Tools/fireflyiii/init.sh\n")])])]),e("ol",{attrs:{start:"4"}},[e("li",[s._v("Access Firefly III at "),e("code",[s._v("firefly.yourserver.org")]),s._v(" and create your admin account.")])])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/114.5a5fa1ee.js b/assets/js/114.7b7b6100.js similarity index 99% rename from assets/js/114.5a5fa1ee.js rename to assets/js/114.7b7b6100.js index c675adb6f0..118725c2fb 100644 --- a/assets/js/114.5a5fa1ee.js +++ b/assets/js/114.7b7b6100.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[114],{735:function(a,e,t){"use strict";t.r(e);var s=t(9),r=Object(s.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"joinmarket-support"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#joinmarket-support"}},[a._v("#")]),a._v(" Joinmarket support")]),a._v(" "),e("p",[a._v("JoinMarket is software to create a special kind of bitcoin transaction called a CoinJoin transaction. Its aim is to improve the confidentiality and privacy of bitcoin transactions.")]),a._v(" "),e("p",[a._v("You will be able to use your bitcoin to help other protect their privacy, while earning a yield for this service.")]),a._v(" "),e("p",[a._v("See "),e("a",{attrs:{href:"https://github.com/JoinMarket-Org/JoinMarket-Docs/blob/master/High-level-design.md",target:"_blank",rel:"noopener noreferrer"}},[a._v("the documentation of the joinmarket project"),e("OutboundLink")],1),a._v(" for more details.")]),a._v(" "),e("p",[a._v("This is a very advanced functionality, and there is no easy way to recover if something goes wrong.")]),a._v(" "),e("p",[a._v("For hardcore bitcoiners only.")]),a._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[a._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"'),e("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),a._v(';opt-add-joinmarket"')]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(".")]),a._v(" btcpay-setup.sh -i\n")])])]),e("p",[a._v("Then you need to setup your default joinmarket wallet:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("jm.sh wallet-tool-generate\njm.sh set-wallet "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("wallet_file_name"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("password"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n")])])]),e("p",[a._v("Once done, you will need to send some money to the joinmarket wallet:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("jm.sh wallet-tool\n")])])]),e("h2",{attrs:{id:"how-to-change-joinmarket-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-change-joinmarket-configuration"}},[a._v("#")]),a._v(" How to change joinmarket configuration?")]),a._v(" "),e("p",[a._v("Connect to your container, and edit your configuration:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("jm.sh "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("bash")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("vim")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$CONFIG")]),a._v("\n")])])]),e("h2",{attrs:{id:"managing-your-wallet"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#managing-your-wallet"}},[a._v("#")]),a._v(" Managing your wallet")]),a._v(" "),e("p",[a._v("By running "),e("code",[a._v("jm.sh")]),a._v(" without parameter, you will get a bunch of command that you can run such as:")]),a._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[a._v("Usage:\n------\n\nTooling to setup your joinmarket yield generator\n\n wallet-tool: Run wallet-tools.py on the wallet\n wallet-tool-generate: Generate a new wallet\n set-wallet: Set the wallet that the yield generator need to use\n bash: Open an interactive bash session in the joinmarket container\n receive-payjoin: Receive a payjoin payment\n sendpayment: Send a payjoin through coinjoin (password needed)\n\nExample:\n * jm.sh wallet-tool-generate\n * jm.sh set-wallet wallet.jmdat mypassword\n * jm.sh wallet-tool\n * jm.sh receive-payjoin \n * jm.sh sendpayment
    \n * jm.sh wallet-tool history\n * jm.sh bash\n")])])]),e("p",[a._v("Note "),e("code",[a._v("jm.sh")]),a._v(" commands are wrapper around joinmarket scripts. Those are just convenience command, you can always directly connect to the container via "),e("code",[a._v("jm.sh bash")]),a._v(" and achieve the same result with the joinmarket python scripts.")]),a._v(" "),e("h2",{attrs:{id:"getting-command-prompt-into-the-container"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getting-command-prompt-into-the-container"}},[a._v("#")]),a._v(" Getting command prompt into the container")]),a._v(" "),e("p",[a._v("You can connect to the container and have direct access to joinmarket scripts such as:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("jm.sh "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("bash")]),a._v("\nsendpayment.py wallet.jmdat "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),a._v(".\n")])])]),e("h2",{attrs:{id:"managing-the-services-such-as-yield-generators"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#managing-the-services-such-as-yield-generators"}},[a._v("#")]),a._v(" Managing the services such as yield generators")]),a._v(" "),e("p",[a._v("First connect to the container's bash")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("jm.sh "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("bash")]),a._v("\n")])])]),e("p",[a._v("You can list available services to run:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl status\n")])])]),e("p",[a._v("Which might show you")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("root"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" supervisorctl status\nob-watcher STOPPED Not started\nyg-privacyenhanced STOPPED Not started\nyield-generator-basic STOPPED Not started\n")])])]),e("p",[a._v("You can start a yield generator with:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl start yg-privacyenhanced\n")])])]),e("p",[a._v("*** Note that services will NOT be restarted automatically if the container restart. ***")]),a._v(" "),e("p",[a._v("If you want to automatically restart the service when the container restart,")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("vim")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$AUTO_START")]),a._v("\n")])])]),e("p",[a._v("Then remove the comment "),e("code",[a._v("#")]),a._v(" in front of the service name you want to automatically restart.")]),a._v(" "),e("h2",{attrs:{id:"ob-watcher"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ob-watcher"}},[a._v("#")]),a._v(" OB-Watcher")]),a._v(" "),e("p",[a._v("The "),e("code",[a._v("ob-watcher")]),a._v(" service allows you to "),e("a",{attrs:{href:"https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/orderbook.md",target:"_blank",rel:"noopener noreferrer"}},[a._v("see an order book"),e("OutboundLink")],1),a._v(".")]),a._v(" "),e("p",[a._v("You can activate it:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl start ob-watcher\n")])])]),e("p",[a._v("Then you can browse it by browsing "),e("code",[a._v("https://.com/obwatch/")])]),a._v(" "),e("h2",{attrs:{id:"troubleshooting"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[a._v("#")]),a._v(" Troubleshooting")]),a._v(" "),e("h3",{attrs:{id:"error-failed-to-load-wallet-you-need-to-remove-the-lock-file"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#error-failed-to-load-wallet-you-need-to-remove-the-lock-file"}},[a._v("#")]),a._v(" Error: Failed to load wallet, you need to remove the lock file")]),a._v(" "),e("p",[a._v("You might sometimes get the following error when running a python script for joinmarket:")]),a._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[a._v("Failed to load wallet, error message: RetryableStorageError('File is currently in use (locked by pid 12822). If this is a leftover from a crashed instance you need to remove the lock file `/root/.joinmarket/wallets/.wallet.jmdat.lock` manually.')\n")])])]),e("p",[a._v("This is because a service using the wallet is running, so you need to shut it down before running the command.")]),a._v(" "),e("p",[a._v("Check which service is running:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl status\n")])])]),e("p",[a._v("And stop it")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl stop yg-privacyenhanced\n")])])]),e("h3",{attrs:{id:"read-the-logs-of-services"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#read-the-logs-of-services"}},[a._v("#")]),a._v(" Read the logs of services")]),a._v(" "),e("p",[a._v("You can use the "),e("code",[a._v("supervisorctl tail")]),a._v(" command:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("tail")]),a._v(" yg-privacyenhanced\n")])])]),e("p",[a._v("You can also check the logs in the "),e("code",[a._v("$DATADIR/logs")]),a._v(" folder.")])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[114],{733:function(a,e,t){"use strict";t.r(e);var s=t(9),r=Object(s.a)({},(function(){var a=this,e=a._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":a.$parent.slotKey}},[e("h1",{attrs:{id:"joinmarket-support"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#joinmarket-support"}},[a._v("#")]),a._v(" Joinmarket support")]),a._v(" "),e("p",[a._v("JoinMarket is software to create a special kind of bitcoin transaction called a CoinJoin transaction. Its aim is to improve the confidentiality and privacy of bitcoin transactions.")]),a._v(" "),e("p",[a._v("You will be able to use your bitcoin to help other protect their privacy, while earning a yield for this service.")]),a._v(" "),e("p",[a._v("See "),e("a",{attrs:{href:"https://github.com/JoinMarket-Org/JoinMarket-Docs/blob/master/High-level-design.md",target:"_blank",rel:"noopener noreferrer"}},[a._v("the documentation of the joinmarket project"),e("OutboundLink")],1),a._v(" for more details.")]),a._v(" "),e("p",[a._v("This is a very advanced functionality, and there is no easy way to recover if something goes wrong.")]),a._v(" "),e("p",[a._v("For hardcore bitcoiners only.")]),a._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[a._v("#")]),a._v(" How to use")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[a._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[a._v('"'),e("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),a._v(';opt-add-joinmarket"')]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[a._v(".")]),a._v(" btcpay-setup.sh -i\n")])])]),e("p",[a._v("Then you need to setup your default joinmarket wallet:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("jm.sh wallet-tool-generate\njm.sh set-wallet "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("wallet_file_name"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v("<")]),a._v("password"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v("\n")])])]),e("p",[a._v("Once done, you will need to send some money to the joinmarket wallet:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("jm.sh wallet-tool\n")])])]),e("h2",{attrs:{id:"how-to-change-joinmarket-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-change-joinmarket-configuration"}},[a._v("#")]),a._v(" How to change joinmarket configuration?")]),a._v(" "),e("p",[a._v("Connect to your container, and edit your configuration:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("jm.sh "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("bash")]),a._v("\n"),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("vim")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$CONFIG")]),a._v("\n")])])]),e("h2",{attrs:{id:"managing-your-wallet"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#managing-your-wallet"}},[a._v("#")]),a._v(" Managing your wallet")]),a._v(" "),e("p",[a._v("By running "),e("code",[a._v("jm.sh")]),a._v(" without parameter, you will get a bunch of command that you can run such as:")]),a._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[a._v("Usage:\n------\n\nTooling to setup your joinmarket yield generator\n\n wallet-tool: Run wallet-tools.py on the wallet\n wallet-tool-generate: Generate a new wallet\n set-wallet: Set the wallet that the yield generator need to use\n bash: Open an interactive bash session in the joinmarket container\n receive-payjoin: Receive a payjoin payment\n sendpayment: Send a payjoin through coinjoin (password needed)\n\nExample:\n * jm.sh wallet-tool-generate\n * jm.sh set-wallet wallet.jmdat mypassword\n * jm.sh wallet-tool\n * jm.sh receive-payjoin \n * jm.sh sendpayment
    \n * jm.sh wallet-tool history\n * jm.sh bash\n")])])]),e("p",[a._v("Note "),e("code",[a._v("jm.sh")]),a._v(" commands are wrapper around joinmarket scripts. Those are just convenience command, you can always directly connect to the container via "),e("code",[a._v("jm.sh bash")]),a._v(" and achieve the same result with the joinmarket python scripts.")]),a._v(" "),e("h2",{attrs:{id:"getting-command-prompt-into-the-container"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getting-command-prompt-into-the-container"}},[a._v("#")]),a._v(" Getting command prompt into the container")]),a._v(" "),e("p",[a._v("You can connect to the container and have direct access to joinmarket scripts such as:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("jm.sh "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("bash")]),a._v("\nsendpayment.py wallet.jmdat "),e("span",{pre:!0,attrs:{class:"token punctuation"}},[a._v("..")]),a._v(".\n")])])]),e("h2",{attrs:{id:"managing-the-services-such-as-yield-generators"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#managing-the-services-such-as-yield-generators"}},[a._v("#")]),a._v(" Managing the services such as yield generators")]),a._v(" "),e("p",[a._v("First connect to the container's bash")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("jm.sh "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("bash")]),a._v("\n")])])]),e("p",[a._v("You can list available services to run:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl status\n")])])]),e("p",[a._v("Which might show you")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("root"),e("span",{pre:!0,attrs:{class:"token operator"}},[a._v(">")]),a._v(" supervisorctl status\nob-watcher STOPPED Not started\nyg-privacyenhanced STOPPED Not started\nyield-generator-basic STOPPED Not started\n")])])]),e("p",[a._v("You can start a yield generator with:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl start yg-privacyenhanced\n")])])]),e("p",[a._v("*** Note that services will NOT be restarted automatically if the container restart. ***")]),a._v(" "),e("p",[a._v("If you want to automatically restart the service when the container restart,")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[a._v("vim")]),a._v(" "),e("span",{pre:!0,attrs:{class:"token variable"}},[a._v("$AUTO_START")]),a._v("\n")])])]),e("p",[a._v("Then remove the comment "),e("code",[a._v("#")]),a._v(" in front of the service name you want to automatically restart.")]),a._v(" "),e("h2",{attrs:{id:"ob-watcher"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ob-watcher"}},[a._v("#")]),a._v(" OB-Watcher")]),a._v(" "),e("p",[a._v("The "),e("code",[a._v("ob-watcher")]),a._v(" service allows you to "),e("a",{attrs:{href:"https://github.com/JoinMarket-Org/joinmarket-clientserver/blob/master/docs/orderbook.md",target:"_blank",rel:"noopener noreferrer"}},[a._v("see an order book"),e("OutboundLink")],1),a._v(".")]),a._v(" "),e("p",[a._v("You can activate it:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl start ob-watcher\n")])])]),e("p",[a._v("Then you can browse it by browsing "),e("code",[a._v("https://.com/obwatch/")])]),a._v(" "),e("h2",{attrs:{id:"troubleshooting"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[a._v("#")]),a._v(" Troubleshooting")]),a._v(" "),e("h3",{attrs:{id:"error-failed-to-load-wallet-you-need-to-remove-the-lock-file"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#error-failed-to-load-wallet-you-need-to-remove-the-lock-file"}},[a._v("#")]),a._v(" Error: Failed to load wallet, you need to remove the lock file")]),a._v(" "),e("p",[a._v("You might sometimes get the following error when running a python script for joinmarket:")]),a._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[a._v("Failed to load wallet, error message: RetryableStorageError('File is currently in use (locked by pid 12822). If this is a leftover from a crashed instance you need to remove the lock file `/root/.joinmarket/wallets/.wallet.jmdat.lock` manually.')\n")])])]),e("p",[a._v("This is because a service using the wallet is running, so you need to shut it down before running the command.")]),a._v(" "),e("p",[a._v("Check which service is running:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl status\n")])])]),e("p",[a._v("And stop it")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl stop yg-privacyenhanced\n")])])]),e("h3",{attrs:{id:"read-the-logs-of-services"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#read-the-logs-of-services"}},[a._v("#")]),a._v(" Read the logs of services")]),a._v(" "),e("p",[a._v("You can use the "),e("code",[a._v("supervisorctl tail")]),a._v(" command:")]),a._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[a._v("supervisorctl "),e("span",{pre:!0,attrs:{class:"token function"}},[a._v("tail")]),a._v(" yg-privacyenhanced\n")])])]),e("p",[a._v("You can also check the logs in the "),e("code",[a._v("$DATADIR/logs")]),a._v(" folder.")])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/115.0846b610.js b/assets/js/115.fd2fa297.js similarity index 97% rename from assets/js/115.0846b610.js rename to assets/js/115.fd2fa297.js index a7bf8f7829..754cdf1e1a 100644 --- a/assets/js/115.0846b610.js +++ b/assets/js/115.fd2fa297.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[115],{736:function(t,a,s){"use strict";s.r(a);var e=s(9),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"lightning-terminal-lit"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#lightning-terminal-lit"}},[t._v("#")]),t._v(" Lightning Terminal (LiT)")]),t._v(" "),a("p",[a("a",{attrs:{href:"https://github.com/lightninglabs/lightning-terminal",target:"_blank",rel:"noopener noreferrer"}},[t._v("Lightning Terminal"),a("OutboundLink")],1),t._v(" (LiT) is a browser-based interface for managing channel liquidity.\nIt integrates the Lightning Labs services Loop, Poold and Faraday all in one and offers a web UI to manage them.\nLND required.")]),t._v(" "),a("h2",{attrs:{id:"installation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),a("p",[t._v("To install the Lightning Terminal service, you need to set a password for the login.")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Set password")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("LIT_PASSWD")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"sUpErSeCuRe"')]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Add fragment and run setup")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t._v(';opt-add-lightning-terminal"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" btcpay-setup.sh -i\n")])])]),a("p",[t._v("Afterwards you should see Lightning Terminal appear as a service on the Server Settings > Services page in BTCPay Server.")]),t._v(" "),a("h2",{attrs:{id:"troubleshooting"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[t._v("#")]),t._v(" Troubleshooting")]),t._v(" "),a("p",[t._v("To see the logs of the Lightning Terminal service, you can run this command:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("docker")]),t._v(" logs -f generated_lnd_lit_1\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[115],{734:function(t,a,s){"use strict";s.r(a);var e=s(9),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"lightning-terminal-lit"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#lightning-terminal-lit"}},[t._v("#")]),t._v(" Lightning Terminal (LiT)")]),t._v(" "),a("p",[a("a",{attrs:{href:"https://github.com/lightninglabs/lightning-terminal",target:"_blank",rel:"noopener noreferrer"}},[t._v("Lightning Terminal"),a("OutboundLink")],1),t._v(" (LiT) is a browser-based interface for managing channel liquidity.\nIt integrates the Lightning Labs services Loop, Poold and Faraday all in one and offers a web UI to manage them.\nLND required.")]),t._v(" "),a("h2",{attrs:{id:"installation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),a("p",[t._v("To install the Lightning Terminal service, you need to set a password for the login.")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Set password")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("LIT_PASSWD")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"sUpErSeCuRe"')]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Add fragment and run setup")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t._v(';opt-add-lightning-terminal"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" btcpay-setup.sh -i\n")])])]),a("p",[t._v("Afterwards you should see Lightning Terminal appear as a service on the Server Settings > Services page in BTCPay Server.")]),t._v(" "),a("h2",{attrs:{id:"troubleshooting"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[t._v("#")]),t._v(" Troubleshooting")]),t._v(" "),a("p",[t._v("To see the logs of the Lightning Terminal service, you can run this command:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("docker")]),t._v(" logs -f generated_lnd_lit_1\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/116.1b183f44.js b/assets/js/116.0b3fb369.js similarity index 98% rename from assets/js/116.1b183f44.js rename to assets/js/116.0b3fb369.js index a2db897b4e..d296f29063 100644 --- a/assets/js/116.1b183f44.js +++ b/assets/js/116.0b3fb369.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[116],{737:function(t,e,a){"use strict";a.r(e);var o=a(9),s=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"ndlc-support"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ndlc-support"}},[t._v("#")]),t._v(" NDLC support")]),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("Disclaimer")]),t._v(" "),e("p",[t._v("This project is experimental and based on a protocol which is still evolving everyday.\nUse with caution.")]),t._v(" "),e("p",[t._v("I will take no attempt at maintaining backwards compatibility at this stage.")])]),t._v(" "),e("h2",{attrs:{id:"introduction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[t._v("#")]),t._v(" Introduction")]),t._v(" "),e("p",[t._v("A DLC can be seen as a smart contract involving two "),e("code",[t._v("parties")]),t._v(", a future "),e("code",[t._v("event")]),t._v(", a set of outcomes and a "),e("code",[t._v("payoff function")]),t._v(".\nAn "),e("code",[t._v("outcome")]),t._v(" can be "),e("code",[t._v("attested")]),t._v(" by an "),e("code",[t._v("oracle")]),t._v(". The "),e("code",[t._v("oracle")]),t._v(" does not need to interact with either party, and its only role is to "),e("code",[t._v("attest")]),t._v(" the outcome of the event.")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("payoff function")]),t._v(" determines the two parties' profit or loss depending on which outcome get "),e("code",[t._v("attested")]),t._v(".")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("oracle")]),t._v(" roles is to define the "),e("code",[t._v("event")]),t._v(" and "),e("code",[t._v("attest")]),t._v(" a single outcome of the event.")]),t._v(" "),e("p",[t._v("Let's call Alice and Bob the two parties of the contract, and Olivia the oracle.")]),t._v(" "),e("p",[t._v("A DLC will show two transactions on the chain:")]),t._v(" "),e("ul",[e("li",[t._v("The Funding Transaction")]),t._v(" "),e("li",[t._v("The Contract Execution Transaction (CET)")])]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("Funding Transaction")]),t._v(" is a transaction built by the two parties of the contract, locking their collateral for the contract.")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("Contract Execution Transaction")]),t._v(" (or "),e("code",[t._v("CET")]),t._v(") is the transaction distributing the locked collateral according to the "),e("code",[t._v("payoff function")]),t._v(" for the outcome attested by the oracle.")]),t._v(" "),e("p",[t._v("The following documentation is also explained in this video.")]),t._v(" "),e("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/DakwshnNkho/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=DakwshnNkho",title:"How to make a DLC with NDLC-CLI","data-id":"DakwshnNkho"}},[e("iframe",{attrs:{title:"How to make a DLC with NDLC-CLI","data-src":"https://www.youtube-nocookie.com/embed/DakwshnNkho?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),t._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),e("p",[t._v("You need to add ndlc's docker fragment to your install with:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"'),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t._v(';opt-add-ndlc"')]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" btcpay-setup.sh -i\n")])])]),e("p",[t._v("You can then use "),e("code",[t._v("ndlc-cli.sh")]),t._v(" to run use ndlc-cli, for example:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[t._v("ndlc.sh oracle generate MyOwnOracle\n")])])]),e("p",[t._v("Read our documentation on our "),e("a",{attrs:{href:"https://github.com/dgarage/NDLC/blob/master/docs/Concepts.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub repository"),e("OutboundLink")],1),t._v(".")])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[116],{736:function(t,e,a){"use strict";a.r(e);var o=a(9),s=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"ndlc-support"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#ndlc-support"}},[t._v("#")]),t._v(" NDLC support")]),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("Disclaimer")]),t._v(" "),e("p",[t._v("This project is experimental and based on a protocol which is still evolving everyday.\nUse with caution.")]),t._v(" "),e("p",[t._v("I will take no attempt at maintaining backwards compatibility at this stage.")])]),t._v(" "),e("h2",{attrs:{id:"introduction"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[t._v("#")]),t._v(" Introduction")]),t._v(" "),e("p",[t._v("A DLC can be seen as a smart contract involving two "),e("code",[t._v("parties")]),t._v(", a future "),e("code",[t._v("event")]),t._v(", a set of outcomes and a "),e("code",[t._v("payoff function")]),t._v(".\nAn "),e("code",[t._v("outcome")]),t._v(" can be "),e("code",[t._v("attested")]),t._v(" by an "),e("code",[t._v("oracle")]),t._v(". The "),e("code",[t._v("oracle")]),t._v(" does not need to interact with either party, and its only role is to "),e("code",[t._v("attest")]),t._v(" the outcome of the event.")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("payoff function")]),t._v(" determines the two parties' profit or loss depending on which outcome get "),e("code",[t._v("attested")]),t._v(".")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("oracle")]),t._v(" roles is to define the "),e("code",[t._v("event")]),t._v(" and "),e("code",[t._v("attest")]),t._v(" a single outcome of the event.")]),t._v(" "),e("p",[t._v("Let's call Alice and Bob the two parties of the contract, and Olivia the oracle.")]),t._v(" "),e("p",[t._v("A DLC will show two transactions on the chain:")]),t._v(" "),e("ul",[e("li",[t._v("The Funding Transaction")]),t._v(" "),e("li",[t._v("The Contract Execution Transaction (CET)")])]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("Funding Transaction")]),t._v(" is a transaction built by the two parties of the contract, locking their collateral for the contract.")]),t._v(" "),e("p",[t._v("The "),e("code",[t._v("Contract Execution Transaction")]),t._v(" (or "),e("code",[t._v("CET")]),t._v(") is the transaction distributing the locked collateral according to the "),e("code",[t._v("payoff function")]),t._v(" for the outcome attested by the oracle.")]),t._v(" "),e("p",[t._v("The following documentation is also explained in this video.")]),t._v(" "),e("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/DakwshnNkho/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=DakwshnNkho",title:"How to make a DLC with NDLC-CLI","data-id":"DakwshnNkho"}},[e("iframe",{attrs:{title:"How to make a DLC with NDLC-CLI","data-src":"https://www.youtube-nocookie.com/embed/DakwshnNkho?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),t._v(" "),e("h2",{attrs:{id:"how-to-use"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[t._v("#")]),t._v(" How to use")]),t._v(" "),e("p",[t._v("You need to add ndlc's docker fragment to your install with:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"'),e("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t._v(';opt-add-ndlc"')]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" btcpay-setup.sh -i\n")])])]),e("p",[t._v("You can then use "),e("code",[t._v("ndlc-cli.sh")]),t._v(" to run use ndlc-cli, for example:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[t._v("ndlc.sh oracle generate MyOwnOracle\n")])])]),e("p",[t._v("Read our documentation on our "),e("a",{attrs:{href:"https://github.com/dgarage/NDLC/blob/master/docs/Concepts.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub repository"),e("OutboundLink")],1),t._v(".")])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/117.017263dc.js b/assets/js/117.ec4df9f2.js similarity index 98% rename from assets/js/117.017263dc.js rename to assets/js/117.ec4df9f2.js index f5676eb394..c4e367eafa 100644 --- a/assets/js/117.017263dc.js +++ b/assets/js/117.ec4df9f2.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[117],{738:function(e,t,a){"use strict";a.r(t);var s=a(9),o=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"pi-hole-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pi-hole-support"}},[e._v("#")]),e._v(" Pi-Hole support")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://pi-hole.net/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Pi-Hole"),t("OutboundLink")],1),e._v(" is a black hole for internet advertisement.\nIt works as a DNS server which blacklist domains tied to advertisement. If you use it as your main DNS server and it detects your query is trying to resolve a domain belonging to an advertisement company, it will resolve the domain to IP "),t("code",[e._v("0.0.0.0")]),e._v(", preventing the advertisement to load on any computer using this DNS server.")]),e._v(" "),t("p",[e._v("Note that our pi-hole integration is meant to be used in a "),t("strong",[e._v("local network")]),e._v(". Please do not try to use this option on a VPS.")]),e._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),t("p",[e._v("Let's imagine the local IP of your BTCPay Server is "),t("code",[e._v("192.168.1.2")]),e._v(".")]),e._v(" "),t("ol",[t("li",[e._v("Connect as root to your server")]),e._v(" "),t("li",[e._v("Add pihole as an option to your docker deployment")])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(';opt-add-pihole"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" btcpay-setup.sh -i\n")])])]),t("ol",{attrs:{start:"3"}},[t("li",[e._v("If your server has a firewall, make sure it allow incoming traffic to port "),t("code",[e._v("53 (UDP)")]),e._v(".")]),e._v(" "),t("li",[e._v("Configure your home router DHCP server to use "),t("code",[e._v("192.168.1.2")]),e._v(" as primary DNS server.")])]),e._v(" "),t("p",[e._v("From now everytime a device will connect to your local network, they will automatically use pi-hole as a DNS server. Advertisements will go to a black hole for all devices.")]),e._v(" "),t("h2",{attrs:{id:"using-the-dashboard"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-the-dashboard"}},[e._v("#")]),e._v(" Using the dashboard")]),e._v(" "),t("p",[e._v("Pi-Hole comes with a very nice admin dashboard to monitor its activity.\nIt is disabled by default. To enable it, you need to configure "),t("code",[e._v("PIHOLE_SERVERIP")]),e._v(" to the IP of your server:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("PIHOLE_SERVERIP")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"192.168.1.2"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" btcpay-setup.sh -i\n")])])]),t("p",[e._v("If your device is using pi-hole as a DNS server, you should now be able to browse "),t("code",[e._v("http://pi.hole/admin")]),e._v(" to connect to your dashboard.")]),e._v(" "),t("p",[e._v("You can find the admin password in the logs of pihole:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" logs pihole "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" random\n")])])]),t("p",[e._v("If the password does not work, you can try to reset the password:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("pihole.sh -a -p\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" restart pihole\n")])])]),t("p",[e._v("Then running again")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" logs pihole "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" random\n")])])])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[117],{737:function(e,t,a){"use strict";a.r(t);var s=a(9),o=Object(s.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"pi-hole-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pi-hole-support"}},[e._v("#")]),e._v(" Pi-Hole support")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://pi-hole.net/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Pi-Hole"),t("OutboundLink")],1),e._v(" is a black hole for internet advertisement.\nIt works as a DNS server which blacklist domains tied to advertisement. If you use it as your main DNS server and it detects your query is trying to resolve a domain belonging to an advertisement company, it will resolve the domain to IP "),t("code",[e._v("0.0.0.0")]),e._v(", preventing the advertisement to load on any computer using this DNS server.")]),e._v(" "),t("p",[e._v("Note that our pi-hole integration is meant to be used in a "),t("strong",[e._v("local network")]),e._v(". Please do not try to use this option on a VPS.")]),e._v(" "),t("h2",{attrs:{id:"how-to-use"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use"}},[e._v("#")]),e._v(" How to use")]),e._v(" "),t("p",[e._v("Let's imagine the local IP of your BTCPay Server is "),t("code",[e._v("192.168.1.2")]),e._v(".")]),e._v(" "),t("ol",[t("li",[e._v("Connect as root to your server")]),e._v(" "),t("li",[e._v("Add pihole as an option to your docker deployment")])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(';opt-add-pihole"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" btcpay-setup.sh -i\n")])])]),t("ol",{attrs:{start:"3"}},[t("li",[e._v("If your server has a firewall, make sure it allow incoming traffic to port "),t("code",[e._v("53 (UDP)")]),e._v(".")]),e._v(" "),t("li",[e._v("Configure your home router DHCP server to use "),t("code",[e._v("192.168.1.2")]),e._v(" as primary DNS server.")])]),e._v(" "),t("p",[e._v("From now everytime a device will connect to your local network, they will automatically use pi-hole as a DNS server. Advertisements will go to a black hole for all devices.")]),e._v(" "),t("h2",{attrs:{id:"using-the-dashboard"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-the-dashboard"}},[e._v("#")]),e._v(" Using the dashboard")]),e._v(" "),t("p",[e._v("Pi-Hole comes with a very nice admin dashboard to monitor its activity.\nIt is disabled by default. To enable it, you need to configure "),t("code",[e._v("PIHOLE_SERVERIP")]),e._v(" to the IP of your server:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("PIHOLE_SERVERIP")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"192.168.1.2"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" btcpay-setup.sh -i\n")])])]),t("p",[e._v("If your device is using pi-hole as a DNS server, you should now be able to browse "),t("code",[e._v("http://pi.hole/admin")]),e._v(" to connect to your dashboard.")]),e._v(" "),t("p",[e._v("You can find the admin password in the logs of pihole:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" logs pihole "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" random\n")])])]),t("p",[e._v("If the password does not work, you can try to reset the password:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("pihole.sh -a -p\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" restart pihole\n")])])]),t("p",[e._v("Then running again")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" logs pihole "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("grep")]),e._v(" random\n")])])])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/118.0c5de943.js b/assets/js/118.29f2c21d.js similarity index 98% rename from assets/js/118.0c5de943.js rename to assets/js/118.29f2c21d.js index 875d57f098..dcbd96dfa8 100644 --- a/assets/js/118.0c5de943.js +++ b/assets/js/118.29f2c21d.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[118],{739:function(t,a,e){"use strict";e.r(a);var s=e(9),n=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"tallycoin-connect"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tallycoin-connect"}},[t._v("#")]),t._v(" Tallycoin Connect")]),t._v(" "),a("p",[t._v("Set up "),a("a",{attrs:{href:"https://github.com/djbooth007/tallycoin_connect",target:"_blank",rel:"noopener noreferrer"}},[t._v("Tallycoin Connect"),a("OutboundLink")],1),t._v(" on your BTCPay Server instance to allow for the retrieval of Lightning invoices via "),a("a",{attrs:{href:"https://tallyco.in/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Tallycoin"),a("OutboundLink")],1),t._v(".\nLND required.")]),t._v(" "),a("h2",{attrs:{id:"installation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),a("p",[t._v("To install the Tallycoin Connect service, you need to set your Tallycoin API key and a password first.\nThe password is optional, but as the service will be publicly available, you are strongly advised to require a secure password for the login.")]),t._v(" "),a("p",[t._v("You can either set "),a("code",[t._v("TALLYCOIN_PASSWD_CLEARTEXT")]),t._v(" (plain text) or "),a("code",[t._v("TALLYCOIN_PASSWD")]),t._v(", which must be a sha256 hash of your login password.")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Set API key and password")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("TALLYCOIN_APIKEY")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"my-tallycoin-api-key"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("TALLYCOIN_PASSWD_CLEARTEXT")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"sUpErSeCuRe"')]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Add fragment and run setup")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t._v(';opt-add-tallycoin-connect"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" btcpay-setup.sh -i\n")])])]),a("p",[t._v("Afterwards you should see Tallycoin Connect appear as a service on the Server Settings > Services page in BTCPay Server.")]),t._v(" "),a("h2",{attrs:{id:"troubleshooting"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[t._v("#")]),t._v(" Troubleshooting")]),t._v(" "),a("p",[t._v("To see the logs of the Tallycoin Connect service, you can run this command:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("docker")]),t._v(" logs -f generated_tallycoin_connect_1\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[118],{738:function(t,a,e){"use strict";e.r(a);var s=e(9),n=Object(s.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"tallycoin-connect"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#tallycoin-connect"}},[t._v("#")]),t._v(" Tallycoin Connect")]),t._v(" "),a("p",[t._v("Set up "),a("a",{attrs:{href:"https://github.com/djbooth007/tallycoin_connect",target:"_blank",rel:"noopener noreferrer"}},[t._v("Tallycoin Connect"),a("OutboundLink")],1),t._v(" on your BTCPay Server instance to allow for the retrieval of Lightning invoices via "),a("a",{attrs:{href:"https://tallyco.in/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Tallycoin"),a("OutboundLink")],1),t._v(".\nLND required.")]),t._v(" "),a("h2",{attrs:{id:"installation"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[t._v("#")]),t._v(" Installation")]),t._v(" "),a("p",[t._v("To install the Tallycoin Connect service, you need to set your Tallycoin API key and a password first.\nThe password is optional, but as the service will be publicly available, you are strongly advised to require a secure password for the login.")]),t._v(" "),a("p",[t._v("You can either set "),a("code",[t._v("TALLYCOIN_PASSWD_CLEARTEXT")]),t._v(" (plain text) or "),a("code",[t._v("TALLYCOIN_PASSWD")]),t._v(", which must be a sha256 hash of your login password.")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Set API key and password")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("TALLYCOIN_APIKEY")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"my-tallycoin-api-key"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("TALLYCOIN_PASSWD_CLEARTEXT")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"sUpErSeCuRe"')]),t._v("\n\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("# Add fragment and run setup")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"'),a("span",{pre:!0,attrs:{class:"token variable"}},[t._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t._v(';opt-add-tallycoin-connect"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" btcpay-setup.sh -i\n")])])]),a("p",[t._v("Afterwards you should see Tallycoin Connect appear as a service on the Server Settings > Services page in BTCPay Server.")]),t._v(" "),a("h2",{attrs:{id:"troubleshooting"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[t._v("#")]),t._v(" Troubleshooting")]),t._v(" "),a("p",[t._v("To see the logs of the Tallycoin Connect service, you can run this command:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[t._v("docker")]),t._v(" logs -f generated_tallycoin_connect_1\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/119.d6a5d259.js b/assets/js/119.82c50aef.js similarity index 98% rename from assets/js/119.d6a5d259.js rename to assets/js/119.82c50aef.js index 821ff97578..e4e445972d 100644 --- a/assets/js/119.d6a5d259.js +++ b/assets/js/119.82c50aef.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[119],{740:function(e,t,r){"use strict";r.r(t);var a=r(9),o=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"drupal-commerce-2x-integration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#drupal-commerce-2x-integration"}},[e._v("#")]),e._v(" Drupal Commerce 2.x integration")]),e._v(" "),t("p",[e._v("The project can be found "),t("a",{attrs:{href:"https://drupal.org/project/commerce_btcpay",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(" on drupal.org and therefore can be installed using "),t("code",[e._v("composer")]),e._v(" from the drupal.org packagist (no need to add the repo manually to your "),t("code",[e._v("composer.json")]),e._v("). The sources are available on "),t("a",{attrs:{href:"https://github.com/btcpayserver/commerce_btcpay",target:"_blank",rel:"noopener noreferrer"}},[e._v("github"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"requirements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#requirements"}},[e._v("#")]),e._v(" Requirements")]),e._v(" "),t("ul",[t("li",[e._v("BTCPay Server ("),t("RouterLink",{attrs:{to:"/Deployment/"}},[e._v("self hosted or 3rd party")]),e._v(" or "),t("RouterLink",{attrs:{to:"/TryItOut/"}},[e._v("quick start with a testserver")]),e._v(")")],1),e._v(" "),t("li",[e._v("Drupal Commerce 2.x installed ("),t("a",{attrs:{href:"https://docs.drupalcommerce.org/commerce2/developer-guide/install-update/installation",target:"_blank",rel:"noopener noreferrer"}},[e._v("installation guide"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Drupal: "),t("a",{attrs:{href:"https://www.drupal.org/docs/8/core/modules/file/overview#content-accessing-private-files",target:"_blank",rel:"noopener noreferrer"}},[e._v("configured private file system"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"module-installation-and-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#module-installation-and-configuration"}},[e._v("#")]),e._v(" Module installation and configuration")]),e._v(" "),t("h3",{attrs:{id:"quick-walkthrough-screencast"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#quick-walkthrough-screencast"}},[e._v("#")]),e._v(" Quick walkthrough screencast")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/XBZwyC2v48s/hqdefault.jpg)"},attrs:{href:"https://youtube.com/watch?v=XBZwyC2v48s",title:"BTCPay Server - Drupal Commerce 2.x quick walkthrough","data-id":"XBZwyC2v48s"}},[t("iframe",{attrs:{title:"BTCPay Server - Drupal Commerce 2.x quick walkthrough","data-src":"https://www.youtube-nocookie.com/embed/XBZwyC2v48s?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("h3",{attrs:{id:"quick-walkthrough-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#quick-walkthrough-steps"}},[e._v("#")]),e._v(" Quick walkthrough steps")]),e._v(" "),t("h4",{attrs:{id:"generate-pairing-code-on-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#generate-pairing-code-on-btcpay-server"}},[e._v("#")]),e._v(" Generate pairing code on BTCPay server")]),e._v(" "),t("ol",[t("li",[e._v("BTCPay server: "),t("RouterLink",{attrs:{to:"/CreateStore/#creating-a-store-in-btcpay"}},[e._v("create and configure a store")])],1),e._v(" "),t("li",[e._v('in store settings go to "'),t("strong",[e._v("Access Tokens")]),e._v('"')]),e._v(" "),t("li",[e._v("click on "),t("strong",[e._v("[Create a new token]")])]),e._v(" "),t("li",[t("strong",[e._v("Label:")]),e._v(" enter some label (eg. my store)")]),e._v(" "),t("li",[t("strong",[e._v("Public key:")]),e._v(" this needs to be left "),t("strong",[e._v("empty")])]),e._v(" "),t("li",[t("strong",[e._v("Facade:")]),e._v(' "merchant"')]),e._v(" "),t("li",[e._v("click on "),t("strong",[e._v("[Request pairing]")])]),e._v(" "),t("li",[e._v("on next screen choose your configured store in "),t("strong",[e._v("Pair to")]),e._v(" select dropdown and click on "),t("strong",[e._v("[approve]")])]),e._v(" "),t("li",[e._v('note down the displayed 7-digit code at the top status message, e.g. "d7afaXr"\n(you will need that code below on gateway configuration, see below)')])]),e._v(" "),t("h4",{attrs:{id:"commerce-btcpay-installation-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#commerce-btcpay-installation-configuration"}},[e._v("#")]),e._v(" Commerce BTCPay: Installation + configuration")]),e._v(" "),t("ol",[t("li",[e._v("install module: "),t("code",[e._v("composer require drupal/commerce_btcpay")])]),e._v(" "),t("li",[e._v("enable the module: "),t("code",[e._v("drush en commerce_btcpay -y")])]),e._v(" "),t("li",[e._v("make sure you have configured "),t("a",{attrs:{href:"https://www.drupal.org/docs/8/core/modules/file/overview#content-accessing-private-files",target:"_blank",rel:"noopener noreferrer"}},[e._v("private file system"),t("OutboundLink")],1),e._v(" (needed to store encrypted public+private key)")]),e._v(" "),t("li",[e._v("Commerce BTCPay configuration ("),t("strong",[e._v("Commerce -> Configuration -> Payment -> Payment gateways")]),e._v("):")]),e._v(" "),t("li",[e._v('add payment method "BTCPay"\n'),t("ul",[t("li",[t("strong",[e._v("Mode")]),e._v(": Test or Live (you can configure both individually)")]),e._v(" "),t("li",[t("strong",[e._v("Test/Live server host")]),e._v(": enter your URL without https:// prefix e.g. btcpay.yourserver.com (note valid SSL certificate needed)")]),e._v(" "),t("li",[t("strong",[e._v("Test/Live Paring code")]),e._v(': enter the 7-digit pairing code from BTCPay "Access tokens" page')]),e._v(" "),t("li",[t("strong",[e._v("Save")]),e._v("\nYou should see a message that the tokens were successfully created.")])])])])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[119],{739:function(e,t,r){"use strict";r.r(t);var a=r(9),o=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"drupal-commerce-2x-integration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#drupal-commerce-2x-integration"}},[e._v("#")]),e._v(" Drupal Commerce 2.x integration")]),e._v(" "),t("p",[e._v("The project can be found "),t("a",{attrs:{href:"https://drupal.org/project/commerce_btcpay",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(" on drupal.org and therefore can be installed using "),t("code",[e._v("composer")]),e._v(" from the drupal.org packagist (no need to add the repo manually to your "),t("code",[e._v("composer.json")]),e._v("). The sources are available on "),t("a",{attrs:{href:"https://github.com/btcpayserver/commerce_btcpay",target:"_blank",rel:"noopener noreferrer"}},[e._v("github"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"requirements"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#requirements"}},[e._v("#")]),e._v(" Requirements")]),e._v(" "),t("ul",[t("li",[e._v("BTCPay Server ("),t("RouterLink",{attrs:{to:"/Deployment/"}},[e._v("self hosted or 3rd party")]),e._v(" or "),t("RouterLink",{attrs:{to:"/TryItOut/"}},[e._v("quick start with a testserver")]),e._v(")")],1),e._v(" "),t("li",[e._v("Drupal Commerce 2.x installed ("),t("a",{attrs:{href:"https://docs.drupalcommerce.org/commerce2/developer-guide/install-update/installation",target:"_blank",rel:"noopener noreferrer"}},[e._v("installation guide"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("li",[e._v("Drupal: "),t("a",{attrs:{href:"https://www.drupal.org/docs/8/core/modules/file/overview#content-accessing-private-files",target:"_blank",rel:"noopener noreferrer"}},[e._v("configured private file system"),t("OutboundLink")],1)])]),e._v(" "),t("h2",{attrs:{id:"module-installation-and-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#module-installation-and-configuration"}},[e._v("#")]),e._v(" Module installation and configuration")]),e._v(" "),t("h3",{attrs:{id:"quick-walkthrough-screencast"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#quick-walkthrough-screencast"}},[e._v("#")]),e._v(" Quick walkthrough screencast")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/XBZwyC2v48s/hqdefault.jpg)"},attrs:{href:"https://youtube.com/watch?v=XBZwyC2v48s",title:"BTCPay Server - Drupal Commerce 2.x quick walkthrough","data-id":"XBZwyC2v48s"}},[t("iframe",{attrs:{title:"BTCPay Server - Drupal Commerce 2.x quick walkthrough","data-src":"https://www.youtube-nocookie.com/embed/XBZwyC2v48s?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("h3",{attrs:{id:"quick-walkthrough-steps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#quick-walkthrough-steps"}},[e._v("#")]),e._v(" Quick walkthrough steps")]),e._v(" "),t("h4",{attrs:{id:"generate-pairing-code-on-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#generate-pairing-code-on-btcpay-server"}},[e._v("#")]),e._v(" Generate pairing code on BTCPay server")]),e._v(" "),t("ol",[t("li",[e._v("BTCPay server: "),t("RouterLink",{attrs:{to:"/CreateStore/#creating-a-store-in-btcpay"}},[e._v("create and configure a store")])],1),e._v(" "),t("li",[e._v('in store settings go to "'),t("strong",[e._v("Access Tokens")]),e._v('"')]),e._v(" "),t("li",[e._v("click on "),t("strong",[e._v("[Create a new token]")])]),e._v(" "),t("li",[t("strong",[e._v("Label:")]),e._v(" enter some label (eg. my store)")]),e._v(" "),t("li",[t("strong",[e._v("Public key:")]),e._v(" this needs to be left "),t("strong",[e._v("empty")])]),e._v(" "),t("li",[t("strong",[e._v("Facade:")]),e._v(' "merchant"')]),e._v(" "),t("li",[e._v("click on "),t("strong",[e._v("[Request pairing]")])]),e._v(" "),t("li",[e._v("on next screen choose your configured store in "),t("strong",[e._v("Pair to")]),e._v(" select dropdown and click on "),t("strong",[e._v("[approve]")])]),e._v(" "),t("li",[e._v('note down the displayed 7-digit code at the top status message, e.g. "d7afaXr"\n(you will need that code below on gateway configuration, see below)')])]),e._v(" "),t("h4",{attrs:{id:"commerce-btcpay-installation-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#commerce-btcpay-installation-configuration"}},[e._v("#")]),e._v(" Commerce BTCPay: Installation + configuration")]),e._v(" "),t("ol",[t("li",[e._v("install module: "),t("code",[e._v("composer require drupal/commerce_btcpay")])]),e._v(" "),t("li",[e._v("enable the module: "),t("code",[e._v("drush en commerce_btcpay -y")])]),e._v(" "),t("li",[e._v("make sure you have configured "),t("a",{attrs:{href:"https://www.drupal.org/docs/8/core/modules/file/overview#content-accessing-private-files",target:"_blank",rel:"noopener noreferrer"}},[e._v("private file system"),t("OutboundLink")],1),e._v(" (needed to store encrypted public+private key)")]),e._v(" "),t("li",[e._v("Commerce BTCPay configuration ("),t("strong",[e._v("Commerce -> Configuration -> Payment -> Payment gateways")]),e._v("):")]),e._v(" "),t("li",[e._v('add payment method "BTCPay"\n'),t("ul",[t("li",[t("strong",[e._v("Mode")]),e._v(": Test or Live (you can configure both individually)")]),e._v(" "),t("li",[t("strong",[e._v("Test/Live server host")]),e._v(": enter your URL without https:// prefix e.g. btcpay.yourserver.com (note valid SSL certificate needed)")]),e._v(" "),t("li",[t("strong",[e._v("Test/Live Paring code")]),e._v(': enter the 7-digit pairing code from BTCPay "Access tokens" page')]),e._v(" "),t("li",[t("strong",[e._v("Save")]),e._v("\nYou should see a message that the tokens were successfully created.")])])])])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/12.1a3f1b6f.js b/assets/js/12.7726a034.js similarity index 82% rename from assets/js/12.1a3f1b6f.js rename to assets/js/12.7726a034.js index c99c08956b..15fa0c8c79 100644 --- a/assets/js/12.1a3f1b6f.js +++ b/assets/js/12.7726a034.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{287:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep1.50bf607b.png"},288:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep1ssh.0dffbb41.png"},289:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep2.6445f876.png"},290:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep3.cbc1a6d5.png"},291:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep4.f508346c.png"},292:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep5.7241d979.png"},293:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep6.2a59c072.png"},294:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep7.03daf718.png"},295:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorDeploy1.47811ae2.png"},296:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorDeploy2.10af2275.png"},297:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorDeploy3.e7fd2183.png"},298:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorDeployManual.f79f2323.png"},681:function(t,e,o){"use strict";o.r(e);var r=o(9),a=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"deploy-btcpay-with-configurator"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#deploy-btcpay-with-configurator"}},[t._v("#")]),t._v(" Deploy BTCPay with Configurator")]),t._v(" "),e("p",[t._v("BTCPay Server can easily be configured and deployed to a server using Configurator. This tool makes deployment simple by allowing users to initialize or modify their BTCPay setup from the Configurator.")]),t._v(" "),e("p",[t._v("Configurator can be used to modify an existing BTCPay Server, from the admin account only. Other users may visit the server's Configurator url to deploy new BTCPay instances.")]),t._v(" "),e("p",[t._v("Someone such as a BTCPay third-party host may provide a Configurator instance for their users. This can help transition users to a self-hosted solution when they are ready to stop using the third-party host's server.")]),t._v(" "),e("p",[t._v("Another use-case is for server admins who are deploying BTCPay Server's on behalf of clients or other users as part of a consulting business. Admins can easily export a Docker deployment script from Configurator selections or deploy the configuration immediately to a VPS or on-premise server using SSH.")]),t._v(" "),e("h1",{attrs:{id:"how-to-set-up-configurator"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-set-up-configurator"}},[t._v("#")]),t._v(" How to set up Configurator")]),t._v(" "),e("h2",{attrs:{id:"option-1-add-as-an-external-service-to-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#option-1-add-as-an-external-service-to-btcpay"}},[t._v("#")]),t._v(" Option 1: Add as an external service to BTCPay")]),t._v(" "),e("p",[t._v("If you already have an existing BTCPay Server "),e("RouterLink",{attrs:{to:"/Deployment/"}},[t._v("deployed")]),t._v(" with the "),e("code",[t._v("opt-add-configurator")]),t._v(" "),e("a",{attrs:{href:"/FAQ/FAQ-Deployment#how-can-i-modify-or-deactivate-environment-variables"}},[t._v("environment variable added")]),t._v(", view your Configurator by navigating to:")],1),t._v(" "),e("p",[e("strong",[t._v("Server Settings > Services > Other external services > Configurator > Click See information")])]),t._v(" "),e("p",[t._v("Once enabled, non-admins may also view the Configurator at: "),e("code",[t._v("yourbtcpaydomain.com/configurator")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"option-2-build-locally-with-docker"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#option-2-build-locally-with-docker"}},[t._v("#")]),t._v(" Option 2: Build locally with Docker")]),t._v(" "),e("p",[t._v("If you have Docker installed on your machine, you can open a terminal and the run the following command to run Configurator inside of a Docker container to use on your local machine:")]),t._v(" "),e("p",[e("code",[t._v("docker run -p 1337:80 --name btcpayserver-configurator btcpayserver/btcpayserver-configurator")])]),t._v(" "),e("p",[t._v("Now you can open a browser tab and view your Configurator at "),e("strong",[t._v("localhost:1337")])]),t._v(" "),e("h1",{attrs:{id:"how-to-use-configurator"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use-configurator"}},[t._v("#")]),t._v(" How to use Configurator")]),t._v(" "),e("p",[t._v("Step 1: Destination")]),t._v(" "),e("p",[t._v("Select an option to deploy using SSH now or generate a bash script for later deployment.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(287),alt:"Select Deployment",title:"Select Deployment"}})]),t._v(" "),e("p",[t._v("To configure and deploy a server now, provide your SSH credentials where you would like it deployed to.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(288),alt:"Provide SSH Details",title:"Provide SSH Details"}})]),t._v(" "),e("p",[t._v('Note: The "Load Existing Settings" option will use the previous deployment\'s selections for faster configuration if you are modifying an existing installation.')]),t._v(" "),e("p",[t._v("Step 2: Domain")]),t._v(" "),e("p",[t._v("Provide the domain name associated with your server IP address.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(289),alt:"Provide Domain",title:"Provide Domain"}})]),t._v(" "),e("p",[t._v("Step 3: Chain")]),t._v(" "),e("p",[t._v("Select the desired Bitcoin network type, Bitcoin node pruning level and add any altcoins.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(290),alt:"Select Chain",title:"Select Chain"}})]),t._v(" "),e("p",[t._v("Step 4: Lightning")]),t._v(" "),e("p",[t._v("Select the desired Lightning network option (optional).")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(291),alt:"Lightning Options",title:"Lightning Options"}})]),t._v(" "),e("p",[t._v("Step 5: Additional")]),t._v(" "),e("p",[t._v("Add any additional services to your BTCPay Server deployment (optional).")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(292),alt:"Docker Options",title:"Docker Options"}})]),t._v(" "),e("p",[t._v("Step 6: Advanced")]),t._v(" "),e("p",[t._v("Provide any additional advanced settings (optional).")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(293),alt:"Advanced Settings",title:"Advanced Settings"}})]),t._v(" "),e("p",[t._v("Step 7: Summary")]),t._v(" "),e("p",[t._v("Verify your configuration settings look correct before deploying the server.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(294),alt:"Review Settings",title:"Review Settings"}})]),t._v(" "),e("p",[t._v("During Deployment:")]),t._v(" "),e("p",[t._v("Configurator will SSH into the target server and do the following actions completely automated on your behalf:")]),t._v(" "),e("ul",[e("li",[t._v("Install Docker")]),t._v(" "),e("li",[t._v("Install Docker-Compose")]),t._v(" "),e("li",[t._v("Install Git")]),t._v(" "),e("li",[t._v("Setup BTCPay settings")]),t._v(" "),e("li",[t._v("Make sure it starts at reboot via upstart or systemd")]),t._v(" "),e("li",[t._v("Add BTCPay utilities in /user/bin")]),t._v(" "),e("li",[t._v("Start BTCPay")])]),t._v(" "),e("p",[t._v("The deployment progress will be displayed in your Configurator.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(295),alt:"Wait for Deployment",title:"Wait for Deployment"}})]),t._v(" "),e("p",[t._v("Upon deployment completion, Configurator will display the domain of the newly configured BTCPay Server.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(296),alt:"Deployment Location",title:"Deployment Location"}})]),t._v(" "),e("p",[t._v("The list of executed commands that were used to deploy the server configuration are also displayed.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(297),alt:"Executed Commands",title:"Executed Commands"}})]),t._v(" "),e("h2",{attrs:{id:"export-manual-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#export-manual-configuration"}},[t._v("#")]),t._v(" Export Manual Configuration")]),t._v(" "),e("p",[t._v("If you want to deploy the configuration to your server at a later time, you can instead export a bash script of your settings. Later you can paste the configuration into your server terminal.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(298),alt:"Manual Script",title:"Manual Script"}})]),t._v(" "),e("h2",{attrs:{id:"privacy-security-concerns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#privacy-security-concerns"}},[t._v("#")]),t._v(" Privacy & Security Concerns")]),t._v(" "),e("p",[t._v("If you are using someone else's Configurator to deploy your BTCPay Server, such as a "),e("RouterLink",{attrs:{to:"/ThirdPartyHosting/"}},[t._v("trusted Third-Party")]),t._v(", you will be providing them with your:")],1),t._v(" "),e("ul",[e("li",[t._v("server IP/domain and ssh password")]),t._v(" "),e("li",[t._v("server configuration settings")])]),t._v(" "),e("p",[t._v("Users are advised to change their SSH password after Configurator deployment is complete.")]),t._v(" "),e("p",[t._v("To mitigate these privacy and security concerns, use either the "),e("a",{attrs:{href:"#option-2-build-locally-with-Docker"}},[t._v("local deployment with Docker")]),t._v(" or the "),e("a",{attrs:{href:"#export-manual-configuration"}},[t._v("exported manual script")]),t._v(" without providing your domain. Be sure to include the domain when you paste the commands into your terminal.")])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[12],{283:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep1.50bf607b.png"},284:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep1ssh.0dffbb41.png"},285:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep2.6445f876.png"},286:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep3.cbc1a6d5.png"},287:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep4.f508346c.png"},288:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep5.7241d979.png"},289:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep6.2a59c072.png"},290:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorStep7.03daf718.png"},291:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorDeploy1.47811ae2.png"},292:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorDeploy2.10af2275.png"},293:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorDeploy3.e7fd2183.png"},294:function(t,e,o){t.exports=o.p+"assets/img/ConfiguratorDeployManual.f79f2323.png"},679:function(t,e,o){"use strict";o.r(e);var r=o(9),a=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"deploy-btcpay-with-configurator"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#deploy-btcpay-with-configurator"}},[t._v("#")]),t._v(" Deploy BTCPay with Configurator")]),t._v(" "),e("p",[t._v("BTCPay Server can easily be configured and deployed to a server using Configurator. This tool makes deployment simple by allowing users to initialize or modify their BTCPay setup from the Configurator.")]),t._v(" "),e("p",[t._v("Configurator can be used to modify an existing BTCPay Server, from the admin account only. Other users may visit the server's Configurator url to deploy new BTCPay instances.")]),t._v(" "),e("p",[t._v("Someone such as a BTCPay third-party host may provide a Configurator instance for their users. This can help transition users to a self-hosted solution when they are ready to stop using the third-party host's server.")]),t._v(" "),e("p",[t._v("Another use-case is for server admins who are deploying BTCPay Server's on behalf of clients or other users as part of a consulting business. Admins can easily export a Docker deployment script from Configurator selections or deploy the configuration immediately to a VPS or on-premise server using SSH.")]),t._v(" "),e("h1",{attrs:{id:"how-to-set-up-configurator"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-set-up-configurator"}},[t._v("#")]),t._v(" How to set up Configurator")]),t._v(" "),e("h2",{attrs:{id:"option-1-add-as-an-external-service-to-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#option-1-add-as-an-external-service-to-btcpay"}},[t._v("#")]),t._v(" Option 1: Add as an external service to BTCPay")]),t._v(" "),e("p",[t._v("If you already have an existing BTCPay Server "),e("RouterLink",{attrs:{to:"/Deployment/"}},[t._v("deployed")]),t._v(" with the "),e("code",[t._v("opt-add-configurator")]),t._v(" "),e("a",{attrs:{href:"/FAQ/FAQ-Deployment#how-can-i-modify-or-deactivate-environment-variables"}},[t._v("environment variable added")]),t._v(", view your Configurator by navigating to:")],1),t._v(" "),e("p",[e("strong",[t._v("Server Settings > Services > Other external services > Configurator > Click See information")])]),t._v(" "),e("p",[t._v("Once enabled, non-admins may also view the Configurator at: "),e("code",[t._v("yourbtcpaydomain.com/configurator")]),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"option-2-build-locally-with-docker"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#option-2-build-locally-with-docker"}},[t._v("#")]),t._v(" Option 2: Build locally with Docker")]),t._v(" "),e("p",[t._v("If you have Docker installed on your machine, you can open a terminal and the run the following command to run Configurator inside of a Docker container to use on your local machine:")]),t._v(" "),e("p",[e("code",[t._v("docker run -p 1337:80 --name btcpayserver-configurator btcpayserver/btcpayserver-configurator")])]),t._v(" "),e("p",[t._v("Now you can open a browser tab and view your Configurator at "),e("strong",[t._v("localhost:1337")])]),t._v(" "),e("h1",{attrs:{id:"how-to-use-configurator"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use-configurator"}},[t._v("#")]),t._v(" How to use Configurator")]),t._v(" "),e("p",[t._v("Step 1: Destination")]),t._v(" "),e("p",[t._v("Select an option to deploy using SSH now or generate a bash script for later deployment.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(283),alt:"Select Deployment",title:"Select Deployment"}})]),t._v(" "),e("p",[t._v("To configure and deploy a server now, provide your SSH credentials where you would like it deployed to.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(284),alt:"Provide SSH Details",title:"Provide SSH Details"}})]),t._v(" "),e("p",[t._v('Note: The "Load Existing Settings" option will use the previous deployment\'s selections for faster configuration if you are modifying an existing installation.')]),t._v(" "),e("p",[t._v("Step 2: Domain")]),t._v(" "),e("p",[t._v("Provide the domain name associated with your server IP address.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(285),alt:"Provide Domain",title:"Provide Domain"}})]),t._v(" "),e("p",[t._v("Step 3: Chain")]),t._v(" "),e("p",[t._v("Select the desired Bitcoin network type, Bitcoin node pruning level and add any altcoins.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(286),alt:"Select Chain",title:"Select Chain"}})]),t._v(" "),e("p",[t._v("Step 4: Lightning")]),t._v(" "),e("p",[t._v("Select the desired Lightning network option (optional).")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(287),alt:"Lightning Options",title:"Lightning Options"}})]),t._v(" "),e("p",[t._v("Step 5: Additional")]),t._v(" "),e("p",[t._v("Add any additional services to your BTCPay Server deployment (optional).")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(288),alt:"Docker Options",title:"Docker Options"}})]),t._v(" "),e("p",[t._v("Step 6: Advanced")]),t._v(" "),e("p",[t._v("Provide any additional advanced settings (optional).")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(289),alt:"Advanced Settings",title:"Advanced Settings"}})]),t._v(" "),e("p",[t._v("Step 7: Summary")]),t._v(" "),e("p",[t._v("Verify your configuration settings look correct before deploying the server.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(290),alt:"Review Settings",title:"Review Settings"}})]),t._v(" "),e("p",[t._v("During Deployment:")]),t._v(" "),e("p",[t._v("Configurator will SSH into the target server and do the following actions completely automated on your behalf:")]),t._v(" "),e("ul",[e("li",[t._v("Install Docker")]),t._v(" "),e("li",[t._v("Install Docker-Compose")]),t._v(" "),e("li",[t._v("Install Git")]),t._v(" "),e("li",[t._v("Setup BTCPay settings")]),t._v(" "),e("li",[t._v("Make sure it starts at reboot via upstart or systemd")]),t._v(" "),e("li",[t._v("Add BTCPay utilities in /user/bin")]),t._v(" "),e("li",[t._v("Start BTCPay")])]),t._v(" "),e("p",[t._v("The deployment progress will be displayed in your Configurator.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(291),alt:"Wait for Deployment",title:"Wait for Deployment"}})]),t._v(" "),e("p",[t._v("Upon deployment completion, Configurator will display the domain of the newly configured BTCPay Server.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(292),alt:"Deployment Location",title:"Deployment Location"}})]),t._v(" "),e("p",[t._v("The list of executed commands that were used to deploy the server configuration are also displayed.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(293),alt:"Executed Commands",title:"Executed Commands"}})]),t._v(" "),e("h2",{attrs:{id:"export-manual-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#export-manual-configuration"}},[t._v("#")]),t._v(" Export Manual Configuration")]),t._v(" "),e("p",[t._v("If you want to deploy the configuration to your server at a later time, you can instead export a bash script of your settings. Later you can paste the configuration into your server terminal.")]),t._v(" "),e("figure",[e("img",{attrs:{src:o(294),alt:"Manual Script",title:"Manual Script"}})]),t._v(" "),e("h2",{attrs:{id:"privacy-security-concerns"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#privacy-security-concerns"}},[t._v("#")]),t._v(" Privacy & Security Concerns")]),t._v(" "),e("p",[t._v("If you are using someone else's Configurator to deploy your BTCPay Server, such as a "),e("RouterLink",{attrs:{to:"/ThirdPartyHosting/"}},[t._v("trusted Third-Party")]),t._v(", you will be providing them with your:")],1),t._v(" "),e("ul",[e("li",[t._v("server IP/domain and ssh password")]),t._v(" "),e("li",[t._v("server configuration settings")])]),t._v(" "),e("p",[t._v("Users are advised to change their SSH password after Configurator deployment is complete.")]),t._v(" "),e("p",[t._v("To mitigate these privacy and security concerns, use either the "),e("a",{attrs:{href:"#option-2-build-locally-with-Docker"}},[t._v("local deployment with Docker")]),t._v(" or the "),e("a",{attrs:{href:"#export-manual-configuration"}},[t._v("exported manual script")]),t._v(" without providing your domain. Be sure to include the domain when you paste the commands into your terminal.")])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/120.225c2ce9.js b/assets/js/120.89c42efb.js similarity index 99% rename from assets/js/120.225c2ce9.js rename to assets/js/120.89c42efb.js index 18cde954b6..6efc3a34b9 100644 --- a/assets/js/120.225c2ce9.js +++ b/assets/js/120.89c42efb.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{741:function(e,t,r){"use strict";r.r(t);var o=r(9),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"electrum-personal-server-eps-integration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#electrum-personal-server-eps-integration"}},[e._v("#")]),e._v(" Electrum Personal Server (EPS) integration")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chris-belcher/electrum-personal-server",target:"_blank",rel:"noopener noreferrer"}},[e._v("Electrum Personal Server or EPS"),t("OutboundLink")],1),e._v(" is a personal version of public Electrum servers like "),t("RouterLink",{attrs:{to:"/ElectrumX/"}},[e._v("ElectrumX")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[e._v("EPS can be integrated into BTCPay Server")]),e._v(" using the optional docker fragment "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-electrum-ps.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-electrum-ps.yml"),t("OutboundLink")],1),e._v(". Use EPS when you want to use your own full node (included in BTCPay Server) to verify your own transactions privately when using Electrum Wallet.")]),e._v(" "),t("p",[e._v("The biggest difference with public Electrum servers (eg. ElectrumX), is that "),t("strong",[e._v("EPS is for monitoring only your own wallet(s)")]),e._v('. The "XPUB" (extended public key) of the wallet you use in Electrum must be shared with EPS in order for it to function all all. Other than this, it functions (from an end user perspective) in the same way as ElectrumX etc. It is '),t("strong",[e._v("easy to integrate into BTCPay")]),e._v(" just follow the instructions below.")]),e._v(" "),t("p",[e._v("EPS does not require "),t("code",[e._v("txindex")]),e._v(" and works on a pruned node.")]),e._v(" "),t("h2",{attrs:{id:"about-tor-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#about-tor-support"}},[e._v("#")]),e._v(" About Tor support")]),e._v(" "),t("p",[e._v("By default your EPS is accessible over Tor. You can run the following command line via SSH on your server to get your Tor address:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cat")]),e._v(" /var/lib/docker/volumes/generated_tor_servicesdir/_data/btc-electrum-ps/hostname\n")])])]),t("p",[e._v("You can can also go to your BTCPay Server > Server Settings > Services and find the tor link in "),t("code",[e._v("Other TOR hidden services")]),e._v(".")]),e._v(" "),t("p",[e._v("On the Electrum wallet machine, if you want to connect to your server via Tor, we assume in this tutorial that you run the Tor Browser locally, and thus you will use SOCKS5 port "),t("code",[e._v("9150")]),e._v(". If you run Tor through the command line instead, the local SOCKS5 port is "),t("code",[e._v("9050")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"how-to-enable-electrum-personal-server-eps-in-btcpay"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-enable-electrum-personal-server-eps-in-btcpay"}},[e._v("#")]),e._v(" How to enable Electrum Personal Server (EPS) in BTCPay:")]),e._v(" "),t("ol",[t("li",[t("p",[t("strong",[e._v("If you do not use Tor")]),e._v(", EPS is accessible for Electrum Wallets via TCP port 50002. You need to open this port up fully at least to be available within your own network to any PC or Android device running Electrum Wallet, and turn on port forwarding. If you use Tor, you can skip this step.")])]),e._v(" "),t("li",[t("p",[e._v('As EPS is for a single wallet (single user), you must specify the XPUB/YPUB/ZPUB of your wallet as an environment varable before you enable the EPS docker-fragment. In Electrum Wallet go to the "Wallet" menu then select "Information" to copy and paste yours. Set ENV variable for your wallet XPUB and enable the Docker Additional Fragment on your BTCPay node by running the following steps:')])])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(';opt-add-electrum-ps"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("EPS_XPUB")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"XPUB_ADD_YOUR_XPUB_YPUB_OR_ZPUB_HERE"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" btcpay-setup.sh -i\n")])])]),t("ol",{attrs:{start:"3"}},[t("li",[e._v("WAIT for your Bitcoin full node and EPS server to fully sync:\nYou can check the status of bitcoin core sync by going to your domain for BTCPay server, and it will show you on the front page. Or, you can check from the command line as well, using these commands:\n"),t("code",[e._v("docker logs btcpayserver_bitcoind")]),e._v(" - this will show you the bitcoin core blockchain sync status (and ALL other info about your node, including any errors)\n"),t("code",[e._v("docker logs generated_electrum_ps_1")]),e._v(" - this will show you the EPS sync status. Note: EPS will NOT start syncing until bitcoin full node has finished syncing, you will see errors until that is finished and these can be ignored.")])]),e._v(" "),t("p",[e._v("Once all syncing for both bitcoin and EPS have finished synching, you can proceed to the next step. (Note: Electrum wallets will not connect to an EPS server that has not finished synching)")]),e._v(" "),t("h2",{attrs:{id:"how-to-connect-electrum-wallet-to-eps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-connect-electrum-wallet-to-eps"}},[e._v("#")]),e._v(" How to connect Electrum Wallet to EPS")]),e._v(" "),t("p",[e._v("There are three ways to use your server from Electrum Wallet:")]),e._v(" "),t("ol",[t("li",[e._v("By editing the configuration file")]),e._v(" "),t("li",[e._v("By running Electrum by the command line")]),e._v(" "),t("li",[e._v("Via the user interface (not recommended, bad privacy)")])]),e._v(" "),t("h4",{attrs:{id:"option-1-connect-to-your-eps-server-by-directly-editing-electrum-wallet-config-file-before-even-opening-the-electrum-wallet-gui-recommended-for-full-privacy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#option-1-connect-to-your-eps-server-by-directly-editing-electrum-wallet-config-file-before-even-opening-the-electrum-wallet-gui-recommended-for-full-privacy"}},[e._v("#")]),e._v(" Option 1: Connect to your EPS Server by directly editing Electrum Wallet config file (before even opening the Electrum wallet GUI - recommended for full privacy):")]),e._v(" "),t("p",[e._v("You can "),t("strong",[e._v("setup your Electrum server")]),e._v(" by editing the configuration file.")]),e._v(" "),t("p",[e._v("In the "),t("a",{attrs:{href:"https://electrum.readthedocs.io/en/latest/faq.html#where-is-my-wallet-file-located",target:"_blank",rel:"noopener noreferrer"}},[e._v("Electrum Wallet folder"),t("OutboundLink")],1),e._v(", open and edit the "),t("code",[e._v("config")]),e._v(" file like this:")]),e._v(" "),t("ol",[t("li",[t("p",[e._v("Find line: "),t("code",[e._v('"auto_connect": true,')]),e._v(" and switch it to: "),t("code",[e._v('"auto_connect": false,')]),e._v(" - this will prevent your Electrum Wallet from auto-connecting to other 3rd party Electrum Servers at launch time (to obtain block headers and transaction information).")])]),e._v(" "),t("li",[t("p",[e._v("Find line: "),t("code",[e._v('"oneserver": false,')]),e._v(" and switch it to: "),t("code",[e._v('"oneserver": true,')]),e._v(" - ensures that all data is obtained from just one server.")])]),e._v(" "),t("li",[t("p",[e._v("Find or add line: "),t("code",[e._v('"server": "yourserver:50002:s",')]),e._v("and switch it to your own EPS Server's IP address, in the example above this would be: "),t("code",[e._v('"server": "192.168.1.3:50002:s",')]),e._v("- hard code your IP address as the default upon opening the Wallet.")])])]),e._v(" "),t("p",[e._v("These 3 steps strongly recommended for full privacy by locking down Electrum Wallet to one single connection with your private server only ("),t("a",{attrs:{href:"https://github.com/chris-belcher/electrum-personal-server#how-to",target:"_blank",rel:"noopener noreferrer"}},[e._v("Reference"),t("OutboundLink")],1),e._v(").")]),e._v(" "),t("ol",{attrs:{start:"4"}},[t("li",[e._v("("),t("strong",[e._v("If you use Tor")]),e._v(") If you run Tor Browser, you can use it as SOCK5 proxy by adding "),t("code",[e._v('"proxy": "socks5:127.0.0.1:9150::",')]),e._v(" to the configuration file.")])]),e._v(" "),t("h4",{attrs:{id:"option-3-connect-to-your-eps-server-by-command-line"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#option-3-connect-to-your-eps-server-by-command-line"}},[e._v("#")]),e._v(" Option 3: Connect to your EPS Server by command line")]),e._v(" "),t("p",[e._v("You can run electrum via command line "),t("code",[e._v("electrum --oneserver --server yourserver:50002:s")]),e._v(".")]),e._v(" "),t("p",[e._v("If you use Tor, add "),t("code",[e._v("-p socks5:localhost:9150")]),e._v(".")]),e._v(" "),t("h4",{attrs:{id:"option-4-connect-to-your-eps-server-from-electrum-wallet-gui-not-recommended-as-this-will-momentarily-connects-with-other-random-public-electrum-servers-if-you-are-online"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#option-4-connect-to-your-eps-server-from-electrum-wallet-gui-not-recommended-as-this-will-momentarily-connects-with-other-random-public-electrum-servers-if-you-are-online"}},[e._v("#")]),e._v(" Option 4: Connect to your EPS Server from Electrum Wallet GUI (not recommended as this will momentarily connects with other random public Electrum servers if you are online):")]),e._v(" "),t("ol",[t("li",[e._v("Open Electrum Wallet. When you click the traffic light (green or red) at the bottom of your Electrum Wallet, you will see a screen with a list of all the available Electrum servers that your wallet can connect to, normally with the "),t("code",[e._v("Select Server Automatically")]),e._v(" box already checked:")])]),e._v(" "),t("figure",[t("img",{attrs:{src:"https://user-images.githubusercontent.com/1388507/68437521-8a5eb580-01c1-11ea-9ece-0666353a6742.png",alt:"ElectrumWalletServerList",title:"ElectrumWalletServerList"}})]),e._v(" "),t("ol",{attrs:{start:"2"}},[t("li",[e._v("Now is the time to UNCHECK that "),t("code",[e._v("Select Server Automatically")]),e._v(" setting, which will enable you to enter the IP address or domain or hostname of your EPS Server. In the case below, the EPS server is on the local network at "),t("code",[e._v("192.168.1.3")]),e._v(" so we enter that manually (leave port as 50002) and press "),t("code",[e._v("close")]),e._v(".")])]),e._v(" "),t("figure",[t("img",{attrs:{src:"https://user-images.githubusercontent.com/1388507/68496320-4e276580-0252-11ea-8caf-facc8a246d70.png",alt:"EnterElectrumServerIP",title:"EnterElectrumServerIP"}})]),e._v(" "),t("ol",{attrs:{start:"4"}},[t("li",[t("p",[e._v("("),t("strong",[e._v("If you use Tor")]),e._v(") Go to proxy, then click on "),t("code",[e._v("Use Tor Proxy at port 9150")]),e._v(".")])]),e._v(" "),t("li",[t("p",[e._v("If all of the above worked well, and your node is healthy and synched, you will get a green traffic light down the bottom right of the wallet screen - that means success!")])])]),e._v(" "),t("h3",{attrs:{id:"reflection-on-what-has-been-achieved"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reflection-on-what-has-been-achieved"}},[e._v("#")]),e._v(" Reflection on what has been achieved:")]),e._v(" "),t("p",[e._v("You are now running your very "),t("strong",[e._v("own private EPS Server")]),e._v(". All Electrum Wallet related data transfer happens directly between your EPS Server and the bitcoin blockchain, without going over any other 3rd party servers. You have attained full bitcoin transaction privacy (at least from the perspective of your blockchain queries and transactions, payment/receive addresses etc - nobody except you and the blockchain can see what you are doing).")]),e._v(" "),t("h3",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting:")]),e._v(" "),t("p",[e._v("So there is one thing you may encounter, where even after you did everything correctly, you still get a red traffic light (which means not connected to any server) in the steps above. Any other troubleshooting tips that people encounter can be added, I would suggest to make a PR to this document directly.")]),e._v(" "),t("ul",[t("li",[e._v("If you get a red traffic light, shutdown Electrum Wallet completely, then go to your Electrum Wallet folder ("),t("a",{attrs:{href:"https://electrum.readthedocs.io/en/latest/faq.html#where-is-my-wallet-file-located",target:"_blank",rel:"noopener noreferrer"}},[e._v("see here"),t("OutboundLink")],1),e._v(" if you don't know where that is).")])]),e._v(" "),t("p",[e._v("Inside the Electrum Wallet folder (in this case below, it is what it looks like on a Mac) locate the "),t("code",[e._v("certs")]),e._v(" directory and delete the certificate for the server you are trying to connect to, in this case "),t("code",[e._v("192.168.1.3")]),e._v(", by dragging it to the Trash.")]),e._v(" "),t("figure",[t("img",{attrs:{src:"https://user-images.githubusercontent.com/1388507/68497330-9a73a500-0254-11ea-9349-71bdb3bd9511.png",alt:"Certs",title:"Certs"}})]),e._v(" "),t("p",[e._v("Start up Electrum Wallet again, and connect to your "),t("strong",[e._v("EPS server")]),e._v(". If it is fully synched, it will now likely show a green traffic light, and you are good to go.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[120],{742:function(e,t,r){"use strict";r.r(t);var o=r(9),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"electrum-personal-server-eps-integration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#electrum-personal-server-eps-integration"}},[e._v("#")]),e._v(" Electrum Personal Server (EPS) integration")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://github.com/chris-belcher/electrum-personal-server",target:"_blank",rel:"noopener noreferrer"}},[e._v("Electrum Personal Server or EPS"),t("OutboundLink")],1),e._v(" is a personal version of public Electrum servers like "),t("RouterLink",{attrs:{to:"/ElectrumX/"}},[e._v("ElectrumX")]),e._v(".")],1),e._v(" "),t("p",[t("strong",[e._v("EPS can be integrated into BTCPay Server")]),e._v(" using the optional docker fragment "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/blob/master/docker-compose-generator/docker-fragments/opt-add-electrum-ps.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("opt-add-electrum-ps.yml"),t("OutboundLink")],1),e._v(". Use EPS when you want to use your own full node (included in BTCPay Server) to verify your own transactions privately when using Electrum Wallet.")]),e._v(" "),t("p",[e._v("The biggest difference with public Electrum servers (eg. ElectrumX), is that "),t("strong",[e._v("EPS is for monitoring only your own wallet(s)")]),e._v('. The "XPUB" (extended public key) of the wallet you use in Electrum must be shared with EPS in order for it to function all all. Other than this, it functions (from an end user perspective) in the same way as ElectrumX etc. It is '),t("strong",[e._v("easy to integrate into BTCPay")]),e._v(" just follow the instructions below.")]),e._v(" "),t("p",[e._v("EPS does not require "),t("code",[e._v("txindex")]),e._v(" and works on a pruned node.")]),e._v(" "),t("h2",{attrs:{id:"about-tor-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#about-tor-support"}},[e._v("#")]),e._v(" About Tor support")]),e._v(" "),t("p",[e._v("By default your EPS is accessible over Tor. You can run the following command line via SSH on your server to get your Tor address:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("cat")]),e._v(" /var/lib/docker/volumes/generated_tor_servicesdir/_data/btc-electrum-ps/hostname\n")])])]),t("p",[e._v("You can can also go to your BTCPay Server > Server Settings > Services and find the tor link in "),t("code",[e._v("Other TOR hidden services")]),e._v(".")]),e._v(" "),t("p",[e._v("On the Electrum wallet machine, if you want to connect to your server via Tor, we assume in this tutorial that you run the Tor Browser locally, and thus you will use SOCKS5 port "),t("code",[e._v("9150")]),e._v(". If you run Tor through the command line instead, the local SOCKS5 port is "),t("code",[e._v("9050")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"how-to-enable-electrum-personal-server-eps-in-btcpay"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-enable-electrum-personal-server-eps-in-btcpay"}},[e._v("#")]),e._v(" How to enable Electrum Personal Server (EPS) in BTCPay:")]),e._v(" "),t("ol",[t("li",[t("p",[t("strong",[e._v("If you do not use Tor")]),e._v(", EPS is accessible for Electrum Wallets via TCP port 50002. You need to open this port up fully at least to be available within your own network to any PC or Android device running Electrum Wallet, and turn on port forwarding. If you use Tor, you can skip this step.")])]),e._v(" "),t("li",[t("p",[e._v('As EPS is for a single wallet (single user), you must specify the XPUB/YPUB/ZPUB of your wallet as an environment varable before you enable the EPS docker-fragment. In Electrum Wallet go to the "Wallet" menu then select "Information" to copy and paste yours. Set ENV variable for your wallet XPUB and enable the Docker Additional Fragment on your BTCPay node by running the following steps:')])])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(';opt-add-electrum-ps"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("EPS_XPUB")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"XPUB_ADD_YOUR_XPUB_YPUB_OR_ZPUB_HERE"')]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" btcpay-setup.sh -i\n")])])]),t("ol",{attrs:{start:"3"}},[t("li",[e._v("WAIT for your Bitcoin full node and EPS server to fully sync:\nYou can check the status of bitcoin core sync by going to your domain for BTCPay server, and it will show you on the front page. Or, you can check from the command line as well, using these commands:\n"),t("code",[e._v("docker logs btcpayserver_bitcoind")]),e._v(" - this will show you the bitcoin core blockchain sync status (and ALL other info about your node, including any errors)\n"),t("code",[e._v("docker logs generated_electrum_ps_1")]),e._v(" - this will show you the EPS sync status. Note: EPS will NOT start syncing until bitcoin full node has finished syncing, you will see errors until that is finished and these can be ignored.")])]),e._v(" "),t("p",[e._v("Once all syncing for both bitcoin and EPS have finished synching, you can proceed to the next step. (Note: Electrum wallets will not connect to an EPS server that has not finished synching)")]),e._v(" "),t("h2",{attrs:{id:"how-to-connect-electrum-wallet-to-eps"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-connect-electrum-wallet-to-eps"}},[e._v("#")]),e._v(" How to connect Electrum Wallet to EPS")]),e._v(" "),t("p",[e._v("There are three ways to use your server from Electrum Wallet:")]),e._v(" "),t("ol",[t("li",[e._v("By editing the configuration file")]),e._v(" "),t("li",[e._v("By running Electrum by the command line")]),e._v(" "),t("li",[e._v("Via the user interface (not recommended, bad privacy)")])]),e._v(" "),t("h4",{attrs:{id:"option-1-connect-to-your-eps-server-by-directly-editing-electrum-wallet-config-file-before-even-opening-the-electrum-wallet-gui-recommended-for-full-privacy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#option-1-connect-to-your-eps-server-by-directly-editing-electrum-wallet-config-file-before-even-opening-the-electrum-wallet-gui-recommended-for-full-privacy"}},[e._v("#")]),e._v(" Option 1: Connect to your EPS Server by directly editing Electrum Wallet config file (before even opening the Electrum wallet GUI - recommended for full privacy):")]),e._v(" "),t("p",[e._v("You can "),t("strong",[e._v("setup your Electrum server")]),e._v(" by editing the configuration file.")]),e._v(" "),t("p",[e._v("In the "),t("a",{attrs:{href:"https://electrum.readthedocs.io/en/latest/faq.html#where-is-my-wallet-file-located",target:"_blank",rel:"noopener noreferrer"}},[e._v("Electrum Wallet folder"),t("OutboundLink")],1),e._v(", open and edit the "),t("code",[e._v("config")]),e._v(" file like this:")]),e._v(" "),t("ol",[t("li",[t("p",[e._v("Find line: "),t("code",[e._v('"auto_connect": true,')]),e._v(" and switch it to: "),t("code",[e._v('"auto_connect": false,')]),e._v(" - this will prevent your Electrum Wallet from auto-connecting to other 3rd party Electrum Servers at launch time (to obtain block headers and transaction information).")])]),e._v(" "),t("li",[t("p",[e._v("Find line: "),t("code",[e._v('"oneserver": false,')]),e._v(" and switch it to: "),t("code",[e._v('"oneserver": true,')]),e._v(" - ensures that all data is obtained from just one server.")])]),e._v(" "),t("li",[t("p",[e._v("Find or add line: "),t("code",[e._v('"server": "yourserver:50002:s",')]),e._v("and switch it to your own EPS Server's IP address, in the example above this would be: "),t("code",[e._v('"server": "192.168.1.3:50002:s",')]),e._v("- hard code your IP address as the default upon opening the Wallet.")])])]),e._v(" "),t("p",[e._v("These 3 steps strongly recommended for full privacy by locking down Electrum Wallet to one single connection with your private server only ("),t("a",{attrs:{href:"https://github.com/chris-belcher/electrum-personal-server#how-to",target:"_blank",rel:"noopener noreferrer"}},[e._v("Reference"),t("OutboundLink")],1),e._v(").")]),e._v(" "),t("ol",{attrs:{start:"4"}},[t("li",[e._v("("),t("strong",[e._v("If you use Tor")]),e._v(") If you run Tor Browser, you can use it as SOCK5 proxy by adding "),t("code",[e._v('"proxy": "socks5:127.0.0.1:9150::",')]),e._v(" to the configuration file.")])]),e._v(" "),t("h4",{attrs:{id:"option-3-connect-to-your-eps-server-by-command-line"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#option-3-connect-to-your-eps-server-by-command-line"}},[e._v("#")]),e._v(" Option 3: Connect to your EPS Server by command line")]),e._v(" "),t("p",[e._v("You can run electrum via command line "),t("code",[e._v("electrum --oneserver --server yourserver:50002:s")]),e._v(".")]),e._v(" "),t("p",[e._v("If you use Tor, add "),t("code",[e._v("-p socks5:localhost:9150")]),e._v(".")]),e._v(" "),t("h4",{attrs:{id:"option-4-connect-to-your-eps-server-from-electrum-wallet-gui-not-recommended-as-this-will-momentarily-connects-with-other-random-public-electrum-servers-if-you-are-online"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#option-4-connect-to-your-eps-server-from-electrum-wallet-gui-not-recommended-as-this-will-momentarily-connects-with-other-random-public-electrum-servers-if-you-are-online"}},[e._v("#")]),e._v(" Option 4: Connect to your EPS Server from Electrum Wallet GUI (not recommended as this will momentarily connects with other random public Electrum servers if you are online):")]),e._v(" "),t("ol",[t("li",[e._v("Open Electrum Wallet. When you click the traffic light (green or red) at the bottom of your Electrum Wallet, you will see a screen with a list of all the available Electrum servers that your wallet can connect to, normally with the "),t("code",[e._v("Select Server Automatically")]),e._v(" box already checked:")])]),e._v(" "),t("figure",[t("img",{attrs:{src:"https://user-images.githubusercontent.com/1388507/68437521-8a5eb580-01c1-11ea-9ece-0666353a6742.png",alt:"ElectrumWalletServerList",title:"ElectrumWalletServerList"}})]),e._v(" "),t("ol",{attrs:{start:"2"}},[t("li",[e._v("Now is the time to UNCHECK that "),t("code",[e._v("Select Server Automatically")]),e._v(" setting, which will enable you to enter the IP address or domain or hostname of your EPS Server. In the case below, the EPS server is on the local network at "),t("code",[e._v("192.168.1.3")]),e._v(" so we enter that manually (leave port as 50002) and press "),t("code",[e._v("close")]),e._v(".")])]),e._v(" "),t("figure",[t("img",{attrs:{src:"https://user-images.githubusercontent.com/1388507/68496320-4e276580-0252-11ea-8caf-facc8a246d70.png",alt:"EnterElectrumServerIP",title:"EnterElectrumServerIP"}})]),e._v(" "),t("ol",{attrs:{start:"4"}},[t("li",[t("p",[e._v("("),t("strong",[e._v("If you use Tor")]),e._v(") Go to proxy, then click on "),t("code",[e._v("Use Tor Proxy at port 9150")]),e._v(".")])]),e._v(" "),t("li",[t("p",[e._v("If all of the above worked well, and your node is healthy and synched, you will get a green traffic light down the bottom right of the wallet screen - that means success!")])])]),e._v(" "),t("h3",{attrs:{id:"reflection-on-what-has-been-achieved"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reflection-on-what-has-been-achieved"}},[e._v("#")]),e._v(" Reflection on what has been achieved:")]),e._v(" "),t("p",[e._v("You are now running your very "),t("strong",[e._v("own private EPS Server")]),e._v(". All Electrum Wallet related data transfer happens directly between your EPS Server and the bitcoin blockchain, without going over any other 3rd party servers. You have attained full bitcoin transaction privacy (at least from the perspective of your blockchain queries and transactions, payment/receive addresses etc - nobody except you and the blockchain can see what you are doing).")]),e._v(" "),t("h3",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting:")]),e._v(" "),t("p",[e._v("So there is one thing you may encounter, where even after you did everything correctly, you still get a red traffic light (which means not connected to any server) in the steps above. Any other troubleshooting tips that people encounter can be added, I would suggest to make a PR to this document directly.")]),e._v(" "),t("ul",[t("li",[e._v("If you get a red traffic light, shutdown Electrum Wallet completely, then go to your Electrum Wallet folder ("),t("a",{attrs:{href:"https://electrum.readthedocs.io/en/latest/faq.html#where-is-my-wallet-file-located",target:"_blank",rel:"noopener noreferrer"}},[e._v("see here"),t("OutboundLink")],1),e._v(" if you don't know where that is).")])]),e._v(" "),t("p",[e._v("Inside the Electrum Wallet folder (in this case below, it is what it looks like on a Mac) locate the "),t("code",[e._v("certs")]),e._v(" directory and delete the certificate for the server you are trying to connect to, in this case "),t("code",[e._v("192.168.1.3")]),e._v(", by dragging it to the Trash.")]),e._v(" "),t("figure",[t("img",{attrs:{src:"https://user-images.githubusercontent.com/1388507/68497330-9a73a500-0254-11ea-9349-71bdb3bd9511.png",alt:"Certs",title:"Certs"}})]),e._v(" "),t("p",[e._v("Start up Electrum Wallet again, and connect to your "),t("strong",[e._v("EPS server")]),e._v(". If it is fully synched, it will now likely show a green traffic light, and you are good to go.")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/122.4ef63845.js b/assets/js/122.8c55cdd4.js similarity index 99% rename from assets/js/122.4ef63845.js rename to assets/js/122.8c55cdd4.js index d53484e11f..d0bd22266b 100644 --- a/assets/js/122.4ef63845.js +++ b/assets/js/122.8c55cdd4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[122],{744:function(t,e,a){"use strict";a.r(e);var o=a(9),n=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"altcoins-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#altcoins-faq"}},[t._v("#")]),t._v(" Altcoins FAQ")]),t._v(" "),e("p",[t._v("This page answers some of the common questions about alternative cryptocurrencies - altcoins.")]),t._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#which-coins-does-btcpay-server-support"}},[t._v("Which coins does BTCPay Server support?")])]),e("li",[e("a",{attrs:{href:"#can-an-xyz-coin-be-added-in-btcpay"}},[t._v("Can an XYZ coin be added in BTCPay?")])]),e("li",[e("a",{attrs:{href:"#how-to-add-an-altcoin-in-btcpay"}},[t._v("How to add an altcoin in BTCPay?")])]),e("li",[e("a",{attrs:{href:"#how-to-add-an-altcoin-to-an-existing-btcpay-deployment"}},[t._v("How to add an altcoin to an existing BTCPay deployment?")])]),e("li",[e("a",{attrs:{href:"#how-to-remove-a-coin-from-btcpay"}},[t._v("How to remove a coin from BTCPay?")])])])]),e("p"),t._v(" "),e("h2",{attrs:{id:"which-coins-does-btcpay-server-support"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#which-coins-does-btcpay-server-support"}},[t._v("#")]),t._v(" Which coins does BTCPay Server support?")]),t._v(" "),e("p",[t._v("Bitcoin is the only focus of the project and its core developers. However, opt in integrations are present for several altcoins:")]),t._v(" "),e("ul",[e("li",[t._v("BGold (BTG) (also known as Bitcoin Gold)")]),t._v(" "),e("li",[t._v("BPlus (XBC) (also known as Bitcoin Plus)")]),t._v(" "),e("li",[t._v("Bitcore (BTX)")]),t._v(" "),e("li",[t._v("Dash (DASH)")]),t._v(" "),e("li",[t._v("Dogecoin (DOGE)")]),t._v(" "),e("li",[t._v("Feathercoin (FTC)")]),t._v(" "),e("li",[t._v("Groestlcoin (GRS)")]),t._v(" "),e("li",[t._v("Htmlcoin (HTML) (also known as Althash)")]),t._v(" "),e("li",[t._v("Liquid Bitcoin (LBTC) (comes with Liquid Tether support USDt) "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues/1282",target:"_blank",rel:"noopener noreferrer"}},[t._v("(notes on deployment & usage)"),e("OutboundLink")],1)]),t._v(" "),e("li",[t._v("Litecoin (LTC)")]),t._v(" "),e("li",[t._v("Monacoin (MONA)")]),t._v(" "),e("li",[t._v("Monero (XMR) "),e("a",{attrs:{href:"https://sethforprivacy.com/guides/accepting-monero-via-btcpay-server/",target:"_blank",rel:"noopener noreferrer"}},[t._v("(guide on deployment and usage)"),e("OutboundLink")],1)]),t._v(" "),e("li",[t._v("Polis (POLIS)")]),t._v(" "),e("li",[t._v("Viacoin (VIA)")])]),t._v(" "),e("p",[t._v("Altcoins are maintained by their respective communities and are listed here only for convenience. For support regarding Altcoin deployment, functionalities or issues, please contact the Altcoin maintainer or community directly.")]),t._v(" "),e("h2",{attrs:{id:"can-an-xyz-coin-be-added-in-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#can-an-xyz-coin-be-added-in-btcpay"}},[t._v("#")]),t._v(" Can an XYZ coin be added in BTCPay?")]),t._v(" "),e("p",[t._v("No. BTCPay developers don't add alternative coins on request. Adding a new coin explicitly depends on the community and developers of those coins. Furthermore, BTCPay developers do not spend excessive time testing nor maintaining the altcoins. If you're submitting a PR for a new coin, make sure that it works. If the altcoin integration is not actively maintained it will be removed from BTCPay.")]),t._v(" "),e("h2",{attrs:{id:"how-to-add-an-altcoin-in-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-add-an-altcoin-in-btcpay"}},[t._v("#")]),t._v(" How to add an altcoin in BTCPay?")]),t._v(" "),e("p",[t._v("To add a new coin to BTCPay, please "),e("RouterLink",{attrs:{to:"/Development/Altcoins/#how-can-i-add-an-altcoin-to-btcpayserver"}},[t._v("follow the instructions here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"how-to-add-an-altcoin-to-an-existing-btcpay-deployment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-add-an-altcoin-to-an-existing-btcpay-deployment"}},[t._v("#")]),t._v(" How to add an altcoin to an existing BTCPay deployment?")]),t._v(" "),e("p",[t._v("If you want to expand the number of coins in your existing BTCPay Server installation, make sure that you have enough storage space on your machine.")]),t._v(" "),e("p",[t._v("In this example, we only have Bitcoin, and we're adding Litecoin to our docker deployment.")]),t._v(" "),e("p",[t._v("The coin structure:")]),t._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("BTCPAYGEN_CRYPTO1: First supported cryptocurrency (e.g., BTC, LTC. Default: btc)\nBTCPAYGEN_CRYPTO2: Second supported crypto currency (e.g. btc, ltc. Default: (empty))\nBTCPAYGEN_CRYPTON: N'th supported crypto currency where N is 9 at maximum. (eg. btc, ltc. Default: (empty))\n")])])]),e("p",[t._v("To add Litecoin, as your second coin (CRYPTO2) do this :")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_CRYPTO2")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ltc"')]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" ./btcpay-setup.sh -i\n")])])]),e("h2",{attrs:{id:"how-to-remove-a-coin-from-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-remove-a-coin-from-btcpay"}},[t._v("#")]),t._v(" How to remove a coin from BTCPay?")]),t._v(" "),e("p",[t._v("In the "),e("a",{attrs:{href:"#how-to-add-an-altcoin-to-an-existing-btcpay-deployment"}},[t._v("example above")]),t._v(" we've added Litecoin as the second coin. To remove a particular coin, use the following command:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_CRYPTO2")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" ./btcpay-setup.sh -i\n")])])]),e("p",[t._v("Where CRYPTO"),e("strong",[t._v("2")]),t._v(" should be replaced with a coin number you wish to remove. If you have an XYZ coin as "),e("code",[t._v("BTCPAYGEN_CRYPTO3")]),t._v(", and you want to remove it, you should use CRYPTO"),e("strong",[t._v("3")]),t._v(".")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[122],{741:function(t,e,a){"use strict";a.r(e);var o=a(9),n=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"altcoins-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#altcoins-faq"}},[t._v("#")]),t._v(" Altcoins FAQ")]),t._v(" "),e("p",[t._v("This page answers some of the common questions about alternative cryptocurrencies - altcoins.")]),t._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#which-coins-does-btcpay-server-support"}},[t._v("Which coins does BTCPay Server support?")])]),e("li",[e("a",{attrs:{href:"#can-an-xyz-coin-be-added-in-btcpay"}},[t._v("Can an XYZ coin be added in BTCPay?")])]),e("li",[e("a",{attrs:{href:"#how-to-add-an-altcoin-in-btcpay"}},[t._v("How to add an altcoin in BTCPay?")])]),e("li",[e("a",{attrs:{href:"#how-to-add-an-altcoin-to-an-existing-btcpay-deployment"}},[t._v("How to add an altcoin to an existing BTCPay deployment?")])]),e("li",[e("a",{attrs:{href:"#how-to-remove-a-coin-from-btcpay"}},[t._v("How to remove a coin from BTCPay?")])])])]),e("p"),t._v(" "),e("h2",{attrs:{id:"which-coins-does-btcpay-server-support"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#which-coins-does-btcpay-server-support"}},[t._v("#")]),t._v(" Which coins does BTCPay Server support?")]),t._v(" "),e("p",[t._v("Bitcoin is the only focus of the project and its core developers. However, opt in integrations are present for several altcoins:")]),t._v(" "),e("ul",[e("li",[t._v("BGold (BTG) (also known as Bitcoin Gold)")]),t._v(" "),e("li",[t._v("BPlus (XBC) (also known as Bitcoin Plus)")]),t._v(" "),e("li",[t._v("Bitcore (BTX)")]),t._v(" "),e("li",[t._v("Dash (DASH)")]),t._v(" "),e("li",[t._v("Dogecoin (DOGE)")]),t._v(" "),e("li",[t._v("Feathercoin (FTC)")]),t._v(" "),e("li",[t._v("Groestlcoin (GRS)")]),t._v(" "),e("li",[t._v("Htmlcoin (HTML) (also known as Althash)")]),t._v(" "),e("li",[t._v("Liquid Bitcoin (LBTC) (comes with Liquid Tether support USDt) "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues/1282",target:"_blank",rel:"noopener noreferrer"}},[t._v("(notes on deployment & usage)"),e("OutboundLink")],1)]),t._v(" "),e("li",[t._v("Litecoin (LTC)")]),t._v(" "),e("li",[t._v("Monacoin (MONA)")]),t._v(" "),e("li",[t._v("Monero (XMR) "),e("a",{attrs:{href:"https://sethforprivacy.com/guides/accepting-monero-via-btcpay-server/",target:"_blank",rel:"noopener noreferrer"}},[t._v("(guide on deployment and usage)"),e("OutboundLink")],1)]),t._v(" "),e("li",[t._v("Polis (POLIS)")]),t._v(" "),e("li",[t._v("Viacoin (VIA)")])]),t._v(" "),e("p",[t._v("Altcoins are maintained by their respective communities and are listed here only for convenience. For support regarding Altcoin deployment, functionalities or issues, please contact the Altcoin maintainer or community directly.")]),t._v(" "),e("h2",{attrs:{id:"can-an-xyz-coin-be-added-in-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#can-an-xyz-coin-be-added-in-btcpay"}},[t._v("#")]),t._v(" Can an XYZ coin be added in BTCPay?")]),t._v(" "),e("p",[t._v("No. BTCPay developers don't add alternative coins on request. Adding a new coin explicitly depends on the community and developers of those coins. Furthermore, BTCPay developers do not spend excessive time testing nor maintaining the altcoins. If you're submitting a PR for a new coin, make sure that it works. If the altcoin integration is not actively maintained it will be removed from BTCPay.")]),t._v(" "),e("h2",{attrs:{id:"how-to-add-an-altcoin-in-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-add-an-altcoin-in-btcpay"}},[t._v("#")]),t._v(" How to add an altcoin in BTCPay?")]),t._v(" "),e("p",[t._v("To add a new coin to BTCPay, please "),e("RouterLink",{attrs:{to:"/Development/Altcoins/#how-can-i-add-an-altcoin-to-btcpayserver"}},[t._v("follow the instructions here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"how-to-add-an-altcoin-to-an-existing-btcpay-deployment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-add-an-altcoin-to-an-existing-btcpay-deployment"}},[t._v("#")]),t._v(" How to add an altcoin to an existing BTCPay deployment?")]),t._v(" "),e("p",[t._v("If you want to expand the number of coins in your existing BTCPay Server installation, make sure that you have enough storage space on your machine.")]),t._v(" "),e("p",[t._v("In this example, we only have Bitcoin, and we're adding Litecoin to our docker deployment.")]),t._v(" "),e("p",[t._v("The coin structure:")]),t._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("BTCPAYGEN_CRYPTO1: First supported cryptocurrency (e.g., BTC, LTC. Default: btc)\nBTCPAYGEN_CRYPTO2: Second supported crypto currency (e.g. btc, ltc. Default: (empty))\nBTCPAYGEN_CRYPTON: N'th supported crypto currency where N is 9 at maximum. (eg. btc, ltc. Default: (empty))\n")])])]),e("p",[t._v("To add Litecoin, as your second coin (CRYPTO2) do this :")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_CRYPTO2")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ltc"')]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" ./btcpay-setup.sh -i\n")])])]),e("h2",{attrs:{id:"how-to-remove-a-coin-from-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-remove-a-coin-from-btcpay"}},[t._v("#")]),t._v(" How to remove a coin from BTCPay?")]),t._v(" "),e("p",[t._v("In the "),e("a",{attrs:{href:"#how-to-add-an-altcoin-to-an-existing-btcpay-deployment"}},[t._v("example above")]),t._v(" we've added Litecoin as the second coin. To remove a particular coin, use the following command:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAYGEN_CRYPTO2")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('""')]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" ./btcpay-setup.sh -i\n")])])]),e("p",[t._v("Where CRYPTO"),e("strong",[t._v("2")]),t._v(" should be replaced with a coin number you wish to remove. If you have an XYZ coin as "),e("code",[t._v("BTCPAYGEN_CRYPTO3")]),t._v(", and you want to remove it, you should use CRYPTO"),e("strong",[t._v("3")]),t._v(".")])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/123.3fd4dde0.js b/assets/js/123.0fceb940.js similarity index 99% rename from assets/js/123.3fd4dde0.js rename to assets/js/123.0fceb940.js index 7a782cbaba..06506dca1f 100644 --- a/assets/js/123.3fd4dde0.js +++ b/assets/js/123.0fceb940.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[123],{750:function(t,e,o){"use strict";o.r(e);var a=o(9),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"frequently-asked-questions-and-common-issues"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#frequently-asked-questions-and-common-issues"}},[t._v("#")]),t._v(" Frequently Asked Questions and Common Issues")]),t._v(" "),e("p",[t._v("This document contains a Table of contents to all FAQ and common issues.")]),t._v(" "),e("h2",{attrs:{id:"general-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/General/"}},[t._v("General FAQ")])],1),t._v(" "),e("p",[t._v("General, non-technical questions about BTCPay. What it is, how it works, what are its features, why is it different and who can use it.")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#what-is-btcpay-server"}},[t._v("What is BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#why-should-i-choose-btcpay-over-other-processors"}},[t._v("Why should I choose BTCPay over other processors?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#why-is-everyone-so-excited-about-btcpay"}},[t._v("Why is everyone so excited about BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#who-can-use-btcpay"}},[t._v("Who can use BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-to-install-btcpay-server"}},[t._v("How to install BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#where-to-find-btcpay-video-tutorials"}},[t._v("Where to find BTCPay video tutorials?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#do-i-need-to-have-an-online-store-to-use-btcpay-server"}},[t._v("Do I need to have an online store to use BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#why-cant-i-just-give-my-bitcoin-address-to-a-buyer"}},[t._v("Why can't I just give my public address to a buyer?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-does-btcpay-create-a-new-address-for-each-invoice"}},[t._v("How does BTCPay create a new address for each invoice?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#does-btcpay-need-myprivate-key"}},[t._v("Does BTCPay need my private key?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#does-btcpay-server-support-crypto-to-fiat-conversion"}},[t._v("Does BTCPay Server support crypto to fiat conversion?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#what-if-i-have-a-problem-paying-an-invoice"}},[t._v("What if I have a problem paying a BTCPay Server invoice?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#what-if-i-have-a-problem-with-a-paid-invoice"}},[t._v("What if I have a problem with a paid invoice?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#where-can-i-get-help-and-support"}},[t._v("Where can I get help and support?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-can-i-contribute-to-btcpay"}},[t._v("How can I contribute to BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-can-i-use-the-btcpay-server-api"}},[t._v("How can I use the BTCPay Server API?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-can-i-backup-my-btcpay-server"}},[t._v("How can I backup my BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-can-i-charge-for-using-my-btcpay-server-instance"}},[t._v("How can I charge for using my BTCPay Server instance?")])],1)]),t._v(" "),e("h2",{attrs:{id:"deployment-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#deployment-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/"}},[t._v("Deployment FAQ")])],1),t._v(" "),e("p",[t._v("Questions and solutions to BTCPay installation.")]),t._v(" "),e("h3",{attrs:{id:"general-deployment-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general-deployment-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/#general-deployment-faq"}},[t._v("General Deployment FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-much-does-it-cost-to-run-btcpay-server"}},[t._v("How much does it cost to run BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#what-are-the-minimal-requirements-for-btcpay"}},[t._v("What are the minimal requirements for BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#what-is-the-easiest-method-to-deploy-a-self-hosted-btcpay-server"}},[t._v("What is the easiest method to deploy a self-hosted BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-to-choose-a-proper-deployment-method"}},[t._v("How to choose a proper deployment method?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/FAQ-Deployment/#can-i-run-btcpay-on-my-home-computer"}},[t._v("Why do I need a VPS? Can't I just run BTCPay on my home computer?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#can-i-run-btcpay-on-my-own-hardware"}},[t._v("Can I run BTCPay on my hardware?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#can-i-deploy-btcpay-on-my-existing-vps"}},[t._v("Can I deploy on my existing VPS?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#are-there-free-hosts-where-i-can-test"}},[t._v("Are there free hosts where I can test?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#after-initial-deployment-i-can-t-register-and-i-don-t-have-a-login-yet"}},[t._v("After initial deployment, I can't register and I don't have a login yet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-do-i-activate-tor-on-my-btcpay-server"}},[t._v("How do I activate Tor on my BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-do-i-disable-tor-on-my-btcpay-server"}},[t._v("How do I disable Tor on my BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#why-activate-tor-does-it-mean-that-nobody-knows-who-i-am"}},[t._v("Why activate Tor? Does it mean that nobody knows who I am?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-to-access-the-onion-address-without-clearnet"}},[t._v("How to access the .onion address without clearnet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-modify-or-deactivate-environment-variables"}},[t._v("How can I modify or deactivate environment variables?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-run-btcpay-on-testnet"}},[t._v("How can I run BTCPay on testnet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#can-i-start-btcpay-only-when-i-m-expecting-a-payment"}},[t._v("Can I start BTCPay only when I'm expecting a payment?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#can-i-connect-to-my-btcpay-bitcoin-p2p-on-port-8333"}},[t._v("Can I connect to my BTCPay Bitcoin P2P on port 8333?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-renew-my-ssl-certificate"}},[t._v("How can I renew my SSL certificate?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#can-i-use-an-existing-nginx-server-as-a-reverse-proxy-with-ssl-termination"}},[t._v("Can I use an existing Nginx server as a reverse proxy with SSL termination?")])],1)]),t._v(" "),e("h3",{attrs:{id:"web-deployment-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#web-deployment-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/#web-deployment-faq"}},[t._v("Web Deployment FAQ")])],1),t._v(" "),e("h4",{attrs:{id:"luna-node-web-deployment-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#luna-node-web-deployment-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/#luna-node-web-deployment-faq"}},[t._v("Luna Node Web Deployment FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-to-change-domain-name-on-my-lunanode-btcpay"}},[t._v("How to change domain name on my LunaNode BTCPay?")])],1)]),t._v(" "),e("h3",{attrs:{id:"manual-deployment-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#manual-deployment-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/#manual-deployment"}},[t._v("Manual Deployment FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-to-manually-install-btcpay-on-ubuntu-18-04"}},[t._v("How to manually install BTCPay on Ubuntu 18.04?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-do-i-completely-uninstall-btcpay-from-a-linux-environment-docker-version"}},[t._v("How do I completely uninstall BTCPay from a linux environment (docker version)")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-to-deploy-btcpay-server-alongside-existing-bitcoin-node"}},[t._v("How to deploy BTCPay Server alongside existing Bitcoin full node?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#with-the-docker-deployment-how-to-use-a-different-volume-for-the-data"}},[t._v("With the docker deployment, how to use a different volume for the data?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#cause-4-getting-500-nginx-error-on-a-local-server-https-and-for-http-btcpay-is-expecting-you-to-access-this-website-from"}},[t._v("Getting 500 nginx error on a local server https and for http (BTCPay is expecting you to access this website from)")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#cause-3-btcpay-is-expecting-you-to-access-this-website-from"}},[t._v("Error: BTCPay is expecting you to access this website from...")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#cause-3-btcpay-is-expecting-you-to-access-this-website-from"}},[t._v("You access BTCPay Server over an unsecured network")])],1)]),t._v(" "),e("h2",{attrs:{id:"synchronization-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#synchronization-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Synchronization/"}},[t._v("Synchronization FAQ")])],1),t._v(" "),e("p",[t._v("Common questions and issues that may occur during the initial sync of BTCPay.")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#why-does-btcpay-sync"}},[t._v("Why does BTCPay sync?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#can-i-skip-the-synchronization"}},[t._v("Can I skip/speed up the sync?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#how-do-i-know-that-btcpay-synced-completely"}},[t._v("How do I know that the sync is finished?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#how-can-i-check-the-block-height-of-my-bitcoin-node"}},[t._v("How can I check the block height of my bitcoin node?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#btcpay-server-takes-forever-to-synchronize"}},[t._v("BTCPay takes forever to synchronize")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[t._v("BTCPay Server keeps showing that my node is always starting")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#im-running-a-full-node-and-have-a-synched-blockchain-can-btcpay-use-it-so-that-it-doesnt-have-to-do-a-full-sync"}},[t._v("I already have a synced full node, can I use it with BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#how-to-enable-bitcoin-node-pruning"}},[t._v("How to enable Bitcoin node pruning?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#how-to-disable-bitcoin-node-pruning"}},[t._v("How to disable Bitcoin node pruning?")])],1)]),t._v(" "),e("h2",{attrs:{id:"integrations-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#integrations-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Integrations/"}},[t._v("Integrations FAQ")])],1),t._v(" "),e("p",[t._v("Questions about e-commerce and other integrations.")]),t._v(" "),e("h3",{attrs:{id:"integrations-general"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#integrations-general"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Integrations/#integrations-general-faq"}},[t._v("Integrations General")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#what-e-commerce-integrations-are-available"}},[t._v("What e-commerce integrations are available?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#does-btcpay-have-a-shopify-plugin"}},[t._v("Does BTCPay have a Shopify plugin?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#can-i-use-btcpay-without-an-integration"}},[t._v("Can I use BTCPay without an integration?")])],1)]),t._v(" "),e("h3",{attrs:{id:"woocommerce-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#woocommerce-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Integrations/#woocommerce-faq-2"}},[t._v("WooCommerce FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#how-to-configure-order-status-in-woocommerce"}},[t._v("How to configure order status in WooCommerce?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#how-to-customize-e-mail-confirmations-in-woocommerce"}},[t._v("How to customize e-mail confirmations in WooCommerce?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#error-if-you-use-an-alternative-order-numbering-system-please-see-class-wc-gateway-btcpayphp-to-apply-a-search-filter"}},[t._v("Error: If you use an alternative order numbering system, please see class-wc-gateway-btcpay.php to apply a search filter")])],1)]),t._v(" "),e("h2",{attrs:{id:"server-settings-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#server-settings-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/"}},[t._v("Server Settings FAQ")])],1),t._v(" "),e("p",[t._v("Common problems and questions server admins have.")]),t._v(" "),e("h3",{attrs:{id:"maintenance-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maintenance-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#maintainance"}},[t._v("Maintenance FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-update-btcpay-server"}},[t._v("How to update BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-restart-btcpay-server"}},[t._v("How to restart BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-ssh-into-my-btcpay-running-on-vps"}},[t._v("How to SSH into my BTCPay running on VPS?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-can-i-see-my-btcpay-version"}},[t._v("How can I check my BTCPay Server version?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-can-i-check-my-btcpay-server-version-via-terminal"}},[t._v("How can I check my BTCPay Server version via terminal?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#what-is-btcpay-ssh-key-file"}},[t._v("What is BTCPay SSH key file")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#forgot-btcpay-admin-password"}},[t._v("Forgot BTCPay Admin password")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-add-a-new-user-by-invite"}},[t._v("How to add a new user by invite?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-disable-u2f-and-2fa-for-a-user"}},[t._v("How to disable U2F and 2FA for a user?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-configure-smtp-settings-in-btcpay"}},[t._v("How to configure SMTP settings in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#error-maintenance-feature-requires-access-to-SSH-properly-configured-in-btcpayserver-configuration"}},[t._v("Error: Maintenance feature requires access to SSH properly configured in BTCPayServer configuration")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#error-your-local-changes-to-the-following-files-would-be-overwritten-by-merge"}},[t._v("Error: Your local changes to the following files would be overwritten by merge")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#error-btcpay-sshkeyfile-is-not-set-when-running-the-docker-install-or-unable-to-update-through-server-settings-maintenance"}},[t._v("Error: the BTCPAY_SSHKEYFILE variable is not set/ Unable to update")])],1)]),t._v(" "),e("h3",{attrs:{id:"theme-customization-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#theme-customization-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#theme-customization"}},[t._v("Theme / Customization FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-customize-my-btcpay-theme-style"}},[t._v("How to customize my BTCPay theme style?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-modify-the-checkout-page"}},[t._v("How to modify BTCPay the checkout page?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/Development/Theme/#2-bootstrap-themes"}},[t._v("How to customize the POS app theme?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-add-google-analytics-code-to-btcpay"}},[t._v("How to add Google Analytics code to BTCPay?")])],1)]),t._v(" "),e("h3",{attrs:{id:"policies-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#policies-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#policies"}},[t._v("Policies FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-allow-registration-on-my-btcpay-server"}},[t._v("How to allow registration on my BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-hide-my-btcpay-server-from-search-engines"}},[t._v("How to hide my BTCPay Server from Search Engines?")])],1)]),t._v(" "),e("h3",{attrs:{id:"services-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#services-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#services"}},[t._v("Services FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-remotely-connect-to-my-btcpay-full-node"}},[t._v("How to remotely connect to my BTCPay full node?")])],1)]),t._v(" "),e("h3",{attrs:{id:"files-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#files-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#files"}},[t._v("Files FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-upload-files-to-btcpay"}},[t._v("How to upload files to BTCPay?")])],1)]),t._v(" "),e("h2",{attrs:{id:"stores-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stores-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Stores/"}},[t._v("Stores FAQ")])],1),t._v(" "),e("p",[t._v("Store settings explained.")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-create-a-store-in-btcpay"}},[t._v("How to create a store in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-many-stores-can-i-create"}},[t._v("How many stores can I create?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#why-are-invoices-without-payment-showing-as-complete"}},[t._v("Why are invoices without payment showing as complete?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#store-general-settings"}},[t._v("Store General Settings")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#add-network-fee-to-invoice-vary-with-mining-fees"}},[t._v("Add network fee to invoice (vary with mining fees)?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#allow-anyone-to-create-invoice"}},[t._v("Allow anyone to create invoice?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#invoice-expires-if-the-full-amount-has-not-been-paid-after-minutes"}},[t._v("Invoice expires if the full amount has not been paid after ... minutes?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#payment-invalid-if-transactions-fails-to-confirm-minutes-after-invoice-expiration"}},[t._v("Payment invalid if transactions fails to confirm ... minutes after invoice expiration?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#consider-the-invoice-confirmed-when-the-payment-transaction"}},[t._v("Consider the invoice confirmed when the payment transaction?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#consider-the-invoice-paid-even-if-the-paid-amount-is-less-than-expected"}},[t._v("Consider the invoice paid even if the paid amount is ... % less than expected?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-disable-email-on-invoices"}},[t._v("How to disable email on invoices?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-denominate-invoices-in-sats"}},[t._v("How to denominate invoices in sats?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-collect-additional-buyer-information"}},[t._v("How to collect additional buyer information?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-redirect-store-invoices-after-payment"}},[t._v("How to redirect store invoices after payment?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#can-i-delete-invoices-from-btcpay"}},[t._v("Can I delete invoices from BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-change-the-exchange-rate-provider-for-invoices"}},[t._v("How to change the exchange rate provider for invoices?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#getting-getratesasync-was-called-on-coinaverage-error"}},[t._v("Getting GetRatesAsync was called on coinaverage error")])],1)]),t._v(" "),e("h2",{attrs:{id:"wallet-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#wallet-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Wallet/"}},[t._v("Wallet FAQ")])],1),t._v(" "),e("p",[t._v("Here are some of the questions and problems about wallets in BTCPay.")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#what-is-btcpay-server-wallet"}},[t._v("What is BTCPay Server wallet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#how-to-set-up-my-wallet-with-btcpay-server"}},[t._v("How to set up my wallet with BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#can-i-use-a-hardware-wallet-with-btcpay-server"}},[t._v("Can I use a hardware wallet with BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#do-i-have-to-use-btcpay-server-wallet"}},[t._v("Do I have to use BTCPay Server wallet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#why-is-sending-a-transaction-using-trezor-failing"}},[t._v("Why is sending a transaction using Trezor failing?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#missing-payments-in-my-software-or-hardware-wallet"}},[t._v("Missing payments in wallet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#what-is-a-derivation-scheme"}},[t._v("What is a derivation scheme?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#what-is-a-replace-by-fee-rbf-transaction"}},[t._v("What is a Replace-By-Fee (RBF) transaction?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#how-to-add-custom-labels-and-comments-to-transactions"}},[t._v("How to add custom labels and comments to transactions?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#i-dont-see-lightning-network-payments-in-btcpay-wallet"}},[t._v("I don't see Lightning network payments in BTCPay wallet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#is-there-a-mobile-app-for-btcpay-server-wallet"}},[t._v("Is there a mobile app for BTCPay Server wallet?")])],1)]),t._v(" "),e("h2",{attrs:{id:"apps-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#apps-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Apps/"}},[t._v("Apps FAQ")])],1),t._v(" "),e("p",[t._v("Frequent questions about the applications in BTCPay.")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#what-are-the-apps-in-btcpay"}},[t._v("What are the Apps in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#is-there-a-limit-on-the-number-of-apps-i-can-create"}},[t._v("Is there a limit on the number of Apps I can create?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#is-there-a-point-of-sale-feature-in-btcpay"}},[t._v("Is there a Point of Sale feature in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-can-i-use-btcpay-in-a-physical-store"}},[t._v("How can I use BTCPay in a physical store?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-to-customize-the-appearance-of-Point-of-Sale-App-in-BTCPay"}},[t._v("How to customize the appearance of POS in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#what-is-a-payment-button"}},[t._v("What is a Payment Button?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-to-create-a-pay-button-with-a-custom-amount"}},[t._v("How to create a Pay Button with a custom amount?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-to-map-a-domain-name-to-an-app"}},[t._v("How to map a domain name to an app?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-to-redirect-to-another-site-after-payment"}},[t._v("How to redirect to another site after payment?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-to-integrate-woocommerce-store-into-a-btcpay-crowdfund-app"}},[t._v("How to integrate WooCommerce Store in BTCPay Crowdfund app?")])],1)]),t._v(" "),e("h2",{attrs:{id:"lightning-network-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lightning-network-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/"}},[t._v("Lightning Network FAQ")])],1),t._v(" "),e("p",[t._v("Lightning Network troubleshooting and common problems.")]),t._v(" "),e("h3",{attrs:{id:"lightning-network-general-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lightning-network-general-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#lightning-network-general-faq"}},[t._v("Lightning Network General FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-many-users-can-use-lightning-network-in-btcpay"}},[t._v("How many users can use Lightning Network in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-find-node-info-and-open-a-direct-channel-with-a-store-using-btcpay"}},[t._v("How to find node info and open a direct channel with a store using BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#as-a-merchant-do-i-need-to-open-direct-channels"}},[t._v("As a merchant, do I need to open direct channels?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-can-i-get-inbound-capacity-to-my-node"}},[t._v("How can I get inbound capacity to my node?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#i-previously-installed-btcpayserver-without-lightning-can-i-enable-it"}},[t._v("Previously installed BTCPay without Lightning, can I enable it?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#can-i-use-a-pruned-node-with-ln-in-btcpay"}},[t._v("Can I use a pruned node with LN in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#can-i-use-my-existing-ln-node-with-btcpay"}},[t._v("Can I use my existing LN node with BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-change-from-core-lightning-cln-to-lnd-or-vice-versa"}},[t._v("How to change from Core Lightning (CLN) to LND or vice-versa?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#i-switched-lightning-network-implementation-but-getting-no-payment-available-error"}},[t._v('Switched Lightning Network implementation, getting "no payment available" error')])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#i-get-warning-the-lightning-alias-variable-is-not-set-defaulting-to-a-blank-string-when-starting-container"}},[t._v('WARNING: The LIGHTNING_ALIAS variable is not set. Defaulting to a blank string" when starting container')])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-display-my-lightning-node-information-so-that-others-can-connect-to-me"}},[t._v("How to display my Lightning Node information so that others can connect to me?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#where-can-i-find-recovery-seed-backup-for-my-lightning-network-wallet-in-btcpay-server"}},[t._v("Where can I find recovery seed backup for my Lightning Network wallet in BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-disable-on-chain-payments-and-use-ln-payments-only"}},[t._v("How to disable on-chain payments and use LN payments only?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#lightning-network-questions-and-support"}},[t._v("Where can I get Lightning Network Support?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-see-my-lightning-network-version"}},[t._v("How to see my Lightning Network version?")])],1)]),t._v(" "),e("h3",{attrs:{id:"lightning-network-lnd-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lightning-network-lnd-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#lightning-network-lnd-faq"}},[t._v("Lightning Network LND FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-restart-my-lnd"}},[t._v("How to restart my LND?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-see-lnd-logs"}},[t._v("How to see LND logs?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#what-s-the-default-directory-of-lnd-in-btcpay"}},[t._v("What’s the default LND Directory in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#which-macaroon-needs-to-be-provided-for-external-nodes"}},[t._v("Which macaroon needs to be provided for external nodes?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#lnd-connection-issues-after-an-update"}},[t._v("LND connection issue - cannot get macaroon: root key with id 0 doesn’t exist")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-change-my-LND-Node-alias"}},[t._v("How to change LND Node alias")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-edit-lndconf"}},[t._v("How to edit lnd.conf")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-install-thunderhub"}},[t._v("How to install ThunderHub")])],1)]),t._v(" "),e("h3",{attrs:{id:"lightning-network-core-lightning-cln-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lightning-network-core-lightning-cln-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#lightning-network-core-lightning-cln-faq"}},[t._v("Lightning Network Core Lightning (CLN) FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-restart-my-core-lightning-cln"}},[t._v("How to restart my Core Lightning (CLN)?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-announce-an-ipv6-address"}},[t._v("How to announce an IPv6 address?")])],1)]),t._v(" "),e("h2",{attrs:{id:"altcoins-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#altcoins-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Altcoin/"}},[t._v("Altcoins FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Altcoin/#which-coins-does-btcpay-server-support"}},[t._v("Which coins does BTCPay Server support?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Altcoin/#can-an-xyz-coin-be-added-in-btcpay"}},[t._v("Can an XYZ coin be added in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Altcoin/#how-to-add-an-altcoin-in-btcpay"}},[t._v("How to add an altcoin to BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Altcoin/#how-to-add-an-altcoin-to-an-existing-btcpay-deployment"}},[t._v("How to add an altcoin to an existing BTCPay deployment?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Altcoin/#how-to-remove-a-coin-from-btcpay"}},[t._v("How to remove a coin from BTCPay?")])],1)])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[123],{749:function(t,e,o){"use strict";o.r(e);var a=o(9),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"frequently-asked-questions-and-common-issues"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#frequently-asked-questions-and-common-issues"}},[t._v("#")]),t._v(" Frequently Asked Questions and Common Issues")]),t._v(" "),e("p",[t._v("This document contains a Table of contents to all FAQ and common issues.")]),t._v(" "),e("h2",{attrs:{id:"general-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/General/"}},[t._v("General FAQ")])],1),t._v(" "),e("p",[t._v("General, non-technical questions about BTCPay. What it is, how it works, what are its features, why is it different and who can use it.")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#what-is-btcpay-server"}},[t._v("What is BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#why-should-i-choose-btcpay-over-other-processors"}},[t._v("Why should I choose BTCPay over other processors?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#why-is-everyone-so-excited-about-btcpay"}},[t._v("Why is everyone so excited about BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#who-can-use-btcpay"}},[t._v("Who can use BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-to-install-btcpay-server"}},[t._v("How to install BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#where-to-find-btcpay-video-tutorials"}},[t._v("Where to find BTCPay video tutorials?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#do-i-need-to-have-an-online-store-to-use-btcpay-server"}},[t._v("Do I need to have an online store to use BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#why-cant-i-just-give-my-bitcoin-address-to-a-buyer"}},[t._v("Why can't I just give my public address to a buyer?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-does-btcpay-create-a-new-address-for-each-invoice"}},[t._v("How does BTCPay create a new address for each invoice?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#does-btcpay-need-myprivate-key"}},[t._v("Does BTCPay need my private key?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#does-btcpay-server-support-crypto-to-fiat-conversion"}},[t._v("Does BTCPay Server support crypto to fiat conversion?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#what-if-i-have-a-problem-paying-an-invoice"}},[t._v("What if I have a problem paying a BTCPay Server invoice?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#what-if-i-have-a-problem-with-a-paid-invoice"}},[t._v("What if I have a problem with a paid invoice?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#where-can-i-get-help-and-support"}},[t._v("Where can I get help and support?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-can-i-contribute-to-btcpay"}},[t._v("How can I contribute to BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-can-i-use-the-btcpay-server-api"}},[t._v("How can I use the BTCPay Server API?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-can-i-backup-my-btcpay-server"}},[t._v("How can I backup my BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/General/#how-can-i-charge-for-using-my-btcpay-server-instance"}},[t._v("How can I charge for using my BTCPay Server instance?")])],1)]),t._v(" "),e("h2",{attrs:{id:"deployment-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#deployment-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/"}},[t._v("Deployment FAQ")])],1),t._v(" "),e("p",[t._v("Questions and solutions to BTCPay installation.")]),t._v(" "),e("h3",{attrs:{id:"general-deployment-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#general-deployment-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/#general-deployment-faq"}},[t._v("General Deployment FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-much-does-it-cost-to-run-btcpay-server"}},[t._v("How much does it cost to run BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#what-are-the-minimal-requirements-for-btcpay"}},[t._v("What are the minimal requirements for BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#what-is-the-easiest-method-to-deploy-a-self-hosted-btcpay-server"}},[t._v("What is the easiest method to deploy a self-hosted BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-to-choose-a-proper-deployment-method"}},[t._v("How to choose a proper deployment method?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/FAQ-Deployment/#can-i-run-btcpay-on-my-home-computer"}},[t._v("Why do I need a VPS? Can't I just run BTCPay on my home computer?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#can-i-run-btcpay-on-my-own-hardware"}},[t._v("Can I run BTCPay on my hardware?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#can-i-deploy-btcpay-on-my-existing-vps"}},[t._v("Can I deploy on my existing VPS?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#are-there-free-hosts-where-i-can-test"}},[t._v("Are there free hosts where I can test?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#after-initial-deployment-i-can-t-register-and-i-don-t-have-a-login-yet"}},[t._v("After initial deployment, I can't register and I don't have a login yet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-do-i-activate-tor-on-my-btcpay-server"}},[t._v("How do I activate Tor on my BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-do-i-disable-tor-on-my-btcpay-server"}},[t._v("How do I disable Tor on my BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#why-activate-tor-does-it-mean-that-nobody-knows-who-i-am"}},[t._v("Why activate Tor? Does it mean that nobody knows who I am?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-to-access-the-onion-address-without-clearnet"}},[t._v("How to access the .onion address without clearnet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-modify-or-deactivate-environment-variables"}},[t._v("How can I modify or deactivate environment variables?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-run-btcpay-on-testnet"}},[t._v("How can I run BTCPay on testnet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#can-i-start-btcpay-only-when-i-m-expecting-a-payment"}},[t._v("Can I start BTCPay only when I'm expecting a payment?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#can-i-connect-to-my-btcpay-bitcoin-p2p-on-port-8333"}},[t._v("Can I connect to my BTCPay Bitcoin P2P on port 8333?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-renew-my-ssl-certificate"}},[t._v("How can I renew my SSL certificate?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#can-i-use-an-existing-nginx-server-as-a-reverse-proxy-with-ssl-termination"}},[t._v("Can I use an existing Nginx server as a reverse proxy with SSL termination?")])],1)]),t._v(" "),e("h3",{attrs:{id:"web-deployment-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#web-deployment-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/#web-deployment-faq"}},[t._v("Web Deployment FAQ")])],1),t._v(" "),e("h4",{attrs:{id:"luna-node-web-deployment-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#luna-node-web-deployment-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/#luna-node-web-deployment-faq"}},[t._v("Luna Node Web Deployment FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-to-change-domain-name-on-my-lunanode-btcpay"}},[t._v("How to change domain name on my LunaNode BTCPay?")])],1)]),t._v(" "),e("h3",{attrs:{id:"manual-deployment-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#manual-deployment-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/#manual-deployment"}},[t._v("Manual Deployment FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-to-manually-install-btcpay-on-ubuntu-18-04"}},[t._v("How to manually install BTCPay on Ubuntu 18.04?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-do-i-completely-uninstall-btcpay-from-a-linux-environment-docker-version"}},[t._v("How do I completely uninstall BTCPay from a linux environment (docker version)")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-to-deploy-btcpay-server-alongside-existing-bitcoin-node"}},[t._v("How to deploy BTCPay Server alongside existing Bitcoin full node?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#with-the-docker-deployment-how-to-use-a-different-volume-for-the-data"}},[t._v("With the docker deployment, how to use a different volume for the data?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#cause-4-getting-500-nginx-error-on-a-local-server-https-and-for-http-btcpay-is-expecting-you-to-access-this-website-from"}},[t._v("Getting 500 nginx error on a local server https and for http (BTCPay is expecting you to access this website from)")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#cause-3-btcpay-is-expecting-you-to-access-this-website-from"}},[t._v("Error: BTCPay is expecting you to access this website from...")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Deployment/#cause-3-btcpay-is-expecting-you-to-access-this-website-from"}},[t._v("You access BTCPay Server over an unsecured network")])],1)]),t._v(" "),e("h2",{attrs:{id:"synchronization-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#synchronization-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Synchronization/"}},[t._v("Synchronization FAQ")])],1),t._v(" "),e("p",[t._v("Common questions and issues that may occur during the initial sync of BTCPay.")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#why-does-btcpay-sync"}},[t._v("Why does BTCPay sync?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#can-i-skip-the-synchronization"}},[t._v("Can I skip/speed up the sync?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#how-do-i-know-that-btcpay-synced-completely"}},[t._v("How do I know that the sync is finished?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#how-can-i-check-the-block-height-of-my-bitcoin-node"}},[t._v("How can I check the block height of my bitcoin node?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#btcpay-server-takes-forever-to-synchronize"}},[t._v("BTCPay takes forever to synchronize")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[t._v("BTCPay Server keeps showing that my node is always starting")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#im-running-a-full-node-and-have-a-synched-blockchain-can-btcpay-use-it-so-that-it-doesnt-have-to-do-a-full-sync"}},[t._v("I already have a synced full node, can I use it with BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#how-to-enable-bitcoin-node-pruning"}},[t._v("How to enable Bitcoin node pruning?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Synchronization/#how-to-disable-bitcoin-node-pruning"}},[t._v("How to disable Bitcoin node pruning?")])],1)]),t._v(" "),e("h2",{attrs:{id:"integrations-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#integrations-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Integrations/"}},[t._v("Integrations FAQ")])],1),t._v(" "),e("p",[t._v("Questions about e-commerce and other integrations.")]),t._v(" "),e("h3",{attrs:{id:"integrations-general"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#integrations-general"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Integrations/#integrations-general-faq"}},[t._v("Integrations General")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#what-e-commerce-integrations-are-available"}},[t._v("What e-commerce integrations are available?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#does-btcpay-have-a-shopify-plugin"}},[t._v("Does BTCPay have a Shopify plugin?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#can-i-use-btcpay-without-an-integration"}},[t._v("Can I use BTCPay without an integration?")])],1)]),t._v(" "),e("h3",{attrs:{id:"woocommerce-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#woocommerce-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Integrations/#woocommerce-faq-2"}},[t._v("WooCommerce FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#how-to-configure-order-status-in-woocommerce"}},[t._v("How to configure order status in WooCommerce?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#how-to-customize-e-mail-confirmations-in-woocommerce"}},[t._v("How to customize e-mail confirmations in WooCommerce?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Integrations/#error-if-you-use-an-alternative-order-numbering-system-please-see-class-wc-gateway-btcpayphp-to-apply-a-search-filter"}},[t._v("Error: If you use an alternative order numbering system, please see class-wc-gateway-btcpay.php to apply a search filter")])],1)]),t._v(" "),e("h2",{attrs:{id:"server-settings-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#server-settings-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/"}},[t._v("Server Settings FAQ")])],1),t._v(" "),e("p",[t._v("Common problems and questions server admins have.")]),t._v(" "),e("h3",{attrs:{id:"maintenance-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#maintenance-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#maintainance"}},[t._v("Maintenance FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-update-btcpay-server"}},[t._v("How to update BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-restart-btcpay-server"}},[t._v("How to restart BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-ssh-into-my-btcpay-running-on-vps"}},[t._v("How to SSH into my BTCPay running on VPS?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-can-i-see-my-btcpay-version"}},[t._v("How can I check my BTCPay Server version?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-can-i-check-my-btcpay-server-version-via-terminal"}},[t._v("How can I check my BTCPay Server version via terminal?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#what-is-btcpay-ssh-key-file"}},[t._v("What is BTCPay SSH key file")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#forgot-btcpay-admin-password"}},[t._v("Forgot BTCPay Admin password")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-add-a-new-user-by-invite"}},[t._v("How to add a new user by invite?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-disable-u2f-and-2fa-for-a-user"}},[t._v("How to disable U2F and 2FA for a user?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-configure-smtp-settings-in-btcpay"}},[t._v("How to configure SMTP settings in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#error-maintenance-feature-requires-access-to-SSH-properly-configured-in-btcpayserver-configuration"}},[t._v("Error: Maintenance feature requires access to SSH properly configured in BTCPayServer configuration")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#error-your-local-changes-to-the-following-files-would-be-overwritten-by-merge"}},[t._v("Error: Your local changes to the following files would be overwritten by merge")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#error-btcpay-sshkeyfile-is-not-set-when-running-the-docker-install-or-unable-to-update-through-server-settings-maintenance"}},[t._v("Error: the BTCPAY_SSHKEYFILE variable is not set/ Unable to update")])],1)]),t._v(" "),e("h3",{attrs:{id:"theme-customization-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#theme-customization-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#theme-customization"}},[t._v("Theme / Customization FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-customize-my-btcpay-theme-style"}},[t._v("How to customize my BTCPay theme style?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-modify-the-checkout-page"}},[t._v("How to modify BTCPay the checkout page?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/Development/Theme/#2-bootstrap-themes"}},[t._v("How to customize the POS app theme?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-add-google-analytics-code-to-btcpay"}},[t._v("How to add Google Analytics code to BTCPay?")])],1)]),t._v(" "),e("h3",{attrs:{id:"policies-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#policies-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#policies"}},[t._v("Policies FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-allow-registration-on-my-btcpay-server"}},[t._v("How to allow registration on my BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-hide-my-btcpay-server-from-search-engines"}},[t._v("How to hide my BTCPay Server from Search Engines?")])],1)]),t._v(" "),e("h3",{attrs:{id:"services-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#services-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#services"}},[t._v("Services FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-remotely-connect-to-my-btcpay-full-node"}},[t._v("How to remotely connect to my BTCPay full node?")])],1)]),t._v(" "),e("h3",{attrs:{id:"files-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#files-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#files"}},[t._v("Files FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-upload-files-to-btcpay"}},[t._v("How to upload files to BTCPay?")])],1)]),t._v(" "),e("h2",{attrs:{id:"stores-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#stores-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Stores/"}},[t._v("Stores FAQ")])],1),t._v(" "),e("p",[t._v("Store settings explained.")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-create-a-store-in-btcpay"}},[t._v("How to create a store in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-many-stores-can-i-create"}},[t._v("How many stores can I create?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#why-are-invoices-without-payment-showing-as-complete"}},[t._v("Why are invoices without payment showing as complete?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#store-general-settings"}},[t._v("Store General Settings")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#add-network-fee-to-invoice-vary-with-mining-fees"}},[t._v("Add network fee to invoice (vary with mining fees)?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#allow-anyone-to-create-invoice"}},[t._v("Allow anyone to create invoice?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#invoice-expires-if-the-full-amount-has-not-been-paid-after-minutes"}},[t._v("Invoice expires if the full amount has not been paid after ... minutes?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#payment-invalid-if-transactions-fails-to-confirm-minutes-after-invoice-expiration"}},[t._v("Payment invalid if transactions fails to confirm ... minutes after invoice expiration?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#consider-the-invoice-confirmed-when-the-payment-transaction"}},[t._v("Consider the invoice confirmed when the payment transaction?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#consider-the-invoice-paid-even-if-the-paid-amount-is-less-than-expected"}},[t._v("Consider the invoice paid even if the paid amount is ... % less than expected?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-disable-email-on-invoices"}},[t._v("How to disable email on invoices?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-denominate-invoices-in-sats"}},[t._v("How to denominate invoices in sats?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-collect-additional-buyer-information"}},[t._v("How to collect additional buyer information?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-redirect-store-invoices-after-payment"}},[t._v("How to redirect store invoices after payment?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#can-i-delete-invoices-from-btcpay"}},[t._v("Can I delete invoices from BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-change-the-exchange-rate-provider-for-invoices"}},[t._v("How to change the exchange rate provider for invoices?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Stores/#getting-getratesasync-was-called-on-coinaverage-error"}},[t._v("Getting GetRatesAsync was called on coinaverage error")])],1)]),t._v(" "),e("h2",{attrs:{id:"wallet-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#wallet-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Wallet/"}},[t._v("Wallet FAQ")])],1),t._v(" "),e("p",[t._v("Here are some of the questions and problems about wallets in BTCPay.")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#what-is-btcpay-server-wallet"}},[t._v("What is BTCPay Server wallet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#how-to-set-up-my-wallet-with-btcpay-server"}},[t._v("How to set up my wallet with BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#can-i-use-a-hardware-wallet-with-btcpay-server"}},[t._v("Can I use a hardware wallet with BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#do-i-have-to-use-btcpay-server-wallet"}},[t._v("Do I have to use BTCPay Server wallet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#why-is-sending-a-transaction-using-trezor-failing"}},[t._v("Why is sending a transaction using Trezor failing?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#missing-payments-in-my-software-or-hardware-wallet"}},[t._v("Missing payments in wallet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#what-is-a-derivation-scheme"}},[t._v("What is a derivation scheme?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#what-is-a-replace-by-fee-rbf-transaction"}},[t._v("What is a Replace-By-Fee (RBF) transaction?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#how-to-add-custom-labels-and-comments-to-transactions"}},[t._v("How to add custom labels and comments to transactions?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#i-dont-see-lightning-network-payments-in-btcpay-wallet"}},[t._v("I don't see Lightning network payments in BTCPay wallet?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#is-there-a-mobile-app-for-btcpay-server-wallet"}},[t._v("Is there a mobile app for BTCPay Server wallet?")])],1)]),t._v(" "),e("h2",{attrs:{id:"apps-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#apps-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Apps/"}},[t._v("Apps FAQ")])],1),t._v(" "),e("p",[t._v("Frequent questions about the applications in BTCPay.")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#what-are-the-apps-in-btcpay"}},[t._v("What are the Apps in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#is-there-a-limit-on-the-number-of-apps-i-can-create"}},[t._v("Is there a limit on the number of Apps I can create?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#is-there-a-point-of-sale-feature-in-btcpay"}},[t._v("Is there a Point of Sale feature in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-can-i-use-btcpay-in-a-physical-store"}},[t._v("How can I use BTCPay in a physical store?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-to-customize-the-appearance-of-Point-of-Sale-App-in-BTCPay"}},[t._v("How to customize the appearance of POS in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#what-is-a-payment-button"}},[t._v("What is a Payment Button?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-to-create-a-pay-button-with-a-custom-amount"}},[t._v("How to create a Pay Button with a custom amount?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-to-map-a-domain-name-to-an-app"}},[t._v("How to map a domain name to an app?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-to-redirect-to-another-site-after-payment"}},[t._v("How to redirect to another site after payment?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Apps/#how-to-integrate-woocommerce-store-into-a-btcpay-crowdfund-app"}},[t._v("How to integrate WooCommerce Store in BTCPay Crowdfund app?")])],1)]),t._v(" "),e("h2",{attrs:{id:"lightning-network-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lightning-network-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/"}},[t._v("Lightning Network FAQ")])],1),t._v(" "),e("p",[t._v("Lightning Network troubleshooting and common problems.")]),t._v(" "),e("h3",{attrs:{id:"lightning-network-general-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lightning-network-general-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#lightning-network-general-faq"}},[t._v("Lightning Network General FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-many-users-can-use-lightning-network-in-btcpay"}},[t._v("How many users can use Lightning Network in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-find-node-info-and-open-a-direct-channel-with-a-store-using-btcpay"}},[t._v("How to find node info and open a direct channel with a store using BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#as-a-merchant-do-i-need-to-open-direct-channels"}},[t._v("As a merchant, do I need to open direct channels?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-can-i-get-inbound-capacity-to-my-node"}},[t._v("How can I get inbound capacity to my node?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#i-previously-installed-btcpayserver-without-lightning-can-i-enable-it"}},[t._v("Previously installed BTCPay without Lightning, can I enable it?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#can-i-use-a-pruned-node-with-ln-in-btcpay"}},[t._v("Can I use a pruned node with LN in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#can-i-use-my-existing-ln-node-with-btcpay"}},[t._v("Can I use my existing LN node with BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-change-from-core-lightning-cln-to-lnd-or-vice-versa"}},[t._v("How to change from Core Lightning (CLN) to LND or vice-versa?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#i-switched-lightning-network-implementation-but-getting-no-payment-available-error"}},[t._v('Switched Lightning Network implementation, getting "no payment available" error')])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#i-get-warning-the-lightning-alias-variable-is-not-set-defaulting-to-a-blank-string-when-starting-container"}},[t._v('WARNING: The LIGHTNING_ALIAS variable is not set. Defaulting to a blank string" when starting container')])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-display-my-lightning-node-information-so-that-others-can-connect-to-me"}},[t._v("How to display my Lightning Node information so that others can connect to me?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#where-can-i-find-recovery-seed-backup-for-my-lightning-network-wallet-in-btcpay-server"}},[t._v("Where can I find recovery seed backup for my Lightning Network wallet in BTCPay Server?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-disable-on-chain-payments-and-use-ln-payments-only"}},[t._v("How to disable on-chain payments and use LN payments only?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#lightning-network-questions-and-support"}},[t._v("Where can I get Lightning Network Support?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-see-my-lightning-network-version"}},[t._v("How to see my Lightning Network version?")])],1)]),t._v(" "),e("h3",{attrs:{id:"lightning-network-lnd-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lightning-network-lnd-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#lightning-network-lnd-faq"}},[t._v("Lightning Network LND FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-restart-my-lnd"}},[t._v("How to restart my LND?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-see-lnd-logs"}},[t._v("How to see LND logs?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#what-s-the-default-directory-of-lnd-in-btcpay"}},[t._v("What’s the default LND Directory in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#which-macaroon-needs-to-be-provided-for-external-nodes"}},[t._v("Which macaroon needs to be provided for external nodes?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#lnd-connection-issues-after-an-update"}},[t._v("LND connection issue - cannot get macaroon: root key with id 0 doesn’t exist")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-change-my-LND-Node-alias"}},[t._v("How to change LND Node alias")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-edit-lndconf"}},[t._v("How to edit lnd.conf")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-install-thunderhub"}},[t._v("How to install ThunderHub")])],1)]),t._v(" "),e("h3",{attrs:{id:"lightning-network-core-lightning-cln-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#lightning-network-core-lightning-cln-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#lightning-network-core-lightning-cln-faq"}},[t._v("Lightning Network Core Lightning (CLN) FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-restart-my-core-lightning-cln"}},[t._v("How to restart my Core Lightning (CLN)?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/LightningNetwork/#how-to-announce-an-ipv6-address"}},[t._v("How to announce an IPv6 address?")])],1)]),t._v(" "),e("h2",{attrs:{id:"altcoins-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#altcoins-faq"}},[t._v("#")]),t._v(" "),e("RouterLink",{attrs:{to:"/FAQ/Altcoin/"}},[t._v("Altcoins FAQ")])],1),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Altcoin/#which-coins-does-btcpay-server-support"}},[t._v("Which coins does BTCPay Server support?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Altcoin/#can-an-xyz-coin-be-added-in-btcpay"}},[t._v("Can an XYZ coin be added in BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Altcoin/#how-to-add-an-altcoin-in-btcpay"}},[t._v("How to add an altcoin to BTCPay?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Altcoin/#how-to-add-an-altcoin-to-an-existing-btcpay-deployment"}},[t._v("How to add an altcoin to an existing BTCPay deployment?")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/FAQ/Altcoin/#how-to-remove-a-coin-from-btcpay"}},[t._v("How to remove a coin from BTCPay?")])],1)])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/124.292fe053.js b/assets/js/124.3e329b2c.js similarity index 99% rename from assets/js/124.292fe053.js rename to assets/js/124.3e329b2c.js index d356d8989a..e0c8ed30bc 100644 --- a/assets/js/124.292fe053.js +++ b/assets/js/124.3e329b2c.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[124],{753:function(e,a,t){"use strict";t.r(a);var s=t(9),n=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"synchronization-faq"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#synchronization-faq"}},[e._v("#")]),e._v(" Synchronization FAQ")]),e._v(" "),a("p",[e._v("This document covers the most common questions and issues that may occur during BTCPay sync.")]),e._v(" "),a("p"),a("div",{staticClass:"table-of-contents"},[a("ul",[a("li",[a("a",{attrs:{href:"#why-does-btcpay-sync"}},[e._v("Why does BTCPay sync?")])]),a("li",[a("a",{attrs:{href:"#can-i-skip-the-synchronization"}},[e._v("Can I skip the synchronization?")])]),a("li",[a("a",{attrs:{href:"#how-do-i-know-that-btcpay-synced-completely"}},[e._v("How do I know that BTCPay synced completely?")])]),a("li",[a("a",{attrs:{href:"#how-can-i-check-the-block-height-of-my-bitcoin-node"}},[e._v("How can I check the block height of my bitcoin node?")])]),a("li",[a("a",{attrs:{href:"#btcpay-server-takes-forever-to-synchronize"}},[e._v("BTCPay Server takes forever to synchronize")]),a("ul",[a("li",[a("a",{attrs:{href:"#cause-1-not-enough-cpu"}},[e._v("Cause 1: Not enough CPU")])]),a("li",[a("a",{attrs:{href:"#cause-2-using-swap-memory"}},[e._v("Cause 2: Using swap memory")])])])]),a("li",[a("a",{attrs:{href:"#btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[e._v("BTCPay Server keeps showing that my node is always starting")]),a("ul",[a("li",[a("a",{attrs:{href:"#cause-1-you-do-not-have-enough-ram"}},[e._v("Cause 1: You do not have enough RAM")])]),a("li",[a("a",{attrs:{href:"#cause-2-you-do-not-have-enough-storage"}},[e._v("Cause 2: You do not have enough storage")])]),a("li",[a("a",{attrs:{href:"#cause-3-you-accidentally-disabled-pruning"}},[e._v("Cause 3: You accidentally disabled pruning")])]),a("li",[a("a",{attrs:{href:"#cause-4-your-bitcoin-data-directory-is-corrupted"}},[e._v("Cause 4: Your bitcoin data directory is corrupted")])]),a("li",[a("a",{attrs:{href:"#cause-5-your-last-wallet-synchronisation-goes-beyond-pruned-data"}},[e._v("Cause 5: Your last wallet synchronisation goes beyond pruned data")])])])]),a("li",[a("a",{attrs:{href:"#im-running-a-full-node-and-have-a-synched-blockchain-can-btcpay-use-it-so-that-it-doesnt-have-to-do-a-full-sync"}},[e._v("I'm running a full node and have a synched blockchain, can BTCPay use it so that it doesn't have to do a full sync?")])]),a("li",[a("a",{attrs:{href:"#how-to-enable-bitcoin-node-pruning"}},[e._v("How to enable Bitcoin node pruning?")])]),a("li",[a("a",{attrs:{href:"#how-to-disable-bitcoin-node-pruning"}},[e._v("How to disable Bitcoin node pruning?")])])])]),a("p"),e._v(" "),a("h2",{attrs:{id:"why-does-btcpay-sync"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#why-does-btcpay-sync"}},[e._v("#")]),e._v(" Why does BTCPay sync?")]),e._v(" "),a("p",[e._v("After deployment, your BTCPay Server needs to sync the entire blockchain and validate all the consensus rules. Depending on your machine specifications, bandwidth and number of altcoins you added, this process may take between 1-5 days.")]),e._v(" "),a("p",[e._v("It may seem tedious, but it's a critical step of running your own full node and not having to trust or rely on anyone. Your node will not only download ~300GB of data (less if you're using a pruned node) but also validate all the rules of the consensus. You can find more information about the importance of blockchain synchronization in "),a("a",{attrs:{href:"https://www.youtube.com/watch?v=OrYDehC-8TU",target:"_blank",rel:"noopener noreferrer"}},[e._v("this video"),a("OutboundLink")],1),e._v(".")]),e._v(" "),a("p",[e._v("If you are only interested in learning about BTCPay Server i.e. simply "),a("RouterLink",{attrs:{to:"/TryItOut/"}},[e._v("trying it out")]),e._v(" without deploying your own instance, you can avoid sync by using a "),a("RouterLink",{attrs:{to:"/Deployment/ThirdPartyHosting/"}},[e._v("Third-Party host")]),e._v(".")],1),e._v(" "),a("h2",{attrs:{id:"can-i-skip-the-synchronization"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#can-i-skip-the-synchronization"}},[e._v("#")]),e._v(" Can I skip the synchronization?")]),e._v(" "),a("p",[e._v("You can't skip synchronization if you are deploying a BTCPay Server, but you can drastically decrease the time it takes. If you're comfortable with using the command line, you can use FastSync to synchronize your node faster. Be sure to "),a("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/tree/master/contrib/FastSync",target:"_blank",rel:"noopener noreferrer"}},[e._v("read this FastSync document"),a("OutboundLink")],1),e._v(" to understand the potential trust issues involved with this feature.")]),e._v(" "),a("p",[e._v("To use FastSync, make sure your deployment has a "),a("a",{attrs:{href:"#how-to-enable-bitcoin-node-pruning"}},[e._v("pruning option enabled")]),e._v(" by using an "),a("code",[e._v("opt-save-storage")]),e._v(" environment variable, otherwise bitcoind will not be able to sync. First step is to "),a("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-ssh-into-my-btcpay-running-on-vps"}},[e._v("ssh into")]),e._v(" your BTCPayServer instance and run the following commands:")],1),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v("/btcpayserver-docker/\nbtcpay-down.sh\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" contrib/FastSync\n./load-utxo-set.sh\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Once FastSync has completed")]),e._v("\nbtcpay-up.sh\n")])])]),a("p",[e._v("After FastSync is complete and you have brought back up your instance, refresh your BTCPay domain and wait for remaining blockchain synchronization. You can also follow "),a("a",{attrs:{href:"https://youtube.com/watch?v=VNMnd-dX9Q8?t=1730",target:"_blank",rel:"noopener noreferrer"}},[e._v("this video"),a("OutboundLink")],1),e._v(".")]),e._v(" "),a("p",[e._v("If your FastSync returns "),a("code",[e._v("You need to delete your Bitcoin Core wallet")]),e._v(" after you load the uxto set, or you find this error: "),a("code",[e._v("Last wallet synchronisation goes beyond pruned data")]),e._v(", see the cause of "),a("a",{attrs:{href:"#btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[e._v("BTCPay Server keeps showing that my node is always starting")]),e._v(".")]),e._v(" "),a("h2",{attrs:{id:"how-do-i-know-that-btcpay-synced-completely"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-do-i-know-that-btcpay-synced-completely"}},[e._v("#")]),e._v(" How do I know that BTCPay synced completely?")]),e._v(" "),a("p",[e._v("When you do not see a pop-up message in the bottom right corner, which shows the sync progress, that means that your server is fully synced and you can "),a("RouterLink",{attrs:{to:"/RegisterAccount/"}},[e._v("begin using it")]),e._v(".")],1),e._v(" "),a("p",[e._v("If you want to check that your BTCPay Server Bitcoin node is synchronized with the most recent block in the Bitcoin blockchain, "),a("a",{attrs:{href:"#how-can-i-check-the-block-height-of-my-bitcoin-node"}},[e._v("check your node height")]),e._v(" matches the current block height using any blockchain explorer.")]),e._v(" "),a("h2",{attrs:{id:"how-can-i-check-the-block-height-of-my-bitcoin-node"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-check-the-block-height-of-my-bitcoin-node"}},[e._v("#")]),e._v(" How can I check the block height of my bitcoin node?")]),e._v(" "),a("p",[e._v("To verify the sync status of your Bitcoin node, you can use bitcoin-cli commands inside your server's Bitcoin container. SSH into your server and navigate to the directory where you "),a("RouterLink",{attrs:{to:"/Troubleshooting/#23-bitcoin-node-logs"}},[e._v("view Bitcoin logs")]),e._v(" run the command: "),a("code",[e._v("bitcoin-cli.sh getblockcount")]),e._v(" to view the current block of your server's Bitcoin node.")],1),e._v(" "),a("h2",{attrs:{id:"btcpay-server-takes-forever-to-synchronize"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-server-takes-forever-to-synchronize"}},[e._v("#")]),e._v(" BTCPay Server takes forever to synchronize")]),e._v(" "),a("p",[e._v("Synchronizing a Full Bitcoin node should take between 1 and 5 days. It should sync quickly at first and more slowly at the end.")]),e._v(" "),a("p",[e._v("If the node appears to not be syncing, verify:")]),e._v(" "),a("ul",[a("li",[e._v("Not enough CPU")]),e._v(" "),a("li",[e._v("Using swap memory")])]),e._v(" "),a("h3",{attrs:{id:"cause-1-not-enough-cpu"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-1-not-enough-cpu"}},[e._v("#")]),e._v(" Cause 1: Not enough CPU")]),e._v(" "),a("p",[e._v("We recommend 2 CPU while synchronizing; however some hosting providers throttle your CPU if you use too much.")]),e._v(" "),a("p",[e._v("Check with")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" stats\n")])])]),a("p",[e._v("If you see more than 100% CPU usage, while being very slow to sync:")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("8e7ac41e6e2a btcpayserver_bitcoind 100% 560.5MiB / 3.853GiB 14.20% 4.17\n")])])]),a("p",[e._v("Then you need to scale up your machine specification.")]),e._v(" "),a("p",[e._v("If you see very low CPU usage (less than 10%) during synchronization:")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("8e7ac41e6e2a btcpayserver_bitcoind 10% 560.5MiB / 3.853GiB 14.20% 4.17\n")])])]),a("p",[e._v("Your hosting provider might throttle your CPU. Please make sure your host supports the high use of CPU for an extended period.")]),e._v(" "),a("p",[e._v("If they don't allow it, shut down your server until they stop throttling you. Then you can limit the CPU via docker, and restart the server:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" update btcpayserver_bitcoind --cpus "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('".8"')]),e._v("\n")])])]),a("h3",{attrs:{id:"cause-2-using-swap-memory"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-2-using-swap-memory"}},[e._v("#")]),e._v(" Cause 2: Using swap memory")]),e._v(" "),a("p",[e._v("If you are synching and don't have enough memory, your server may use swap memory to continue operating:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("free")]),e._v(" -h\n")])])]),a("p",[e._v("If you see swap memory usage:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v(" total used "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("free")]),e._v(" shared buff/cache available\nMem: "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G 0M 66M 0G 0M\nSwap: "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(".0G 200M 800M\n")])])]),a("p",[e._v("Then it means you need to scale up your server by adding more memory.")]),e._v(" "),a("h2",{attrs:{id:"btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[e._v("#")]),e._v(" BTCPay Server keeps showing that my node is always starting")]),e._v(" "),a("p",[e._v("Possible cause:")]),e._v(" "),a("ul",[a("li",[e._v("You do not have enough RAM")]),e._v(" "),a("li",[e._v("You do not have enough storage")]),e._v(" "),a("li",[e._v("You accidentally disabled pruning")]),e._v(" "),a("li",[e._v("Your bitcoin data directory is corrupted")]),e._v(" "),a("li",[e._v("Your last wallet synchronisation goes beyond pruned data")])]),e._v(" "),a("h3",{attrs:{id:"cause-1-you-do-not-have-enough-ram"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-1-you-do-not-have-enough-ram"}},[e._v("#")]),e._v(" Cause 1: You do not have enough RAM")]),e._v(" "),a("p",[e._v("Check your RAM:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("free")]),e._v(" -h\n")])])]),a("p",[e._v("If you see that you have no "),a("code",[e._v("free")]),e._v(" or very little "),a("code",[e._v("available")]),e._v(" memory:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v(" total used "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("free")]),e._v(" shared buff/cache available\nMem: "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G 0M 66M 0G 0M\nSwap: 0B 0B 0B\n")])])]),a("p",[e._v("Then you need more memory. If you have already synched your node, you can add some swap memory. If you haven't, your server specs are too limited.")]),e._v(" "),a("p",[e._v("If you have already synched, you can add 2G of swap memory with:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("fallocate -l 2G /mnt/swapfile\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("600")]),e._v(" /mnt/swapfile\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkswap")]),e._v(" /mnt/swapfile\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("swapon")]),e._v(" /mnt/swapfile\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/mnt/swapfile none swap sw 0 0"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">>")]),e._v(" /etc/fstab\n")])])]),a("h3",{attrs:{id:"cause-2-you-do-not-have-enough-storage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-2-you-do-not-have-enough-storage"}},[e._v("#")]),e._v(" Cause 2: You do not have enough storage")]),e._v(" "),a("p",[e._v("Check the storage of your machine:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("df")]),e._v(" -h\n")])])]),a("p",[e._v("If you see you don't have any storage left (/dev/sda1 in my case)")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("Filesystem Size Used Avail Use% Mounted on\nudev "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v("% /dev\ntmpfs 395M 41M 354M "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("11")]),e._v("% /run\n/dev/sda1 125G 125G 0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("100")]),e._v("% /\ntmpfs "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v("% /dev/shm\ntmpfs "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("5")]),e._v(".0M "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("5")]),e._v(".0M "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v("% /run/lock\ntmpfs "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v("% /sys/fs/cgroup\n/dev/sdb1 "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("7")]),e._v(".8G 18M "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("7")]),e._v(".4G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v("% /mnt\n")])])]),a("p",[a("RouterLink",{attrs:{to:"/Docker/#generated-docker-compose"}},[e._v("Choose the docker fragment")]),e._v(" for the amount of storage you aim to keep. Then "),a("RouterLink",{attrs:{to:"/Docker/#how-i-can-prune-my-nodes"}},[e._v("prune your node")]),e._v(".")],1),e._v(" "),a("h3",{attrs:{id:"cause-3-you-accidentally-disabled-pruning"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-3-you-accidentally-disabled-pruning"}},[e._v("#")]),e._v(" Cause 3: You accidentally disabled pruning")]),e._v(" "),a("p",[e._v("If you have recently tried to modify your environment variables using the "),a("code",[e._v('export BTCPAYGEN_ADDITIONAL_FRAGMENTS="xyz"')]),e._v(" command to add an additional fragment, but forgot to include your current ones, you may have disabled pruning.")]),e._v(" "),a("p",[e._v("If you don't have enough memory to store the entire Bitcoin blockchain and you don't have an "),a("code",[e._v("opt-save-storage")]),e._v(" listed when you "),a("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-modify-or-deactivate-environment-variables"}},[e._v("print the complete list of options")]),e._v(" that you are running, it is very likely you have disabled pruning.")],1),e._v(" "),a("p",[e._v("You can verify by checking your Bitcoind logs:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" logs --tail "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("100")]),e._v(" btcpayserver_bitcoind\n")])])]),a("p",[e._v("If you see:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("Block files have previously been pruned.\nYou need to rebuild the database using -reindex to go back to unpruned mode.\nThis will redownload the entire blockchain.\nPlease restart with -reindex or -reindex-chainstate to recover.\n")])])]),a("p",[e._v("You can simply "),a("a",{attrs:{href:"#how-to-enable-bitcoin-node-pruning"}},[e._v("re-enable pruning")]),e._v(" to solve the issue.")]),e._v(" "),a("h3",{attrs:{id:"cause-4-your-bitcoin-data-directory-is-corrupted"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-4-your-bitcoin-data-directory-is-corrupted"}},[e._v("#")]),e._v(" Cause 4: Your bitcoin data directory is corrupted")]),e._v(" "),a("p",[e._v("Check the logs of your node:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" logs --tail "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("10")]),e._v(" btcpayserver_bitcoind\n")])])]),a("p",[e._v("If you see:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("Please restart with -reindex or -reindex-chainstate to recover.\n")])])]),a("p",[e._v("Then your bitcoin data directory has been corrupted. It may be physical damage or failure of the hard drive.\nTo reindex your node:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("btcpay-down.sh\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Delete 'blocks' and 'chainstate' folders")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" -rf /var/lib/docker/volumes/generated_bitcoin_datadir/_data/blocks\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" -rf /var/lib/docker/volumes/generated_bitcoin_datadir/_data/chainstate\nbtcpay-up.sh\n")])])]),a("h3",{attrs:{id:"cause-5-your-last-wallet-synchronisation-goes-beyond-pruned-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-5-your-last-wallet-synchronisation-goes-beyond-pruned-data"}},[e._v("#")]),e._v(" Cause 5: Your last wallet synchronisation goes beyond pruned data")]),e._v(" "),a("p",[e._v("This can happen if you use FastSync or import an already synched blockchain. It means that the bitcoin core wallet needs to be removed because it was created before the utxoset, likely because BTCPay Server started without the utxoset at the first boot. To verify this case, "),a("RouterLink",{attrs:{to:"/Troubleshooting/#21-btcpay-logs"}},[e._v("check the bitcoind log")]),e._v(" for this:")],1),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("Error: Prune: last wallet synchronisation goes beyond pruned data. You need to -reindex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("download the whole blockchain again "),a("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("in")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("case")]),e._v(" of pruned "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("node")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),a("p",[e._v("If you see this error and agree to remove the wallet to finish syncing, use "),a("code",[e._v("docker volume rm generated_bitcoin_wallet_datadir")]),e._v(" after you run "),a("code",[e._v("btcpay-down.sh")]),e._v(" and before you run "),a("code",[e._v("btcpay-up.sh")]),e._v("\nWARNING: Do not delete this wallet if you have any funds on it.")]),e._v(" "),a("h2",{attrs:{id:"im-running-a-full-node-and-have-a-synched-blockchain-can-btcpay-use-it-so-that-it-doesnt-have-to-do-a-full-sync"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#im-running-a-full-node-and-have-a-synched-blockchain-can-btcpay-use-it-so-that-it-doesnt-have-to-do-a-full-sync"}},[e._v("#")]),e._v(" I'm running a full node and have a synched blockchain, can BTCPay use it so that it doesn't have to do a full sync?")]),e._v(" "),a("p",[e._v("Yes you can! However, before you do that, you'll want to stop bitcoind from updating docker's volume for it, as that job will be taken over by BTCPay Server.")]),e._v(" "),a("p",[e._v("If you want to run BTCPay Server inside a docker-compose, and that you have the data directory ("),a("code",[e._v(".bitcoin")]),e._v(") of a fully synched node on your docker host, then you can reuse it easily for BTCPay Server.")]),e._v(" "),a("p",[e._v("To do that, follow the following steps :")]),e._v(" "),a("ul",[a("li",[e._v("Do the normal setup according to "),a("RouterLink",{attrs:{to:"/Docker/"}},[e._v("this instruction")]),e._v(". Note the "),a("code",[e._v("opt-save-storage")]),e._v(" environment variable, which is used to enable various pruning levels. If you do not want to prune your exiting data directory, then omit the following line in your BTCPay docker deployment: "),a("code",[e._v('export BTCPAYGEN_ADDITIONAL_FRAGMENTS="opt-save-storage-s"')]),e._v(".")],1),e._v(" "),a("li",[e._v("Once "),a("code",[e._v("btcpay-setup.sh")]),e._v(" is over, turn down the docker compose with "),a("code",[e._v("btcpay-down.sh")]),e._v(".")]),e._v(" "),a("li",[e._v("Login as root with "),a("code",[e._v("sudo su -")]),e._v(".")]),e._v(" "),a("li",[e._v("Open the docker's volume for bitcoind : "),a("code",[e._v("cd /var/lib/docker/volumes/generated_bitcoin_datadir/")]),e._v(", and check its content with "),a("code",[e._v("ls -la")]),e._v(". You should see only one directory named "),a("code",[e._v("_data")]),e._v(".")]),e._v(" "),a("li",[e._v("Now remove the "),a("code",[e._v("_data")]),e._v("directory : "),a("code",[e._v("rm -r _data")]),e._v(". If for any reason you want to keep this directory and its content you can also rename it instead : "),a("code",[e._v("mv _data/ _data.old/")])]),e._v(" "),a("li",[e._v("Now create a "),a("a",{attrs:{href:"https://www.cyberciti.biz/faq/creating-soft-link-or-symbolic-link/",target:"_blank",rel:"noopener noreferrer"}},[e._v("symbolic link"),a("OutboundLink")],1),e._v(" between "),a("code",[e._v("/var/lib/docker/volumes/generated_bitcoin_datadir/_data")]),e._v(" and your data directory ("),a("code",[e._v(".bitcoin")]),e._v(") on your host: "),a("code",[e._v("ln -s path/to/.bitcoin /var/lib/docker/volumes/generated_bitcoin_datadir/_data")])]),e._v(" "),a("li",[e._v("Check that the link has been done with a "),a("code",[e._v("ls -la")])]),e._v(" "),a("li",[e._v("Start your docker-compose again with "),a("code",[e._v("btcpay-up.sh")])])]),e._v(" "),a("p",[e._v("Your BTCPay Server should now be fully synched.")]),e._v(" "),a("p",[e._v("If after this BTCPay Server keeps showing that your node is always starting, see the cause of "),a("a",{attrs:{href:"#btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[e._v("BTCPay Server keeps showing that my node is always starting")]),e._v(".")]),e._v(" "),a("h2",{attrs:{id:"how-to-enable-bitcoin-node-pruning"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-enable-bitcoin-node-pruning"}},[e._v("#")]),e._v(" How to enable Bitcoin node pruning?")]),e._v(" "),a("p",[e._v("This will prune your Bitcoin full node to a maximum of 100GB (of blocks):")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"opt-save-storage"')]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n")])])]),a("p",[e._v("Other pruning options are "),a("RouterLink",{attrs:{to:"/Docker/#generated-docker-compose"}},[e._v("documented here")]),e._v(". See "),a("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-modify-or-deactivate-environment-variables"}},[e._v("this example")]),e._v(" for use with other additional fragments.")],1),e._v(" "),a("h2",{attrs:{id:"how-to-disable-bitcoin-node-pruning"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-disable-bitcoin-node-pruning"}},[e._v("#")]),e._v(" How to disable Bitcoin node pruning?")]),e._v(" "),a("p",[e._v("To disable pruning of your Bitcoin node in BTCPay, first ensure you have enough memory to store the entire blockchain and BTCPayServer on your system. Then disable the "),a("code",[e._v("opt-save-storage")]),e._v(" environment variable. See "),a("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-modify-or-deactivate-environment-variables"}},[e._v("this example")]),e._v(" to view your fragment list and select only one for removal. The following example will remove "),a("strong",[e._v("all")]),e._v(" additional fragments:")],1),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n")])])]),a("p",[e._v("Then run the following commands to recreate a non-pruned Bitcoin node:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("btcpay-down.sh\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Delete 'blocks' and 'chainstate' folders")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" -rf /var/lib/docker/volumes/generated_bitcoin_datadir/_data/blocks\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" -rf /var/lib/docker/volumes/generated_bitcoin_datadir/_data/chainstate\nbtcpay-up.sh\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[124],{752:function(e,a,t){"use strict";t.r(a);var s=t(9),n=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"synchronization-faq"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#synchronization-faq"}},[e._v("#")]),e._v(" Synchronization FAQ")]),e._v(" "),a("p",[e._v("This document covers the most common questions and issues that may occur during BTCPay sync.")]),e._v(" "),a("p"),a("div",{staticClass:"table-of-contents"},[a("ul",[a("li",[a("a",{attrs:{href:"#why-does-btcpay-sync"}},[e._v("Why does BTCPay sync?")])]),a("li",[a("a",{attrs:{href:"#can-i-skip-the-synchronization"}},[e._v("Can I skip the synchronization?")])]),a("li",[a("a",{attrs:{href:"#how-do-i-know-that-btcpay-synced-completely"}},[e._v("How do I know that BTCPay synced completely?")])]),a("li",[a("a",{attrs:{href:"#how-can-i-check-the-block-height-of-my-bitcoin-node"}},[e._v("How can I check the block height of my bitcoin node?")])]),a("li",[a("a",{attrs:{href:"#btcpay-server-takes-forever-to-synchronize"}},[e._v("BTCPay Server takes forever to synchronize")]),a("ul",[a("li",[a("a",{attrs:{href:"#cause-1-not-enough-cpu"}},[e._v("Cause 1: Not enough CPU")])]),a("li",[a("a",{attrs:{href:"#cause-2-using-swap-memory"}},[e._v("Cause 2: Using swap memory")])])])]),a("li",[a("a",{attrs:{href:"#btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[e._v("BTCPay Server keeps showing that my node is always starting")]),a("ul",[a("li",[a("a",{attrs:{href:"#cause-1-you-do-not-have-enough-ram"}},[e._v("Cause 1: You do not have enough RAM")])]),a("li",[a("a",{attrs:{href:"#cause-2-you-do-not-have-enough-storage"}},[e._v("Cause 2: You do not have enough storage")])]),a("li",[a("a",{attrs:{href:"#cause-3-you-accidentally-disabled-pruning"}},[e._v("Cause 3: You accidentally disabled pruning")])]),a("li",[a("a",{attrs:{href:"#cause-4-your-bitcoin-data-directory-is-corrupted"}},[e._v("Cause 4: Your bitcoin data directory is corrupted")])]),a("li",[a("a",{attrs:{href:"#cause-5-your-last-wallet-synchronisation-goes-beyond-pruned-data"}},[e._v("Cause 5: Your last wallet synchronisation goes beyond pruned data")])])])]),a("li",[a("a",{attrs:{href:"#im-running-a-full-node-and-have-a-synched-blockchain-can-btcpay-use-it-so-that-it-doesnt-have-to-do-a-full-sync"}},[e._v("I'm running a full node and have a synched blockchain, can BTCPay use it so that it doesn't have to do a full sync?")])]),a("li",[a("a",{attrs:{href:"#how-to-enable-bitcoin-node-pruning"}},[e._v("How to enable Bitcoin node pruning?")])]),a("li",[a("a",{attrs:{href:"#how-to-disable-bitcoin-node-pruning"}},[e._v("How to disable Bitcoin node pruning?")])])])]),a("p"),e._v(" "),a("h2",{attrs:{id:"why-does-btcpay-sync"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#why-does-btcpay-sync"}},[e._v("#")]),e._v(" Why does BTCPay sync?")]),e._v(" "),a("p",[e._v("After deployment, your BTCPay Server needs to sync the entire blockchain and validate all the consensus rules. Depending on your machine specifications, bandwidth and number of altcoins you added, this process may take between 1-5 days.")]),e._v(" "),a("p",[e._v("It may seem tedious, but it's a critical step of running your own full node and not having to trust or rely on anyone. Your node will not only download ~300GB of data (less if you're using a pruned node) but also validate all the rules of the consensus. You can find more information about the importance of blockchain synchronization in "),a("a",{attrs:{href:"https://www.youtube.com/watch?v=OrYDehC-8TU",target:"_blank",rel:"noopener noreferrer"}},[e._v("this video"),a("OutboundLink")],1),e._v(".")]),e._v(" "),a("p",[e._v("If you are only interested in learning about BTCPay Server i.e. simply "),a("RouterLink",{attrs:{to:"/TryItOut/"}},[e._v("trying it out")]),e._v(" without deploying your own instance, you can avoid sync by using a "),a("RouterLink",{attrs:{to:"/Deployment/ThirdPartyHosting/"}},[e._v("Third-Party host")]),e._v(".")],1),e._v(" "),a("h2",{attrs:{id:"can-i-skip-the-synchronization"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#can-i-skip-the-synchronization"}},[e._v("#")]),e._v(" Can I skip the synchronization?")]),e._v(" "),a("p",[e._v("You can't skip synchronization if you are deploying a BTCPay Server, but you can drastically decrease the time it takes. If you're comfortable with using the command line, you can use FastSync to synchronize your node faster. Be sure to "),a("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-docker/tree/master/contrib/FastSync",target:"_blank",rel:"noopener noreferrer"}},[e._v("read this FastSync document"),a("OutboundLink")],1),e._v(" to understand the potential trust issues involved with this feature.")]),e._v(" "),a("p",[e._v("To use FastSync, make sure your deployment has a "),a("a",{attrs:{href:"#how-to-enable-bitcoin-node-pruning"}},[e._v("pruning option enabled")]),e._v(" by using an "),a("code",[e._v("opt-save-storage")]),e._v(" environment variable, otherwise bitcoind will not be able to sync. First step is to "),a("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-ssh-into-my-btcpay-running-on-vps"}},[e._v("ssh into")]),e._v(" your BTCPayServer instance and run the following commands:")],1),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAY_BASE_DIRECTORY")]),e._v("/btcpayserver-docker/\nbtcpay-down.sh\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" contrib/FastSync\n./load-utxo-set.sh\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Once FastSync has completed")]),e._v("\nbtcpay-up.sh\n")])])]),a("p",[e._v("After FastSync is complete and you have brought back up your instance, refresh your BTCPay domain and wait for remaining blockchain synchronization. You can also follow "),a("a",{attrs:{href:"https://youtube.com/watch?v=VNMnd-dX9Q8?t=1730",target:"_blank",rel:"noopener noreferrer"}},[e._v("this video"),a("OutboundLink")],1),e._v(".")]),e._v(" "),a("p",[e._v("If your FastSync returns "),a("code",[e._v("You need to delete your Bitcoin Core wallet")]),e._v(" after you load the uxto set, or you find this error: "),a("code",[e._v("Last wallet synchronisation goes beyond pruned data")]),e._v(", see the cause of "),a("a",{attrs:{href:"#btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[e._v("BTCPay Server keeps showing that my node is always starting")]),e._v(".")]),e._v(" "),a("h2",{attrs:{id:"how-do-i-know-that-btcpay-synced-completely"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-do-i-know-that-btcpay-synced-completely"}},[e._v("#")]),e._v(" How do I know that BTCPay synced completely?")]),e._v(" "),a("p",[e._v("When you do not see a pop-up message in the bottom right corner, which shows the sync progress, that means that your server is fully synced and you can "),a("RouterLink",{attrs:{to:"/RegisterAccount/"}},[e._v("begin using it")]),e._v(".")],1),e._v(" "),a("p",[e._v("If you want to check that your BTCPay Server Bitcoin node is synchronized with the most recent block in the Bitcoin blockchain, "),a("a",{attrs:{href:"#how-can-i-check-the-block-height-of-my-bitcoin-node"}},[e._v("check your node height")]),e._v(" matches the current block height using any blockchain explorer.")]),e._v(" "),a("h2",{attrs:{id:"how-can-i-check-the-block-height-of-my-bitcoin-node"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-check-the-block-height-of-my-bitcoin-node"}},[e._v("#")]),e._v(" How can I check the block height of my bitcoin node?")]),e._v(" "),a("p",[e._v("To verify the sync status of your Bitcoin node, you can use bitcoin-cli commands inside your server's Bitcoin container. SSH into your server and navigate to the directory where you "),a("RouterLink",{attrs:{to:"/Troubleshooting/#23-bitcoin-node-logs"}},[e._v("view Bitcoin logs")]),e._v(" run the command: "),a("code",[e._v("bitcoin-cli.sh getblockcount")]),e._v(" to view the current block of your server's Bitcoin node.")],1),e._v(" "),a("h2",{attrs:{id:"btcpay-server-takes-forever-to-synchronize"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-server-takes-forever-to-synchronize"}},[e._v("#")]),e._v(" BTCPay Server takes forever to synchronize")]),e._v(" "),a("p",[e._v("Synchronizing a Full Bitcoin node should take between 1 and 5 days. It should sync quickly at first and more slowly at the end.")]),e._v(" "),a("p",[e._v("If the node appears to not be syncing, verify:")]),e._v(" "),a("ul",[a("li",[e._v("Not enough CPU")]),e._v(" "),a("li",[e._v("Using swap memory")])]),e._v(" "),a("h3",{attrs:{id:"cause-1-not-enough-cpu"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-1-not-enough-cpu"}},[e._v("#")]),e._v(" Cause 1: Not enough CPU")]),e._v(" "),a("p",[e._v("We recommend 2 CPU while synchronizing; however some hosting providers throttle your CPU if you use too much.")]),e._v(" "),a("p",[e._v("Check with")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" stats\n")])])]),a("p",[e._v("If you see more than 100% CPU usage, while being very slow to sync:")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("8e7ac41e6e2a btcpayserver_bitcoind 100% 560.5MiB / 3.853GiB 14.20% 4.17\n")])])]),a("p",[e._v("Then you need to scale up your machine specification.")]),e._v(" "),a("p",[e._v("If you see very low CPU usage (less than 10%) during synchronization:")]),e._v(" "),a("div",{staticClass:"language- extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("8e7ac41e6e2a btcpayserver_bitcoind 10% 560.5MiB / 3.853GiB 14.20% 4.17\n")])])]),a("p",[e._v("Your hosting provider might throttle your CPU. Please make sure your host supports the high use of CPU for an extended period.")]),e._v(" "),a("p",[e._v("If they don't allow it, shut down your server until they stop throttling you. Then you can limit the CPU via docker, and restart the server:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" update btcpayserver_bitcoind --cpus "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('".8"')]),e._v("\n")])])]),a("h3",{attrs:{id:"cause-2-using-swap-memory"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-2-using-swap-memory"}},[e._v("#")]),e._v(" Cause 2: Using swap memory")]),e._v(" "),a("p",[e._v("If you are synching and don't have enough memory, your server may use swap memory to continue operating:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("free")]),e._v(" -h\n")])])]),a("p",[e._v("If you see swap memory usage:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v(" total used "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("free")]),e._v(" shared buff/cache available\nMem: "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G 0M 66M 0G 0M\nSwap: "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v(".0G 200M 800M\n")])])]),a("p",[e._v("Then it means you need to scale up your server by adding more memory.")]),e._v(" "),a("h2",{attrs:{id:"btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[e._v("#")]),e._v(" BTCPay Server keeps showing that my node is always starting")]),e._v(" "),a("p",[e._v("Possible cause:")]),e._v(" "),a("ul",[a("li",[e._v("You do not have enough RAM")]),e._v(" "),a("li",[e._v("You do not have enough storage")]),e._v(" "),a("li",[e._v("You accidentally disabled pruning")]),e._v(" "),a("li",[e._v("Your bitcoin data directory is corrupted")]),e._v(" "),a("li",[e._v("Your last wallet synchronisation goes beyond pruned data")])]),e._v(" "),a("h3",{attrs:{id:"cause-1-you-do-not-have-enough-ram"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-1-you-do-not-have-enough-ram"}},[e._v("#")]),e._v(" Cause 1: You do not have enough RAM")]),e._v(" "),a("p",[e._v("Check your RAM:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("free")]),e._v(" -h\n")])])]),a("p",[e._v("If you see that you have no "),a("code",[e._v("free")]),e._v(" or very little "),a("code",[e._v("available")]),e._v(" memory:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v(" total used "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("free")]),e._v(" shared buff/cache available\nMem: "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G 0M 66M 0G 0M\nSwap: 0B 0B 0B\n")])])]),a("p",[e._v("Then you need more memory. If you have already synched your node, you can add some swap memory. If you haven't, your server specs are too limited.")]),e._v(" "),a("p",[e._v("If you have already synched, you can add 2G of swap memory with:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("fallocate -l 2G /mnt/swapfile\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("chmod")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("600")]),e._v(" /mnt/swapfile\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("mkswap")]),e._v(" /mnt/swapfile\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("swapon")]),e._v(" /mnt/swapfile\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("echo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"/mnt/swapfile none swap sw 0 0"')]),e._v(" "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">>")]),e._v(" /etc/fstab\n")])])]),a("h3",{attrs:{id:"cause-2-you-do-not-have-enough-storage"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-2-you-do-not-have-enough-storage"}},[e._v("#")]),e._v(" Cause 2: You do not have enough storage")]),e._v(" "),a("p",[e._v("Check the storage of your machine:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("df")]),e._v(" -h\n")])])]),a("p",[e._v("If you see you don't have any storage left (/dev/sda1 in my case)")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("Filesystem Size Used Avail Use% Mounted on\nudev "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v("% /dev\ntmpfs 395M 41M 354M "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("11")]),e._v("% /run\n/dev/sda1 125G 125G 0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("100")]),e._v("% /\ntmpfs "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v("% /dev/shm\ntmpfs "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("5")]),e._v(".0M "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("5")]),e._v(".0M "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v("% /run/lock\ntmpfs "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("2")]),e._v(".0G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("0")]),e._v("% /sys/fs/cgroup\n/dev/sdb1 "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("7")]),e._v(".8G 18M "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("7")]),e._v(".4G "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("1")]),e._v("% /mnt\n")])])]),a("p",[a("RouterLink",{attrs:{to:"/Docker/#generated-docker-compose"}},[e._v("Choose the docker fragment")]),e._v(" for the amount of storage you aim to keep. Then "),a("RouterLink",{attrs:{to:"/Docker/#how-i-can-prune-my-nodes"}},[e._v("prune your node")]),e._v(".")],1),e._v(" "),a("h3",{attrs:{id:"cause-3-you-accidentally-disabled-pruning"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-3-you-accidentally-disabled-pruning"}},[e._v("#")]),e._v(" Cause 3: You accidentally disabled pruning")]),e._v(" "),a("p",[e._v("If you have recently tried to modify your environment variables using the "),a("code",[e._v('export BTCPAYGEN_ADDITIONAL_FRAGMENTS="xyz"')]),e._v(" command to add an additional fragment, but forgot to include your current ones, you may have disabled pruning.")]),e._v(" "),a("p",[e._v("If you don't have enough memory to store the entire Bitcoin blockchain and you don't have an "),a("code",[e._v("opt-save-storage")]),e._v(" listed when you "),a("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-modify-or-deactivate-environment-variables"}},[e._v("print the complete list of options")]),e._v(" that you are running, it is very likely you have disabled pruning.")],1),e._v(" "),a("p",[e._v("You can verify by checking your Bitcoind logs:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" logs --tail "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("100")]),e._v(" btcpayserver_bitcoind\n")])])]),a("p",[e._v("If you see:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("Block files have previously been pruned.\nYou need to rebuild the database using -reindex to go back to unpruned mode.\nThis will redownload the entire blockchain.\nPlease restart with -reindex or -reindex-chainstate to recover.\n")])])]),a("p",[e._v("You can simply "),a("a",{attrs:{href:"#how-to-enable-bitcoin-node-pruning"}},[e._v("re-enable pruning")]),e._v(" to solve the issue.")]),e._v(" "),a("h3",{attrs:{id:"cause-4-your-bitcoin-data-directory-is-corrupted"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-4-your-bitcoin-data-directory-is-corrupted"}},[e._v("#")]),e._v(" Cause 4: Your bitcoin data directory is corrupted")]),e._v(" "),a("p",[e._v("Check the logs of your node:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" logs --tail "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("10")]),e._v(" btcpayserver_bitcoind\n")])])]),a("p",[e._v("If you see:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("Please restart with -reindex or -reindex-chainstate to recover.\n")])])]),a("p",[e._v("Then your bitcoin data directory has been corrupted. It may be physical damage or failure of the hard drive.\nTo reindex your node:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("btcpay-down.sh\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Delete 'blocks' and 'chainstate' folders")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" -rf /var/lib/docker/volumes/generated_bitcoin_datadir/_data/blocks\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" -rf /var/lib/docker/volumes/generated_bitcoin_datadir/_data/chainstate\nbtcpay-up.sh\n")])])]),a("h3",{attrs:{id:"cause-5-your-last-wallet-synchronisation-goes-beyond-pruned-data"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#cause-5-your-last-wallet-synchronisation-goes-beyond-pruned-data"}},[e._v("#")]),e._v(" Cause 5: Your last wallet synchronisation goes beyond pruned data")]),e._v(" "),a("p",[e._v("This can happen if you use FastSync or import an already synched blockchain. It means that the bitcoin core wallet needs to be removed because it was created before the utxoset, likely because BTCPay Server started without the utxoset at the first boot. To verify this case, "),a("RouterLink",{attrs:{to:"/Troubleshooting/#21-btcpay-logs"}},[e._v("check the bitcoind log")]),e._v(" for this:")],1),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("Error: Prune: last wallet synchronisation goes beyond pruned data. You need to -reindex "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("download the whole blockchain again "),a("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("in")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("case")]),e._v(" of pruned "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("node")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),a("p",[e._v("If you see this error and agree to remove the wallet to finish syncing, use "),a("code",[e._v("docker volume rm generated_bitcoin_wallet_datadir")]),e._v(" after you run "),a("code",[e._v("btcpay-down.sh")]),e._v(" and before you run "),a("code",[e._v("btcpay-up.sh")]),e._v("\nWARNING: Do not delete this wallet if you have any funds on it.")]),e._v(" "),a("h2",{attrs:{id:"im-running-a-full-node-and-have-a-synched-blockchain-can-btcpay-use-it-so-that-it-doesnt-have-to-do-a-full-sync"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#im-running-a-full-node-and-have-a-synched-blockchain-can-btcpay-use-it-so-that-it-doesnt-have-to-do-a-full-sync"}},[e._v("#")]),e._v(" I'm running a full node and have a synched blockchain, can BTCPay use it so that it doesn't have to do a full sync?")]),e._v(" "),a("p",[e._v("Yes you can! However, before you do that, you'll want to stop bitcoind from updating docker's volume for it, as that job will be taken over by BTCPay Server.")]),e._v(" "),a("p",[e._v("If you want to run BTCPay Server inside a docker-compose, and that you have the data directory ("),a("code",[e._v(".bitcoin")]),e._v(") of a fully synched node on your docker host, then you can reuse it easily for BTCPay Server.")]),e._v(" "),a("p",[e._v("To do that, follow the following steps :")]),e._v(" "),a("ul",[a("li",[e._v("Do the normal setup according to "),a("RouterLink",{attrs:{to:"/Docker/"}},[e._v("this instruction")]),e._v(". Note the "),a("code",[e._v("opt-save-storage")]),e._v(" environment variable, which is used to enable various pruning levels. If you do not want to prune your exiting data directory, then omit the following line in your BTCPay docker deployment: "),a("code",[e._v('export BTCPAYGEN_ADDITIONAL_FRAGMENTS="opt-save-storage-s"')]),e._v(".")],1),e._v(" "),a("li",[e._v("Once "),a("code",[e._v("btcpay-setup.sh")]),e._v(" is over, turn down the docker compose with "),a("code",[e._v("btcpay-down.sh")]),e._v(".")]),e._v(" "),a("li",[e._v("Login as root with "),a("code",[e._v("sudo su -")]),e._v(".")]),e._v(" "),a("li",[e._v("Open the docker's volume for bitcoind : "),a("code",[e._v("cd /var/lib/docker/volumes/generated_bitcoin_datadir/")]),e._v(", and check its content with "),a("code",[e._v("ls -la")]),e._v(". You should see only one directory named "),a("code",[e._v("_data")]),e._v(".")]),e._v(" "),a("li",[e._v("Now remove the "),a("code",[e._v("_data")]),e._v("directory : "),a("code",[e._v("rm -r _data")]),e._v(". If for any reason you want to keep this directory and its content you can also rename it instead : "),a("code",[e._v("mv _data/ _data.old/")])]),e._v(" "),a("li",[e._v("Now create a "),a("a",{attrs:{href:"https://www.cyberciti.biz/faq/creating-soft-link-or-symbolic-link/",target:"_blank",rel:"noopener noreferrer"}},[e._v("symbolic link"),a("OutboundLink")],1),e._v(" between "),a("code",[e._v("/var/lib/docker/volumes/generated_bitcoin_datadir/_data")]),e._v(" and your data directory ("),a("code",[e._v(".bitcoin")]),e._v(") on your host: "),a("code",[e._v("ln -s path/to/.bitcoin /var/lib/docker/volumes/generated_bitcoin_datadir/_data")])]),e._v(" "),a("li",[e._v("Check that the link has been done with a "),a("code",[e._v("ls -la")])]),e._v(" "),a("li",[e._v("Start your docker-compose again with "),a("code",[e._v("btcpay-up.sh")])])]),e._v(" "),a("p",[e._v("Your BTCPay Server should now be fully synched.")]),e._v(" "),a("p",[e._v("If after this BTCPay Server keeps showing that your node is always starting, see the cause of "),a("a",{attrs:{href:"#btcpay-server-keeps-showing-that-my-node-is-always-starting"}},[e._v("BTCPay Server keeps showing that my node is always starting")]),e._v(".")]),e._v(" "),a("h2",{attrs:{id:"how-to-enable-bitcoin-node-pruning"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-enable-bitcoin-node-pruning"}},[e._v("#")]),e._v(" How to enable Bitcoin node pruning?")]),e._v(" "),a("p",[e._v("This will prune your Bitcoin full node to a maximum of 100GB (of blocks):")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('"opt-save-storage"')]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n")])])]),a("p",[e._v("Other pruning options are "),a("RouterLink",{attrs:{to:"/Docker/#generated-docker-compose"}},[e._v("documented here")]),e._v(". See "),a("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-modify-or-deactivate-environment-variables"}},[e._v("this example")]),e._v(" for use with other additional fragments.")],1),e._v(" "),a("h2",{attrs:{id:"how-to-disable-bitcoin-node-pruning"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-disable-bitcoin-node-pruning"}},[e._v("#")]),e._v(" How to disable Bitcoin node pruning?")]),e._v(" "),a("p",[e._v("To disable pruning of your Bitcoin node in BTCPay, first ensure you have enough memory to store the entire blockchain and BTCPayServer on your system. Then disable the "),a("code",[e._v("opt-save-storage")]),e._v(" environment variable. See "),a("RouterLink",{attrs:{to:"/FAQ/Deployment/#how-can-i-modify-or-deactivate-environment-variables"}},[e._v("this example")]),e._v(" to view your fragment list and select only one for removal. The following example will remove "),a("strong",[e._v("all")]),e._v(" additional fragments:")],1),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),a("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),a("span",{pre:!0,attrs:{class:"token string"}},[e._v('""')]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n")])])]),a("p",[e._v("Then run the following commands to recreate a non-pruned Bitcoin node:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("btcpay-down.sh\n"),a("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# Delete 'blocks' and 'chainstate' folders")]),e._v("\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" -rf /var/lib/docker/volumes/generated_bitcoin_datadir/_data/blocks\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("rm")]),e._v(" -rf /var/lib/docker/volumes/generated_bitcoin_datadir/_data/chainstate\nbtcpay-up.sh\n")])])])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/127.8c7788dc.js b/assets/js/127.3a8c72fe.js similarity index 98% rename from assets/js/127.8c7788dc.js rename to assets/js/127.3a8c72fe.js index 8b584ff44d..2d16725fca 100644 --- a/assets/js/127.8c7788dc.js +++ b/assets/js/127.3a8c72fe.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{765:function(e,n,t){"use strict";t.r(n);var i=t(9),o=Object(i.a)({},(function(){var e=this,n=e._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[n("h1",{attrs:{id:"opening-and-operating-payment-channels"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#opening-and-operating-payment-channels"}},[e._v("#")]),e._v(" Opening and operating payment channels")]),e._v(" "),n("p",[e._v("Given that the Lightning Network is a relatively new technology under active development, getting your freshly deployed node ready to send and receive payments, still, requires a couple of steps.")]),e._v(" "),n("p",[e._v("Overview:")]),e._v(" "),n("ol",[n("li",[e._v("The lightning node is deployed, enabled and its on-chain wallet is funded")]),e._v(" "),n("li",[e._v("A peer is identified and the first payment channel is opened")]),e._v(" "),n("li",[e._v("Inbound and outbound liquidity is acquired. The node is now able to "),n("strong",[e._v("send")]),e._v(" and "),n("strong",[e._v("receive")])]),e._v(" "),n("li",[e._v("Liquidity management, an ongoing process to maintain the capacity to "),n("strong",[e._v("send")]),e._v(" and "),n("strong",[e._v("receive")])])]),e._v(" "),n("p",[e._v("Key considerations:")]),e._v(" "),n("ul",[n("li",[n("strong",[e._v("Choosing")]),e._v(" the channel partner. Consider opening the first channel to a well connected peer with robust uptime. This will increase the chances for your payments to be routed and settled.")]),e._v(" "),n("li",[n("strong",[e._v("Inbound")]),e._v(" vs "),n("strong",[e._v("outbound")]),e._v(" capacity. Outbound capacity allows nodes to "),n("strong",[e._v("send")]),e._v(" payments whereas inbound capacity allows nodes to "),n("strong",[e._v("receive")]),e._v(" payments. As a merchant using lightning, having inbound capacity is essential for customers to be able to pay you.")]),e._v(" "),n("li",[n("strong",[e._v("Inbound capacity")]),e._v(". A node adds inbound capacity by either spending sats from its local balance or having other nodes in the network open channels to it.")]),e._v(" "),n("li",[n("strong",[e._v("Liquidity management")]),e._v(": maintaining the ability to send and receive is a continous process where a balance between inbound vs outbound capacity has to be maintained across payment channels. This capacity distribution must be adjusted depending upon the use case of the node operator.")]),e._v(" "),n("li",[n("strong",[e._v("Lightning Service Providers")]),e._v(": LSPs offer paid third-party services that improve the ease of operating a lightning network node. Such services can be used to acquire inbound capacity or to automate the rebalancing process.")])]),e._v(" "),n("p",[e._v("Below a set of good resources for a deeper dive into topics such as:")]),e._v(" "),n("ul",[n("li",[n("a",{attrs:{href:"https://docs.lightning.engineering/the-lightning-network/the-gossip-network/identify-good-peers",target:"_blank",rel:"noopener noreferrer"}},[e._v("Good peers on the LN"),n("OutboundLink")],1)]),e._v(" "),n("li",[n("a",{attrs:{href:"https://bitcoin.design/guide/how-it-works/nodes/#lightning-nodes",target:"_blank",rel:"noopener noreferrer"}},[e._v("Lightning node types"),n("OutboundLink")],1)]),e._v(" "),n("li",[n("a",{attrs:{href:"https://bitcoin.design/guide/how-it-works/liquidity/",target:"_blank",rel:"noopener noreferrer"}},[e._v("What is Lightning liquidity?"),n("OutboundLink")],1)]),e._v(" "),n("li",[n("a",{attrs:{href:"https://lightningnetwork.plus/posts/234",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to get inbound capacity?"),n("OutboundLink")],1)]),e._v(" "),n("li",[n("a",{attrs:{href:"https://docs.lightning.engineering/the-lightning-network/liquidity/manage-liquidity#rebalancing-channels",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to manage liquidity?"),n("OutboundLink")],1)]),e._v(" "),n("li",[n("a",{attrs:{href:"https://bitcoin.design/guide/how-it-works/lightning-services/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Lightning service providers (LSP)"),n("OutboundLink")],1)])])])}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[127],{764:function(e,n,t){"use strict";t.r(n);var i=t(9),o=Object(i.a)({},(function(){var e=this,n=e._self._c;return n("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[n("h1",{attrs:{id:"opening-and-operating-payment-channels"}},[n("a",{staticClass:"header-anchor",attrs:{href:"#opening-and-operating-payment-channels"}},[e._v("#")]),e._v(" Opening and operating payment channels")]),e._v(" "),n("p",[e._v("Given that the Lightning Network is a relatively new technology under active development, getting your freshly deployed node ready to send and receive payments, still, requires a couple of steps.")]),e._v(" "),n("p",[e._v("Overview:")]),e._v(" "),n("ol",[n("li",[e._v("The lightning node is deployed, enabled and its on-chain wallet is funded")]),e._v(" "),n("li",[e._v("A peer is identified and the first payment channel is opened")]),e._v(" "),n("li",[e._v("Inbound and outbound liquidity is acquired. The node is now able to "),n("strong",[e._v("send")]),e._v(" and "),n("strong",[e._v("receive")])]),e._v(" "),n("li",[e._v("Liquidity management, an ongoing process to maintain the capacity to "),n("strong",[e._v("send")]),e._v(" and "),n("strong",[e._v("receive")])])]),e._v(" "),n("p",[e._v("Key considerations:")]),e._v(" "),n("ul",[n("li",[n("strong",[e._v("Choosing")]),e._v(" the channel partner. Consider opening the first channel to a well connected peer with robust uptime. This will increase the chances for your payments to be routed and settled.")]),e._v(" "),n("li",[n("strong",[e._v("Inbound")]),e._v(" vs "),n("strong",[e._v("outbound")]),e._v(" capacity. Outbound capacity allows nodes to "),n("strong",[e._v("send")]),e._v(" payments whereas inbound capacity allows nodes to "),n("strong",[e._v("receive")]),e._v(" payments. As a merchant using lightning, having inbound capacity is essential for customers to be able to pay you.")]),e._v(" "),n("li",[n("strong",[e._v("Inbound capacity")]),e._v(". A node adds inbound capacity by either spending sats from its local balance or having other nodes in the network open channels to it.")]),e._v(" "),n("li",[n("strong",[e._v("Liquidity management")]),e._v(": maintaining the ability to send and receive is a continous process where a balance between inbound vs outbound capacity has to be maintained across payment channels. This capacity distribution must be adjusted depending upon the use case of the node operator.")]),e._v(" "),n("li",[n("strong",[e._v("Lightning Service Providers")]),e._v(": LSPs offer paid third-party services that improve the ease of operating a lightning network node. Such services can be used to acquire inbound capacity or to automate the rebalancing process.")])]),e._v(" "),n("p",[e._v("Below a set of good resources for a deeper dive into topics such as:")]),e._v(" "),n("ul",[n("li",[n("a",{attrs:{href:"https://docs.lightning.engineering/the-lightning-network/the-gossip-network/identify-good-peers",target:"_blank",rel:"noopener noreferrer"}},[e._v("Good peers on the LN"),n("OutboundLink")],1)]),e._v(" "),n("li",[n("a",{attrs:{href:"https://bitcoin.design/guide/how-it-works/nodes/#lightning-nodes",target:"_blank",rel:"noopener noreferrer"}},[e._v("Lightning node types"),n("OutboundLink")],1)]),e._v(" "),n("li",[n("a",{attrs:{href:"https://bitcoin.design/guide/how-it-works/liquidity/",target:"_blank",rel:"noopener noreferrer"}},[e._v("What is Lightning liquidity?"),n("OutboundLink")],1)]),e._v(" "),n("li",[n("a",{attrs:{href:"https://lightningnetwork.plus/posts/234",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to get inbound capacity?"),n("OutboundLink")],1)]),e._v(" "),n("li",[n("a",{attrs:{href:"https://docs.lightning.engineering/the-lightning-network/liquidity/manage-liquidity#rebalancing-channels",target:"_blank",rel:"noopener noreferrer"}},[e._v("How to manage liquidity?"),n("OutboundLink")],1)]),e._v(" "),n("li",[n("a",{attrs:{href:"https://bitcoin.design/guide/how-it-works/lightning-services/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Lightning service providers (LSP)"),n("OutboundLink")],1)])])])}),[],!1,null,null,null);n.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/129.1dbcec3a.js b/assets/js/129.1dbcec3a.js deleted file mode 100644 index 2a4e161337..0000000000 --- a/assets/js/129.1dbcec3a.js +++ /dev/null @@ -1 +0,0 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[129],{767:function(t,a,s){"use strict";s.r(a);var e=s(9),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"api-specification"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#api-specification"}},[t._v("#")]),t._v(" API Specification")]),t._v(" "),a("p",[t._v("NBXplorer is a multi crypto currency lightweight block explorer.")]),t._v(" "),a("p",[t._v("NBXplorer does not index the whole blockchain, rather, it listens transactions and blocks from a trusted full node and index only addresses and transactions which belongs to a "),a("code",[t._v("DerivationScheme")]),t._v(" that you decide to track.")]),t._v(" "),a("h2",{attrs:{id:"table-of-content"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#table-of-content"}},[t._v("#")]),t._v(" Table of content")]),t._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"#configuration"}},[t._v("Configuration")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#authentication"}},[t._v("Authentication")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#derivationScheme"}},[t._v("Derivation Scheme Format")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#track"}},[t._v("Tracking a Derivation Scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#address"}},[t._v("Track a specific address")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#transactions"}},[t._v("Query transactions associated to a Derivation Scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#address-transactions"}},[t._v("Query transactions associated to a specific address")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#singletransaction"}},[t._v("Query a single transaction associated to a address or derivation scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#balance"}},[t._v("Get current balance")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#gettransaction"}},[t._v("Get a transaction")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#status"}},[t._v("Get connection status to the chain")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#unused"}},[t._v("Get a new unused address")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#scriptPubKey"}},[t._v("Get scriptPubKey information of a Derivation Scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#utxos"}},[t._v("Get available Unspent Transaction Outputs (UTXOs)")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#address-utxos"}},[t._v("Get available Unspent Transaction Outputs of a specific address")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#websocket"}},[t._v("Notifications via websocket")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#broadcast"}},[t._v("Broadcast a transaction")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#rescan"}},[t._v("Rescan a transaction")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#feerate"}},[t._v("Get fee rate")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#scanUtxoSet"}},[t._v("Scan UTXO Set")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#wipe"}},[t._v("Wipe derivation scheme transactions")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#eventStream"}},[t._v("Query event stream")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#eventStreamLatest"}},[t._v("Query event stream from most recent")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#psbt"}},[t._v("Create Partially Signed Bitcoin Transaction")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#updatepsbt"}},[t._v("Update Partially Signed Bitcoin Transaction")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#metadata"}},[t._v("Attach metadata to a derivation scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#detachmetadata"}},[t._v("Detach metadata from a derivation scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#getmetadata"}},[t._v("Retrieve metadata from a derivation scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#pruning"}},[t._v("Manual pruning")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#wallet"}},[t._v("Generate a wallet")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#rpc-proxy"}},[t._v("Node RPC Proxy")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#health"}},[t._v("Health check")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#liquid"}},[t._v("Liquid integration")])])]),t._v(" "),a("h2",{attrs:{id:"configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configuration"}},[t._v("#")]),t._v(" Configuration")]),t._v(" "),a("p",[t._v("You can check the available settings with "),a("code",[t._v("--help")]),t._v(".")]),t._v(" "),a("p",[t._v("NBXplorer can be configured in three way:")]),t._v(" "),a("ul",[a("li",[t._v("Through command line arguments (eg. "),a("code",[t._v("--chains btc")]),t._v(")")]),t._v(" "),a("li",[t._v("Through environment variables (eg. "),a("code",[t._v("NBXPLORER_CHAINS=btc")]),t._v(")")]),t._v(" "),a("li",[t._v("Through configuration file (eg. "),a("code",[t._v("chains=btc")]),t._v(")")])]),t._v(" "),a("p",[t._v("If you use configuration file, you can find it on windows in:")]),t._v(" "),a("div",{staticClass:"language-pwsh extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("C:\\Users\\\\AppData\\Roaming\\NBXplorer\\\\settings.config\n")])])]),a("p",[t._v("On linux or mac:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[t._v("~/.nbxplorer/"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("network"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v("/settings.config\n")])])]),a("p",[t._v("Be careful, if you run NBXplorer with "),a("code",[t._v("dotnet run")]),t._v(", you should do it this way, with settings after the "),a("code",[t._v("--")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[t._v("dotnet run --no-launch-profile --no-build -c Release -p ."),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("NBXplorer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("NBXplorer.csproj -- --chains btc\n")])])]),a("p",[t._v("Else, launch profiles, which are settings meant to be used only for debugging time, might be taken into account.")]),t._v(" "),a("h2",{attrs:{id:"authentication"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#authentication"}},[t._v("#")]),t._v(" Authentication")]),t._v(" "),a("p",[t._v("By default a cookie file is generated when NBXplorer is starting, for windows in:")]),t._v(" "),a("div",{staticClass:"language-pwsh extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("C:\\Users\\\\AppData\\Roaming\\NBXplorer\\\\.cookie\n")])])]),a("p",[t._v("On linux or mac:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[t._v("~/.nbxplorer/"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("network"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v("/.cookie\n")])])]),a("p",[t._v("The content of this cookie must be used is used as HTTP BASIC authentication to use the API.")]),t._v(" "),a("p",[t._v("This can be disabled with "),a("code",[t._v("--noauth")]),t._v(".")]),t._v(" "),a("p",[t._v("Also, NBXPlorer listen by default on "),a("code",[t._v("127.0.0.1")]),t._v(", if you want to access it from another machine, run "),a("code",[t._v('--bind "0.0.0.0"')]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"derivation-scheme-format"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#derivation-scheme-format"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"derivationScheme"}}),t._v("Derivation Scheme Format")]),t._v(" "),a("p",[t._v("A derivation scheme, also called derivationStrategy in the code, is a flexible way to define how to generate address of a wallet.\nNBXplorer will track any addresses on the "),a("code",[t._v("0/x")]),t._v(", "),a("code",[t._v("1/x")]),t._v(" and "),a("code",[t._v("x")]),t._v(" path.")]),t._v(" "),a("p",[t._v("Here a documentation of the different derivation scheme supported:")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Address type")]),t._v(" "),a("th",[t._v("Format")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("P2WPKH")]),t._v(" "),a("td",[t._v("xpub1")])]),t._v(" "),a("tr",[a("td",[t._v("P2SH-P2WPKH")]),t._v(" "),a("td",[t._v("xpub1-[p2sh]")])]),t._v(" "),a("tr",[a("td",[t._v("P2PKH")]),t._v(" "),a("td",[t._v("xpub-[legacy]")])]),t._v(" "),a("tr",[a("td",[t._v("Multi-sig P2WSH")]),t._v(" "),a("td",[t._v("2-of-xpub1-xpub2")])]),t._v(" "),a("tr",[a("td",[t._v("Multi-sig P2SH-P2WSH")]),t._v(" "),a("td",[t._v("2-of-xpub1-xpub2-[p2sh]")])]),t._v(" "),a("tr",[a("td",[t._v("Multi-sig P2SH")]),t._v(" "),a("td",[t._v("2-of-xpub1-xpub2-[legacy]")])]),t._v(" "),a("tr",[a("td",[t._v("P2TR")]),t._v(" "),a("td",[t._v("xpub1-[taproot]")])])])]),t._v(" "),a("p",[t._v("For multisig, the public keys are ordered before generating the address by default for privacy reason, use "),a("code",[t._v("-[keeporder]")]),t._v(" to disable it.")]),t._v(" "),a("p",[t._v("You can use more than one options at same time, example: "),a("code",[t._v("2-of-xpub1-xpub2-[legacy]-[keeporder]")])]),t._v(" "),a("p",[t._v("Most of routes asks for a "),a("code",[t._v("cryptoCode")]),t._v(". This identify the crypto currency to request data from. (eg. "),a("code",[t._v("BTC")]),t._v(", "),a("code",[t._v("LTC")]),t._v("...)")]),t._v(" "),a("p",[t._v("Note: Taproot is incompatible with all other options.")]),t._v(" "),a("h2",{attrs:{id:"track-a-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#track-a-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"track"}}),t._v("Track a derivation scheme")]),t._v(" "),a("p",[t._v("After this call, the specified "),a("code",[t._v("derivation scheme")]),t._v(" will be tracked by NBXplorer")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations/{derivationScheme}")])]),t._v(" "),a("p",[t._v("Returns nothing.")]),t._v(" "),a("p",[t._v("Optionally, you can attach a json body:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationOptions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Deposit"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"minAddresses"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"maxAddresses"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"wait"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("wait")]),t._v(": Optional. If "),a("code",[t._v("true")]),t._v(" the call will return when all addresses has been generated, addresses will be generated in the background (default: "),a("code",[t._v("false")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("derivationOptions")]),t._v(": Optional. Options to manually start the address generation process. (default: empty)")]),t._v(" "),a("li",[a("code",[t._v("derivationOptions.feature")]),t._v(": Optional. Define to which feature this option should be used. (defaut: null, which match all feature)")]),t._v(" "),a("li",[a("code",[t._v("derivationOptions.minAddresses")]),t._v(": Optional. The minimum addresses that need to be generated with this call. (default: null, make sure the number of address in the pool is between MinGap and MaxGap)")]),t._v(" "),a("li",[a("code",[t._v("derivationOptions.maxAddresses")]),t._v(": Optional. The maximum addresses that need to be generated with this call. (default: null, make sure the number of address in the pool is between MinGap and MaxGap)")])]),t._v(" "),a("h2",{attrs:{id:"track-a-specific-address"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#track-a-specific-address"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"address"}}),t._v("Track a specific address")]),t._v(" "),a("p",[t._v("After this call, the specified address will be tracked by NBXplorer")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/addresses/{address}")])]),t._v(" "),a("p",[t._v("Returns nothing.")]),t._v(" "),a("h2",{attrs:{id:"query-transactions-associated-to-a-derivationscheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query-transactions-associated-to-a-derivationscheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"transactions"}}),t._v("Query transactions associated to a derivationScheme")]),t._v(" "),a("p",[t._v("To query all transactions of a "),a("code",[t._v("derivation scheme")]),t._v(":")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/transactions")])]),t._v(" "),a("p",[t._v("To query a specific transaction:")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/transactions/{txId}")])]),t._v(" "),a("p",[t._v("Optional Parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("includeTransaction")]),t._v(" includes the hex of the transaction, not only information (default: true)")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"3e7bcca309f92ab78a47c1cdd1166de9190fa49e97165c93e2b10ae1a14b99eb"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cc33dfaf2ed794b11af83dc6e29303e2d8ff9e5e29303153dad1a1d3d8b43e40"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"020000000166d6befa387fd646f77a10e4b0f0e66b3569f18a83f77104a0c440e4156f80890000000048473044022064b1398653171440d3e79924cb6593633e7b2c3d80b60a2e21d6c6e287ee785a02203899009df443d0a0a1b06cb970aee0158d35166fd3e26d4e3e85570738e706d101feffffff028c02102401000000160014ee0a1889783da2e1f9bba47be4184b6610efd00400e1f5050000000016001452f88af314ef3b6d03d40a5fd1f2c906188a477567000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"001452f88af314ef3b6d03d40a5fd1f2c906188a4775"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381888")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replaceable"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacing"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedBy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unconfirmedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014b39fc4eb5c6dd238d39449b70a2e30d575426d99"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381889")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replaceable"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacing"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"e070e213a0815b84b4ae96d4d64ce551158524364d3522e7d6bd5415c6c15d3f"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedBy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014b39fc4eb5c6dd238d39449b70a2e30d575426d99"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381889")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replaceable"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacing"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedBy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"immatureTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("replaceable")]),t._v(": "),a("code",[t._v("true")]),t._v(" if the transaction can be replaced (the transaction has RBF activated, is in the unconfirmed list and is not an intermediate transaction in a chain of unconfirmed transaction)")]),t._v(" "),a("li",[a("code",[t._v("replacing")]),t._v(": Only set in the unconfirmed list, and is pointing to a transaction id in the replaced list.")]),t._v(" "),a("li",[a("code",[t._v("replacedBy")]),t._v(": Only set in the replaced list, and is pointing to a transaction id in the unconfirmed list.")]),t._v(" "),a("li",[a("code",[t._v("immatureTransactions")]),t._v(": Coinbase transactions with less than 100 confirmations.")])]),t._v(" "),a("p",[t._v("Note for liquid, "),a("code",[t._v("balanceChange")]),t._v(" is an array of "),a("a",{attrs:{href:"#liquid"}},[t._v("AssetMoney")]),t._v(".\nNote that the list of confirmed transaction also include immature transactions.")]),t._v(" "),a("h2",{attrs:{id:"query-transactions-associated-to-a-specific-address"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query-transactions-associated-to-a-specific-address"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"address-transactions"}}),t._v("Query transactions associated to a specific address")]),t._v(" "),a("p",[t._v("Query all transactions of a tracked address. (Only work if you called the Track operation on this specific address)")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/addresses/{address}/transactions")])]),t._v(" "),a("p",[t._v("Optional Parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("includeTransaction")]),t._v(" includes the hex of the transaction, not only information (default: true)")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"3e7bcca309f92ab78a47c1cdd1166de9190fa49e97165c93e2b10ae1a14b99eb"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cc33dfaf2ed794b11af83dc6e29303e2d8ff9e5e29303153dad1a1d3d8b43e40"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"020000000166d6befa387fd646f77a10e4b0f0e66b3569f18a83f77104a0c440e4156f80890000000048473044022064b1398653171440d3e79924cb6593633e7b2c3d80b60a2e21d6c6e287ee785a02203899009df443d0a0a1b06cb970aee0158d35166fd3e26d4e3e85570738e706d101feffffff028c02102401000000160014ee0a1889783da2e1f9bba47be4184b6610efd00400e1f5050000000016001452f88af314ef3b6d03d40a5fd1f2c906188a477567000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"001452f88af314ef3b6d03d40a5fd1f2c906188a4775"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381888")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unconfirmedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014b39fc4eb5c6dd238d39449b70a2e30d575426d99"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381889")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"query-a-single-transaction-associated-to-a-address-or-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query-a-single-transaction-associated-to-a-address-or-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"singletransaction"}}),t._v("Query a single transaction associated to a address or derivation scheme")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/transactions/{txId}")]),t._v(" "),a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/addresses/{address}/transactions/{txId}")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: Transaction not found")])]),t._v(" "),a("p",[t._v("Optional Parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("includeTransaction")]),t._v(" includes the hex of the transaction, not only information (default: true)")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014b39fc4eb5c6dd238d39449b70a2e30d575426d99"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381889")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"get-current-balance"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-current-balance"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"balance"}}),t._v("Get current balance")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/balance")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unconfirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("110000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"available"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("210000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"immature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"total"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("210000000")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Note for liquid, the values are array of "),a("a",{attrs:{href:"#liquid"}},[t._v("AssetMoney")]),t._v(".")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("unconfirmed")]),t._v(": How the confirmed balance would be updated once all the unconfirmed transactions were confirmed.")]),t._v(" "),a("li",[a("code",[t._v("confirmed")]),t._v(": The balance of all funds in confirmed transactions.")]),t._v(" "),a("li",[a("code",[t._v("total")]),t._v(": The total of funds owned (ie, "),a("code",[t._v("confirmed + unconfirmed")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("immature")]),t._v(": The total unspendable funds (ie, coinbase reward which need 100 confirmations before being spendable)")]),t._v(" "),a("li",[a("code",[t._v("available")]),t._v(": The total spendable balance. (ie, "),a("code",[t._v("total - immature")]),t._v(")")])]),t._v(" "),a("p",[t._v("Immature funds is the sum of UTXO's belonging to a coinbase transaction with less than 100 confirmations.")]),t._v(" "),a("h2",{attrs:{id:"get-a-transaction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-a-transaction"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"gettransaction"}}),t._v("Get a transaction")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/transactions/{txId}")])]),t._v(" "),a("p",[t._v("Optional Parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("includeTransaction")]),t._v(" includes the hex of the transaction, not only information (default: true)")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: Transaction not found")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"5efa23803df818cd21faa0c11e84db28c8352e76acb93d0c0adfe123db827190"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ed86c55b519c26ab4ba8130c976294753934c1f9f6d30203e65bb222648a8cdf"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0200000001205dcde69a5bd2b3281d387e6f125338f9ccb904d94df383ff56d9923599681e000000004847304402200b9d78e01691339acb238d7cd7a40ae620796bdcf8cb167dff4e100b71a2b0950220518e3a955ea7229d57c0160ecf491e8048662d7112fe5feaa312ff71388fda9701feffffff028c02102401000000160014a4ccb74ada7dd01b3018c3308894fea27b4813be00e1f5050000000016001408f86300ddff26ddf779ddce833f7e9e7442156c67000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540390804")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedBy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[a("code",[t._v("height")]),t._v(" and "),a("code",[t._v("blockId")]),t._v(" will be null if the transaction is not confirmed.")]),t._v(" "),a("h2",{attrs:{id:"get-connection-status-to-the-chain"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-connection-status-to-the-chain"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"status"}}),t._v("Get connection status to the chain")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/status")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"bitcoinStatus"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blocks"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("103")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"headers"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("103")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"verificationProgress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1.0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"isSynched"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"incrementalRelayFee"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"minRelayTxFee"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"capabilities"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"canScanTxoutSet"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"canSupportSegwit"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"canSupportTaproot"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"canSupportTransactionCheck"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"repositoryPingTime"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.0087891999999999987")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"isFullySynched"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"chainHeight"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("103")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"syncHeight"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("103")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"networkType"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Regtest"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"instanceName"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"MyInstance"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"supportedCryptoCodes"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"version"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1.0.3.5"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[a("code",[t._v("instanceName")]),t._v(" can be configured via configuration's key "),a("code",[t._v("instancename")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"get-a-new-unused-address"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-a-new-unused-address"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"unused"}}),t._v("Get a new unused address")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/addresses/unused")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("strategy-not-found")])])]),t._v(" "),a("p",[t._v("Optional parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("feature")]),t._v(": Use "),a("code",[t._v("Deposit")]),t._v(" to get a deposit address ("),a("code",[t._v("0/x")]),t._v("), "),a("code",[t._v("Change")]),t._v(" to get a change address ("),a("code",[t._v("1/x")]),t._v("), "),a("code",[t._v("Direct")]),t._v(" to get "),a("code",[t._v("x")]),t._v(" or "),a("code",[t._v("Custom")]),t._v(" if "),a("code",[t._v("customKeyPathTemplate")]),t._v(" is configured (default: "),a("code",[t._v("Deposit")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("skip")]),t._v(": How much address to skip, needed if the user want multiple unused addresses (default:0)")]),t._v(" "),a("li",[a("code",[t._v("reserve")]),t._v(": Mark the returned address as used (default: false)")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"DERIVATIONSCHEME:tpubD6NzVbkrYhZ4Wo2RMq8Xbnrorf1xnABkKMS3EGshPkQ3Z4N4GN8uyLuDPvnK7Ekc2FHdXbLvcuZny1gPiohMksFGKmaX3APD2DbTeBWj751-[p2sh]"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Deposit"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationStrategy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4Wo2RMq8Xbnrorf1xnABkKMS3EGshPkQ3Z4N4GN8uyLuDPvnK7Ekc2FHdXbLvcuZny1gPiohMksFGKmaX3APD2DbTeBWj751-[p2sh]"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/2"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"a91412cbf6154ef6d9aecf9c978dc2bdc43f1881dd5f87"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2MtxcVDMiRrJ3V4zfsAwZGbZfPiDUxSXDY2"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"redeem"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014e2eb89edba1fe6c6c0863699eeb78f6ec3271b45"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Note: "),a("code",[t._v("redeem")]),t._v(" is returning the segwit redeem if the derivation scheme is a P2SH-P2WSH or P2WSH, or the p2sh redeem if just a p2sh.")]),t._v(" "),a("h2",{attrs:{id:"get-scriptpubkey-information-of-a-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-scriptpubkey-information-of-a-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"scriptPubKey"}}),t._v("Get scriptPubKey information of a Derivation Scheme")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/scripts/{script}")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"DERIVATIONSCHEME:tpubD6NzVbkrYhZ4WcPozSqALNCrJEt4C45sPDhEBBuokoCeDgjX6YTs4QVvhD9kao6f2uZLqZF4qcXprYyRqooSXr1uPp1KPH1o4m6aw9nxbiA"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Deposit"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationStrategy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4WcPozSqALNCrJEt4C45sPDhEBBuokoCeDgjX6YTs4QVvhD9kao6f2uZLqZF4qcXprYyRqooSXr1uPp1KPH1o4m6aw9nxbiA"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"001460c25d29559774803f262acf5ee5c922eff52ccd"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tb1qvrp96224ja6gq0ex9t84aewfythl2txdkpdmu0"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"get-available-unspent-transaction-outputs-utxos"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-available-unspent-transaction-outputs-utxos"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"utxos"}}),t._v("Get available Unspent Transaction Outputs (UTXOs)")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/utxos")])]),t._v(" "),a("p",[t._v("Error:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])])]),t._v(" "),a("p",[t._v("Result:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"DERIVATIONSCHEME:tpubD6NzVbkrYhZ4XQVi1sSEDBWTcicDqVSCTnYDxpwGwcSZVbPii2b7baRg57YfL64ed36sBRe6GviihHwhy3D1cnBe5uXb27DjrDZCKUA7PQi"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationStrategy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4XQVi1sSEDBWTcicDqVSCTnYDxpwGwcSZVbPii2b7baRg57YfL64ed36sBRe6GviihHwhy3D1cnBe5uXb27DjrDZCKUA7PQi"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"currentHeight"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("107")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unconfirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"utxOs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Deposit"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outpoint"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"10ba4bcadd03130b1bd98b0bc7aea9910f871b25b87ec06e484456e84440c88a01000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"8ac84044e85644486ec07eb8251b870f91a9aec70b8bd91b0b1303ddca4bba10"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"00149681ae465a045e2068460b9d281cf97dede87cd8"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bcrt1qj6q6u3j6q30zq6zxpwwjs88e0hk7slxcunru7u"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540376171")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"spentOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"utxOs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Deposit"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outpoint"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"29ca6590f3f03a6523ad79975392e74e385bf2b7dafe6c537ffa12f9e124348800000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"883424e1f912fa7f536cfedab7f25b384ee792539779ad23653af0f39065ca29"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"001436a37f2f508650f7074bec4d091fc82bb01cc57f"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bcrt1qx63h7t6sseg0wp6ta3xsj87g9wcpe3tlgqgnql"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/3"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540376174")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"spentOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"9345f9585d643a31202e686ec7a4c2fe17917a5e7731a79d2327d24d25c0339f01000000"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("This call does not returns conflicted unconfirmed UTXOs.\nNote that confirmed utxo, do not include immature UTXOs. (ie. UTXOs belonging to a coinbase transaction with less than 100 confirmations)")]),t._v(" "),a("h2",{attrs:{id:"get-available-unspent-transaction-outputs-of-a-specific-address"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-available-unspent-transaction-outputs-of-a-specific-address"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"address-utxos"}}),t._v("Get available Unspent Transaction Outputs of a specific address")]),t._v(" "),a("p",[t._v("Assuming you use Track on this specific address:")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/addresses/{address}/utxos")])]),t._v(" "),a("p",[t._v("Error:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])])]),t._v(" "),a("p",[t._v("Result:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ADDRESS:moD8QpWufPMFP9y7gC8m5ih9rmejavbf3K"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"currentHeight"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("105")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unconfirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"utxOs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"spentOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"utxOs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outpoint"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f532022bebe8d90c72853a2663c26ca9d42fad5d9cde21d35bad38135a5dfd0701000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"07fd5d5a1338ad5bd321de9c5dad2fd4a96cc263263a85720cd9e8eb2b0232f5"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"76a9145461f6c342451142e07d95dd2a42b48af9114cea88ac"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540390664")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outpoint"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"a470a71144d4cdaef2b9bd8d24f20ebc8d6548bae523869f8cceb2cef5b4538a01000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"8a53b4f5ceb2ce8c9f8623e5ba48658dbc0ef2248dbdb9f2aecdd44411a770a4"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"76a9145461f6c342451142e07d95dd2a42b48af9114cea88ac"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540390666")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outpoint"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1710a1b61cb1f988182347be52a16502bae5a78fa9740a68107f9ddc6e30896a00000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"6a89306edc9d7f10680a74a98fa7e5ba0265a152be47231888f9b11cb6a11017"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"76a9145461f6c342451142e07d95dd2a42b48af9114cea88ac"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("60000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540390666")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"spentOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("This call does not returns conflicted unconfirmed UTXOs.")]),t._v(" "),a("h2",{attrs:{id:"notifications-via-websocket"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#notifications-via-websocket"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"websocket"}}),t._v("Notifications via websocket")]),t._v(" "),a("p",[t._v("NBXplorer implements real-time notification via websocket supports for new block or transaction.")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/connect")])]),t._v(" "),a("p",[t._v("Once you are connected to the websocket, you can subscribe to block notifications by sending the following JSON to it.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"subscribeblock"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Then a notification will be delivered through the websocket when a new block is mined:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"newblock"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"eventId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"10b0e5178aaf42c4a938f0d37430413b7d76feae14b01fc07e1f23300b8821ce"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"previousBlockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"4c6a9c1cadf143c87249519639e86e236feac9d3cea2904e4c42bc5bc32a48a7"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("For notification concerning "),a("code",[t._v("Derivation Scheme")]),t._v(" transactions, you can subscribe by sending through the websocket:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"subscribetransaction"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationSchemes"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4YL91Ez5fdgaBPQbFhedFdn5gQL4tSCJn1usmHsV1L6VokzLbgcqzh9hiBnfnQANp5BYW15QdFGRKspZVSW1v2QY917RDs1V-[legacy]"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Then you will receive such notifications when a transaction is impacting the "),a("code",[t._v("derivation scheme")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"newtransaction"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"eventId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"DERIVATIONSCHEME:tpubD6NzVbkrYhZ4X2p2D8kx6XV9V5iCJKMBHuBim1BLnZAZC1JobYkdwSrwF8R74V2oUWkJG3H24LwxnXs9wb6Ksivs2gj4RudMteyVai2AsmA-[p2sh]"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationStrategy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4X2p2D8kx6XV9V5iCJKMBHuBim1BLnZAZC1JobYkdwSrwF8R74V2oUWkJG3H24LwxnXs9wb6Ksivs2gj4RudMteyVai2AsmA-[p2sh]"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionData"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f135537b40ac7a524273176b60e464b7f279f622031ec53af302d959966d7364"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0200000001dd7f53b09438fed83abe25dd6cdc30ee2092ce8c855cb9e7b0faa38aba8bc0f500000000484730440220093a837ff4be4b64b2ed4625abb128966caad0cb7830cac7af4f615bbf6b52ce02206227a3ddec3fac9e49f414eeab1388d0e67829620ac3a8fb2f4bbfc5b67bd02901feffffff0200e1f5050000000017a91476de0c5d07fd202880672bc702162b7f18e13aca87640210240100000017a9147cfa038496438a6d3c95cfac990f4dffc6cb44f28768000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540434424")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"a91476de0c5d07fd202880672bc702162b7f18e13aca87"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2N45jj76a7YjGLDoKs2mnQ4tt5N7t6R9xoM"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"redeem"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"00147d31e1c7959cd047bb7b9b35e4c877a28efe2f0b"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacing"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"25d6bc1b2812670550aca8b2984670203b5ebf00e75f9b2bbf1940c3fa27841e"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"81a20eb55ec16b92c65d4e142278fd521caa9e5dcad9d941c8e256dbd917ae84"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("If you want all transactions of all derivation schemes of BTC, send this to the WebSocket:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"subscribetransaction"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("If you want all transactions of all derivation schemes of all crypto currencies, send this to the WebSocket:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"subscribetransaction"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"*"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("As an alternative to get notification, you can also use long polling with the "),a("a",{attrs:{href:"#eventStream"}},[t._v("event stream")]),t._v(".")]),t._v(" "),a("p",[t._v("Fields:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("replacing")]),t._v(": The list of the unconfirmed transactions of this wallet which have been replaced by this new transaction. This can typically be used to detect when the sender is bumping fee. This can't be used to detect when the sender is attempting to abort a transaction.")])]),t._v(" "),a("h2",{attrs:{id:"broadcast-a-transaction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#broadcast-a-transaction"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"broadcast"}}),t._v("Broadcast a transaction")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/transactions")])]),t._v(" "),a("p",[t._v("Body:")]),t._v(" "),a("p",[t._v("Raw bytes of the transaction.")]),t._v(" "),a("p",[t._v("Parameter:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("testMempoolAccept")]),t._v(": If "),a("code",[t._v("true")]),t._v(", will not attempt to broadcast the transaction but just test its acceptance in the mempool. (default: "),a("code",[t._v("false")]),t._v(")")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("rpc-unavailable")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("not-supported")]),t._v(" if "),a("code",[t._v("testMempoolAccept")]),t._v(" is "),a("code",[t._v("true")]),t._v(", but the underlying node does not support it")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"success"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rpcCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("-25")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rpcCodeMessage"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"General error during transaction submission"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rpcMessage"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Missing inputs"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"rescan-a-transaction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rescan-a-transaction"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"rescan"}}),t._v("Rescan a transaction")]),t._v(" "),a("p",[t._v("NBXplorer does not rescan the whole blockchain when tracking a new derivation scheme.\nThis means that if the derivation scheme already received UTXOs in the past, NBXplorer will not be aware of it and might reuse addresses already generated in the past, and will not show past transactions.")]),t._v(" "),a("p",[t._v("By using this route, you can ask NBXplorer to rescan specific transactions found in the blockchain.\nThis way, the transactions and the UTXOs present before tracking the derivation scheme will appear correctly.")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/rescan")])]),t._v(" "),a("p",[t._v("Body:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Specify the blockId and transactionId to scan. Your node must not be pruned for this to work.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"19b44484c79c40d4e74da406e25390348b86a252c1ab784cfd7198c724a0169f"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f83c7f31e2c39202bbbca619ab354ca8841721cf3440a253e056a7bea43e9745"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Only the transactionId is specified. Your node must run --txindex=1 for this to work")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"754c14060b958de0ff4e77e2ccdca617964c939d40ec9a01ef21fca2aad78d00"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// This will index the transaction without using RPC. Careful: A wrong blockId will corrupt the database.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"19b44484c79c40d4e74da406e25390348b86a252c1ab784cfd7198c724a0169f"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"02000000000101008dd7aaa2fc21ef019aec409d934c9617a6dccce2774effe08d950b06144c750000000000feffffff026c3e2e12010000001600143072110b34b66acd9469b2882d6d57a8ae27183900e1f505000000001600140429b3eebb7d55c50ca36ace12ae874ff2fd16af0247304402202e32739cc6e42877699d4159159941f3cc39027c7626f9962cca9a865816d43502205389e9d6c1a4cab41f2c504413cf0f46a5c1f8814f368e03c9bf1f8017c6787e012103b8858085f2a0c9c906fb793bedb2c115c340de1f7b279d6099f675ddf3eec0bf67000000"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Returns:")]),t._v(" "),a("p",[t._v("HTTP 200")]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 400: "),a("code",[t._v("rpc-unavailable")])])]),t._v(" "),a("h2",{attrs:{id:"get-fee-rate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-fee-rate"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"feerate"}}),t._v("Get fee rate")]),t._v(" "),a("p",[t._v("HTTP GET v1/cryptos/{cryptoCode}/fees/{blockCount}")]),t._v(" "),a("p",[t._v("Get expected fee rate for being confirmed in "),a("code",[t._v("blockCount")]),t._v(" blocks.")]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 400: "),a("code",[t._v("fee-estimation-unavailable")])]),t._v(" "),a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("rpc-unavailable")])])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feeRate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockCount"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("The fee rate is in satoshi/byte.")]),t._v(" "),a("h2",{attrs:{id:"scan-utxo-set"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#scan-utxo-set"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"scanUtxoSet"}}),t._v("Scan UTXO Set")]),t._v(" "),a("p",[t._v("NBXplorer can scan the UTXO Set for output belonging to your derivationScheme.")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/BTC/derivations/{derivationScheme}/utxos/scan")])]),t._v(" "),a("p",[t._v("In order to not consume too much RAM, NBXplorer splits the addresses to scan in several "),a("code",[t._v("batch")]),t._v(" and scan the whole UTXO set sequentially.\nThree branches are scanned: 0/x, 1/x and x.")]),t._v(" "),a("p",[t._v("If a UTXO in one branch get found at a specific x, then all addresses inferior to index x will be considered used and not proposed when fetching a new unused address.")]),t._v(" "),a("p",[t._v("Query parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("batchSize")]),t._v(" the number of addresses scanned at once per derivation scheme branch (default: 1000)")]),t._v(" "),a("li",[a("code",[t._v("gapLimit")]),t._v(" If no UTXO are detected in this interval, the scan stop (default: 10000)")]),t._v(" "),a("li",[a("code",[t._v("from")]),t._v(" the first address index to check (default: 0)")])]),t._v(" "),a("p",[t._v("This call queue the request for scanning and returns immediately.")]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 405: "),a("code",[t._v("scanutxoset-not-suported")]),t._v(" ScanUTXOSet is not supported for this currency")]),t._v(" "),a("li",[t._v("HTTP 409: "),a("code",[t._v("scanutxoset-in-progress")]),t._v(" ScanUTXOSet has already been called for this derivationScheme")]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("rpc-unavailable")])])]),t._v(" "),a("h2",{attrs:{id:"get-scan-status"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-scan-status"}},[t._v("#")]),t._v(" Get scan status")]),t._v(" "),a("p",[t._v("You can poll the status of the scan. Note that if the scan is complete, the result will be kept for 24H.\nThe state can be:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("Queued")]),t._v(" the demand has been done, but the scan request is queuing to be started")]),t._v(" "),a("li",[a("code",[t._v("Pending")]),t._v(" the scan is in progress")]),t._v(" "),a("li",[a("code",[t._v("Complete")]),t._v(" the scan is successful")]),t._v(" "),a("li",[a("code",[t._v("Error")]),t._v(" the scan errored")])]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"error"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"queuedAt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540439841")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"status"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Pending"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"progress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"startedAt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540439841")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"completedAt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"found"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"batchNumber"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("9")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"remainingBatches"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"currentBatchProgress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"remainingSeconds"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"overallProgress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("91")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"from"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("900")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"count"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"totalSearched"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2700")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"totalSizeOfUTXOSet"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"highestKeyIndexFound"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"change"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"deposit"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("51")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"direct"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[a("code",[t._v("TotalSizeOfUTXOSet")]),t._v(" is set only when the scan is complete.")]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404 "),a("code",[t._v("scanutxoset-info-not-found")]),t._v(" if the scan has been done above the last 24H.")])]),t._v(" "),a("h2",{attrs:{id:"wipe-derivation-scheme-transactions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#wipe-derivation-scheme-transactions"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"wipe"}}),t._v("Wipe derivation scheme transactions")]),t._v(" "),a("p",[t._v("Wipe all the transactions from a derivation scheme.")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST cryptos/{cryptoCode}/derivations/{derivationScheme}/utxos/wipe")])]),t._v(" "),a("h2",{attrs:{id:"query-event-stream"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query-event-stream"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"eventStream"}}),t._v("Query event stream")]),t._v(" "),a("p",[t._v("All notifications sent through websocket are also saved in a crypto specifc event stream.")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/events")])]),t._v(" "),a("p",[t._v("Query parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("lastEventId")]),t._v(": Will query all events which happened after this event id, the first event has id 1 (default: 0)")]),t._v(" "),a("li",[a("code",[t._v("longPolling")]),t._v(": If no events have been received since "),a("code",[t._v("lastEventId")]),t._v(", the call will block (default: false)")]),t._v(" "),a("li",[a("code",[t._v("limit")]),t._v(": Limit the maximum number of events to return (default: null)")])]),t._v(" "),a("p",[t._v("All events are registered in a query stream which you can replay by keeping track of the "),a("code",[t._v("lastEventId")]),t._v(".\nThe smallest "),a("code",[t._v("eventId")]),t._v(" is 1.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"eventId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"newblock"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1f31c605c0a5d54b65fa39dc8cb4db025be63c66280279ade9338571a9e63d35"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"previousBlockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7639350b31f3ce07ff976ebae772fef1602b30a10ccb8ca69047fe0fe8b9083c"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"eventId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"newtransaction"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"DERIVATIONSCHEME:tpubD6NzVbkrYhZ4XfeFUTn2D4RQ7D5HpvnHywa3eZYhxZBriRTsfe8ZKFSDMcEMBqGrAighxxmq5VUqoRvo7DnNMS5VbJjRHwqDfCAMXLwAL5j"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationStrategy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4XfeFUTn2D4RQ7D5HpvnHywa3eZYhxZBriRTsfe8ZKFSDMcEMBqGrAighxxmq5VUqoRvo7DnNMS5VbJjRHwqDfCAMXLwAL5j"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionData"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"500359d971698c021587ea952bd38bd57dafc2b99615f71f7f978af394682737"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0200000001b8af58c5dbed4bd0ea60ae8ba7e68e66143440b8c1c69b6eaaf719566676ab1b0000000048473044022040b419aeb9042a53fb2d03abec911901ed42fc50d6a143e322bc61d51e4e35a9022073c10fe827b53332d50fbde581e36ad31f57b98ec35a125562dc8c739762ec8901feffffff028c02102401000000160014b6bedaf0cb795c01a1e427bd7752d6ef058964f100e1f50500000000160014c5e0b07f40b8dbe69b22864d84d83d5b4120835368000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1542703963")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014c5e0b07f40b8dbe69b22864d84d83d5b41208353"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bcrt1qchstql6qhrd7dxezsexcfkpatdqjpq6nntvtrd"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),a("h2",{attrs:{id:"query-event-stream-from-most-recent"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query-event-stream-from-most-recent"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"eventStreamLatest"}}),t._v("Query event stream (from most recent)")]),t._v(" "),a("p",[t._v("Exact same as "),a("a",{attrs:{href:"#eventStream"}},[t._v("event stream")]),t._v(" but it returns a maximum number "),a("code",[t._v("#limit")]),t._v(" of the most recent events.")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/events/latest")])]),t._v(" "),a("p",[t._v("Query parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("limit")]),t._v(": Limit the maximum number of events to return (default: 10)")])]),t._v(" "),a("h2",{attrs:{id:"create-partially-signed-bitcoin-transaction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-partially-signed-bitcoin-transaction"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"psbt"}}),t._v("Create Partially Signed Bitcoin Transaction")]),t._v(" "),a("p",[t._v("Create a "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("Partially Signed Bitcoin Transaction"),a("OutboundLink")],1),t._v(" (PSBT).")]),t._v(" "),a("p",[t._v("A PSBT is a standard format to represent a transaction with pending signatures associated to it.\nA PSBT can be signed independently by many signers, and combined together before broadcast.")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/psbt/create")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 400: "),a("code",[t._v("not-enough-funds")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("output-too-small")]),t._v(" (if the output on which the "),a("code",[t._v("substractFee=true")]),t._v(" is too small to cover the fees)")]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("fee-estimation-unavailable")])]),t._v(" "),a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])])]),t._v(" "),a("p",[t._v("Fields:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"seed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rbf"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"version"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timeLock"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("512000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"includeGlobalXPub"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"explicitChangeAddress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mu5kevv6FiLygJfVvxQnB4hArXCUArMC7C"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"destinations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"destination"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mu5kevv6FiLygJfVvxQnB4hArXCUArMC7C"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"amount"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"substractFees"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"sweepAll"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feePreference"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"explicitFeeRate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"explicitFee"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("23000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockTarget"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"fallbackFeeRate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"discourageFeeSniping"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"reserveChangeAddress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"minConfirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"excludeOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7c02d7d6923ab5e9bbdadf7cf6873a5454ae5aa86d15308ed8d68840a79cf644-1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7c02d7d6923ab5e9bbdadf7cf6873a5454ae5aa86d15308ed8d68840a79cf644-2"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"includeOnlyOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7c02d7d6923ab5e9bbdadf7cf6873a5454ae5aa86d15308ed8d68840a79cf644-1"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"minValue"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rebaseKeyPaths"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4XfeFUTn2D4RQ7D5HpvnHywa3eZYhxZBriRTsfe8ZKFSDMcEMBqGrAighxxmq5VUqoRvo7DnNMS5VbJjRHwqDfCAMXLwAL5j"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountKeyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("\"ab5ed9ab/49'/0'/0'\"")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"disableFingerprintRandomization"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"alwaysIncludeNonWitnessUTXO"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"mergeOutputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("seed")]),t._v(": Optional, default to null, a seed to specific to get a deterministic PSBT (useful for tests)")]),t._v(" "),a("li",[a("code",[t._v("version")]),t._v(": Optional, the version of the transaction (default: 1, if "),a("code",[t._v("disableFingerprintRandomization")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("timeLock")]),t._v(": Optional, The timelock of the transaction, activate RBF if not null (default: 0, if "),a("code",[t._v("disableFingerprintRandomization")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("includeGlobalXPub")]),t._v(": Optional. Whether or not to include the global xpubs of the derivation scheme in the PSBT. (default: false)")]),t._v(" "),a("li",[a("code",[t._v("rbf")]),t._v(": Optional, determine if the transaction should have Replace By Fee (RBF) activated (default: "),a("code",[t._v("true")]),t._v(", if "),a("code",[t._v("disableFingerprintRandomization")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("reserveChangeAddress")]),t._v(": default to false, whether the creation of this PSBT will reserve a new change address.")]),t._v(" "),a("li",[a("code",[t._v("explicitChangeAddress")]),t._v(": default to null, use a specific change address (Optional, mutually exclusive with reserveChangeAddress)")]),t._v(" "),a("li",[a("code",[t._v("minConfirmations")]),t._v(": default to 0, the minimum confirmations a UTXO need to be selected. (by default unconfirmed and confirmed UTXO will be used)")]),t._v(" "),a("li",[a("code",[t._v("includeOnlyOutpoints")]),t._v(": Only select the following outpoints for creating the PSBT (default to null)")]),t._v(" "),a("li",[a("code",[t._v("excludeOutpoints")]),t._v(": Do not select the following outpoints for creating the PSBT (default to empty)")]),t._v(" "),a("li",[a("code",[t._v("minValue")]),t._v(": UTXO's with value below this amount will be ignored (default to null)")]),t._v(" "),a("li",[a("code",[t._v("destinations")]),t._v(": Required, the destinations where to send the money")]),t._v(" "),a("li",[a("code",[t._v("destinations[].destination")]),t._v(": Required, the destination address")]),t._v(" "),a("li",[a("code",[t._v("destinations[].amount")]),t._v(" Send this amount to the destination (Mutually exclusive with: sweepAll)")]),t._v(" "),a("li",[a("code",[t._v("destinations[].substractFees")]),t._v(" Default to false, will substract the fees of this transaction to this destination (Mutually exclusive with: sweepAll)")]),t._v(" "),a("li",[a("code",[t._v("destinations[].sweepAll")]),t._v(" Deault to false, will sweep all the balance of your wallet to this destination (Mutually exclusive with: amount, substractFees)")]),t._v(" "),a("li",[a("code",[t._v("feePreference")]),t._v(": Optional, determines how fees for the transaction are calculated, default to the full node estimation for 1 block target.")]),t._v(" "),a("li",[a("code",[t._v("feePreference.explicitFeeRate")]),t._v(": An explicit fee rate for the transaction in Satoshi per vBytes (Mutually exclusive with: blockTarget, explicitFee, fallbackFeeRate)")]),t._v(" "),a("li",[a("code",[t._v("feePreference.explicitFee")]),t._v(": An explicit fee for the transaction in Satoshi (Mutually exclusive with: blockTarget, explicitFeeRate, fallbackFeeRate)")]),t._v(" "),a("li",[a("code",[t._v("feePreference.blockTarget")]),t._v(": A number of blocks after which the user expect one confirmation (Mutually exclusive with: explicitFeeRate, explicitFee)")]),t._v(" "),a("li",[a("code",[t._v("feePreference.fallbackFeeRate")]),t._v(": If the NBXplorer's node does not have proper fee estimation, this specific rate will be use in Satoshi per vBytes, this make sure that "),a("code",[t._v("fee-estimation-unavailable")]),t._v(" is never sent. (Mutually exclusive with: explicitFeeRate, explicitFee)")]),t._v(" "),a("li",[a("code",[t._v("discourageFeeSniping")]),t._v(": If "),a("code",[t._v("timeLock")]),t._v(" is not set, set the timeLock to a random value to discourage fee sniping (default to "),a("code",[t._v("true")]),t._v(", if "),a("code",[t._v("disableFingerprintRandomization")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths")]),t._v(": Optional. rebase the hdkey paths (if no rebase, the key paths are relative to the xpub that NBXplorer knows about), a rebase can transform (PubKey0, 0/0, accountFingerprint) by (PubKey0, m/49'/0'/0/0, masterFingerprint)")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths[].accountKey")]),t._v(": The account key to rebase")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths[].accountKeyPath")]),t._v(": The path from the root to the account key prefixed by the master public key fingerprint.")]),t._v(" "),a("li",[a("code",[t._v("disableFingerprintRandomization")]),t._v(": Disable the randomization of default parameter's value to match the network's fingerprint distribution. (randomized default values are "),a("code",[t._v("version")]),t._v(", "),a("code",[t._v("timeLock")]),t._v(", "),a("code",[t._v("rbf")]),t._v(", "),a("code",[t._v("discourageFeeSniping")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("alwaysIncludeNonWitnessUTXO")]),t._v(": Try to set the full transaction in "),a("code",[t._v("non_witness_utxo")]),t._v(", even for segwit inputs (default to "),a("code",[t._v("false")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("mergeOutputs")]),t._v(": Optional, default to true, whether the outputs sending to the same scriptPubKey should be merged into a single output.")])]),t._v(" "),a("p",[t._v("Response:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"psbt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cHNidP8BAHcBAAAAASjvZHM29AbxO4IGGHbk3IE82yciSQFr2Ihge7P9P1HeAQAAAAD/////AmzQMAEAAAAAGXapFG1/TpHnIajdweam5Z3V9s6oGWBRiKyAw8kBAAAAABl2qRSVNmCfrnVeIwVkuTrCR6EvRFCP7IisAAAAAAABAP10AQEAAAACe9C2c9VL+gfYpic4c+Wk/Nn7bvhewA82owtcUDo/tPoAAAAAakcwRAIgUlLS0SDj7IXeY44x21eUg16Vh4qbJe+NDQ/ywUrB84kCIGLU5Vec2bjL1DZhUmDueLrf0uh/PycOK7FWg/Ptvwi0ASED7OpQGf+HzIRwWKZ1Hmd8h6vxkFOt5RlJ3u/flzNTesv/////818+qp4hLnw9DWOD+a601fLjFciZ/4iCNT1M9g+kMvkAAAAAakcwRAIgfk+bUUYfRs6AU1mt5unV4fZxCit34g8pE5fsawUM7H0CIBGpSil8+JCHdAHxKU2I7CvEBzAyz3ggd9RlH+QQSnlkASEC/wwlQ07b3xdSQaEf+wRJEnzEJT2GPNTY4Wb3Gg1hxFz/////AoDw+gIAAAAAGXapFHoZHSjaWNcmJk7sSHvRG29RaqIiiKxQlPoCAAAAABl2qRTSKm2x4ITWeuYLwCv3PUDtt+CL+YisAAAAACIGA1KRWHyJqdpbUzuezCSzj4+bj1+gNWGEibLG0BMj9/RmDDAn+hsBAAAAAgAAAAAiAgIuwas0MohgjmGIXoOgS95USEDawK//ZqrVEi5UIfP/FAwwJ/obAQAAAAMAAAAAAA=="')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"changeAddress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqVvTQKsdJ36Z8m5uFWQSA5nhrJ5NHQ2Hs"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"suggestions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"shouldEnforceLowR"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("psbt")]),t._v(": The partially signed bitcoin transaction in Base64.")]),t._v(" "),a("li",[a("code",[t._v("changeAddress")]),t._v(": The change address of the transaction, useful for tests (can be null)")]),t._v(" "),a("li",[a("code",[t._v("suggestions")]),t._v(": Suggestions to the signer of the PSBT (null value if "),a("code",[t._v("disableFingerprintRandomization")]),t._v(" is set to "),a("code",[t._v("false")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("suggestions.shouldEnforceLowR")]),t._v(": If "),a("code",[t._v("true")]),t._v(", the signer should enforce the creation of 71 bytes ECDSA signature to maximize privacy.")])]),t._v(" "),a("p",[t._v("Note, in the example above, if the "),a("a",{attrs:{href:"#metadata"}},[t._v("metadata")]),t._v(" "),a("code",[t._v("AccountKeyPath")]),t._v(" is set to "),a("code",[t._v("ab5ed9ab/49'/0'/0'")]),t._v(", then you don't have to pass "),a("code",[t._v("rebaseKeyPaths")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"update-partially-signed-bitcoin-transaction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-partially-signed-bitcoin-transaction"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"updatepsbt"}}),t._v("Update Partially Signed Bitcoin Transaction")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/psbt/update")])]),t._v(" "),a("p",[t._v("NBXplorer will take to complete as much information as it can about this PSBT.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"psbt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cHNidP8BAHcBAAAAASjvZHM29AbxO4IGGHbk3IE82yciSQFr2Ihge7P9P1HeAQAAAAD/////AmzQMAEAAAAAGXapFG1/TpHnIajdweam5Z3V9s6oGWBRiKyAw8kBAAAAABl2qRSVNmCfrnVeIwVkuTrCR6EvRFCP7IisAAAAAAABAP10AQEAAAACe9C2c9VL+gfYpic4c+Wk/Nn7bvhewA82owtcUDo/tPoAAAAAakcwRAIgUlLS0SDj7IXeY44x21eUg16Vh4qbJe+NDQ/ywUrB84kCIGLU5Vec2bjL1DZhUmDueLrf0uh/PycOK7FWg/Ptvwi0ASED7OpQGf+HzIRwWKZ1Hmd8h6vxkFOt5RlJ3u/flzNTesv/////818+qp4hLnw9DWOD+a601fLjFciZ/4iCNT1M9g+kMvkAAAAAakcwRAIgfk+bUUYfRs6AU1mt5unV4fZxCit34g8pE5fsawUM7H0CIBGpSil8+JCHdAHxKU2I7CvEBzAyz3ggd9RlH+QQSnlkASEC/wwlQ07b3xdSQaEf+wRJEnzEJT2GPNTY4Wb3Gg1hxFz/////AoDw+gIAAAAAGXapFHoZHSjaWNcmJk7sSHvRG29RaqIiiKxQlPoCAAAAABl2qRTSKm2x4ITWeuYLwCv3PUDtt+CL+YisAAAAACIGA1KRWHyJqdpbUzuezCSzj4+bj1+gNWGEibLG0BMj9/RmDDAn+hsBAAAAAgAAAAAiAgIuwas0MohgjmGIXoOgS95USEDawK//ZqrVEi5UIfP/FAwwJ/obAQAAAAMAAAAAAA=="')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationScheme"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4WcPozSqALNCrJEt4C45sPDhEBBuokoCeDgjX6YTs4QVvhD9kao6f2uZLqZF4qcXprYyRqooSXr1uPp1KPH1o4m6aw9nxbiA"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"includeGlobalXPub"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rebaseKeyPaths"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4XfeFUTn2D4RQ7D5HpvnHywa3eZYhxZBriRTsfe8ZKFSDMcEMBqGrAighxxmq5VUqoRvo7DnNMS5VbJjRHwqDfCAMXLwAL5j"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountKeyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("\"ab5ed9ab/49'/0'/0'\"")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("psbt")]),t._v(": Required. A potentially incomplete PSBT that you want to update (Input WitnessUTXO, NonWitnessUTXO)")]),t._v(" "),a("li",[a("code",[t._v("derivationScheme")]),t._v(": Optional. If specified, will complete HDKeyPaths, witness script and redeem script information in the PSBT belonging to this derivationScheme.")]),t._v(" "),a("li",[a("code",[t._v("includeGlobalXPub")]),t._v(": Optional. Whether or not to include the global xpubs of the derivation scheme in the PSBT. (default: false)")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths")]),t._v(": Optional. Rebase the hdkey paths (if no rebase, the key paths are relative to the xpub that NBXplorer knows about), a rebase can transform (PubKey0, 0/0, accountFingerprint) by (PubKey0, m/49'/0'/0/0, masterFingerprint)")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths[].accountKey")]),t._v(": The account key to rebase")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths[].accountKeyPath")]),t._v(": The path from the root to the account key prefixed by the master public key fingerprint.")]),t._v(" "),a("li",[a("code",[t._v("alwaysIncludeNonWitnessUTXO")]),t._v(": Try to set the full transaction in "),a("code",[t._v("non_witness_utxo")]),t._v(", even for segwit inputs (default to "),a("code",[t._v("false")]),t._v(")")])]),t._v(" "),a("p",[t._v("Response:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"psbt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cHNidP8BAHcBAAAAASjvZHM29AbxO4IGGHbk3IE82yciSQFr2Ihge7P9P1HeAQAAAAD/////AmzQMAEAAAAAGXapFG1/TpHnIajdweam5Z3V9s6oGWBRiKyAw8kBAAAAABl2qRSVNmCfrnVeIwVkuTrCR6EvRFCP7IisAAAAAAABAP10AQEAAAACe9C2c9VL+gfYpic4c+Wk/Nn7bvhewA82owtcUDo/tPoAAAAAakcwRAIgUlLS0SDj7IXeY44x21eUg16Vh4qbJe+NDQ/ywUrB84kCIGLU5Vec2bjL1DZhUmDueLrf0uh/PycOK7FWg/Ptvwi0ASED7OpQGf+HzIRwWKZ1Hmd8h6vxkFOt5RlJ3u/flzNTesv/////818+qp4hLnw9DWOD+a601fLjFciZ/4iCNT1M9g+kMvkAAAAAakcwRAIgfk+bUUYfRs6AU1mt5unV4fZxCit34g8pE5fsawUM7H0CIBGpSil8+JCHdAHxKU2I7CvEBzAyz3ggd9RlH+QQSnlkASEC/wwlQ07b3xdSQaEf+wRJEnzEJT2GPNTY4Wb3Gg1hxFz/////AoDw+gIAAAAAGXapFHoZHSjaWNcmJk7sSHvRG29RaqIiiKxQlPoCAAAAABl2qRTSKm2x4ITWeuYLwCv3PUDtt+CL+YisAAAAACIGA1KRWHyJqdpbUzuezCSzj4+bj1+gNWGEibLG0BMj9/RmDDAn+hsBAAAAAgAAAAAiAgIuwas0MohgjmGIXoOgS95USEDawK//ZqrVEi5UIfP/FAwwJ/obAQAAAAMAAAAAAA=="')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Note, in the example above, if the "),a("a",{attrs:{href:"#metadata"}},[t._v("metadata")]),t._v(" "),a("code",[t._v("AccountKeyPath")]),t._v(" is set to "),a("code",[t._v("ab5ed9ab/49'/0'/0'")]),t._v(", then you don't have to pass "),a("code",[t._v("rebaseKeyPaths")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"attach-metadata-to-a-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#attach-metadata-to-a-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"metadata"}}),t._v("Attach metadata to a derivation scheme")]),t._v(" "),a("p",[t._v("You can attach JSON metadata to a derivation scheme:")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/metadata/{key}")])]),t._v(" "),a("p",[t._v("The body can be any JSON token.")]),t._v(" "),a("p",[t._v("Body:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"example"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"value"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"detach-metadata-from-a-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#detach-metadata-from-a-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"detachmetadata"}}),t._v("Detach metadata from a derivation scheme")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/metadata/{key}")])]),t._v(" "),a("p",[t._v("Call without body and without content type.")]),t._v(" "),a("h2",{attrs:{id:"retrieve-metadata-from-a-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-metadata-from-a-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"getmetadata"}}),t._v("Retrieve metadata from a derivation scheme")]),t._v(" "),a("p",[t._v("You retrieve the JSON metadata of a derivation scheme:")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/metadata/{key}")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: The key is not found")])]),t._v(" "),a("p",[t._v("The body can be any piece of JSON.")]),t._v(" "),a("p",[t._v("Body:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"example"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"value"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"manual-pruning"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#manual-pruning"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"pruning"}}),t._v("Manual pruning")]),t._v(" "),a("p",[t._v("NBXplorer has an auto pruning feature configurable with "),a("code",[t._v("--autopruning x")]),t._v(" where "),a("code",[t._v("x")]),t._v(" is in second. If a call to NBXplorer's "),a("code",[t._v("Get utxo")]),t._v(" or "),a("code",[t._v("Get PSBT")]),t._v(" takes more time than "),a("code",[t._v("x seconds")]),t._v(", then the auto pruning will delete transactions whose all UTXOs have been already spent and which are old enough.")]),t._v(" "),a("p",[t._v("You can however force pruning by calling:")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/prune")])]),t._v(" "),a("p",[t._v("Request:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"daysToKeep"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1.0")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("daysToKeep")]),t._v(": Optional. The number of days of history to keep. (Default: 1.0)")])]),t._v(" "),a("p",[t._v("Response:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"totalPruned"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("totalPruned")]),t._v(" is the number of transactions pruned from the derivation scheme")])]),t._v(" "),a("h2",{attrs:{id:"generate-a-wallet"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#generate-a-wallet"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"wallet"}}),t._v("Generate a wallet")]),t._v(" "),a("p",[t._v("NBXplorer will generate and save a mnemonic and create a derivationScheme.")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations")])]),t._v(" "),a("p",[t._v("Request:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountNumber"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"wordList"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"French"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"existingMnemonic"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"musicien sinistre divertir réussir louve alliage péplum innocent filmer stipuler chignon utopie effusion heureux légal"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"wordCount"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("15")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKeyType"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"SegwitP2SH"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"passphrase"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"hello"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"importKeysToRPC"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"savePrivateKeys"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"additionalOptions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"slip77"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"6c2de18eabeff3f7822bc724ad482bef0557f3e1c1e1c75b7a393a5ced4de616"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("accountNumber")]),t._v(": Optional, the account number used for determining the keypath that NBXplorer will track, see "),a("code",[t._v("accountKeyPath")]),t._v(" in the response. (Default: "),a("code",[t._v("0")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("existingMnemonic")]),t._v(": Optional, an existing "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" mnemonic seed to import instead of generating.")]),t._v(" "),a("li",[a("code",[t._v("wordList")]),t._v(": Optional, the "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" wordlist to use when generating the mnemonic, available: English, French, Japanese, Spanish, ChineseSimplified (Defaut: "),a("code",[t._v("English")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("wordCount")]),t._v(": Optional, the "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" word count in the mnemonic (Default: "),a("code",[t._v("12")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("scriptPubKeyType")]),t._v(": Optional, the type of scriptPubKey (address) to generate, available: Legacy, Segwit, SegwitP2SH, Taproot (Default: "),a("code",[t._v("Segwit")]),t._v(" or "),a("code",[t._v("Legacy")]),t._v(" if "),a("code",[t._v("cryptoCode")]),t._v(" does not support segwit)")]),t._v(" "),a("li",[a("code",[t._v("passphrase")]),t._v(": Optional, the "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" passphrase. (Default: empty string)")]),t._v(" "),a("li",[a("code",[t._v("importKeysToRPC")]),t._v(": Optional, if true, every times a call to "),a("a",{attrs:{href:"#unused"}},[t._v("get a new unused address")]),t._v(" is called, the private key will be imported into the underlying node via RPC's "),a("code",[t._v("importprivkey")]),t._v(". (Default: "),a("code",[t._v("false")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("savePrivateKeys")]),t._v(": If true, private keys will be saved inside the following metadata "),a("code",[t._v("Mnemonic")]),t._v(", "),a("code",[t._v("MasterHDKey")]),t._v(" and "),a("code",[t._v("AccountHDKey")]),t._v(".")]),t._v(" "),a("li",[a("code",[t._v("additionalOptions")]),t._v(": Optional, additional options that a derivation scheme of some networks may support, such as "),a("a",{attrs:{href:"#liquid"}},[t._v("Liquid")])])]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("importKeysToRPC")]),t._v(" is only useful if one need to manage his wallet via the node's cli tooling.")]),t._v(" "),a("p",[t._v("Response:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"mnemonic"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"musicien sinistre divertir réussir louve alliage péplum innocent filmer stipuler chignon utopie effusion heureux légal"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"passphrase"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"hello"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"wordList"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"French"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"wordCount"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("15")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"masterHDKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tprv8ZgxMBicQKsPdv26BvirqqQCZJPSYEkSW7Por7a7r2PpsCUKHjjT18Gwk8k4FtkvqvakMFnsv9uaXHHoibieRd5BMhGCPYxVLaVY9vqpaxb"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountHDKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tprv8gPRns62uoh4zbRatcxUWZY7aX3XsTchHBp79YL6E3fEocsgd6XjThU4r7E3iUemBffeLSjcjXyD1VrmHMwNceVipFL7txTFMgKm4kehuSR"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountKeyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("\"a0aa59b4/49'/1'/2'\"")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountDescriptor"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("\"sh(wpkh([a0aa59b4/49'/1'/2']tpubDD5TwH8H4BNjt4TNnGd4uyCE9YZU2nobrVQtS4NPeKTde78TFVMKeC5w2G1nj7amQbGDptv4FtDBLuVQhofegQaZdFVuuxuCGpZQ4jZ6L5q))\"")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationScheme"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubDD5TwH8H4BNjt4TNnGd4uyCE9YZU2nobrVQtS4NPeKTde78TFVMKeC5w2G1nj7amQbGDptv4FtDBLuVQhofegQaZdFVuuxuCGpZQ4jZ6L5q-[p2sh]"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("mnemonic")]),t._v(": The generated "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" mnemonic.")]),t._v(" "),a("li",[a("code",[t._v("passphrase")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" passphrase.")]),t._v(" "),a("li",[a("code",[t._v("wordList")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" wordlist to use when generating the mnemonic.")]),t._v(" "),a("li",[a("code",[t._v("wordCount")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" word count in the mnemonic.")]),t._v(" "),a("li",[a("code",[t._v("masterHDKey")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP32"),a("OutboundLink")],1),t._v(" master key derived from the mnemonic and passphrase.")]),t._v(" "),a("li",[a("code",[t._v("accountHDKey")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP32"),a("OutboundLink")],1),t._v(" account key derived from the "),a("code",[t._v("masterHDKey")]),t._v(" and "),a("code",[t._v("accountKeyPath")]),t._v(".")]),t._v(" "),a("li",[a("code",[t._v("accountKeyPath")]),t._v(": The fingerprint of the master key as defined by The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP174"),a("OutboundLink")],1),t._v(", followed by the derivation path used to generate the "),a("code",[t._v("derivationScheme")]),t._v(". ("),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0043.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("Purpose field"),a("OutboundLink")],1),t._v(" based on "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP44"),a("OutboundLink")],1),t._v(", "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0049.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP49"),a("OutboundLink")],1),t._v(" or "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP84"),a("OutboundLink")],1),t._v(" and "),a("a",{attrs:{href:"https://github.com/satoshilabs/slips/blob/master/slip-0044.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("SLIP44"),a("OutboundLink")],1),t._v(" for the coin type)")]),t._v(" "),a("li",[a("code",[t._v("accountDescriptor")]),t._v(": The output descriptor of the created account public key.")]),t._v(" "),a("li",[a("code",[t._v("derivationScheme")]),t._v(": The "),a("a",{attrs:{href:"#derivationScheme"}},[t._v("derivation scheme")]),t._v(" that is being tracked by NBXplorer.")])]),t._v(" "),a("p",[a("a",{attrs:{href:"#metadata"}},[t._v("Metadata")]),t._v(" for this derivation scheme after this call:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("Mnemonic")]),t._v(": The mnemonic generated. (if "),a("code",[t._v("savePrivateKeys")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("MasterHDKey")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("xpriv"),a("OutboundLink")],1),t._v(" master key generated by the mnemonic and passphrase. (if "),a("code",[t._v("savePrivateKeys")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("AccountHDKey")]),t._v(": The derived "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("xpriv"),a("OutboundLink")],1),t._v(" account key from the "),a("code",[t._v("MasterHDKey")]),t._v(" and "),a("code",[t._v("AccountKeyPath")]),t._v(". (if "),a("code",[t._v("savePrivateKeys")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("AccountKeyPath")]),t._v(": The fingerprint of the master key as defined by The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP174"),a("OutboundLink")],1),t._v(", followed by the derivation path used to generate the "),a("code",[t._v("derivationScheme")]),t._v(". ("),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0043.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("Purpose field"),a("OutboundLink")],1),t._v(" based on "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP44"),a("OutboundLink")],1),t._v(", "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0049.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP49"),a("OutboundLink")],1),t._v(" or "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP84"),a("OutboundLink")],1),t._v(" and "),a("a",{attrs:{href:"https://github.com/satoshilabs/slips/blob/master/slip-0044.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("SLIP44"),a("OutboundLink")],1),t._v(" for the coin type)")]),t._v(" "),a("li",[a("code",[t._v("ImportAddressToRPC")]),t._v(": "),a("code",[t._v("Legacy")]),t._v(" (or "),a("code",[t._v("True")]),t._v(", for old wallet) if the generated addresses are added to legacy style Bitcoin core wallet. "),a("code",[t._v("Descriptors")]),t._v(" or "),a("code",[t._v("DescriptorsReadOnly")]),t._v(" if the generated addresses and private keys are added to a descriptor enabled Bitcoin Core wallet.")]),t._v(" "),a("li",[a("code",[t._v("AccountDescriptor")]),t._v(": The output descriptor format of the derivation scheme.")]),t._v(" "),a("li",[a("code",[t._v("Birthdate")]),t._v(": The birthdate of the wallet in ISO-8601 format.")])]),t._v(" "),a("p",[t._v("Note that the metadata "),a("code",[t._v("AccountKeyPath")]),t._v(" is leveraged by "),a("a",{attrs:{href:"#psbt"}},[t._v("Create a PSBT")]),t._v(" and "),a("a",{attrs:{href:"#updatepsbt"}},[t._v("Update a PSBT")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"node-rpc-proxy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#node-rpc-proxy"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"rpc-proxy"}}),t._v("Node RPC Proxy")]),t._v(" "),a("p",[t._v("NBXplorer allows you to query the node's JSON-RPC through it when "),a("code",[t._v("exposerpc")]),t._v(" option is enabled")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/rpc")]),t._v("\nwith Header "),a("code",[t._v("Content-Type")]),t._v(" set to value "),a("code",[t._v("application/json")]),t._v(" or "),a("code",[t._v("application/json-rpc")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 415: You did not send the correct "),a("code",[t._v("Content-Type")]),t._v(" header.")]),t._v(" "),a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])]),t._v(" "),a("li",[t._v("HTTP 401: "),a("code",[t._v("json-rpc-not-exposed")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("rpc-unavailable")])]),t._v(" "),a("li",[t._v("HTTP 422: "),a("code",[t._v("no-json-rpc-request")])])]),t._v(" "),a("p",[t._v("Request:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"jsonrpc"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1.0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"method"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"getblockchaininfo"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"params"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Response:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"error"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"result"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"chain"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"regtest"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n ...\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"resultString"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"..."')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("NOTE: Batch commands are also supported by sending the JSON-RPC requests in an array. The result is also returned in an array.")]),t._v(" "),a("h2",{attrs:{id:"health-check"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#health-check"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"health"}}),t._v("Health check")]),t._v(" "),a("p",[t._v("A endpoint that can be used without the need for "),a("a",{attrs:{href:"#auth"}},[t._v("authentication")]),t._v(" which will returns HTTP 200 only if all nodes connected to NBXplorer are ready.")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET /health")])]),t._v(" "),a("p",[t._v("It will output the state for each nodes in JSON, whose format might change in the future.")]),t._v(" "),a("h2",{attrs:{id:"liquid-integration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#liquid-integration"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"liquid"}}),t._v("Liquid integration")]),t._v(" "),a("p",[t._v("NBXplorer supports liquid, the API is the same as all the other coins, except for the following:")]),t._v(" "),a("ul",[a("li",[t._v("All references to "),a("code",[t._v("value")]),t._v(" which normally contains an integer of the amount of the altcoin will instead output a JSON Object of type "),a("code",[t._v("AssetMoney")]),t._v(".")]),t._v(" "),a("li",[t._v("If NBXplorer is unable to unblind a value, then the value will be "),a("code",[t._v("null")]),t._v(".")]),t._v(" "),a("li",[a("a",{attrs:{href:"#transactions"}},[t._v("When listing the transaction of a derivation scheme")]),t._v(", the "),a("code",[t._v("balanceChange")]),t._v(" elements is instead a "),a("code",[t._v("JSON array of AssetMoney")]),t._v(".")]),t._v(" "),a("li",[a("a",{attrs:{href:"#balance"}},[t._v("Get Balance")]),t._v(" returns values as "),a("code",[t._v("JSON array of AssetMoney")]),t._v(".")]),t._v(" "),a("li",[a("a",{attrs:{href:"#unused"}},[t._v("Get a new unused address")]),t._v(" returns a confidential address. (See note below)")]),t._v(" "),a("li",[a("a",{attrs:{href:"#psbt"}},[t._v("Create Partially Signed Bitcoin Transaction")]),t._v(" is not supported.")]),t._v(" "),a("li",[a("a",{attrs:{href:"#updatepsbt"}},[t._v("Update Partially Signed Bitcoin Transaction")]),t._v(" is not supported")]),t._v(" "),a("li",[a("a",{attrs:{href:"#scanUtxoSet"}},[t._v("Scan UTXO Set")]),t._v(" is not supported.")]),t._v(" "),a("li",[t._v("Any sort of recovery is not supported.")])]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("AssetMoney")]),t._v(" JSON format is:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"assetId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"abc"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h3",{attrs:{id:"liquid-confidential-addresses"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#liquid-confidential-addresses"}},[t._v("#")]),t._v(" Liquid Confidential Addresses")]),t._v(" "),a("p",[t._v("Liquid confidential addresses are supported in two ways:")]),t._v(" "),a("ul",[a("li",[t._v("By default, the blinding key of the confidential address is derived directly from the "),a("code",[t._v("derivationScheme")]),t._v(". If the "),a("code",[t._v("scriptPubKey")]),t._v(" "),a("code",[t._v("0/2")]),t._v(" is generated, the blinding private key used by NBXplorer is the SHA256 of the scriptPubKey at "),a("code",[t._v("0/2/0")]),t._v(".")]),t._v(" "),a("li",[a("a",{attrs:{href:"https://github.com/satoshilabs/slips/blob/master/slip-0077.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("SLIP77"),a("OutboundLink")],1),t._v(", by suffixing the derivation scheme with either:\n"),a("ul",[a("li",[t._v("the mnemonic seed derivation (usually the same as your wallet's)"),a("code",[t._v("-[slip77=all all all all all all all all all all all all]")])]),t._v(" "),a("li",[t._v("the master blinding key in hex or wif format"),a("code",[t._v("-[slip77=6c2de18eabeff3f7822bc724ad482bef0557f3e1c1e1c75b7a393a5ced4de616]")]),t._v("\nYou may also choose to not use confidential addresses by applying the suffix "),a("code",[t._v("-[unblinded]")]),t._v(" to the derivation scheme")])])])]),t._v(" "),a("h3",{attrs:{id:"liquid-transactions-support"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#liquid-transactions-support"}},[t._v("#")]),t._v(" Liquid Transactions support")]),t._v(" "),a("p",[t._v("Due to the changes in the transaction format in Elements networks to support assets, we do not support transaction building features.")]),t._v(" "),a("p",[t._v("In order to send in and out of liquid, we advise you to rely on the RPC command line interface of the liquid deamon.\nFor doing this you need to "),a("a",{attrs:{href:"#wallet"}},[t._v("Generate a wallet")]),t._v(" with "),a("code",[t._v("importAddressToRPC")]),t._v(" and "),a("code",[t._v("savePrivateKeys")]),t._v(" set to "),a("code",[t._v("true")]),t._v(".")]),t._v(" "),a("p",[t._v("Be careful to not expose your NBXplorer server on internet, your private keys can be "),a("a",{attrs:{href:"#getmetadata"}},[t._v("retrieved trivially")]),t._v(".")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/129.403fffc9.js b/assets/js/129.403fffc9.js new file mode 100644 index 0000000000..af6cddcc45 --- /dev/null +++ b/assets/js/129.403fffc9.js @@ -0,0 +1 @@ +(window.webpackJsonp=window.webpackJsonp||[]).push([[129],{765:function(t,a,s){"use strict";s.r(a);var e=s(9),n=Object(e.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"api-specification"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#api-specification"}},[t._v("#")]),t._v(" API Specification")]),t._v(" "),a("p",[t._v("NBXplorer is a multi crypto currency lightweight block explorer.")]),t._v(" "),a("p",[t._v("NBXplorer does not index the whole blockchain, rather, it listens transactions and blocks from a trusted full node and index only addresses and transactions which belongs to a "),a("code",[t._v("DerivationScheme")]),t._v(" that you decide to track.")]),t._v(" "),a("h2",{attrs:{id:"table-of-content"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#table-of-content"}},[t._v("#")]),t._v(" Table of content")]),t._v(" "),a("ul",[a("li",[a("a",{attrs:{href:"#configuration"}},[t._v("Configuration")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#authentication"}},[t._v("Authentication")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#derivationScheme"}},[t._v("Derivation Scheme Format")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#track"}},[t._v("Tracking a Derivation Scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#address"}},[t._v("Track a specific address")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#transactions"}},[t._v("Query transactions associated to a Derivation Scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#address-transactions"}},[t._v("Query transactions associated to a specific address")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#singletransaction"}},[t._v("Query a single transaction associated to a address or derivation scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#balance"}},[t._v("Get current balance")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#gettransaction"}},[t._v("Get a transaction")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#status"}},[t._v("Get connection status to the chain")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#unused"}},[t._v("Get a new unused address")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#scriptPubKey"}},[t._v("Get scriptPubKey information of a Derivation Scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#utxos"}},[t._v("Get available Unspent Transaction Outputs (UTXOs)")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#address-utxos"}},[t._v("Get available Unspent Transaction Outputs of a specific address")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#websocket"}},[t._v("Notifications via websocket")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#broadcast"}},[t._v("Broadcast a transaction")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#rescan"}},[t._v("Rescan a transaction")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#feerate"}},[t._v("Get fee rate")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#scanUtxoSet"}},[t._v("Scan UTXO Set")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#wipe"}},[t._v("Wipe derivation scheme transactions")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#eventStream"}},[t._v("Query event stream")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#eventStreamLatest"}},[t._v("Query event stream from most recent")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#psbt"}},[t._v("Create Partially Signed Bitcoin Transaction")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#updatepsbt"}},[t._v("Update Partially Signed Bitcoin Transaction")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#metadata"}},[t._v("Attach metadata to a derivation scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#detachmetadata"}},[t._v("Detach metadata from a derivation scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#getmetadata"}},[t._v("Retrieve metadata from a derivation scheme")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#pruning"}},[t._v("Manual pruning")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#wallet"}},[t._v("Generate a wallet")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#rpc-proxy"}},[t._v("Node RPC Proxy")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#health"}},[t._v("Health check")])]),t._v(" "),a("li",[a("a",{attrs:{href:"#liquid"}},[t._v("Liquid integration")])])]),t._v(" "),a("h2",{attrs:{id:"configuration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#configuration"}},[t._v("#")]),t._v(" Configuration")]),t._v(" "),a("p",[t._v("You can check the available settings with "),a("code",[t._v("--help")]),t._v(".")]),t._v(" "),a("p",[t._v("NBXplorer can be configured in three way:")]),t._v(" "),a("ul",[a("li",[t._v("Through command line arguments (eg. "),a("code",[t._v("--chains btc")]),t._v(")")]),t._v(" "),a("li",[t._v("Through environment variables (eg. "),a("code",[t._v("NBXPLORER_CHAINS=btc")]),t._v(")")]),t._v(" "),a("li",[t._v("Through configuration file (eg. "),a("code",[t._v("chains=btc")]),t._v(")")])]),t._v(" "),a("p",[t._v("If you use configuration file, you can find it on windows in:")]),t._v(" "),a("div",{staticClass:"language-pwsh extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("C:\\Users\\\\AppData\\Roaming\\NBXplorer\\\\settings.config\n")])])]),a("p",[t._v("On linux or mac:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[t._v("~/.nbxplorer/"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("network"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v("/settings.config\n")])])]),a("p",[t._v("Be careful, if you run NBXplorer with "),a("code",[t._v("dotnet run")]),t._v(", you should do it this way, with settings after the "),a("code",[t._v("--")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[t._v("dotnet run --no-launch-profile --no-build -c Release -p ."),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("NBXplorer"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("\\")]),t._v("NBXplorer.csproj -- --chains btc\n")])])]),a("p",[t._v("Else, launch profiles, which are settings meant to be used only for debugging time, might be taken into account.")]),t._v(" "),a("h2",{attrs:{id:"authentication"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#authentication"}},[t._v("#")]),t._v(" Authentication")]),t._v(" "),a("p",[t._v("By default a cookie file is generated when NBXplorer is starting, for windows in:")]),t._v(" "),a("div",{staticClass:"language-pwsh extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[t._v("C:\\Users\\\\AppData\\Roaming\\NBXplorer\\\\.cookie\n")])])]),a("p",[t._v("On linux or mac:")]),t._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[t._v("~/.nbxplorer/"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v("<")]),t._v("network"),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">")]),t._v("/.cookie\n")])])]),a("p",[t._v("The content of this cookie must be used is used as HTTP BASIC authentication to use the API.")]),t._v(" "),a("p",[t._v("This can be disabled with "),a("code",[t._v("--noauth")]),t._v(".")]),t._v(" "),a("p",[t._v("Also, NBXPlorer listen by default on "),a("code",[t._v("127.0.0.1")]),t._v(", if you want to access it from another machine, run "),a("code",[t._v('--bind "0.0.0.0"')]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"derivation-scheme-format"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#derivation-scheme-format"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"derivationScheme"}}),t._v("Derivation Scheme Format")]),t._v(" "),a("p",[t._v("A derivation scheme, also called derivationStrategy in the code, is a flexible way to define how to generate address of a wallet.\nNBXplorer will track any addresses on the "),a("code",[t._v("0/x")]),t._v(", "),a("code",[t._v("1/x")]),t._v(" and "),a("code",[t._v("x")]),t._v(" path.")]),t._v(" "),a("p",[t._v("Here a documentation of the different derivation scheme supported:")]),t._v(" "),a("table",[a("thead",[a("tr",[a("th",[t._v("Address type")]),t._v(" "),a("th",[t._v("Format")])])]),t._v(" "),a("tbody",[a("tr",[a("td",[t._v("P2WPKH")]),t._v(" "),a("td",[t._v("xpub1")])]),t._v(" "),a("tr",[a("td",[t._v("P2SH-P2WPKH")]),t._v(" "),a("td",[t._v("xpub1-[p2sh]")])]),t._v(" "),a("tr",[a("td",[t._v("P2PKH")]),t._v(" "),a("td",[t._v("xpub-[legacy]")])]),t._v(" "),a("tr",[a("td",[t._v("Multi-sig P2WSH")]),t._v(" "),a("td",[t._v("2-of-xpub1-xpub2")])]),t._v(" "),a("tr",[a("td",[t._v("Multi-sig P2SH-P2WSH")]),t._v(" "),a("td",[t._v("2-of-xpub1-xpub2-[p2sh]")])]),t._v(" "),a("tr",[a("td",[t._v("Multi-sig P2SH")]),t._v(" "),a("td",[t._v("2-of-xpub1-xpub2-[legacy]")])]),t._v(" "),a("tr",[a("td",[t._v("P2TR")]),t._v(" "),a("td",[t._v("xpub1-[taproot]")])])])]),t._v(" "),a("p",[t._v("For multisig, the public keys are ordered before generating the address by default for privacy reason, use "),a("code",[t._v("-[keeporder]")]),t._v(" to disable it.")]),t._v(" "),a("p",[t._v("You can use more than one options at same time, example: "),a("code",[t._v("2-of-xpub1-xpub2-[legacy]-[keeporder]")])]),t._v(" "),a("p",[t._v("Most of routes asks for a "),a("code",[t._v("cryptoCode")]),t._v(". This identify the crypto currency to request data from. (eg. "),a("code",[t._v("BTC")]),t._v(", "),a("code",[t._v("LTC")]),t._v("...)")]),t._v(" "),a("p",[t._v("Note: Taproot is incompatible with all other options.")]),t._v(" "),a("h2",{attrs:{id:"track-a-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#track-a-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"track"}}),t._v("Track a derivation scheme")]),t._v(" "),a("p",[t._v("After this call, the specified "),a("code",[t._v("derivation scheme")]),t._v(" will be tracked by NBXplorer")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations/{derivationScheme}")])]),t._v(" "),a("p",[t._v("Returns nothing.")]),t._v(" "),a("p",[t._v("Optionally, you can attach a json body:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationOptions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Deposit"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"minAddresses"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("30")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"maxAddresses"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"wait"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("wait")]),t._v(": Optional. If "),a("code",[t._v("true")]),t._v(" the call will return when all addresses has been generated, addresses will be generated in the background (default: "),a("code",[t._v("false")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("derivationOptions")]),t._v(": Optional. Options to manually start the address generation process. (default: empty)")]),t._v(" "),a("li",[a("code",[t._v("derivationOptions.feature")]),t._v(": Optional. Define to which feature this option should be used. (defaut: null, which match all feature)")]),t._v(" "),a("li",[a("code",[t._v("derivationOptions.minAddresses")]),t._v(": Optional. The minimum addresses that need to be generated with this call. (default: null, make sure the number of address in the pool is between MinGap and MaxGap)")]),t._v(" "),a("li",[a("code",[t._v("derivationOptions.maxAddresses")]),t._v(": Optional. The maximum addresses that need to be generated with this call. (default: null, make sure the number of address in the pool is between MinGap and MaxGap)")])]),t._v(" "),a("h2",{attrs:{id:"track-a-specific-address"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#track-a-specific-address"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"address"}}),t._v("Track a specific address")]),t._v(" "),a("p",[t._v("After this call, the specified address will be tracked by NBXplorer")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/addresses/{address}")])]),t._v(" "),a("p",[t._v("Returns nothing.")]),t._v(" "),a("h2",{attrs:{id:"query-transactions-associated-to-a-derivationscheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query-transactions-associated-to-a-derivationscheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"transactions"}}),t._v("Query transactions associated to a derivationScheme")]),t._v(" "),a("p",[t._v("To query all transactions of a "),a("code",[t._v("derivation scheme")]),t._v(":")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/transactions")])]),t._v(" "),a("p",[t._v("To query a specific transaction:")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/transactions/{txId}")])]),t._v(" "),a("p",[t._v("Optional Parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("includeTransaction")]),t._v(" includes the hex of the transaction, not only information (default: true)")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"3e7bcca309f92ab78a47c1cdd1166de9190fa49e97165c93e2b10ae1a14b99eb"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cc33dfaf2ed794b11af83dc6e29303e2d8ff9e5e29303153dad1a1d3d8b43e40"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"020000000166d6befa387fd646f77a10e4b0f0e66b3569f18a83f77104a0c440e4156f80890000000048473044022064b1398653171440d3e79924cb6593633e7b2c3d80b60a2e21d6c6e287ee785a02203899009df443d0a0a1b06cb970aee0158d35166fd3e26d4e3e85570738e706d101feffffff028c02102401000000160014ee0a1889783da2e1f9bba47be4184b6610efd00400e1f5050000000016001452f88af314ef3b6d03d40a5fd1f2c906188a477567000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"001452f88af314ef3b6d03d40a5fd1f2c906188a4775"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381888")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replaceable"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacing"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedBy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unconfirmedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014b39fc4eb5c6dd238d39449b70a2e30d575426d99"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381889")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replaceable"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacing"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"e070e213a0815b84b4ae96d4d64ce551158524364d3522e7d6bd5415c6c15d3f"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedBy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014b39fc4eb5c6dd238d39449b70a2e30d575426d99"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381889")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replaceable"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacing"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedBy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"immatureTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("replaceable")]),t._v(": "),a("code",[t._v("true")]),t._v(" if the transaction can be replaced (the transaction has RBF activated, is in the unconfirmed list and is not an intermediate transaction in a chain of unconfirmed transaction)")]),t._v(" "),a("li",[a("code",[t._v("replacing")]),t._v(": Only set in the unconfirmed list, and is pointing to a transaction id in the replaced list.")]),t._v(" "),a("li",[a("code",[t._v("replacedBy")]),t._v(": Only set in the replaced list, and is pointing to a transaction id in the unconfirmed list.")]),t._v(" "),a("li",[a("code",[t._v("immatureTransactions")]),t._v(": Coinbase transactions with less than 100 confirmations.")])]),t._v(" "),a("p",[t._v("Note for liquid, "),a("code",[t._v("balanceChange")]),t._v(" is an array of "),a("a",{attrs:{href:"#liquid"}},[t._v("AssetMoney")]),t._v(".\nNote that the list of confirmed transaction also include immature transactions.")]),t._v(" "),a("h2",{attrs:{id:"query-transactions-associated-to-a-specific-address"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query-transactions-associated-to-a-specific-address"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"address-transactions"}}),t._v("Query transactions associated to a specific address")]),t._v(" "),a("p",[t._v("Query all transactions of a tracked address. (Only work if you called the Track operation on this specific address)")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/addresses/{address}/transactions")])]),t._v(" "),a("p",[t._v("Optional Parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("includeTransaction")]),t._v(" includes the hex of the transaction, not only information (default: true)")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"3e7bcca309f92ab78a47c1cdd1166de9190fa49e97165c93e2b10ae1a14b99eb"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cc33dfaf2ed794b11af83dc6e29303e2d8ff9e5e29303153dad1a1d3d8b43e40"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"020000000166d6befa387fd646f77a10e4b0f0e66b3569f18a83f77104a0c440e4156f80890000000048473044022064b1398653171440d3e79924cb6593633e7b2c3d80b60a2e21d6c6e287ee785a02203899009df443d0a0a1b06cb970aee0158d35166fd3e26d4e3e85570738e706d101feffffff028c02102401000000160014ee0a1889783da2e1f9bba47be4184b6610efd00400e1f5050000000016001452f88af314ef3b6d03d40a5fd1f2c906188a477567000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"001452f88af314ef3b6d03d40a5fd1f2c906188a4775"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381888")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unconfirmedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014b39fc4eb5c6dd238d39449b70a2e30d575426d99"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381889")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedTransactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"query-a-single-transaction-associated-to-a-address-or-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query-a-single-transaction-associated-to-a-address-or-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"singletransaction"}}),t._v("Query a single transaction associated to a address or derivation scheme")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/transactions/{txId}")]),t._v(" "),a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/addresses/{address}/transactions/{txId}")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: Transaction not found")])]),t._v(" "),a("p",[t._v("Optional Parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("includeTransaction")]),t._v(" includes the hex of the transaction, not only information (default: true)")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014b39fc4eb5c6dd238d39449b70a2e30d575426d99"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"inputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540381889")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"balanceChange"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"get-current-balance"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-current-balance"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"balance"}}),t._v("Get current balance")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/balance")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unconfirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("110000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"available"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("210000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"immature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"total"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("210000000")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Note for liquid, the values are array of "),a("a",{attrs:{href:"#liquid"}},[t._v("AssetMoney")]),t._v(".")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("unconfirmed")]),t._v(": How the confirmed balance would be updated once all the unconfirmed transactions were confirmed.")]),t._v(" "),a("li",[a("code",[t._v("confirmed")]),t._v(": The balance of all funds in confirmed transactions.")]),t._v(" "),a("li",[a("code",[t._v("total")]),t._v(": The total of funds owned (ie, "),a("code",[t._v("confirmed + unconfirmed")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("immature")]),t._v(": The total unspendable funds (ie, coinbase reward which need 100 confirmations before being spendable)")]),t._v(" "),a("li",[a("code",[t._v("available")]),t._v(": The total spendable balance. (ie, "),a("code",[t._v("total - immature")]),t._v(")")])]),t._v(" "),a("p",[t._v("Immature funds is the sum of UTXO's belonging to a coinbase transaction with less than 100 confirmations.")]),t._v(" "),a("h2",{attrs:{id:"get-a-transaction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-a-transaction"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"gettransaction"}}),t._v("Get a transaction")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/transactions/{txId}")])]),t._v(" "),a("p",[t._v("Optional Parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("includeTransaction")]),t._v(" includes the hex of the transaction, not only information (default: true)")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: Transaction not found")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("3")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"5efa23803df818cd21faa0c11e84db28c8352e76acb93d0c0adfe123db827190"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ed86c55b519c26ab4ba8130c976294753934c1f9f6d30203e65bb222648a8cdf"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0200000001205dcde69a5bd2b3281d387e6f125338f9ccb904d94df383ff56d9923599681e000000004847304402200b9d78e01691339acb238d7cd7a40ae620796bdcf8cb167dff4e100b71a2b0950220518e3a955ea7229d57c0160ecf491e8048662d7112fe5feaa312ff71388fda9701feffffff028c02102401000000160014a4ccb74ada7dd01b3018c3308894fea27b4813be00e1f5050000000016001408f86300ddff26ddf779ddce833f7e9e7442156c67000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540390804")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacedBy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7ec0bcbd3b7685b6bbdb4287a250b64bfcb799dbbbcffa78c00e6cc11185e5f1"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[a("code",[t._v("height")]),t._v(" and "),a("code",[t._v("blockId")]),t._v(" will be null if the transaction is not confirmed.")]),t._v(" "),a("h2",{attrs:{id:"get-connection-status-to-the-chain"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-connection-status-to-the-chain"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"status"}}),t._v("Get connection status to the chain")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/status")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"bitcoinStatus"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blocks"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("103")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"headers"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("103")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"verificationProgress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1.0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"isSynched"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"incrementalRelayFee"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"minRelayTxFee"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"capabilities"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"canScanTxoutSet"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"canSupportSegwit"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"canSupportTaproot"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"canSupportTransactionCheck"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"repositoryPingTime"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0.0087891999999999987")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"isFullySynched"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"chainHeight"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("103")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"syncHeight"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("103")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"networkType"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Regtest"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"instanceName"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"MyInstance"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"supportedCryptoCodes"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"version"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1.0.3.5"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[a("code",[t._v("instanceName")]),t._v(" can be configured via configuration's key "),a("code",[t._v("instancename")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"get-a-new-unused-address"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-a-new-unused-address"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"unused"}}),t._v("Get a new unused address")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/addresses/unused")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("strategy-not-found")])])]),t._v(" "),a("p",[t._v("Optional parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("feature")]),t._v(": Use "),a("code",[t._v("Deposit")]),t._v(" to get a deposit address ("),a("code",[t._v("0/x")]),t._v("), "),a("code",[t._v("Change")]),t._v(" to get a change address ("),a("code",[t._v("1/x")]),t._v("), "),a("code",[t._v("Direct")]),t._v(" to get "),a("code",[t._v("x")]),t._v(" or "),a("code",[t._v("Custom")]),t._v(" if "),a("code",[t._v("customKeyPathTemplate")]),t._v(" is configured (default: "),a("code",[t._v("Deposit")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("skip")]),t._v(": How many addresses to skip, needed if the user want multiple unused addresses (default:0)")]),t._v(" "),a("li",[a("code",[t._v("reserve")]),t._v(": Mark the returned address as used (default: false)")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"DERIVATIONSCHEME:tpubD6NzVbkrYhZ4Wo2RMq8Xbnrorf1xnABkKMS3EGshPkQ3Z4N4GN8uyLuDPvnK7Ekc2FHdXbLvcuZny1gPiohMksFGKmaX3APD2DbTeBWj751-[p2sh]"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Deposit"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationStrategy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4Wo2RMq8Xbnrorf1xnABkKMS3EGshPkQ3Z4N4GN8uyLuDPvnK7Ekc2FHdXbLvcuZny1gPiohMksFGKmaX3APD2DbTeBWj751-[p2sh]"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/2"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"a91412cbf6154ef6d9aecf9c978dc2bdc43f1881dd5f87"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2MtxcVDMiRrJ3V4zfsAwZGbZfPiDUxSXDY2"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"redeem"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014e2eb89edba1fe6c6c0863699eeb78f6ec3271b45"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Note: "),a("code",[t._v("redeem")]),t._v(" is returning the segwit redeem if the derivation scheme is a P2SH-P2WSH or P2WSH, or the p2sh redeem if just a p2sh.")]),t._v(" "),a("h2",{attrs:{id:"get-scriptpubkey-information-of-a-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-scriptpubkey-information-of-a-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"scriptPubKey"}}),t._v("Get scriptPubKey information of a Derivation Scheme")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/scripts/{script}")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"DERIVATIONSCHEME:tpubD6NzVbkrYhZ4WcPozSqALNCrJEt4C45sPDhEBBuokoCeDgjX6YTs4QVvhD9kao6f2uZLqZF4qcXprYyRqooSXr1uPp1KPH1o4m6aw9nxbiA"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Deposit"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationStrategy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4WcPozSqALNCrJEt4C45sPDhEBBuokoCeDgjX6YTs4QVvhD9kao6f2uZLqZF4qcXprYyRqooSXr1uPp1KPH1o4m6aw9nxbiA"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"001460c25d29559774803f262acf5ee5c922eff52ccd"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tb1qvrp96224ja6gq0ex9t84aewfythl2txdkpdmu0"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"get-available-unspent-transaction-outputs-utxos"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-available-unspent-transaction-outputs-utxos"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"utxos"}}),t._v("Get available Unspent Transaction Outputs (UTXOs)")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/utxos")])]),t._v(" "),a("p",[t._v("Error:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])])]),t._v(" "),a("p",[t._v("Result:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"DERIVATIONSCHEME:tpubD6NzVbkrYhZ4XQVi1sSEDBWTcicDqVSCTnYDxpwGwcSZVbPii2b7baRg57YfL64ed36sBRe6GviihHwhy3D1cnBe5uXb27DjrDZCKUA7PQi"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationStrategy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4XQVi1sSEDBWTcicDqVSCTnYDxpwGwcSZVbPii2b7baRg57YfL64ed36sBRe6GviihHwhy3D1cnBe5uXb27DjrDZCKUA7PQi"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"currentHeight"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("107")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unconfirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"utxOs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Deposit"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outpoint"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"10ba4bcadd03130b1bd98b0bc7aea9910f871b25b87ec06e484456e84440c88a01000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"8ac84044e85644486ec07eb8251b870f91a9aec70b8bd91b0b1303ddca4bba10"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"00149681ae465a045e2068460b9d281cf97dede87cd8"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bcrt1qj6q6u3j6q30zq6zxpwwjs88e0hk7slxcunru7u"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540376171")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"spentOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"utxOs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feature"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Deposit"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outpoint"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"29ca6590f3f03a6523ad79975392e74e385bf2b7dafe6c537ffa12f9e124348800000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"883424e1f912fa7f536cfedab7f25b384ee792539779ad23653af0f39065ca29"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"001436a37f2f508650f7074bec4d091fc82bb01cc57f"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bcrt1qx63h7t6sseg0wp6ta3xsj87g9wcpe3tlgqgnql"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/3"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540376174")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"spentOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"9345f9585d643a31202e686ec7a4c2fe17917a5e7731a79d2327d24d25c0339f01000000"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("This call does not returns conflicted unconfirmed UTXOs.\nNote that confirmed utxo, do not include immature UTXOs. (ie. UTXOs belonging to a coinbase transaction with less than 100 confirmations)")]),t._v(" "),a("h2",{attrs:{id:"get-available-unspent-transaction-outputs-of-a-specific-address"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-available-unspent-transaction-outputs-of-a-specific-address"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"address-utxos"}}),t._v("Get available Unspent Transaction Outputs of a specific address")]),t._v(" "),a("p",[t._v("Assuming you use Track on this specific address:")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/addresses/{address}/utxos")])]),t._v(" "),a("p",[t._v("Error:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])])]),t._v(" "),a("p",[t._v("Result:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"ADDRESS:moD8QpWufPMFP9y7gC8m5ih9rmejavbf3K"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"currentHeight"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("105")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"unconfirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"utxOs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"spentOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"utxOs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outpoint"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f532022bebe8d90c72853a2663c26ca9d42fad5d9cde21d35bad38135a5dfd0701000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"07fd5d5a1338ad5bd321de9c5dad2fd4a96cc263263a85720cd9e8eb2b0232f5"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"76a9145461f6c342451142e07d95dd2a42b48af9114cea88ac"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540390664")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outpoint"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"a470a71144d4cdaef2b9bd8d24f20ebc8d6548bae523869f8cceb2cef5b4538a01000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"8a53b4f5ceb2ce8c9f8623e5ba48658dbc0ef2248dbdb9f2aecdd44411a770a4"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"76a9145461f6c342451142e07d95dd2a42b48af9114cea88ac"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540390666")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outpoint"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1710a1b61cb1f988182347be52a16502bae5a78fa9740a68107f9ddc6e30896a00000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"6a89306edc9d7f10680a74a98fa7e5ba0265a152be47231888f9b11cb6a11017"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"76a9145461f6c342451142e07d95dd2a42b48af9114cea88ac"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("60000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540390666")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"spentOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hasChanges"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("This call does not returns conflicted unconfirmed UTXOs.")]),t._v(" "),a("h2",{attrs:{id:"notifications-via-websocket"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#notifications-via-websocket"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"websocket"}}),t._v("Notifications via websocket")]),t._v(" "),a("p",[t._v("NBXplorer implements real-time notification via websocket supports for new block or transaction.")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/connect")])]),t._v(" "),a("p",[t._v("Once you are connected to the websocket, you can subscribe to block notifications by sending the following JSON to it.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"subscribeblock"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Then a notification will be delivered through the websocket when a new block is mined:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"newblock"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"eventId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"10b0e5178aaf42c4a938f0d37430413b7d76feae14b01fc07e1f23300b8821ce"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"previousBlockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"4c6a9c1cadf143c87249519639e86e236feac9d3cea2904e4c42bc5bc32a48a7"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("For notification concerning "),a("code",[t._v("Derivation Scheme")]),t._v(" transactions, you can subscribe by sending through the websocket:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"subscribetransaction"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationSchemes"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4YL91Ez5fdgaBPQbFhedFdn5gQL4tSCJn1usmHsV1L6VokzLbgcqzh9hiBnfnQANp5BYW15QdFGRKspZVSW1v2QY917RDs1V-[legacy]"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Then you will receive such notifications when a transaction is impacting the "),a("code",[t._v("derivation scheme")]),t._v(":")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"newtransaction"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"eventId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"DERIVATIONSCHEME:tpubD6NzVbkrYhZ4X2p2D8kx6XV9V5iCJKMBHuBim1BLnZAZC1JobYkdwSrwF8R74V2oUWkJG3H24LwxnXs9wb6Ksivs2gj4RudMteyVai2AsmA-[p2sh]"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationStrategy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4X2p2D8kx6XV9V5iCJKMBHuBim1BLnZAZC1JobYkdwSrwF8R74V2oUWkJG3H24LwxnXs9wb6Ksivs2gj4RudMteyVai2AsmA-[p2sh]"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionData"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f135537b40ac7a524273176b60e464b7f279f622031ec53af302d959966d7364"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0200000001dd7f53b09438fed83abe25dd6cdc30ee2092ce8c855cb9e7b0faa38aba8bc0f500000000484730440220093a837ff4be4b64b2ed4625abb128966caad0cb7830cac7af4f615bbf6b52ce02206227a3ddec3fac9e49f414eeab1388d0e67829620ac3a8fb2f4bbfc5b67bd02901feffffff0200e1f5050000000017a91476de0c5d07fd202880672bc702162b7f18e13aca87640210240100000017a9147cfa038496438a6d3c95cfac990f4dffc6cb44f28768000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540434424")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"a91476de0c5d07fd202880672bc702162b7f18e13aca87"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"2N45jj76a7YjGLDoKs2mnQ4tt5N7t6R9xoM"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"redeem"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"00147d31e1c7959cd047bb7b9b35e4c877a28efe2f0b"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"replacing"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"25d6bc1b2812670550aca8b2984670203b5ebf00e75f9b2bbf1940c3fa27841e"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"81a20eb55ec16b92c65d4e142278fd521caa9e5dcad9d941c8e256dbd917ae84"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("If you want all transactions of all derivation schemes of BTC, send this to the WebSocket:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"subscribetransaction"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("If you want all transactions of all derivation schemes of all crypto currencies, send this to the WebSocket:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"subscribetransaction"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"*"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("As an alternative to get notification, you can also use long polling with the "),a("a",{attrs:{href:"#eventStream"}},[t._v("event stream")]),t._v(".")]),t._v(" "),a("p",[t._v("Fields:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("replacing")]),t._v(": The list of the unconfirmed transactions of this wallet which have been replaced by this new transaction. This can typically be used to detect when the sender is bumping fee. This can't be used to detect when the sender is attempting to abort a transaction.")])]),t._v(" "),a("h2",{attrs:{id:"broadcast-a-transaction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#broadcast-a-transaction"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"broadcast"}}),t._v("Broadcast a transaction")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/transactions")])]),t._v(" "),a("p",[t._v("Body:")]),t._v(" "),a("p",[t._v("Raw bytes of the transaction.")]),t._v(" "),a("p",[t._v("Parameter:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("testMempoolAccept")]),t._v(": If "),a("code",[t._v("true")]),t._v(", will not attempt to broadcast the transaction but just test its acceptance in the mempool. (default: "),a("code",[t._v("false")]),t._v(")")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("rpc-unavailable")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("not-supported")]),t._v(" if "),a("code",[t._v("testMempoolAccept")]),t._v(" is "),a("code",[t._v("true")]),t._v(", but the underlying node does not support it")])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"success"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rpcCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("-25")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rpcCodeMessage"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"General error during transaction submission"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rpcMessage"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Missing inputs"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"rescan-a-transaction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#rescan-a-transaction"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"rescan"}}),t._v("Rescan a transaction")]),t._v(" "),a("p",[t._v("NBXplorer does not rescan the whole blockchain when tracking a new derivation scheme.\nThis means that if the derivation scheme already received UTXOs in the past, NBXplorer will not be aware of it and might reuse addresses already generated in the past, and will not show past transactions.")]),t._v(" "),a("p",[t._v("By using this route, you can ask NBXplorer to rescan specific transactions found in the blockchain.\nThis way, the transactions and the UTXOs present before tracking the derivation scheme will appear correctly.")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/rescan")])]),t._v(" "),a("p",[t._v("Body:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Specify the blockId and transactionId to scan. Your node must not be pruned for this to work.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"19b44484c79c40d4e74da406e25390348b86a252c1ab784cfd7198c724a0169f"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"f83c7f31e2c39202bbbca619ab354ca8841721cf3440a253e056a7bea43e9745"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// Only the transactionId is specified. Your node must run --txindex=1 for this to work")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"754c14060b958de0ff4e77e2ccdca617964c939d40ec9a01ef21fca2aad78d00"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token comment"}},[t._v("// This will index the transaction without using RPC. Careful: A wrong blockId will corrupt the database.")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"19b44484c79c40d4e74da406e25390348b86a252c1ab784cfd7198c724a0169f"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"02000000000101008dd7aaa2fc21ef019aec409d934c9617a6dccce2774effe08d950b06144c750000000000feffffff026c3e2e12010000001600143072110b34b66acd9469b2882d6d57a8ae27183900e1f505000000001600140429b3eebb7d55c50ca36ace12ae874ff2fd16af0247304402202e32739cc6e42877699d4159159941f3cc39027c7626f9962cca9a865816d43502205389e9d6c1a4cab41f2c504413cf0f46a5c1f8814f368e03c9bf1f8017c6787e012103b8858085f2a0c9c906fb793bedb2c115c340de1f7b279d6099f675ddf3eec0bf67000000"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Returns:")]),t._v(" "),a("p",[t._v("HTTP 200")]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 400: "),a("code",[t._v("rpc-unavailable")])])]),t._v(" "),a("h2",{attrs:{id:"get-fee-rate"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-fee-rate"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"feerate"}}),t._v("Get fee rate")]),t._v(" "),a("p",[t._v("HTTP GET v1/cryptos/{cryptoCode}/fees/{blockCount}")]),t._v(" "),a("p",[t._v("Get expected fee rate for being confirmed in "),a("code",[t._v("blockCount")]),t._v(" blocks.")]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 400: "),a("code",[t._v("fee-estimation-unavailable")])]),t._v(" "),a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("rpc-unavailable")])])]),t._v(" "),a("p",[t._v("Returns:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feeRate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("5")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockCount"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("The fee rate is in satoshi/byte.")]),t._v(" "),a("h2",{attrs:{id:"scan-utxo-set"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#scan-utxo-set"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"scanUtxoSet"}}),t._v("Scan UTXO Set")]),t._v(" "),a("p",[t._v("NBXplorer can scan the UTXO Set for output belonging to your derivationScheme.")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/BTC/derivations/{derivationScheme}/utxos/scan")])]),t._v(" "),a("p",[t._v("In order to not consume too much RAM, NBXplorer splits the addresses to scan in several "),a("code",[t._v("batch")]),t._v(" and scan the whole UTXO set sequentially.\nThree branches are scanned: 0/x, 1/x and x.")]),t._v(" "),a("p",[t._v("If a UTXO in one branch get found at a specific x, then all addresses inferior to index x will be considered used and not proposed when fetching a new unused address.")]),t._v(" "),a("p",[t._v("Query parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("batchSize")]),t._v(" the number of addresses scanned at once per derivation scheme branch (default: 1000)")]),t._v(" "),a("li",[a("code",[t._v("gapLimit")]),t._v(" If no UTXO are detected in this interval, the scan stop (default: 10000)")]),t._v(" "),a("li",[a("code",[t._v("from")]),t._v(" the first address index to check (default: 0)")])]),t._v(" "),a("p",[t._v("This call queue the request for scanning and returns immediately.")]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 405: "),a("code",[t._v("scanutxoset-not-suported")]),t._v(" ScanUTXOSet is not supported for this currency")]),t._v(" "),a("li",[t._v("HTTP 409: "),a("code",[t._v("scanutxoset-in-progress")]),t._v(" ScanUTXOSet has already been called for this derivationScheme")]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("rpc-unavailable")])])]),t._v(" "),a("h2",{attrs:{id:"get-scan-status"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#get-scan-status"}},[t._v("#")]),t._v(" Get scan status")]),t._v(" "),a("p",[t._v("You can poll the status of the scan. Note that if the scan is complete, the result will be kept for 24H.\nThe state can be:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("Queued")]),t._v(" the demand has been done, but the scan request is queuing to be started")]),t._v(" "),a("li",[a("code",[t._v("Pending")]),t._v(" the scan is in progress")]),t._v(" "),a("li",[a("code",[t._v("Complete")]),t._v(" the scan is successful")]),t._v(" "),a("li",[a("code",[t._v("Error")]),t._v(" the scan errored")])]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"error"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"queuedAt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540439841")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"status"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"Pending"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"progress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"startedAt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1540439841")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"completedAt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"found"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"batchNumber"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("9")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"remainingBatches"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"currentBatchProgress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"remainingSeconds"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"overallProgress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("91")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"from"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("900")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"count"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"totalSearched"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2700")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"totalSizeOfUTXOSet"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"highestKeyIndexFound"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"change"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"deposit"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("51")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"direct"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[a("code",[t._v("TotalSizeOfUTXOSet")]),t._v(" is set only when the scan is complete.")]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404 "),a("code",[t._v("scanutxoset-info-not-found")]),t._v(" if the scan has been done above the last 24H.")])]),t._v(" "),a("h2",{attrs:{id:"wipe-derivation-scheme-transactions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#wipe-derivation-scheme-transactions"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"wipe"}}),t._v("Wipe derivation scheme transactions")]),t._v(" "),a("p",[t._v("Wipe all the transactions from a derivation scheme.")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST cryptos/{cryptoCode}/derivations/{derivationScheme}/utxos/wipe")])]),t._v(" "),a("h2",{attrs:{id:"query-event-stream"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query-event-stream"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"eventStream"}}),t._v("Query event stream")]),t._v(" "),a("p",[t._v("All notifications sent through websocket are also saved in a crypto specifc event stream.")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/events")])]),t._v(" "),a("p",[t._v("Query parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("lastEventId")]),t._v(": Will query all events which happened after this event id, the first event has id 1 (default: 0)")]),t._v(" "),a("li",[a("code",[t._v("longPolling")]),t._v(": If no events have been received since "),a("code",[t._v("lastEventId")]),t._v(", the call will block (default: false)")]),t._v(" "),a("li",[a("code",[t._v("limit")]),t._v(": Limit the maximum number of events to return (default: null)")])]),t._v(" "),a("p",[t._v("All events are registered in a query stream which you can replay by keeping track of the "),a("code",[t._v("lastEventId")]),t._v(".\nThe smallest "),a("code",[t._v("eventId")]),t._v(" is 1.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"eventId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"newblock"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("104")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"hash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1f31c605c0a5d54b65fa39dc8cb4db025be63c66280279ade9338571a9e63d35"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"previousBlockHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7639350b31f3ce07ff976ebae772fef1602b30a10ccb8ca69047fe0fe8b9083c"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"eventId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"type"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"newtransaction"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"data"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"trackedSource"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"DERIVATIONSCHEME:tpubD6NzVbkrYhZ4XfeFUTn2D4RQ7D5HpvnHywa3eZYhxZBriRTsfe8ZKFSDMcEMBqGrAighxxmq5VUqoRvo7DnNMS5VbJjRHwqDfCAMXLwAL5j"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationStrategy"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4XfeFUTn2D4RQ7D5HpvnHywa3eZYhxZBriRTsfe8ZKFSDMcEMBqGrAighxxmq5VUqoRvo7DnNMS5VbJjRHwqDfCAMXLwAL5j"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionData"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"confirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transactionHash"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"500359d971698c021587ea952bd38bd57dafc2b99615f71f7f978af394682737"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"transaction"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0200000001b8af58c5dbed4bd0ea60ae8ba7e68e66143440b8c1c69b6eaaf719566676ab1b0000000048473044022040b419aeb9042a53fb2d03abec911901ed42fc50d6a143e322bc61d51e4e35a9022073c10fe827b53332d50fbde581e36ad31f57b98ec35a125562dc8c739762ec8901feffffff028c02102401000000160014b6bedaf0cb795c01a1e427bd7752d6ef058964f100e1f50500000000160014c5e0b07f40b8dbe69b22864d84d83d5b4120835368000000"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"height"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timestamp"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1542703963")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"outputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"keyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0/0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"0014c5e0b07f40b8dbe69b22864d84d83d5b41208353"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"address"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"bcrt1qchstql6qhrd7dxezsexcfkpatdqjpq6nntvtrd"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"index"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100000000")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"cryptoCode"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"BTC"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n")])])]),a("h2",{attrs:{id:"query-event-stream-from-most-recent"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#query-event-stream-from-most-recent"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"eventStreamLatest"}}),t._v("Query event stream (from most recent)")]),t._v(" "),a("p",[t._v("Exact same as "),a("a",{attrs:{href:"#eventStream"}},[t._v("event stream")]),t._v(" but it returns a maximum number "),a("code",[t._v("#limit")]),t._v(" of the most recent events.")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/events/latest")])]),t._v(" "),a("p",[t._v("Query parameters:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("limit")]),t._v(": Limit the maximum number of events to return (default: 10)")])]),t._v(" "),a("h2",{attrs:{id:"create-partially-signed-bitcoin-transaction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#create-partially-signed-bitcoin-transaction"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"psbt"}}),t._v("Create Partially Signed Bitcoin Transaction")]),t._v(" "),a("p",[t._v("Create a "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("Partially Signed Bitcoin Transaction"),a("OutboundLink")],1),t._v(" (PSBT).")]),t._v(" "),a("p",[t._v("A PSBT is a standard format to represent a transaction with pending signatures associated to it.\nA PSBT can be signed independently by many signers, and combined together before broadcast.")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/psbt/create")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 400: "),a("code",[t._v("not-enough-funds")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("output-too-small")]),t._v(" (if the output on which the "),a("code",[t._v("substractFee=true")]),t._v(" is too small to cover the fees)")]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("fee-estimation-unavailable")])]),t._v(" "),a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])])]),t._v(" "),a("p",[t._v("Fields:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"seed"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rbf"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"version"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"timeLock"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("512000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"includeGlobalXPub"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"explicitChangeAddress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mu5kevv6FiLygJfVvxQnB4hArXCUArMC7C"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"destinations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"destination"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mu5kevv6FiLygJfVvxQnB4hArXCUArMC7C"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"amount"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("50000000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"substractFees"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"sweepAll"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"feePreference"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"explicitFeeRate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"explicitFee"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("23000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"blockTarget"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"fallbackFeeRate"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("100")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"discourageFeeSniping"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"reserveChangeAddress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"minConfirmations"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("0")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"excludeOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7c02d7d6923ab5e9bbdadf7cf6873a5454ae5aa86d15308ed8d68840a79cf644-1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7c02d7d6923ab5e9bbdadf7cf6873a5454ae5aa86d15308ed8d68840a79cf644-2"')]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"includeOnlyOutpoints"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"7c02d7d6923ab5e9bbdadf7cf6873a5454ae5aa86d15308ed8d68840a79cf644-1"')]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"minValue"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1000")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rebaseKeyPaths"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4XfeFUTn2D4RQ7D5HpvnHywa3eZYhxZBriRTsfe8ZKFSDMcEMBqGrAighxxmq5VUqoRvo7DnNMS5VbJjRHwqDfCAMXLwAL5j"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountKeyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("\"ab5ed9ab/49'/0'/0'\"")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"disableFingerprintRandomization"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"alwaysIncludeNonWitnessUTXO"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"mergeOutputs"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("seed")]),t._v(": Optional, default to null, a seed to specific to get a deterministic PSBT (useful for tests)")]),t._v(" "),a("li",[a("code",[t._v("version")]),t._v(": Optional, the version of the transaction (default: 1, if "),a("code",[t._v("disableFingerprintRandomization")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("timeLock")]),t._v(": Optional, The timelock of the transaction, activate RBF if not null (default: 0, if "),a("code",[t._v("disableFingerprintRandomization")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("includeGlobalXPub")]),t._v(": Optional. Whether or not to include the global xpubs of the derivation scheme in the PSBT. (default: false)")]),t._v(" "),a("li",[a("code",[t._v("rbf")]),t._v(": Optional, determine if the transaction should have Replace By Fee (RBF) activated (default: "),a("code",[t._v("true")]),t._v(", if "),a("code",[t._v("disableFingerprintRandomization")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("reserveChangeAddress")]),t._v(": default to false, whether the creation of this PSBT will reserve a new change address.")]),t._v(" "),a("li",[a("code",[t._v("explicitChangeAddress")]),t._v(": default to null, use a specific change address (Optional, mutually exclusive with reserveChangeAddress)")]),t._v(" "),a("li",[a("code",[t._v("minConfirmations")]),t._v(": default to 0, the minimum confirmations a UTXO need to be selected. (by default unconfirmed and confirmed UTXO will be used)")]),t._v(" "),a("li",[a("code",[t._v("includeOnlyOutpoints")]),t._v(": Only select the following outpoints for creating the PSBT (default to null)")]),t._v(" "),a("li",[a("code",[t._v("excludeOutpoints")]),t._v(": Do not select the following outpoints for creating the PSBT (default to empty)")]),t._v(" "),a("li",[a("code",[t._v("minValue")]),t._v(": UTXO's with value below this amount will be ignored (default to null)")]),t._v(" "),a("li",[a("code",[t._v("destinations")]),t._v(": Required, the destinations where to send the money")]),t._v(" "),a("li",[a("code",[t._v("destinations[].destination")]),t._v(": Required, the destination address")]),t._v(" "),a("li",[a("code",[t._v("destinations[].amount")]),t._v(" Send this amount to the destination (Mutually exclusive with: sweepAll)")]),t._v(" "),a("li",[a("code",[t._v("destinations[].substractFees")]),t._v(" Default to false, will substract the fees of this transaction to this destination (Mutually exclusive with: sweepAll)")]),t._v(" "),a("li",[a("code",[t._v("destinations[].sweepAll")]),t._v(" Deault to false, will sweep all the balance of your wallet to this destination (Mutually exclusive with: amount, substractFees)")]),t._v(" "),a("li",[a("code",[t._v("feePreference")]),t._v(": Optional, determines how fees for the transaction are calculated, default to the full node estimation for 1 block target.")]),t._v(" "),a("li",[a("code",[t._v("feePreference.explicitFeeRate")]),t._v(": An explicit fee rate for the transaction in Satoshi per vBytes (Mutually exclusive with: blockTarget, explicitFee, fallbackFeeRate)")]),t._v(" "),a("li",[a("code",[t._v("feePreference.explicitFee")]),t._v(": An explicit fee for the transaction in Satoshi (Mutually exclusive with: blockTarget, explicitFeeRate, fallbackFeeRate)")]),t._v(" "),a("li",[a("code",[t._v("feePreference.blockTarget")]),t._v(": A number of blocks after which the user expect one confirmation (Mutually exclusive with: explicitFeeRate, explicitFee)")]),t._v(" "),a("li",[a("code",[t._v("feePreference.fallbackFeeRate")]),t._v(": If the NBXplorer's node does not have proper fee estimation, this specific rate will be use in Satoshi per vBytes, this make sure that "),a("code",[t._v("fee-estimation-unavailable")]),t._v(" is never sent. (Mutually exclusive with: explicitFeeRate, explicitFee)")]),t._v(" "),a("li",[a("code",[t._v("discourageFeeSniping")]),t._v(": If "),a("code",[t._v("timeLock")]),t._v(" is not set, set the timeLock to a random value to discourage fee sniping (default to "),a("code",[t._v("true")]),t._v(", if "),a("code",[t._v("disableFingerprintRandomization")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths")]),t._v(": Optional. rebase the hdkey paths (if no rebase, the key paths are relative to the xpub that NBXplorer knows about), a rebase can transform (PubKey0, 0/0, accountFingerprint) by (PubKey0, m/49'/0'/0/0, masterFingerprint)")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths[].accountKey")]),t._v(": The account key to rebase")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths[].accountKeyPath")]),t._v(": The path from the root to the account key prefixed by the master public key fingerprint.")]),t._v(" "),a("li",[a("code",[t._v("disableFingerprintRandomization")]),t._v(": Disable the randomization of default parameter's value to match the network's fingerprint distribution. (randomized default values are "),a("code",[t._v("version")]),t._v(", "),a("code",[t._v("timeLock")]),t._v(", "),a("code",[t._v("rbf")]),t._v(", "),a("code",[t._v("discourageFeeSniping")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("alwaysIncludeNonWitnessUTXO")]),t._v(": Try to set the full transaction in "),a("code",[t._v("non_witness_utxo")]),t._v(", even for segwit inputs (default to "),a("code",[t._v("false")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("mergeOutputs")]),t._v(": Optional, default to true, whether the outputs sending to the same scriptPubKey should be merged into a single output.")])]),t._v(" "),a("p",[t._v("Response:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"psbt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cHNidP8BAHcBAAAAASjvZHM29AbxO4IGGHbk3IE82yciSQFr2Ihge7P9P1HeAQAAAAD/////AmzQMAEAAAAAGXapFG1/TpHnIajdweam5Z3V9s6oGWBRiKyAw8kBAAAAABl2qRSVNmCfrnVeIwVkuTrCR6EvRFCP7IisAAAAAAABAP10AQEAAAACe9C2c9VL+gfYpic4c+Wk/Nn7bvhewA82owtcUDo/tPoAAAAAakcwRAIgUlLS0SDj7IXeY44x21eUg16Vh4qbJe+NDQ/ywUrB84kCIGLU5Vec2bjL1DZhUmDueLrf0uh/PycOK7FWg/Ptvwi0ASED7OpQGf+HzIRwWKZ1Hmd8h6vxkFOt5RlJ3u/flzNTesv/////818+qp4hLnw9DWOD+a601fLjFciZ/4iCNT1M9g+kMvkAAAAAakcwRAIgfk+bUUYfRs6AU1mt5unV4fZxCit34g8pE5fsawUM7H0CIBGpSil8+JCHdAHxKU2I7CvEBzAyz3ggd9RlH+QQSnlkASEC/wwlQ07b3xdSQaEf+wRJEnzEJT2GPNTY4Wb3Gg1hxFz/////AoDw+gIAAAAAGXapFHoZHSjaWNcmJk7sSHvRG29RaqIiiKxQlPoCAAAAABl2qRTSKm2x4ITWeuYLwCv3PUDtt+CL+YisAAAAACIGA1KRWHyJqdpbUzuezCSzj4+bj1+gNWGEibLG0BMj9/RmDDAn+hsBAAAAAgAAAAAiAgIuwas0MohgjmGIXoOgS95USEDawK//ZqrVEi5UIfP/FAwwJ/obAQAAAAMAAAAAAA=="')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"changeAddress"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mqVvTQKsdJ36Z8m5uFWQSA5nhrJ5NHQ2Hs"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"suggestions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"shouldEnforceLowR"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("psbt")]),t._v(": The partially signed bitcoin transaction in Base64.")]),t._v(" "),a("li",[a("code",[t._v("changeAddress")]),t._v(": The change address of the transaction, useful for tests (can be null)")]),t._v(" "),a("li",[a("code",[t._v("suggestions")]),t._v(": Suggestions to the signer of the PSBT (null value if "),a("code",[t._v("disableFingerprintRandomization")]),t._v(" is set to "),a("code",[t._v("false")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("suggestions.shouldEnforceLowR")]),t._v(": If "),a("code",[t._v("true")]),t._v(", the signer should enforce the creation of 71 bytes ECDSA signature to maximize privacy.")])]),t._v(" "),a("p",[t._v("Note, in the example above, if the "),a("a",{attrs:{href:"#metadata"}},[t._v("metadata")]),t._v(" "),a("code",[t._v("AccountKeyPath")]),t._v(" is set to "),a("code",[t._v("ab5ed9ab/49'/0'/0'")]),t._v(", then you don't have to pass "),a("code",[t._v("rebaseKeyPaths")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"update-partially-signed-bitcoin-transaction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#update-partially-signed-bitcoin-transaction"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"updatepsbt"}}),t._v("Update Partially Signed Bitcoin Transaction")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/psbt/update")])]),t._v(" "),a("p",[t._v("NBXplorer will take to complete as much information as it can about this PSBT.")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"psbt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cHNidP8BAHcBAAAAASjvZHM29AbxO4IGGHbk3IE82yciSQFr2Ihge7P9P1HeAQAAAAD/////AmzQMAEAAAAAGXapFG1/TpHnIajdweam5Z3V9s6oGWBRiKyAw8kBAAAAABl2qRSVNmCfrnVeIwVkuTrCR6EvRFCP7IisAAAAAAABAP10AQEAAAACe9C2c9VL+gfYpic4c+Wk/Nn7bvhewA82owtcUDo/tPoAAAAAakcwRAIgUlLS0SDj7IXeY44x21eUg16Vh4qbJe+NDQ/ywUrB84kCIGLU5Vec2bjL1DZhUmDueLrf0uh/PycOK7FWg/Ptvwi0ASED7OpQGf+HzIRwWKZ1Hmd8h6vxkFOt5RlJ3u/flzNTesv/////818+qp4hLnw9DWOD+a601fLjFciZ/4iCNT1M9g+kMvkAAAAAakcwRAIgfk+bUUYfRs6AU1mt5unV4fZxCit34g8pE5fsawUM7H0CIBGpSil8+JCHdAHxKU2I7CvEBzAyz3ggd9RlH+QQSnlkASEC/wwlQ07b3xdSQaEf+wRJEnzEJT2GPNTY4Wb3Gg1hxFz/////AoDw+gIAAAAAGXapFHoZHSjaWNcmJk7sSHvRG29RaqIiiKxQlPoCAAAAABl2qRTSKm2x4ITWeuYLwCv3PUDtt+CL+YisAAAAACIGA1KRWHyJqdpbUzuezCSzj4+bj1+gNWGEibLG0BMj9/RmDDAn+hsBAAAAAgAAAAAiAgIuwas0MohgjmGIXoOgS95USEDawK//ZqrVEi5UIfP/FAwwJ/obAQAAAAMAAAAAAA=="')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationScheme"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4WcPozSqALNCrJEt4C45sPDhEBBuokoCeDgjX6YTs4QVvhD9kao6f2uZLqZF4qcXprYyRqooSXr1uPp1KPH1o4m6aw9nxbiA"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"includeGlobalXPub"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("false")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"rebaseKeyPaths"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubD6NzVbkrYhZ4XfeFUTn2D4RQ7D5HpvnHywa3eZYhxZBriRTsfe8ZKFSDMcEMBqGrAighxxmq5VUqoRvo7DnNMS5VbJjRHwqDfCAMXLwAL5j"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountKeyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("\"ab5ed9ab/49'/0'/0'\"")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("psbt")]),t._v(": Required. A potentially incomplete PSBT that you want to update (Input WitnessUTXO, NonWitnessUTXO)")]),t._v(" "),a("li",[a("code",[t._v("derivationScheme")]),t._v(": Optional. If specified, will complete HDKeyPaths, witness script and redeem script information in the PSBT belonging to this derivationScheme.")]),t._v(" "),a("li",[a("code",[t._v("includeGlobalXPub")]),t._v(": Optional. Whether or not to include the global xpubs of the derivation scheme in the PSBT. (default: false)")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths")]),t._v(": Optional. Rebase the hdkey paths (if no rebase, the key paths are relative to the xpub that NBXplorer knows about), a rebase can transform (PubKey0, 0/0, accountFingerprint) by (PubKey0, m/49'/0'/0/0, masterFingerprint)")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths[].accountKey")]),t._v(": The account key to rebase")]),t._v(" "),a("li",[a("code",[t._v("rebaseKeyPaths[].accountKeyPath")]),t._v(": The path from the root to the account key prefixed by the master public key fingerprint.")]),t._v(" "),a("li",[a("code",[t._v("alwaysIncludeNonWitnessUTXO")]),t._v(": Try to set the full transaction in "),a("code",[t._v("non_witness_utxo")]),t._v(", even for segwit inputs (default to "),a("code",[t._v("false")]),t._v(")")])]),t._v(" "),a("p",[t._v("Response:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"psbt"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"cHNidP8BAHcBAAAAASjvZHM29AbxO4IGGHbk3IE82yciSQFr2Ihge7P9P1HeAQAAAAD/////AmzQMAEAAAAAGXapFG1/TpHnIajdweam5Z3V9s6oGWBRiKyAw8kBAAAAABl2qRSVNmCfrnVeIwVkuTrCR6EvRFCP7IisAAAAAAABAP10AQEAAAACe9C2c9VL+gfYpic4c+Wk/Nn7bvhewA82owtcUDo/tPoAAAAAakcwRAIgUlLS0SDj7IXeY44x21eUg16Vh4qbJe+NDQ/ywUrB84kCIGLU5Vec2bjL1DZhUmDueLrf0uh/PycOK7FWg/Ptvwi0ASED7OpQGf+HzIRwWKZ1Hmd8h6vxkFOt5RlJ3u/flzNTesv/////818+qp4hLnw9DWOD+a601fLjFciZ/4iCNT1M9g+kMvkAAAAAakcwRAIgfk+bUUYfRs6AU1mt5unV4fZxCit34g8pE5fsawUM7H0CIBGpSil8+JCHdAHxKU2I7CvEBzAyz3ggd9RlH+QQSnlkASEC/wwlQ07b3xdSQaEf+wRJEnzEJT2GPNTY4Wb3Gg1hxFz/////AoDw+gIAAAAAGXapFHoZHSjaWNcmJk7sSHvRG29RaqIiiKxQlPoCAAAAABl2qRTSKm2x4ITWeuYLwCv3PUDtt+CL+YisAAAAACIGA1KRWHyJqdpbUzuezCSzj4+bj1+gNWGEibLG0BMj9/RmDDAn+hsBAAAAAgAAAAAiAgIuwas0MohgjmGIXoOgS95USEDawK//ZqrVEi5UIfP/FAwwJ/obAQAAAAMAAAAAAA=="')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Note, in the example above, if the "),a("a",{attrs:{href:"#metadata"}},[t._v("metadata")]),t._v(" "),a("code",[t._v("AccountKeyPath")]),t._v(" is set to "),a("code",[t._v("ab5ed9ab/49'/0'/0'")]),t._v(", then you don't have to pass "),a("code",[t._v("rebaseKeyPaths")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"attach-metadata-to-a-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#attach-metadata-to-a-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"metadata"}}),t._v("Attach metadata to a derivation scheme")]),t._v(" "),a("p",[t._v("You can attach JSON metadata to a derivation scheme:")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/metadata/{key}")])]),t._v(" "),a("p",[t._v("The body can be any JSON token.")]),t._v(" "),a("p",[t._v("Body:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"example"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"value"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"detach-metadata-from-a-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#detach-metadata-from-a-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"detachmetadata"}}),t._v("Detach metadata from a derivation scheme")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/metadata/{key}")])]),t._v(" "),a("p",[t._v("Call without body and without content type.")]),t._v(" "),a("h2",{attrs:{id:"retrieve-metadata-from-a-derivation-scheme"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#retrieve-metadata-from-a-derivation-scheme"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"getmetadata"}}),t._v("Retrieve metadata from a derivation scheme")]),t._v(" "),a("p",[t._v("You retrieve the JSON metadata of a derivation scheme:")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/metadata/{key}")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 404: The key is not found")])]),t._v(" "),a("p",[t._v("The body can be any piece of JSON.")]),t._v(" "),a("p",[t._v("Body:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"example"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"value"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h2",{attrs:{id:"manual-pruning"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#manual-pruning"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"pruning"}}),t._v("Manual pruning")]),t._v(" "),a("p",[t._v("NBXplorer has an auto pruning feature configurable with "),a("code",[t._v("--autopruning x")]),t._v(" where "),a("code",[t._v("x")]),t._v(" is in second. If a call to NBXplorer's "),a("code",[t._v("Get utxo")]),t._v(" or "),a("code",[t._v("Get PSBT")]),t._v(" takes more time than "),a("code",[t._v("x seconds")]),t._v(", then the auto pruning will delete transactions whose all UTXOs have been already spent and which are old enough.")]),t._v(" "),a("p",[t._v("You can however force pruning by calling:")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations/{derivationScheme}/prune")])]),t._v(" "),a("p",[t._v("Request:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"daysToKeep"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("1.0")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("daysToKeep")]),t._v(": Optional. The number of days of history to keep. (Default: 1.0)")])]),t._v(" "),a("p",[t._v("Response:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"totalPruned"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("10")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("totalPruned")]),t._v(" is the number of transactions pruned from the derivation scheme")])]),t._v(" "),a("h2",{attrs:{id:"generate-a-wallet"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#generate-a-wallet"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"wallet"}}),t._v("Generate a wallet")]),t._v(" "),a("p",[t._v("NBXplorer will generate and save a mnemonic and create a derivationScheme.")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/derivations")])]),t._v(" "),a("p",[t._v("Request:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountNumber"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("2")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"wordList"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"French"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"existingMnemonic"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"musicien sinistre divertir réussir louve alliage péplum innocent filmer stipuler chignon utopie effusion heureux légal"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"wordCount"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("15")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"scriptPubKeyType"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"SegwitP2SH"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"passphrase"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"hello"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"importKeysToRPC"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"savePrivateKeys"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token boolean"}},[t._v("true")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"additionalOptions"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"slip77"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"6c2de18eabeff3f7822bc724ad482bef0557f3e1c1e1c75b7a393a5ced4de616"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("accountNumber")]),t._v(": Optional, the account number used for determining the keypath that NBXplorer will track, see "),a("code",[t._v("accountKeyPath")]),t._v(" in the response. (Default: "),a("code",[t._v("0")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("existingMnemonic")]),t._v(": Optional, an existing "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" mnemonic seed to import instead of generating.")]),t._v(" "),a("li",[a("code",[t._v("wordList")]),t._v(": Optional, the "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" wordlist to use when generating the mnemonic, available: English, French, Japanese, Spanish, ChineseSimplified (Defaut: "),a("code",[t._v("English")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("wordCount")]),t._v(": Optional, the "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" word count in the mnemonic (Default: "),a("code",[t._v("12")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("scriptPubKeyType")]),t._v(": Optional, the type of scriptPubKey (address) to generate, available: Legacy, Segwit, SegwitP2SH, Taproot (Default: "),a("code",[t._v("Segwit")]),t._v(" or "),a("code",[t._v("Legacy")]),t._v(" if "),a("code",[t._v("cryptoCode")]),t._v(" does not support segwit)")]),t._v(" "),a("li",[a("code",[t._v("passphrase")]),t._v(": Optional, the "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" passphrase. (Default: empty string)")]),t._v(" "),a("li",[a("code",[t._v("importKeysToRPC")]),t._v(": Optional, if true, every times a call to "),a("a",{attrs:{href:"#unused"}},[t._v("get a new unused address")]),t._v(" is called, the private key will be imported into the underlying node via RPC's "),a("code",[t._v("importprivkey")]),t._v(". (Default: "),a("code",[t._v("false")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("savePrivateKeys")]),t._v(": If true, private keys will be saved inside the following metadata "),a("code",[t._v("Mnemonic")]),t._v(", "),a("code",[t._v("MasterHDKey")]),t._v(" and "),a("code",[t._v("AccountHDKey")]),t._v(".")]),t._v(" "),a("li",[a("code",[t._v("additionalOptions")]),t._v(": Optional, additional options that a derivation scheme of some networks may support, such as "),a("a",{attrs:{href:"#liquid"}},[t._v("Liquid")])])]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("importKeysToRPC")]),t._v(" is only useful if one need to manage his wallet via the node's cli tooling.")]),t._v(" "),a("p",[t._v("Response:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"mnemonic"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"musicien sinistre divertir réussir louve alliage péplum innocent filmer stipuler chignon utopie effusion heureux légal"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"passphrase"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"hello"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"wordList"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"French"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"wordCount"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("15")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"masterHDKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tprv8ZgxMBicQKsPdv26BvirqqQCZJPSYEkSW7Por7a7r2PpsCUKHjjT18Gwk8k4FtkvqvakMFnsv9uaXHHoibieRd5BMhGCPYxVLaVY9vqpaxb"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountHDKey"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tprv8gPRns62uoh4zbRatcxUWZY7aX3XsTchHBp79YL6E3fEocsgd6XjThU4r7E3iUemBffeLSjcjXyD1VrmHMwNceVipFL7txTFMgKm4kehuSR"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountKeyPath"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("\"a0aa59b4/49'/1'/2'\"")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"accountDescriptor"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v("\"sh(wpkh([a0aa59b4/49'/1'/2']tpubDD5TwH8H4BNjt4TNnGd4uyCE9YZU2nobrVQtS4NPeKTde78TFVMKeC5w2G1nj7amQbGDptv4FtDBLuVQhofegQaZdFVuuxuCGpZQ4jZ6L5q))\"")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"derivationScheme"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"tpubDD5TwH8H4BNjt4TNnGd4uyCE9YZU2nobrVQtS4NPeKTde78TFVMKeC5w2G1nj7amQbGDptv4FtDBLuVQhofegQaZdFVuuxuCGpZQ4jZ6L5q-[p2sh]"')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("ul",[a("li",[a("code",[t._v("mnemonic")]),t._v(": The generated "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" mnemonic.")]),t._v(" "),a("li",[a("code",[t._v("passphrase")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" passphrase.")]),t._v(" "),a("li",[a("code",[t._v("wordList")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" wordlist to use when generating the mnemonic.")]),t._v(" "),a("li",[a("code",[t._v("wordCount")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP39"),a("OutboundLink")],1),t._v(" word count in the mnemonic.")]),t._v(" "),a("li",[a("code",[t._v("masterHDKey")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP32"),a("OutboundLink")],1),t._v(" master key derived from the mnemonic and passphrase.")]),t._v(" "),a("li",[a("code",[t._v("accountHDKey")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP32"),a("OutboundLink")],1),t._v(" account key derived from the "),a("code",[t._v("masterHDKey")]),t._v(" and "),a("code",[t._v("accountKeyPath")]),t._v(".")]),t._v(" "),a("li",[a("code",[t._v("accountKeyPath")]),t._v(": The fingerprint of the master key as defined by The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP174"),a("OutboundLink")],1),t._v(", followed by the derivation path used to generate the "),a("code",[t._v("derivationScheme")]),t._v(". ("),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0043.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("Purpose field"),a("OutboundLink")],1),t._v(" based on "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP44"),a("OutboundLink")],1),t._v(", "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0049.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP49"),a("OutboundLink")],1),t._v(" or "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP84"),a("OutboundLink")],1),t._v(" and "),a("a",{attrs:{href:"https://github.com/satoshilabs/slips/blob/master/slip-0044.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("SLIP44"),a("OutboundLink")],1),t._v(" for the coin type)")]),t._v(" "),a("li",[a("code",[t._v("accountDescriptor")]),t._v(": The output descriptor of the created account public key.")]),t._v(" "),a("li",[a("code",[t._v("derivationScheme")]),t._v(": The "),a("a",{attrs:{href:"#derivationScheme"}},[t._v("derivation scheme")]),t._v(" that is being tracked by NBXplorer.")])]),t._v(" "),a("p",[a("a",{attrs:{href:"#metadata"}},[t._v("Metadata")]),t._v(" for this derivation scheme after this call:")]),t._v(" "),a("ul",[a("li",[a("code",[t._v("Mnemonic")]),t._v(": The mnemonic generated. (if "),a("code",[t._v("savePrivateKeys")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("MasterHDKey")]),t._v(": The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("xpriv"),a("OutboundLink")],1),t._v(" master key generated by the mnemonic and passphrase. (if "),a("code",[t._v("savePrivateKeys")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("AccountHDKey")]),t._v(": The derived "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("xpriv"),a("OutboundLink")],1),t._v(" account key from the "),a("code",[t._v("MasterHDKey")]),t._v(" and "),a("code",[t._v("AccountKeyPath")]),t._v(". (if "),a("code",[t._v("savePrivateKeys")]),t._v(" is "),a("code",[t._v("true")]),t._v(")")]),t._v(" "),a("li",[a("code",[t._v("AccountKeyPath")]),t._v(": The fingerprint of the master key as defined by The "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0174.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP174"),a("OutboundLink")],1),t._v(", followed by the derivation path used to generate the "),a("code",[t._v("derivationScheme")]),t._v(". ("),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0043.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("Purpose field"),a("OutboundLink")],1),t._v(" based on "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0044.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP44"),a("OutboundLink")],1),t._v(", "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0049.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP49"),a("OutboundLink")],1),t._v(" or "),a("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0084.mediawiki",target:"_blank",rel:"noopener noreferrer"}},[t._v("BIP84"),a("OutboundLink")],1),t._v(" and "),a("a",{attrs:{href:"https://github.com/satoshilabs/slips/blob/master/slip-0044.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("SLIP44"),a("OutboundLink")],1),t._v(" for the coin type)")]),t._v(" "),a("li",[a("code",[t._v("ImportAddressToRPC")]),t._v(": "),a("code",[t._v("Legacy")]),t._v(" (or "),a("code",[t._v("True")]),t._v(", for old wallet) if the generated addresses are added to legacy style Bitcoin core wallet. "),a("code",[t._v("Descriptors")]),t._v(" or "),a("code",[t._v("DescriptorsReadOnly")]),t._v(" if the generated addresses and private keys are added to a descriptor enabled Bitcoin Core wallet.")]),t._v(" "),a("li",[a("code",[t._v("AccountDescriptor")]),t._v(": The output descriptor format of the derivation scheme.")]),t._v(" "),a("li",[a("code",[t._v("Birthdate")]),t._v(": The birthdate of the wallet in ISO-8601 format.")])]),t._v(" "),a("p",[t._v("Note that the metadata "),a("code",[t._v("AccountKeyPath")]),t._v(" is leveraged by "),a("a",{attrs:{href:"#psbt"}},[t._v("Create a PSBT")]),t._v(" and "),a("a",{attrs:{href:"#updatepsbt"}},[t._v("Update a PSBT")]),t._v(".")]),t._v(" "),a("h2",{attrs:{id:"node-rpc-proxy"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#node-rpc-proxy"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"rpc-proxy"}}),t._v("Node RPC Proxy")]),t._v(" "),a("p",[t._v("NBXplorer allows you to query the node's JSON-RPC through it when "),a("code",[t._v("exposerpc")]),t._v(" option is enabled")]),t._v(" "),a("p",[a("code",[t._v("HTTP POST v1/cryptos/{cryptoCode}/rpc")]),t._v("\nwith Header "),a("code",[t._v("Content-Type")]),t._v(" set to value "),a("code",[t._v("application/json")]),t._v(" or "),a("code",[t._v("application/json-rpc")])]),t._v(" "),a("p",[t._v("Error codes:")]),t._v(" "),a("ul",[a("li",[t._v("HTTP 415: You did not send the correct "),a("code",[t._v("Content-Type")]),t._v(" header.")]),t._v(" "),a("li",[t._v("HTTP 404: "),a("code",[t._v("cryptoCode-not-supported")])]),t._v(" "),a("li",[t._v("HTTP 401: "),a("code",[t._v("json-rpc-not-exposed")])]),t._v(" "),a("li",[t._v("HTTP 400: "),a("code",[t._v("rpc-unavailable")])]),t._v(" "),a("li",[t._v("HTTP 422: "),a("code",[t._v("no-json-rpc-request")])])]),t._v(" "),a("p",[t._v("Request:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"jsonrpc"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1.0"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"id"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"1"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"method"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"getblockchaininfo"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"params"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("[")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("]")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("Response:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"error"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token null keyword"}},[t._v("null")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"result"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"chain"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"regtest"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n ...\n "),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"resultString"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"..."')]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("p",[t._v("NOTE: Batch commands are also supported by sending the JSON-RPC requests in an array. The result is also returned in an array.")]),t._v(" "),a("h2",{attrs:{id:"health-check"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#health-check"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"health"}}),t._v("Health check")]),t._v(" "),a("p",[t._v("A endpoint that can be used without the need for "),a("a",{attrs:{href:"#auth"}},[t._v("authentication")]),t._v(" which will returns HTTP 200 only if all nodes connected to NBXplorer are ready.")]),t._v(" "),a("p",[a("code",[t._v("HTTP GET /health")])]),t._v(" "),a("p",[t._v("It will output the state for each nodes in JSON, whose format might change in the future.")]),t._v(" "),a("h2",{attrs:{id:"liquid-integration"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#liquid-integration"}},[t._v("#")]),t._v(" "),a("a",{attrs:{name:"liquid"}}),t._v("Liquid integration")]),t._v(" "),a("p",[t._v("NBXplorer supports liquid, the API is the same as all the other coins, except for the following:")]),t._v(" "),a("ul",[a("li",[t._v("All references to "),a("code",[t._v("value")]),t._v(" which normally contains an integer of the amount of the altcoin will instead output a JSON Object of type "),a("code",[t._v("AssetMoney")]),t._v(".")]),t._v(" "),a("li",[t._v("If NBXplorer is unable to unblind a value, then the value will be "),a("code",[t._v("null")]),t._v(".")]),t._v(" "),a("li",[a("a",{attrs:{href:"#transactions"}},[t._v("When listing the transaction of a derivation scheme")]),t._v(", the "),a("code",[t._v("balanceChange")]),t._v(" elements is instead a "),a("code",[t._v("JSON array of AssetMoney")]),t._v(".")]),t._v(" "),a("li",[a("a",{attrs:{href:"#balance"}},[t._v("Get Balance")]),t._v(" returns values as "),a("code",[t._v("JSON array of AssetMoney")]),t._v(".")]),t._v(" "),a("li",[a("a",{attrs:{href:"#unused"}},[t._v("Get a new unused address")]),t._v(" returns a confidential address. (See note below)")]),t._v(" "),a("li",[a("a",{attrs:{href:"#psbt"}},[t._v("Create Partially Signed Bitcoin Transaction")]),t._v(" is not supported.")]),t._v(" "),a("li",[a("a",{attrs:{href:"#updatepsbt"}},[t._v("Update Partially Signed Bitcoin Transaction")]),t._v(" is not supported")]),t._v(" "),a("li",[a("a",{attrs:{href:"#scanUtxoSet"}},[t._v("Scan UTXO Set")]),t._v(" is not supported.")]),t._v(" "),a("li",[t._v("Any sort of recovery is not supported.")])]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("AssetMoney")]),t._v(" JSON format is:")]),t._v(" "),a("div",{staticClass:"language-json extra-class"},[a("pre",{pre:!0,attrs:{class:"language-json"}},[a("code",[a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("{")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"assetId"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token string"}},[t._v('"abc"')]),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v(",")]),t._v("\n "),a("span",{pre:!0,attrs:{class:"token property"}},[t._v('"value"')]),a("span",{pre:!0,attrs:{class:"token operator"}},[t._v(":")]),t._v(" "),a("span",{pre:!0,attrs:{class:"token number"}},[t._v("123")]),t._v("\n"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[t._v("}")]),t._v("\n")])])]),a("h3",{attrs:{id:"liquid-confidential-addresses"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#liquid-confidential-addresses"}},[t._v("#")]),t._v(" Liquid Confidential Addresses")]),t._v(" "),a("p",[t._v("Liquid confidential addresses are supported in two ways:")]),t._v(" "),a("ul",[a("li",[t._v("By default, the blinding key of the confidential address is derived directly from the "),a("code",[t._v("derivationScheme")]),t._v(". If the "),a("code",[t._v("scriptPubKey")]),t._v(" "),a("code",[t._v("0/2")]),t._v(" is generated, the blinding private key used by NBXplorer is the SHA256 of the scriptPubKey at "),a("code",[t._v("0/2/0")]),t._v(".")]),t._v(" "),a("li",[a("a",{attrs:{href:"https://github.com/satoshilabs/slips/blob/master/slip-0077.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("SLIP77"),a("OutboundLink")],1),t._v(", by suffixing the derivation scheme with either:\n"),a("ul",[a("li",[t._v("the mnemonic seed derivation (usually the same as your wallet's)"),a("code",[t._v("-[slip77=all all all all all all all all all all all all]")])]),t._v(" "),a("li",[t._v("the master blinding key in hex or wif format"),a("code",[t._v("-[slip77=6c2de18eabeff3f7822bc724ad482bef0557f3e1c1e1c75b7a393a5ced4de616]")]),t._v("\nYou may also choose to not use confidential addresses by applying the suffix "),a("code",[t._v("-[unblinded]")]),t._v(" to the derivation scheme")])])])]),t._v(" "),a("h3",{attrs:{id:"liquid-transactions-support"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#liquid-transactions-support"}},[t._v("#")]),t._v(" Liquid Transactions support")]),t._v(" "),a("p",[t._v("Due to the changes in the transaction format in Elements networks to support assets, we do not support transaction building features.")]),t._v(" "),a("p",[t._v("In order to send in and out of liquid, we advise you to rely on the RPC command line interface of the liquid deamon.\nFor doing this you need to "),a("a",{attrs:{href:"#wallet"}},[t._v("Generate a wallet")]),t._v(" with "),a("code",[t._v("importAddressToRPC")]),t._v(" and "),a("code",[t._v("savePrivateKeys")]),t._v(" set to "),a("code",[t._v("true")]),t._v(".")]),t._v(" "),a("p",[t._v("Be careful to not expose your NBXplorer server on internet, your private keys can be "),a("a",{attrs:{href:"#getmetadata"}},[t._v("retrieved trivially")]),t._v(".")])])}),[],!1,null,null,null);a.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/13.156ba371.js b/assets/js/13.f1e857c5.js similarity index 83% rename from assets/js/13.156ba371.js rename to assets/js/13.f1e857c5.js index 46ec2b8604..8ecb1caa61 100644 --- a/assets/js/13.156ba371.js +++ b/assets/js/13.f1e857c5.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{240:function(t,e,a){t.exports=a.p+"assets/img/BroadcastConfirm.fde15efd.png"},457:function(t,e,a){t.exports=a.p+"assets/img/1-store-created.617b1965.png"},458:function(t,e,a){t.exports=a.p+"assets/img/2-connect-wallet.1ace2dcb.png"},459:function(t,e,a){t.exports=a.p+"assets/img/3-choose-import-method.d4dbc1cd.png"},460:function(t,e,a){t.exports=a.p+"assets/img/4-vault-notif.2c298f47.png"},461:function(t,e,a){t.exports=a.p+"assets/img/5-address-type.bebe1cf2.png"},462:function(t,e,a){t.exports=a.p+"assets/img/6-pubkey-hww.30a1cab5.png"},463:function(t,e,a){t.exports=a.p+"assets/img/7-confirm-addresses.8735ed56.png"},464:function(t,e,a){t.exports=a.p+"assets/img/8-wallet-setup-complete.d955c440.png"},465:function(t,e,a){t.exports=a.p+"assets/img/9-send-btc.58dad487.png"},466:function(t,e,a){t.exports=a.p+"assets/img/10-choose-signing-method.843569ac.png"},467:function(t,e,a){t.exports=a.p+"assets/img/11-sign-transaction.69390a6b.png"},757:function(t,e,a){"use strict";a.r(e);var r=a(9),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hardware-wallet-integration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hardware-wallet-integration"}},[t._v("#")]),t._v(" Hardware Wallet Integration")]),t._v(" "),e("p",[t._v("For optimal balance between ease of use, security and privacy, it's recommended to use "),e("RouterLink",{attrs:{to:"/Wallet/"}},[t._v("BTCPay Server Wallet")]),t._v(" with a hardware wallet.")],1),t._v(" "),e("p",[t._v("The hardware wallet integration within BTCPay Server allows you to import your hardware wallet and spend the incoming funds with a simple confirmation on your device. Your private keys never leave the device and all funds are being validated against your own full node and no data leakage.")]),t._v(" "),e("h2",{attrs:{id:"getting-started"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[t._v("#")]),t._v(" Getting Started")]),t._v(" "),e("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/s4qbGxef43A/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=s4qbGxef43A",title:"BTCPay Server Vault","data-id":"s4qbGxef43A"}},[e("iframe",{attrs:{title:"BTCPay Server Vault","data-src":"https://www.youtube-nocookie.com/embed/s4qbGxef43A?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),t._v(" "),e("ol",[e("li",[e("a",{attrs:{href:"https://github.com/btcpayserver/BTCPayServer.Vault/releases",target:"_blank",rel:"noopener noreferrer"}},[t._v("Download the BTCPay Vault app"),e("OutboundLink")],1)]),t._v(" "),e("li",[t._v("Install the Vault on your PC (Windows, MacOS or Linux)")]),t._v(" "),e("li",[t._v("Open the BTCPay Vault app")]),t._v(" "),e("li",[t._v("Plug in the hardware wallet into your PC and make sure it’s in a wake up state")]),t._v(" "),e("li",[t._v("Do you have an existing store? Skip ahead to step 7.")]),t._v(" "),e("li",[t._v("Connect existing wallet and then click on the Connect a hardware wallet.")]),t._v(" "),e("li",[t._v("Now you will see BTCPay Server searching for your hardware wallet, this step requires you to run BTCPay Server Vault.")]),t._v(" "),e("li",[t._v("Click accept on your BTCPay Vault application. Vault is now searching for your device, it will now ask for your pin on the device.")]),t._v(" "),e("li",[t._v("After device was found and accepted, select your address type and click confirm. BTCPay Server will show your public key information from your hardware wallet.")]),t._v(" "),e("li",[t._v("Once you've confirmed the public key is correct, BTCPay Server now shows the address to validate on your device. If they are correct click confirm to complete the setup.")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(457),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(458),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(459),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(460),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(461),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(462),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(463),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(464),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("h3",{attrs:{id:"spending-funds"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#spending-funds"}},[t._v("#")]),t._v(" Spending funds")]),t._v(" "),e("p",[t._v("Once you’ve received funds to your wallet and you decide to spend them, you can sign the transaction with your hardware wallet, all inside BTCPay Server.")]),t._v(" "),e("ol",[e("li",[t._v("Open BTCPay Vault app on your PC")]),t._v(" "),e("li",[t._v("Plug in the hardware wallet and make sure it’s in wake up state")]),t._v(" "),e("li",[t._v("In BTCPay Server, go to your Bitcoin Wallet and click on send")]),t._v(" "),e("li",[t._v("Fill in the Destination address and the Amount")]),t._v(" "),e("li",[t._v("Select Sign with a hardware wallet")]),t._v(" "),e("li",[t._v("Verify the transaction on your hardware wallet and confirm it")]),t._v(" "),e("li",[t._v("Broadcast the transaction")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(465),alt:"Send Bitcoin via BTCPay Vault",title:"Send Bitcoin via BTCPay Vault"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(466),alt:"Send Bitcoin via BTCPay Vault",title:"Send Bitcoin via BTCPay Vault"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(467),alt:"Send Bitcoin via BTCPay Vault",title:"Send Bitcoin via BTCPay Vault"}})]),t._v(" "),e("h2",{attrs:{id:"advanced-settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#advanced-settings"}},[t._v("#")]),t._v(" Advanced Settings")]),t._v(" "),e("p",[t._v("Additional transaction settings can be found by clicking on the "),e("RouterLink",{attrs:{to:"/Wallet/#advanced-settings"}},[t._v("Advanced Settings")]),t._v(" button. If you are not familiar with these types of settings, you may leave them as is to use the default settings.")],1),t._v(" "),e("p",[t._v("If you are experiencing issues sending transactions from a Trezor wallet, you may need to enable "),e("RouterLink",{attrs:{to:"/FAQ/Wallet/#why-is-sending-a-transaction-using-trezor-failing"}},[t._v("this advanced setting")]),t._v(".")],1),t._v(" "),e("figure",[e("img",{attrs:{src:a(240),alt:"Send Bitcoin via BTCPay Vault",title:"Send Bitcoin via BTCPay Vault"}})]),t._v(" "),e("h2",{attrs:{id:"supported-hardware-wallets"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#supported-hardware-wallets"}},[t._v("#")]),t._v(" Supported Hardware Wallets")]),t._v(" "),e("p",[t._v("The list of supported hardware wallets is available at "),e("a",{attrs:{href:"https://github.com/bitcoin-core/HWI#device-support",target:"_blank",rel:"noopener noreferrer"}},[t._v("this link"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("The hardware wallet integration in BTCPay Server only supports Bitcoin. "),e("RouterLink",{attrs:{to:"/Development/Altcoins/"}},[t._v("Altcoin")]),t._v(" wallets enabled on your server won't work.")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[13],{240:function(t,e,a){t.exports=a.p+"assets/img/BroadcastConfirm.fde15efd.png"},458:function(t,e,a){t.exports=a.p+"assets/img/1-store-created.617b1965.png"},459:function(t,e,a){t.exports=a.p+"assets/img/2-connect-wallet.1ace2dcb.png"},460:function(t,e,a){t.exports=a.p+"assets/img/3-choose-import-method.d4dbc1cd.png"},461:function(t,e,a){t.exports=a.p+"assets/img/4-vault-notif.2c298f47.png"},462:function(t,e,a){t.exports=a.p+"assets/img/5-address-type.bebe1cf2.png"},463:function(t,e,a){t.exports=a.p+"assets/img/6-pubkey-hww.30a1cab5.png"},464:function(t,e,a){t.exports=a.p+"assets/img/7-confirm-addresses.8735ed56.png"},465:function(t,e,a){t.exports=a.p+"assets/img/8-wallet-setup-complete.d955c440.png"},466:function(t,e,a){t.exports=a.p+"assets/img/9-send-btc.58dad487.png"},467:function(t,e,a){t.exports=a.p+"assets/img/10-choose-signing-method.843569ac.png"},468:function(t,e,a){t.exports=a.p+"assets/img/11-sign-transaction.69390a6b.png"},757:function(t,e,a){"use strict";a.r(e);var r=a(9),i=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"hardware-wallet-integration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#hardware-wallet-integration"}},[t._v("#")]),t._v(" Hardware Wallet Integration")]),t._v(" "),e("p",[t._v("For optimal balance between ease of use, security and privacy, it's recommended to use "),e("RouterLink",{attrs:{to:"/Wallet/"}},[t._v("BTCPay Server Wallet")]),t._v(" with a hardware wallet.")],1),t._v(" "),e("p",[t._v("The hardware wallet integration within BTCPay Server allows you to import your hardware wallet and spend the incoming funds with a simple confirmation on your device. Your private keys never leave the device and all funds are being validated against your own full node and no data leakage.")]),t._v(" "),e("h2",{attrs:{id:"getting-started"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#getting-started"}},[t._v("#")]),t._v(" Getting Started")]),t._v(" "),e("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/s4qbGxef43A/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=s4qbGxef43A",title:"BTCPay Server Vault","data-id":"s4qbGxef43A"}},[e("iframe",{attrs:{title:"BTCPay Server Vault","data-src":"https://www.youtube-nocookie.com/embed/s4qbGxef43A?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),t._v(" "),e("ol",[e("li",[e("a",{attrs:{href:"https://github.com/btcpayserver/BTCPayServer.Vault/releases",target:"_blank",rel:"noopener noreferrer"}},[t._v("Download the BTCPay Vault app"),e("OutboundLink")],1)]),t._v(" "),e("li",[t._v("Install the Vault on your PC (Windows, MacOS or Linux)")]),t._v(" "),e("li",[t._v("Open the BTCPay Vault app")]),t._v(" "),e("li",[t._v("Plug in the hardware wallet into your PC and make sure it’s in a wake up state")]),t._v(" "),e("li",[t._v("Do you have an existing store? Skip ahead to step 7.")]),t._v(" "),e("li",[t._v("Connect existing wallet and then click on the Connect a hardware wallet.")]),t._v(" "),e("li",[t._v("Now you will see BTCPay Server searching for your hardware wallet, this step requires you to run BTCPay Server Vault.")]),t._v(" "),e("li",[t._v("Click accept on your BTCPay Vault application. Vault is now searching for your device, it will now ask for your pin on the device.")]),t._v(" "),e("li",[t._v("After device was found and accepted, select your address type and click confirm. BTCPay Server will show your public key information from your hardware wallet.")]),t._v(" "),e("li",[t._v("Once you've confirmed the public key is correct, BTCPay Server now shows the address to validate on your device. If they are correct click confirm to complete the setup.")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(458),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(459),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(460),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(461),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(462),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(463),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(464),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(465),alt:"BTCPay Server Vault configuration",title:"BTCPay Server Vault configuration"}})]),t._v(" "),e("h3",{attrs:{id:"spending-funds"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#spending-funds"}},[t._v("#")]),t._v(" Spending funds")]),t._v(" "),e("p",[t._v("Once you’ve received funds to your wallet and you decide to spend them, you can sign the transaction with your hardware wallet, all inside BTCPay Server.")]),t._v(" "),e("ol",[e("li",[t._v("Open BTCPay Vault app on your PC")]),t._v(" "),e("li",[t._v("Plug in the hardware wallet and make sure it’s in wake up state")]),t._v(" "),e("li",[t._v("In BTCPay Server, go to your Bitcoin Wallet and click on send")]),t._v(" "),e("li",[t._v("Fill in the Destination address and the Amount")]),t._v(" "),e("li",[t._v("Select Sign with a hardware wallet")]),t._v(" "),e("li",[t._v("Verify the transaction on your hardware wallet and confirm it")]),t._v(" "),e("li",[t._v("Broadcast the transaction")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(466),alt:"Send Bitcoin via BTCPay Vault",title:"Send Bitcoin via BTCPay Vault"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(467),alt:"Send Bitcoin via BTCPay Vault",title:"Send Bitcoin via BTCPay Vault"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:a(468),alt:"Send Bitcoin via BTCPay Vault",title:"Send Bitcoin via BTCPay Vault"}})]),t._v(" "),e("h2",{attrs:{id:"advanced-settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#advanced-settings"}},[t._v("#")]),t._v(" Advanced Settings")]),t._v(" "),e("p",[t._v("Additional transaction settings can be found by clicking on the "),e("RouterLink",{attrs:{to:"/Wallet/#advanced-settings"}},[t._v("Advanced Settings")]),t._v(" button. If you are not familiar with these types of settings, you may leave them as is to use the default settings.")],1),t._v(" "),e("p",[t._v("If you are experiencing issues sending transactions from a Trezor wallet, you may need to enable "),e("RouterLink",{attrs:{to:"/FAQ/Wallet/#why-is-sending-a-transaction-using-trezor-failing"}},[t._v("this advanced setting")]),t._v(".")],1),t._v(" "),e("figure",[e("img",{attrs:{src:a(240),alt:"Send Bitcoin via BTCPay Vault",title:"Send Bitcoin via BTCPay Vault"}})]),t._v(" "),e("h2",{attrs:{id:"supported-hardware-wallets"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#supported-hardware-wallets"}},[t._v("#")]),t._v(" Supported Hardware Wallets")]),t._v(" "),e("p",[t._v("The list of supported hardware wallets is available at "),e("a",{attrs:{href:"https://github.com/bitcoin-core/HWI#device-support",target:"_blank",rel:"noopener noreferrer"}},[t._v("this link"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("The hardware wallet integration in BTCPay Server only supports Bitcoin. "),e("RouterLink",{attrs:{to:"/Development/Altcoins/"}},[t._v("Altcoin")]),t._v(" wallets enabled on your server won't work.")],1)])])}),[],!1,null,null,null);e.default=i.exports}}]); \ No newline at end of file diff --git a/assets/js/130.e5b6bb57.js b/assets/js/130.b3d4adc4.js similarity index 98% rename from assets/js/130.e5b6bb57.js rename to assets/js/130.b3d4adc4.js index 89f1e5e6be..9b6aaa1466 100644 --- a/assets/js/130.e5b6bb57.js +++ b/assets/js/130.b3d4adc4.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[130],{768:function(e,t,a){"use strict";a.r(t);var r=a(9),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"migration-from-dbtrie-backend-to-postgres-backend"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#migration-from-dbtrie-backend-to-postgres-backend"}},[e._v("#")]),e._v(" Migration from DBTrie backend to Postgres backend")]),e._v(" "),t("p",[e._v("For an extended period, NBXplorer depended on an embedded database dubbed DBTrie. This internal database imposed limitations for various reasons, prompting us to upgrade NBXplorer to employ a Postgres backend rather than DBTrie.")]),e._v(" "),t("p",[e._v("Although we continue to support DBTrie, it is now deemed obsolete. We offer a migration pathway for existing deployments.")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Command line argument")]),e._v(" "),t("th",[e._v("Environment variable")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("--deleteaftermigration")]),e._v(" "),t("td",[e._v("NBXPLORER_DELETEAFTERMIGRATION=1")]),e._v(" "),t("td",[e._v("Once migration succeed, delete the original DBTrie database (default: false)")])]),e._v(" "),t("tr",[t("td",[e._v("--postgres")]),e._v(" "),t("td",[e._v('NBXPLORER_POSTGRES="..."')]),e._v(" "),t("td",[e._v("The connection string to postgres")])]),e._v(" "),t("tr",[t("td",[e._v("--automigrate")]),e._v(" "),t("td",[e._v("NBXPLORER_AUTOMIGRATE=1")]),e._v(" "),t("td",[e._v("If DBTrie database exists, migrate it (default: false)")])]),e._v(" "),t("tr",[t("td",[e._v("--nomigrateevts")]),e._v(" "),t("td",[e._v("NBXPLORER_NOMIGRATEEVTS=1")]),e._v(" "),t("td",[e._v("Do not migrate the events table (default: false)")])]),e._v(" "),t("tr",[t("td",[e._v("--nomigraterawtxs")]),e._v(" "),t("td",[e._v("NBXPLORER_NOMIGRATERAWTXS=1")]),e._v(" "),t("td",[e._v("Do not migrate the raw bytes of transactions (default: false)")])])])]),e._v(" "),t("p",[t("code",[e._v("automigrate")]),e._v(": will seamlessly determine if a DBTrie database necessitates migration, disregarding the flag if migration is unnecessary or already executed.")]),e._v(" "),t("p",[t("code",[e._v("nomigrateevts")]),e._v(": may be employed for services reliant on NBXplorer that do not query past events, thereby hastening the migration process. (BTCPay Server, for example, does not utilize past events)")]),e._v(" "),t("p",[t("code",[e._v("nomigraterawtxs")]),e._v(": may be utilized if preserving raw transaction bytes is nonessential, consequently expediting migration. Raw transactions are typically crucial for signing with a non-segwit wallet.")]),e._v(" "),t("p",[e._v("The majority of instances will complete migration in under five minutes.")]),e._v(" "),t("p",[e._v("For larger instances, our BTCPay Server's mainnet demo server with 800,000 addresses and 44,000 transactions and the DBTrie database approximating 5GB took roughly 40 minutes.")]),e._v(" "),t("p",[e._v("If you use BTCPay Server, ensure that its environment variable "),t("code",[e._v("BTCPAY_EXPLORERPOSTGRES")]),e._v(" is assigned the same connection string as NBXplorer.")]),e._v(" "),t("p",[e._v("You can find more information in this "),t("a",{attrs:{href:"https://blog.btcpayserver.org/nbxplorer-postgres/",target:"_blank",rel:"noopener noreferrer"}},[e._v("blog post"),t("OutboundLink")],1),e._v(".")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[130],{767:function(e,t,a){"use strict";a.r(t);var r=a(9),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"migration-from-dbtrie-backend-to-postgres-backend"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#migration-from-dbtrie-backend-to-postgres-backend"}},[e._v("#")]),e._v(" Migration from DBTrie backend to Postgres backend")]),e._v(" "),t("p",[e._v("For an extended period, NBXplorer depended on an embedded database dubbed DBTrie. This internal database imposed limitations for various reasons, prompting us to upgrade NBXplorer to employ a Postgres backend rather than DBTrie.")]),e._v(" "),t("p",[e._v("Although we continue to support DBTrie, it is now deemed obsolete. We offer a migration pathway for existing deployments.")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("Command line argument")]),e._v(" "),t("th",[e._v("Environment variable")]),e._v(" "),t("th",[e._v("Description")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("--deleteaftermigration")]),e._v(" "),t("td",[e._v("NBXPLORER_DELETEAFTERMIGRATION=1")]),e._v(" "),t("td",[e._v("Once migration succeed, delete the original DBTrie database (default: false)")])]),e._v(" "),t("tr",[t("td",[e._v("--postgres")]),e._v(" "),t("td",[e._v('NBXPLORER_POSTGRES="..."')]),e._v(" "),t("td",[e._v("The connection string to postgres")])]),e._v(" "),t("tr",[t("td",[e._v("--automigrate")]),e._v(" "),t("td",[e._v("NBXPLORER_AUTOMIGRATE=1")]),e._v(" "),t("td",[e._v("If DBTrie database exists, migrate it (default: false)")])]),e._v(" "),t("tr",[t("td",[e._v("--nomigrateevts")]),e._v(" "),t("td",[e._v("NBXPLORER_NOMIGRATEEVTS=1")]),e._v(" "),t("td",[e._v("Do not migrate the events table (default: false)")])]),e._v(" "),t("tr",[t("td",[e._v("--nomigraterawtxs")]),e._v(" "),t("td",[e._v("NBXPLORER_NOMIGRATERAWTXS=1")]),e._v(" "),t("td",[e._v("Do not migrate the raw bytes of transactions (default: false)")])])])]),e._v(" "),t("p",[t("code",[e._v("automigrate")]),e._v(": will seamlessly determine if a DBTrie database necessitates migration, disregarding the flag if migration is unnecessary or already executed.")]),e._v(" "),t("p",[t("code",[e._v("nomigrateevts")]),e._v(": may be employed for services reliant on NBXplorer that do not query past events, thereby hastening the migration process. (BTCPay Server, for example, does not utilize past events)")]),e._v(" "),t("p",[t("code",[e._v("nomigraterawtxs")]),e._v(": may be utilized if preserving raw transaction bytes is nonessential, consequently expediting migration. Raw transactions are typically crucial for signing with a non-segwit wallet.")]),e._v(" "),t("p",[e._v("The majority of instances will complete migration in under five minutes.")]),e._v(" "),t("p",[e._v("For larger instances, our BTCPay Server's mainnet demo server with 800,000 addresses and 44,000 transactions and the DBTrie database approximating 5GB took roughly 40 minutes.")]),e._v(" "),t("p",[e._v("If you use BTCPay Server, ensure that its environment variable "),t("code",[e._v("BTCPAY_EXPLORERPOSTGRES")]),e._v(" is assigned the same connection string as NBXplorer.")]),e._v(" "),t("p",[e._v("You can find more information in this "),t("a",{attrs:{href:"https://blog.btcpayserver.org/nbxplorer-postgres/",target:"_blank",rel:"noopener noreferrer"}},[e._v("blog post"),t("OutboundLink")],1),e._v(".")])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/131.09b09488.js b/assets/js/131.62141ac7.js similarity index 99% rename from assets/js/131.09b09488.js rename to assets/js/131.62141ac7.js index 8bfca5f6b8..cca99ff054 100644 --- a/assets/js/131.09b09488.js +++ b/assets/js/131.62141ac7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[131],{770:function(e,t,a){"use strict";a.r(t);var o=a(9),r=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"nbxplorer"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nbxplorer"}},[e._v("#")]),e._v(" NBXplorer")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.nuget.org/packages/NBxplorer.Client",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.shields.io/nuget/v/NBxplorer.Client.svg",alt:"NuGet",title:"NuGet"}}),t("OutboundLink")],1),e._v(" "),t("a",{attrs:{href:"https://hub.docker.com/r/nicolasdorier/nbxplorer/",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg",alt:"Docker Automated buil",title:"Docker Automated buil"}}),t("OutboundLink")],1),e._v(" "),t("a",{attrs:{href:"https://circleci.com/gh/dgarage/NBXplorer",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://circleci.com/gh/dgarage/NBXplorer.svg?style=svg",alt:"CircleCI",title:"CircleCI"}}),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("A minimalist UTXO tracker for HD Wallets.\nThe goal is to have a flexible, .NET based UTXO tracker for HD wallets.\nThe explorer supports P2SH,P2PKH,P2WPKH,P2WSH and Multi-sig derivation.")]),e._v(" "),t("p",[e._v("This explorer is not meant to be exposed on internet, but should be used as an internal tool for tracking the UTXOs of your own service.")]),e._v(" "),t("p",[e._v("It has a bunch of features:")]),e._v(" "),t("ul",[t("li",[e._v("Can pass arguments via environment variable, command line or configuration file")]),e._v(" "),t("li",[e._v("Automatically reconnect to your node if the connection goes temporarily down")]),e._v(" "),t("li",[e._v("An easy to use REST API")]),e._v(" "),t("li",[e._v("Persistence (via in-file no-SQL datbase called DBreeze or Postgres)")]),e._v(" "),t("li",[e._v("Connect via RPC to broadcast transaction instead of using the P2P protocol like this example")]),e._v(" "),t("li",[e._v("Connect via RPC to your trusted node to get the proper fee rate.")]),e._v(" "),t("li",[e._v("Altcoin support")]),e._v(" "),t("li",[e._v("Huge test suite")]),e._v(" "),t("li",[e._v("Pruning of transaction data (in practice, we don't need to save the whole transaction, only the spent outpoint and received coin for the wallet)")]),e._v(" "),t("li",[e._v("Multi-wallet")]),e._v(" "),t("li",[e._v("Flexible address generation schemes (multisig, segwit, legacy etc...)")]),e._v(" "),t("li",[e._v("Pruning for big wallets (Removal of tracked transaction which do not impact the resulting UTXO set)")])]),e._v(" "),t("p",[e._v("It currently supports the following altcoins:")]),e._v(" "),t("ul",[t("li",[e._v("Althash")]),e._v(" "),t("li",[e._v("Argoneum")]),e._v(" "),t("li",[e._v("BCash (also known as Bitcoin Cash)")]),e._v(" "),t("li",[e._v("BGold (also known as Bitcoin Gold)")]),e._v(" "),t("li",[e._v("BitCore")]),e._v(" "),t("li",[e._v("Chaincoin")]),e._v(" "),t("li",[e._v("ColossusXT")]),e._v(" "),t("li",[e._v("Dash")]),e._v(" "),t("li",[e._v("Dogecoin")]),e._v(" "),t("li",[e._v("Feathercoin")]),e._v(" "),t("li",[e._v("Gobyte")]),e._v(" "),t("li",[e._v("Groestlcoin")]),e._v(" "),t("li",[e._v("Litecoin")]),e._v(" "),t("li",[e._v("Monacoin")]),e._v(" "),t("li",[e._v("MonetaryUnit")]),e._v(" "),t("li",[e._v("Monoeci")]),e._v(" "),t("li",[e._v("Polis")]),e._v(" "),t("li",[e._v("Qtum")]),e._v(" "),t("li",[e._v("Terracoin")]),e._v(" "),t("li",[e._v("Ufo")]),e._v(" "),t("li",[e._v("Viacoin")])]),e._v(" "),t("p",[e._v("Read our "),t("RouterLink",{attrs:{to:"/NBXplorer/API/"}},[e._v("API Specification")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"prerequisite"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisite"}},[e._v("#")]),e._v(" Prerequisite")]),e._v(" "),t("ul",[t("li",[e._v("Install "),t("a",{attrs:{href:"https://www.microsoft.com/net/download",target:"_blank",rel:"noopener noreferrer"}},[e._v(".NET Core SDK v6.0 or above"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("Bitcoin Core instance synched and running (at least 0.16.0).")]),e._v(" "),t("li",[e._v("PostgresSQL v13+ (Technically 11+ works, but you may have performance issues at higher scale)")])]),e._v(" "),t("p",[e._v("There are two backend available:")]),e._v(" "),t("ul",[t("li",[e._v("DBTrie (with the "),t("code",[e._v("--dbtrie")]),e._v(" flag)")]),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/NBXplorer/Postgres-Schema/"}},[e._v("Postgres")]),e._v(" (with the "),t("code",[e._v("--postgres")]),e._v(" flags)")],1)]),e._v(" "),t("p",[e._v("However, "),t("code",[e._v("DBTrie")]),e._v(" is now deprecated. We will continue to support it to give more time for our users "),t("RouterLink",{attrs:{to:"/NBXplorer/Postgres-Migration/"}},[e._v("to migrate")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"api-specification"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#api-specification"}},[e._v("#")]),e._v(" API Specification")]),e._v(" "),t("p",[e._v("Read our "),t("RouterLink",{attrs:{to:"/NBXplorer/API/"}},[e._v("API Specification")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"how-to-build-and-run"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-build-and-run"}},[e._v("#")]),e._v(" How to build and run?")]),e._v(" "),t("p",[e._v("If you are using Bitcoin core default settings:")]),e._v(" "),t("p",[e._v("On Powershell:")]),e._v(" "),t("div",{staticClass:"language-pwsh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(".\\build.ps1\n")])])]),t("p",[e._v("On Linux:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("./build.sh\n")])])]),t("p",[e._v("Then to run:")]),e._v(" "),t("p",[e._v("On Powershell:")]),e._v(" "),t("div",{staticClass:"language-pwsh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(".\\run.ps1 --help\n")])])]),t("p",[e._v("On Linux:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("./run.sh --help\n")])])]),t("p",[e._v("Example, if you have ltc node and btc node on regtest (default configuration), and want to connect to them: (see documentation for other options in the "),t("a",{attrs:{href:"https://www.npgsql.org/doc/connection-string-parameters.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("postgres connection string"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("./run.sh --chains"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("btc,ltc --network"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("regtest --postgres "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"User ID=postgres;Host=127.0.0.1;Port=39382;Database=nbxplorer"')]),e._v("\n")])])]),t("h2",{attrs:{id:"how-to-use-the-api"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use-the-api"}},[e._v("#")]),e._v(" How to use the API?")]),e._v(" "),t("p",[e._v("Check "),t("RouterLink",{attrs:{to:"/NBXplorer/API/"}},[e._v("the API documentation")]),e._v(", you can then use any client library:")],1),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/junderw/NBXplorer.NodeJS",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBXplorer.NodeJS"),t("OutboundLink")],1),e._v(" for NodeJS clients.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.nuget.org/packages/NBxplorer.Client",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBXplorer.Client"),t("OutboundLink")],1),e._v(" for .NET clients.")])]),e._v(" "),t("p",[e._v("Here is "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer/blob/master/Examples/MultiSig/Program.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("a small C# example"),t("OutboundLink")],1),e._v(" showing a 2-2 multisig with Alice and Bob that you can run on regtest.")]),e._v(" "),t("h2",{attrs:{id:"with-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#with-docker"}},[e._v("#")]),e._v(" With Docker")]),e._v(" "),t("p",[e._v("Use "),t("a",{attrs:{href:"https://hub.docker.com/r/nicolasdorier/nbxplorer/",target:"_blank",rel:"noopener noreferrer"}},[e._v("our image"),t("OutboundLink")],1),e._v(".\nYou can check "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer/blob/master/docker-compose.regtest.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("the sample"),t("OutboundLink")],1),e._v(" for configuring and composing it bitcoin core.")]),e._v(" "),t("h2",{attrs:{id:"how-to-develop-on-it"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-develop-on-it"}},[e._v("#")]),e._v(" How to develop on it?")]),e._v(" "),t("p",[e._v("If you are on Windows, I recommend Visual Studio 2017 update 4 (15.4).\nIf you are on other platform and want lightweight environment, use "),t("a",{attrs:{href:"https://code.visualstudio.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Visual Studio Code"),t("OutboundLink")],1),e._v(".\nIf you are hardcore, you can code on vim.")]),e._v(" "),t("p",[e._v("I like Visual Studio Code and Visual Studio 2017 as it allows me to debug in step by step.")]),e._v(" "),t("h2",{attrs:{id:"how-to-configure"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-configure"}},[e._v("#")]),e._v(" How to configure?")]),e._v(" "),t("p",[e._v("NBXplorer supports configuration through command line arguments, configuration file, or environment variables.")]),e._v(" "),t("h3",{attrs:{id:"configuration-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration-file"}},[e._v("#")]),e._v(" Configuration file")]),e._v(" "),t("p",[e._v("If you are not using standard install for bitcoind, you will have to change the configuration file:\nIn Windows it is located in")]),e._v(" "),t("div",{staticClass:"language-pwsh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("C:\\Users\\\\AppData\\Roaming\\NBXplorer\\\\settings.config\n")])])]),t("p",[e._v("On linux or mac:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("~/.nbxplorer/"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("network"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("/settings.config\n")])])]),t("p",[e._v("The default configuration assumes "),t("code",[e._v("mainnet")]),e._v(" with only "),t("code",[e._v("btc")]),e._v(" chain supported, and uses the default settings of bitcoind.")]),e._v(" "),t("p",[e._v("You can change the location of the configuration file with the "),t("code",[e._v("--conf=pathToConf")]),e._v(" command line argument.")]),e._v(" "),t("h3",{attrs:{id:"command-line-parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#command-line-parameters"}},[e._v("#")]),e._v(" Command line parameters")]),e._v(" "),t("p",[e._v("Please note that NBXplorer uses cookie authentication by default. If you run your Bitcoin/Litecoin/Dash nodes using their daemon (like "),t("code",[e._v("bitcoind")]),e._v(", "),t("code",[e._v("litecoind")]),e._v(" or "),t("code",[e._v("dashd")]),e._v("), they generate a new cookie every time you start them, and that should work without any extra configuration.\nIf you run the node(s) using the GUI versions, like Bitcoin\\Litecoin\\Dash Core Qt with the "),t("code",[e._v("-server")]),e._v(" parameter while you set the rpcusername and rpcpassword in their "),t("code",[e._v(".conf")]),e._v(" files, you must set those values for every crypto you are planning to support.\nSee samples below.")]),e._v(" "),t("h4",{attrs:{id:"run-from-source-requires-net-core-sdk"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#run-from-source-requires-net-core-sdk"}},[e._v("#")]),e._v(" Run from source (requires .NET Core SDK)")]),e._v(" "),t("p",[e._v("You should use "),t("code",[e._v("run.ps1")]),e._v(" (Windows) or "),t("code",[e._v("run.sh")]),e._v(" (Linux) to execute NBXplorer, but you can also execute it manually with the following command:\n"),t("code",[e._v("dotnet run --no-launch-profile -p .\\NBXplorer\\NBXplorer.csproj -- ")])]),e._v(" "),t("h4",{attrs:{id:"run-using-built-dll-requires-net-core-runtime-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#run-using-built-dll-requires-net-core-runtime-only"}},[e._v("#")]),e._v(" Run using built DLL (requires .NET Core Runtime only)")]),e._v(" "),t("p",[e._v("If you already have a compiled DLL, you can run the executable with the following command:\n"),t("code",[e._v("dotnet NBXplorer.dll ")])]),e._v(" "),t("h4",{attrs:{id:"sample-parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sample-parameters"}},[e._v("#")]),e._v(" Sample parameters")]),e._v(" "),t("p",[e._v("Running NBXplorer HTTP server on port 20300, connecting to the BTC mainnet node locally.\n"),t("code",[e._v("--port=20300 --network=mainnet --btcnodeendpoint=127.0.0.1:32939")])]),e._v(" "),t("p",[e._v("Running NBXplorer on testnet, supporting Bitcoin, Litecoin and Dash, using cookie authentication for BTC and LTC, and RPC username and password for Dash, connecting to all of them locally.\n"),t("code",[e._v("--chains=btc,ltc,dash --network=testnet --dashrpcuser=myuser --dashrpcpassword=mypassword")])]),e._v(" "),t("h3",{attrs:{id:"environment-variables"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#environment-variables"}},[e._v("#")]),e._v(" Environment variables")]),e._v(" "),t("p",[e._v("The same settings as above, for example "),t("code",[e._v("export NBXPLORER_PORT=20300")]),e._v(". This is usefull for configuring docker.")]),e._v(" "),t("h2",{attrs:{id:"how-to-run"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-run"}},[e._v("#")]),e._v(" How to Run")]),e._v(" "),t("h3",{attrs:{id:"command-line"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#command-line"}},[e._v("#")]),e._v(" Command Line")]),e._v(" "),t("p",[e._v("You can use the "),t("a",{attrs:{href:"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet",target:"_blank",rel:"noopener noreferrer"}},[e._v("dotnet"),t("OutboundLink")],1),e._v(" command which is part of .NET Core to run NBXplorer. To run from source you must have the .NET Core SDK installed e.g.\n"),t("code",[e._v("dotnet run NBXplorer.dll")]),e._v("\nAs described above you may add configuration parameters if desired.")]),e._v(" "),t("p",[e._v("If you have a compiled version of NBXplorer you should have a file in your build folder named NBXplorer.dll. This cannot itself be directly executed on the command line as it is not an executable file. Instead we can use the "),t("code",[e._v("dotnet")]),e._v(" runtime to execute the dll file.")]),e._v(" "),t("p",[e._v("e.g. "),t("code",[e._v("dotnet NBXplorer.dll")])]),e._v(" "),t("h2",{attrs:{id:"important-note"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#important-note"}},[e._v("#")]),e._v(" Important Note")]),e._v(" "),t("p",[e._v("This tool will only start scanning from the configured "),t("code",[e._v("startheight")]),e._v(". (By default, the height of the blockchain during your first run)\nThis means that you might not see old payments from your HD key.")]),e._v(" "),t("p",[e._v("If you need to see old payments, you need to configure "),t("code",[e._v("--[crypto]startheight")]),e._v(" to a specific height of your choice, then run it again with "),t("code",[e._v("--[crypto]rescan")]),e._v(", e.g.\n"),t("code",[e._v("./run.sh --chains=ltc --ltcrescan --ltcstartheight=101")])]),e._v(" "),t("h2",{attrs:{id:"how-to-query"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-query"}},[e._v("#")]),e._v(" How to query?")]),e._v(" "),t("h3",{attrs:{id:"using-postman"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-postman"}},[e._v("#")]),e._v(" Using Postman")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.getpostman.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("Postman"),t("OutboundLink")],1),e._v(" is a useful tool for testing and experimenting with REST API's.")]),e._v(" "),t("p",[e._v("You can test the "),t("RouterLink",{attrs:{to:"/NBXplorer/API/"}},[e._v("NBXplorer API")]),e._v(" quickly and easily using Postman.")],1),e._v(" "),t("p",[e._v("If you use cookie authentication (enabled by default) in your locally run NBXplorer, you need to set that up in Postman:")]),e._v(" "),t("ul",[t("li",[e._v("Run NBXplorer and locate you cookie file (NBXplorer will generate a new Cookie file each time it runs in "),t("RouterLink",{attrs:{to:"/NBXplorer/API/#authentication"}},[e._v("its default data folder")]),e._v(")")],1),e._v(" "),t("li",[e._v("In Postman create a new GET API test")]),e._v(" "),t("li",[e._v("In Authorization select "),t("em",[e._v("Basic Auth")]),e._v(", you should see 2 input boxes for username and password")]),e._v(" "),t("li",[e._v("Open your cookie file with a text editor e.g. Notepad on windows . You should see a cookie string e.g. "),t("code",[e._v("__cookie__:0ff9cd83a5ac7c19a6b56a3d1e7a5c96e113d42dba7720a1f72a3a5e8c4b6c66")])]),e._v(" "),t("li",[e._v("Back in Postman paste the "),t("code",[e._v("__cookie__")]),e._v(" part of your cookie file into username (whatever comes before the 😃")]),e._v(" "),t("li",[e._v("Paste the Hex string (after the : ) into the password box")]),e._v(" "),t("li",[e._v("Click the Update Request button in Postman - this will force Postman to generate the correct HTTP headers based on your cookie details")]),e._v(" "),t("li",[e._v("You should now see a new entry in the Headers section with a Key of "),t("em",[e._v("Authorization")]),e._v(" and Value of "),t("em",[e._v("Basic xxxxxxxxx")]),e._v(" where the string after "),t("code",[e._v("Basic")]),e._v(" will be your Base64 encoded username and password.")]),e._v(" "),t("li",[e._v("Enter the API URL you are going to test")])]),e._v(" "),t("p",[e._v("You can also disable authentication in NBXplorer for testing with the "),t("code",[e._v("--noauth")]),e._v(" parameter. This makes testing quicker:")]),e._v(" "),t("ul",[t("li",[e._v("Run NBXplorer with the "),t("code",[e._v("--noauth")]),e._v(" parameter")]),e._v(" "),t("li",[e._v("In Postman create a new GET API test")]),e._v(" "),t("li",[e._v("In Authorization select "),t("em",[e._v("No Auth")])]),e._v(" "),t("li",[e._v("Enter the API URL you are going to test")])]),e._v(" "),t("p",[e._v("You are now ready to test the API - it is easiest to start with something simple such as the fees endpoint e.g.")]),e._v(" "),t("p",[t("code",[e._v("http://localhost:24444/v1/cryptos/btc/fees/3")])]),e._v(" "),t("p",[e._v("this should return a JSON payload e.g.")]),e._v(" "),t("p",[e._v('{\n"feeRate": 9,\n"blockCount": 3\n}')]),e._v(" "),t("h2",{attrs:{id:"message-brokers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#message-brokers"}},[e._v("#")]),e._v(" Message Brokers")]),e._v(" "),t("h3",{attrs:{id:"azure-service-bus"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#azure-service-bus"}},[e._v("#")]),e._v(" Azure Service Bus")]),e._v(" "),t("p",[e._v("Support has been added for Azure Service Bus as a message broker. Currently 2 Queues and 2 Topics are supported")]),e._v(" "),t("h3",{attrs:{id:"queues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#queues"}},[e._v("#")]),e._v(" Queues")]),e._v(" "),t("ul",[t("li",[e._v("New Block")]),e._v(" "),t("li",[e._v("New Transaction")])]),e._v(" "),t("h3",{attrs:{id:"topics"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#topics"}},[e._v("#")]),e._v(" Topics")]),e._v(" "),t("ul",[t("li",[e._v("New Block")]),e._v(" "),t("li",[e._v("New Transaction")])]),e._v(" "),t("p",[e._v("Filters should be applied on the client, if required.")]),e._v(" "),t("p",[e._v("To activate Azure Service Bus Mesages you should add an Azure Service Bus Connection string to your config file or on the command line.")]),e._v(" "),t("ul",[t("li",[e._v("To use queues you should specify the queue names you wish to use")]),e._v(" "),t("li",[e._v("To use topics you should specify the topic names you wish to use")])]),e._v(" "),t("p",[e._v("You can use both queues and topics at the same time.")]),e._v(" "),t("h4",{attrs:{id:"config-settings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#config-settings"}},[e._v("#")]),e._v(" Config Settings")]),e._v(" "),t("p",[e._v("If you use the Configuration file to setup your NBXplorer options:")]),e._v(" "),t("div",{staticClass:"language-ini extra-class"},[t("pre",{pre:!0,attrs:{class:"language-ini"}},[t("code",[t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("asbcnstr")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Your Azure Service Bus Connection string")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("asbblockq")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of queue to send New Block message to")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("asbtranq")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of queue to send New Transaction message to")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("asbblockt")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of topic to send New Block message to")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("asbtrant")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of queue to send New Transaction message to")]),e._v("\n")])])]),t("h3",{attrs:{id:"rabbitmq"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rabbitmq"}},[e._v("#")]),e._v(" RabbitMq")]),e._v(" "),t("p",[e._v("Support has been added for RabbitMq as a message broker. Currently 2 exchanges supported;")]),e._v(" "),t("ul",[t("li",[e._v("New Block")]),e._v(" "),t("li",[e._v("New Transaction")])]),e._v(" "),t("p",[e._v("Filters can be applied on the client by defining routing keys;")]),e._v(" "),t("p",[e._v("For transactions;")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("transactions.#")]),e._v(" to get all transactions.")]),e._v(" "),t("li",[t("code",[e._v("transactions.[BTC].#")]),e._v(" to get all [Bitcoin] transactions.")]),e._v(" "),t("li",[t("code",[e._v("transactions.[BTC].confirmed")]),e._v(" to get only confirmed [Bitcoin] transactions.")]),e._v(" "),t("li",[t("code",[e._v("transactions.[BTC].unconfirmed")]),e._v(" to get only unconfirmed [Bitcoin] transactions.")]),e._v(" "),t("li",[t("code",[e._v("transactions.*.confirmed")]),e._v(" to get all confirmed transactions.")]),e._v(" "),t("li",[t("code",[e._v("transactions.*.unconfirmed")]),e._v(" to get all unconfirmed transactions.")])]),e._v(" "),t("p",[e._v("For blocks;")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("blocks.#")]),e._v(" to get all blocks.")]),e._v(" "),t("li",[t("code",[e._v("blocks.[BTC]")]),e._v(" to get all [Bitcoin] blocks.")])]),e._v(" "),t("p",[e._v("To activate RabbitMq mesages you should add following settings to your config file or on the command line.")]),e._v(" "),t("ul",[t("li",[e._v("rmqhost, rmquser, rmqpass")])]),e._v(" "),t("h4",{attrs:{id:"config-settings-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#config-settings-2"}},[e._v("#")]),e._v(" Config Settings")]),e._v(" "),t("p",[e._v("If you use the Configuration file to setup your NBXplorer options:")]),e._v(" "),t("div",{staticClass:"language-ini extra-class"},[t("pre",{pre:!0,attrs:{class:"language-ini"}},[t("code",[t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmqhost")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("RabbitMq host name")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmqvirtual")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("RabbitMq virtual host")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmquser")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("RabbitMq username")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmqpass")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("RabbitMq password")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmqtranex")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of exchange to send transaction messages")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmqblockex")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of exchange to send block messages")]),e._v("\n")])])]),t("p",[e._v("Payloads are JSON and map to "),t("code",[e._v("NewBlockEvent")]),e._v(", "),t("code",[e._v("NewTransactionEvent")]),e._v(" in the "),t("code",[e._v("NBXplorer.Models")]),e._v(" namespace. There is no support in NBXplorer client for message borkers at the current time. You will need to use the "),t("code",[e._v("Serializer")]),e._v(" in "),t("code",[e._v("NBXplorer.Client")]),e._v(" to de-serialize the objects or then implement your own JSON de-serializers for the custom types used in the payload.")]),e._v(" "),t("p",[e._v("For configuring serializers you can get crypto code info from "),t("code",[e._v("BasicProperties.Headers[CryptoCode]")]),e._v(" of RabbitMq messages or "),t("code",[e._v("UserProperties[CryptoCode]")]),e._v(" of Azure Service Bus messages.\nExamples can be found in unit tests.")]),e._v(" "),t("h4",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting")]),e._v(" "),t("p",[e._v("If you receive a 401 Unauthorized then your cookie data is not working. Check you are using the current cookie by opening the cookie file again - also check the date/time of the cookie file to ensure it is the latest cookie (generated when you launched NBXplorer).")]),e._v(" "),t("p",[e._v("If you receive a 404 or timeout then Postman cannot see the endpoint")]),e._v(" "),t("ul",[t("li",[e._v("are you using the correct Port ?")]),e._v(" "),t("li",[e._v("are you running postman on localhost ?")])]),e._v(" "),t("h2",{attrs:{id:"client-api"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#client-api"}},[e._v("#")]),e._v(" Client API")]),e._v(" "),t("p",[e._v("A better documentation is on the way, for now the only documentation is the client API in C# on "),t("a",{attrs:{href:"https://www.nuget.org/packages/NBxplorer.Client",target:"_blank",rel:"noopener noreferrer"}},[e._v("nuget"),t("OutboundLink")],1),e._v(".\nThe "),t("code",[e._v("ExplorerClient")]),e._v(" classes allows you to query unused addresses, and the UTXO of an HD PubKey.\nYou can take a look at "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer/blob/master/NBXplorer.Tests/UnitTest1.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("the tests"),t("OutboundLink")],1),e._v(" to see how it works.")]),e._v(" "),t("p",[e._v("There is a simple use case documented on "),t("a",{attrs:{href:"https://programmingblockchain.gitbooks.io/programmingblockchain/content/wallet/web-api.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("Blockchain Programming in C#"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"how-to-run-the-tests"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-run-the-tests"}},[e._v("#")]),e._v(" How to run the tests?")]),e._v(" "),t("p",[e._v("This is easy, from repo directory:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" NBXplorer.Tests\ndotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v("\n")])])]),t("p",[e._v("The tests can take long the first time, as it download Bitcoin Core binaries. (Between 5 and 10 minutes)")]),e._v(" "),t("h2",{attrs:{id:"how-to-add-support-to-my-altcoin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-add-support-to-my-altcoin"}},[e._v("#")]),e._v(" How to add support to my altcoin")]),e._v(" "),t("p",[e._v("First you need to add support for your altcoin to "),t("code",[e._v("NBitcoin.Altcoins")]),e._v(". (See "),t("a",{attrs:{href:"https://github.com/MetacoSA/NBitcoin/tree/master/NBitcoin.Altcoins",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(").")]),e._v(" "),t("p",[e._v("Once this is done and "),t("code",[e._v("NBXplorer")]),e._v(" updated to use the last version of "),t("code",[e._v("NBitcoin.Altcoins")]),e._v(", follow "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer/blob/master/NBXplorer.Client/NBXplorerNetworkProvider.Litecoin.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("Litecoin example"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("If you want to test if everything is working, modify "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer/blob/master/NBXplorer.Tests/ServerTester.Environment.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("ServerTester.Environment.cs"),t("OutboundLink")],1),e._v(" to match your altcoin.")]),e._v(" "),t("p",[e._v("Then run the tests.")]),e._v(" "),t("h2",{attrs:{id:"licence"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#licence"}},[e._v("#")]),e._v(" Licence")]),e._v(" "),t("p",[e._v("This project is under MIT License.")]),e._v(" "),t("h2",{attrs:{id:"special-thanks"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#special-thanks"}},[e._v("#")]),e._v(" Special thanks")]),e._v(" "),t("p",[e._v("Special thanks to Digital Garage for allowing me to open source the project, which is based on an internal work I have done on Elements.")]),e._v(" "),t("p",[e._v("Thanks to the DG Lab Blockchain Team who had to fight with lots of bugs. (in particular kallewoof :p)")]),e._v(" "),t("p",[e._v("Thanks to Metaco SA, whose constant challenging projects refine my taste on what a perfect Bitcoin API should be.")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[131],{769:function(e,t,a){"use strict";a.r(t);var o=a(9),r=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"nbxplorer"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#nbxplorer"}},[e._v("#")]),e._v(" NBXplorer")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.nuget.org/packages/NBxplorer.Client",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.shields.io/nuget/v/NBxplorer.Client.svg",alt:"NuGet",title:"NuGet"}}),t("OutboundLink")],1),e._v(" "),t("a",{attrs:{href:"https://hub.docker.com/r/nicolasdorier/nbxplorer/",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://img.shields.io/docker/automated/jrottenberg/ffmpeg.svg",alt:"Docker Automated buil",title:"Docker Automated buil"}}),t("OutboundLink")],1),e._v(" "),t("a",{attrs:{href:"https://circleci.com/gh/dgarage/NBXplorer",target:"_blank",rel:"noopener noreferrer"}},[t("img",{attrs:{src:"https://circleci.com/gh/dgarage/NBXplorer.svg?style=svg",alt:"CircleCI",title:"CircleCI"}}),t("OutboundLink")],1)]),e._v(" "),t("p",[e._v("A minimalist UTXO tracker for HD Wallets.\nThe goal is to have a flexible, .NET based UTXO tracker for HD wallets.\nThe explorer supports P2SH,P2PKH,P2WPKH,P2WSH and Multi-sig derivation.")]),e._v(" "),t("p",[e._v("This explorer is not meant to be exposed on internet, but should be used as an internal tool for tracking the UTXOs of your own service.")]),e._v(" "),t("p",[e._v("It has a bunch of features:")]),e._v(" "),t("ul",[t("li",[e._v("Can pass arguments via environment variable, command line or configuration file")]),e._v(" "),t("li",[e._v("Automatically reconnect to your node if the connection goes temporarily down")]),e._v(" "),t("li",[e._v("An easy to use REST API")]),e._v(" "),t("li",[e._v("Persistence (via in-file no-SQL datbase called DBreeze or Postgres)")]),e._v(" "),t("li",[e._v("Connect via RPC to broadcast transaction instead of using the P2P protocol like this example")]),e._v(" "),t("li",[e._v("Connect via RPC to your trusted node to get the proper fee rate.")]),e._v(" "),t("li",[e._v("Altcoin support")]),e._v(" "),t("li",[e._v("Huge test suite")]),e._v(" "),t("li",[e._v("Pruning of transaction data (in practice, we don't need to save the whole transaction, only the spent outpoint and received coin for the wallet)")]),e._v(" "),t("li",[e._v("Multi-wallet")]),e._v(" "),t("li",[e._v("Flexible address generation schemes (multisig, segwit, legacy etc...)")]),e._v(" "),t("li",[e._v("Pruning for big wallets (Removal of tracked transaction which do not impact the resulting UTXO set)")])]),e._v(" "),t("p",[e._v("It currently supports the following altcoins:")]),e._v(" "),t("ul",[t("li",[e._v("Althash")]),e._v(" "),t("li",[e._v("Argoneum")]),e._v(" "),t("li",[e._v("BCash (also known as Bitcoin Cash)")]),e._v(" "),t("li",[e._v("BGold (also known as Bitcoin Gold)")]),e._v(" "),t("li",[e._v("BitCore")]),e._v(" "),t("li",[e._v("Chaincoin")]),e._v(" "),t("li",[e._v("ColossusXT")]),e._v(" "),t("li",[e._v("Dash")]),e._v(" "),t("li",[e._v("Dogecoin")]),e._v(" "),t("li",[e._v("Feathercoin")]),e._v(" "),t("li",[e._v("Gobyte")]),e._v(" "),t("li",[e._v("Groestlcoin")]),e._v(" "),t("li",[e._v("Litecoin")]),e._v(" "),t("li",[e._v("Monacoin")]),e._v(" "),t("li",[e._v("MonetaryUnit")]),e._v(" "),t("li",[e._v("Monoeci")]),e._v(" "),t("li",[e._v("Polis")]),e._v(" "),t("li",[e._v("Qtum")]),e._v(" "),t("li",[e._v("Terracoin")]),e._v(" "),t("li",[e._v("Ufo")]),e._v(" "),t("li",[e._v("Viacoin")])]),e._v(" "),t("p",[e._v("Read our "),t("RouterLink",{attrs:{to:"/NBXplorer/API/"}},[e._v("API Specification")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"prerequisite"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#prerequisite"}},[e._v("#")]),e._v(" Prerequisite")]),e._v(" "),t("ul",[t("li",[e._v("Install "),t("a",{attrs:{href:"https://www.microsoft.com/net/download",target:"_blank",rel:"noopener noreferrer"}},[e._v(".NET Core SDK v6.0 or above"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("Bitcoin Core instance synched and running (at least 0.16.0).")]),e._v(" "),t("li",[e._v("PostgresSQL v13+ (Technically 11+ works, but you may have performance issues at higher scale)")])]),e._v(" "),t("p",[e._v("There are two backend available:")]),e._v(" "),t("ul",[t("li",[e._v("DBTrie (with the "),t("code",[e._v("--dbtrie")]),e._v(" flag)")]),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/NBXplorer/Postgres-Schema/"}},[e._v("Postgres")]),e._v(" (with the "),t("code",[e._v("--postgres")]),e._v(" flags)")],1)]),e._v(" "),t("p",[e._v("However, "),t("code",[e._v("DBTrie")]),e._v(" is now deprecated. We will continue to support it to give more time for our users "),t("RouterLink",{attrs:{to:"/NBXplorer/Postgres-Migration/"}},[e._v("to migrate")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"api-specification"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#api-specification"}},[e._v("#")]),e._v(" API Specification")]),e._v(" "),t("p",[e._v("Read our "),t("RouterLink",{attrs:{to:"/NBXplorer/API/"}},[e._v("API Specification")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"how-to-build-and-run"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-build-and-run"}},[e._v("#")]),e._v(" How to build and run?")]),e._v(" "),t("p",[e._v("If you are using Bitcoin core default settings:")]),e._v(" "),t("p",[e._v("On Powershell:")]),e._v(" "),t("div",{staticClass:"language-pwsh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(".\\build.ps1\n")])])]),t("p",[e._v("On Linux:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("./build.sh\n")])])]),t("p",[e._v("Then to run:")]),e._v(" "),t("p",[e._v("On Powershell:")]),e._v(" "),t("div",{staticClass:"language-pwsh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v(".\\run.ps1 --help\n")])])]),t("p",[e._v("On Linux:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("./run.sh --help\n")])])]),t("p",[e._v("Example, if you have ltc node and btc node on regtest (default configuration), and want to connect to them: (see documentation for other options in the "),t("a",{attrs:{href:"https://www.npgsql.org/doc/connection-string-parameters.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("postgres connection string"),t("OutboundLink")],1),e._v(")")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("./run.sh --chains"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("btc,ltc --network"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),e._v("regtest --postgres "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"User ID=postgres;Host=127.0.0.1;Port=39382;Database=nbxplorer"')]),e._v("\n")])])]),t("h2",{attrs:{id:"how-to-use-the-api"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-use-the-api"}},[e._v("#")]),e._v(" How to use the API?")]),e._v(" "),t("p",[e._v("Check "),t("RouterLink",{attrs:{to:"/NBXplorer/API/"}},[e._v("the API documentation")]),e._v(", you can then use any client library:")],1),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/junderw/NBXplorer.NodeJS",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBXplorer.NodeJS"),t("OutboundLink")],1),e._v(" for NodeJS clients.")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.nuget.org/packages/NBxplorer.Client",target:"_blank",rel:"noopener noreferrer"}},[e._v("NBXplorer.Client"),t("OutboundLink")],1),e._v(" for .NET clients.")])]),e._v(" "),t("p",[e._v("Here is "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer/blob/master/Examples/MultiSig/Program.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("a small C# example"),t("OutboundLink")],1),e._v(" showing a 2-2 multisig with Alice and Bob that you can run on regtest.")]),e._v(" "),t("h2",{attrs:{id:"with-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#with-docker"}},[e._v("#")]),e._v(" With Docker")]),e._v(" "),t("p",[e._v("Use "),t("a",{attrs:{href:"https://hub.docker.com/r/nicolasdorier/nbxplorer/",target:"_blank",rel:"noopener noreferrer"}},[e._v("our image"),t("OutboundLink")],1),e._v(".\nYou can check "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer/blob/master/docker-compose.regtest.yml",target:"_blank",rel:"noopener noreferrer"}},[e._v("the sample"),t("OutboundLink")],1),e._v(" for configuring and composing it bitcoin core.")]),e._v(" "),t("h2",{attrs:{id:"how-to-develop-on-it"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-develop-on-it"}},[e._v("#")]),e._v(" How to develop on it?")]),e._v(" "),t("p",[e._v("If you are on Windows, I recommend Visual Studio 2017 update 4 (15.4).\nIf you are on other platform and want lightweight environment, use "),t("a",{attrs:{href:"https://code.visualstudio.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Visual Studio Code"),t("OutboundLink")],1),e._v(".\nIf you are hardcore, you can code on vim.")]),e._v(" "),t("p",[e._v("I like Visual Studio Code and Visual Studio 2017 as it allows me to debug in step by step.")]),e._v(" "),t("h2",{attrs:{id:"how-to-configure"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-configure"}},[e._v("#")]),e._v(" How to configure?")]),e._v(" "),t("p",[e._v("NBXplorer supports configuration through command line arguments, configuration file, or environment variables.")]),e._v(" "),t("h3",{attrs:{id:"configuration-file"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configuration-file"}},[e._v("#")]),e._v(" Configuration file")]),e._v(" "),t("p",[e._v("If you are not using standard install for bitcoind, you will have to change the configuration file:\nIn Windows it is located in")]),e._v(" "),t("div",{staticClass:"language-pwsh extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("C:\\Users\\\\AppData\\Roaming\\NBXplorer\\\\settings.config\n")])])]),t("p",[e._v("On linux or mac:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("~/.nbxplorer/"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("network"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("/settings.config\n")])])]),t("p",[e._v("The default configuration assumes "),t("code",[e._v("mainnet")]),e._v(" with only "),t("code",[e._v("btc")]),e._v(" chain supported, and uses the default settings of bitcoind.")]),e._v(" "),t("p",[e._v("You can change the location of the configuration file with the "),t("code",[e._v("--conf=pathToConf")]),e._v(" command line argument.")]),e._v(" "),t("h3",{attrs:{id:"command-line-parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#command-line-parameters"}},[e._v("#")]),e._v(" Command line parameters")]),e._v(" "),t("p",[e._v("Please note that NBXplorer uses cookie authentication by default. If you run your Bitcoin/Litecoin/Dash nodes using their daemon (like "),t("code",[e._v("bitcoind")]),e._v(", "),t("code",[e._v("litecoind")]),e._v(" or "),t("code",[e._v("dashd")]),e._v("), they generate a new cookie every time you start them, and that should work without any extra configuration.\nIf you run the node(s) using the GUI versions, like Bitcoin\\Litecoin\\Dash Core Qt with the "),t("code",[e._v("-server")]),e._v(" parameter while you set the rpcusername and rpcpassword in their "),t("code",[e._v(".conf")]),e._v(" files, you must set those values for every crypto you are planning to support.\nSee samples below.")]),e._v(" "),t("h4",{attrs:{id:"run-from-source-requires-net-core-sdk"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#run-from-source-requires-net-core-sdk"}},[e._v("#")]),e._v(" Run from source (requires .NET Core SDK)")]),e._v(" "),t("p",[e._v("You should use "),t("code",[e._v("run.ps1")]),e._v(" (Windows) or "),t("code",[e._v("run.sh")]),e._v(" (Linux) to execute NBXplorer, but you can also execute it manually with the following command:\n"),t("code",[e._v("dotnet run --no-launch-profile -p .\\NBXplorer\\NBXplorer.csproj -- ")])]),e._v(" "),t("h4",{attrs:{id:"run-using-built-dll-requires-net-core-runtime-only"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#run-using-built-dll-requires-net-core-runtime-only"}},[e._v("#")]),e._v(" Run using built DLL (requires .NET Core Runtime only)")]),e._v(" "),t("p",[e._v("If you already have a compiled DLL, you can run the executable with the following command:\n"),t("code",[e._v("dotnet NBXplorer.dll ")])]),e._v(" "),t("h4",{attrs:{id:"sample-parameters"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sample-parameters"}},[e._v("#")]),e._v(" Sample parameters")]),e._v(" "),t("p",[e._v("Running NBXplorer HTTP server on port 20300, connecting to the BTC mainnet node locally.\n"),t("code",[e._v("--port=20300 --network=mainnet --btcnodeendpoint=127.0.0.1:32939")])]),e._v(" "),t("p",[e._v("Running NBXplorer on testnet, supporting Bitcoin, Litecoin and Dash, using cookie authentication for BTC and LTC, and RPC username and password for Dash, connecting to all of them locally.\n"),t("code",[e._v("--chains=btc,ltc,dash --network=testnet --dashrpcuser=myuser --dashrpcpassword=mypassword")])]),e._v(" "),t("h3",{attrs:{id:"environment-variables"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#environment-variables"}},[e._v("#")]),e._v(" Environment variables")]),e._v(" "),t("p",[e._v("The same settings as above, for example "),t("code",[e._v("export NBXPLORER_PORT=20300")]),e._v(". This is usefull for configuring docker.")]),e._v(" "),t("h2",{attrs:{id:"how-to-run"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-run"}},[e._v("#")]),e._v(" How to Run")]),e._v(" "),t("h3",{attrs:{id:"command-line"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#command-line"}},[e._v("#")]),e._v(" Command Line")]),e._v(" "),t("p",[e._v("You can use the "),t("a",{attrs:{href:"https://docs.microsoft.com/en-us/dotnet/core/tools/dotnet",target:"_blank",rel:"noopener noreferrer"}},[e._v("dotnet"),t("OutboundLink")],1),e._v(" command which is part of .NET Core to run NBXplorer. To run from source you must have the .NET Core SDK installed e.g.\n"),t("code",[e._v("dotnet run NBXplorer.dll")]),e._v("\nAs described above you may add configuration parameters if desired.")]),e._v(" "),t("p",[e._v("If you have a compiled version of NBXplorer you should have a file in your build folder named NBXplorer.dll. This cannot itself be directly executed on the command line as it is not an executable file. Instead we can use the "),t("code",[e._v("dotnet")]),e._v(" runtime to execute the dll file.")]),e._v(" "),t("p",[e._v("e.g. "),t("code",[e._v("dotnet NBXplorer.dll")])]),e._v(" "),t("h2",{attrs:{id:"important-note"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#important-note"}},[e._v("#")]),e._v(" Important Note")]),e._v(" "),t("p",[e._v("This tool will only start scanning from the configured "),t("code",[e._v("startheight")]),e._v(". (By default, the height of the blockchain during your first run)\nThis means that you might not see old payments from your HD key.")]),e._v(" "),t("p",[e._v("If you need to see old payments, you need to configure "),t("code",[e._v("--[crypto]startheight")]),e._v(" to a specific height of your choice, then run it again with "),t("code",[e._v("--[crypto]rescan")]),e._v(", e.g.\n"),t("code",[e._v("./run.sh --chains=ltc --ltcrescan --ltcstartheight=101")])]),e._v(" "),t("h2",{attrs:{id:"how-to-query"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-query"}},[e._v("#")]),e._v(" How to query?")]),e._v(" "),t("h3",{attrs:{id:"using-postman"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#using-postman"}},[e._v("#")]),e._v(" Using Postman")]),e._v(" "),t("p",[t("a",{attrs:{href:"https://www.getpostman.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("Postman"),t("OutboundLink")],1),e._v(" is a useful tool for testing and experimenting with REST API's.")]),e._v(" "),t("p",[e._v("You can test the "),t("RouterLink",{attrs:{to:"/NBXplorer/API/"}},[e._v("NBXplorer API")]),e._v(" quickly and easily using Postman.")],1),e._v(" "),t("p",[e._v("If you use cookie authentication (enabled by default) in your locally run NBXplorer, you need to set that up in Postman:")]),e._v(" "),t("ul",[t("li",[e._v("Run NBXplorer and locate you cookie file (NBXplorer will generate a new Cookie file each time it runs in "),t("RouterLink",{attrs:{to:"/NBXplorer/API/#authentication"}},[e._v("its default data folder")]),e._v(")")],1),e._v(" "),t("li",[e._v("In Postman create a new GET API test")]),e._v(" "),t("li",[e._v("In Authorization select "),t("em",[e._v("Basic Auth")]),e._v(", you should see 2 input boxes for username and password")]),e._v(" "),t("li",[e._v("Open your cookie file with a text editor e.g. Notepad on windows . You should see a cookie string e.g. "),t("code",[e._v("__cookie__:0ff9cd83a5ac7c19a6b56a3d1e7a5c96e113d42dba7720a1f72a3a5e8c4b6c66")])]),e._v(" "),t("li",[e._v("Back in Postman paste the "),t("code",[e._v("__cookie__")]),e._v(" part of your cookie file into username (whatever comes before the 😃")]),e._v(" "),t("li",[e._v("Paste the Hex string (after the : ) into the password box")]),e._v(" "),t("li",[e._v("Click the Update Request button in Postman - this will force Postman to generate the correct HTTP headers based on your cookie details")]),e._v(" "),t("li",[e._v("You should now see a new entry in the Headers section with a Key of "),t("em",[e._v("Authorization")]),e._v(" and Value of "),t("em",[e._v("Basic xxxxxxxxx")]),e._v(" where the string after "),t("code",[e._v("Basic")]),e._v(" will be your Base64 encoded username and password.")]),e._v(" "),t("li",[e._v("Enter the API URL you are going to test")])]),e._v(" "),t("p",[e._v("You can also disable authentication in NBXplorer for testing with the "),t("code",[e._v("--noauth")]),e._v(" parameter. This makes testing quicker:")]),e._v(" "),t("ul",[t("li",[e._v("Run NBXplorer with the "),t("code",[e._v("--noauth")]),e._v(" parameter")]),e._v(" "),t("li",[e._v("In Postman create a new GET API test")]),e._v(" "),t("li",[e._v("In Authorization select "),t("em",[e._v("No Auth")])]),e._v(" "),t("li",[e._v("Enter the API URL you are going to test")])]),e._v(" "),t("p",[e._v("You are now ready to test the API - it is easiest to start with something simple such as the fees endpoint e.g.")]),e._v(" "),t("p",[t("code",[e._v("http://localhost:24444/v1/cryptos/btc/fees/3")])]),e._v(" "),t("p",[e._v("this should return a JSON payload e.g.")]),e._v(" "),t("p",[e._v('{\n"feeRate": 9,\n"blockCount": 3\n}')]),e._v(" "),t("h2",{attrs:{id:"message-brokers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#message-brokers"}},[e._v("#")]),e._v(" Message Brokers")]),e._v(" "),t("h3",{attrs:{id:"azure-service-bus"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#azure-service-bus"}},[e._v("#")]),e._v(" Azure Service Bus")]),e._v(" "),t("p",[e._v("Support has been added for Azure Service Bus as a message broker. Currently 2 Queues and 2 Topics are supported")]),e._v(" "),t("h3",{attrs:{id:"queues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#queues"}},[e._v("#")]),e._v(" Queues")]),e._v(" "),t("ul",[t("li",[e._v("New Block")]),e._v(" "),t("li",[e._v("New Transaction")])]),e._v(" "),t("h3",{attrs:{id:"topics"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#topics"}},[e._v("#")]),e._v(" Topics")]),e._v(" "),t("ul",[t("li",[e._v("New Block")]),e._v(" "),t("li",[e._v("New Transaction")])]),e._v(" "),t("p",[e._v("Filters should be applied on the client, if required.")]),e._v(" "),t("p",[e._v("To activate Azure Service Bus Mesages you should add an Azure Service Bus Connection string to your config file or on the command line.")]),e._v(" "),t("ul",[t("li",[e._v("To use queues you should specify the queue names you wish to use")]),e._v(" "),t("li",[e._v("To use topics you should specify the topic names you wish to use")])]),e._v(" "),t("p",[e._v("You can use both queues and topics at the same time.")]),e._v(" "),t("h4",{attrs:{id:"config-settings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#config-settings"}},[e._v("#")]),e._v(" Config Settings")]),e._v(" "),t("p",[e._v("If you use the Configuration file to setup your NBXplorer options:")]),e._v(" "),t("div",{staticClass:"language-ini extra-class"},[t("pre",{pre:!0,attrs:{class:"language-ini"}},[t("code",[t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("asbcnstr")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Your Azure Service Bus Connection string")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("asbblockq")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of queue to send New Block message to")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("asbtranq")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of queue to send New Transaction message to")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("asbblockt")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of topic to send New Block message to")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("asbtrant")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of queue to send New Transaction message to")]),e._v("\n")])])]),t("h3",{attrs:{id:"rabbitmq"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#rabbitmq"}},[e._v("#")]),e._v(" RabbitMq")]),e._v(" "),t("p",[e._v("Support has been added for RabbitMq as a message broker. Currently 2 exchanges supported;")]),e._v(" "),t("ul",[t("li",[e._v("New Block")]),e._v(" "),t("li",[e._v("New Transaction")])]),e._v(" "),t("p",[e._v("Filters can be applied on the client by defining routing keys;")]),e._v(" "),t("p",[e._v("For transactions;")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("transactions.#")]),e._v(" to get all transactions.")]),e._v(" "),t("li",[t("code",[e._v("transactions.[BTC].#")]),e._v(" to get all [Bitcoin] transactions.")]),e._v(" "),t("li",[t("code",[e._v("transactions.[BTC].confirmed")]),e._v(" to get only confirmed [Bitcoin] transactions.")]),e._v(" "),t("li",[t("code",[e._v("transactions.[BTC].unconfirmed")]),e._v(" to get only unconfirmed [Bitcoin] transactions.")]),e._v(" "),t("li",[t("code",[e._v("transactions.*.confirmed")]),e._v(" to get all confirmed transactions.")]),e._v(" "),t("li",[t("code",[e._v("transactions.*.unconfirmed")]),e._v(" to get all unconfirmed transactions.")])]),e._v(" "),t("p",[e._v("For blocks;")]),e._v(" "),t("ul",[t("li",[t("code",[e._v("blocks.#")]),e._v(" to get all blocks.")]),e._v(" "),t("li",[t("code",[e._v("blocks.[BTC]")]),e._v(" to get all [Bitcoin] blocks.")])]),e._v(" "),t("p",[e._v("To activate RabbitMq mesages you should add following settings to your config file or on the command line.")]),e._v(" "),t("ul",[t("li",[e._v("rmqhost, rmquser, rmqpass")])]),e._v(" "),t("h4",{attrs:{id:"config-settings-2"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#config-settings-2"}},[e._v("#")]),e._v(" Config Settings")]),e._v(" "),t("p",[e._v("If you use the Configuration file to setup your NBXplorer options:")]),e._v(" "),t("div",{staticClass:"language-ini extra-class"},[t("pre",{pre:!0,attrs:{class:"language-ini"}},[t("code",[t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmqhost")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("RabbitMq host name")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmqvirtual")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("RabbitMq virtual host")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmquser")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("RabbitMq username")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmqpass")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("RabbitMq password")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmqtranex")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of exchange to send transaction messages")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token key attr-name"}},[e._v("rmqblockex")]),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("=")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token value attr-value"}},[e._v("Name of exchange to send block messages")]),e._v("\n")])])]),t("p",[e._v("Payloads are JSON and map to "),t("code",[e._v("NewBlockEvent")]),e._v(", "),t("code",[e._v("NewTransactionEvent")]),e._v(" in the "),t("code",[e._v("NBXplorer.Models")]),e._v(" namespace. There is no support in NBXplorer client for message borkers at the current time. You will need to use the "),t("code",[e._v("Serializer")]),e._v(" in "),t("code",[e._v("NBXplorer.Client")]),e._v(" to de-serialize the objects or then implement your own JSON de-serializers for the custom types used in the payload.")]),e._v(" "),t("p",[e._v("For configuring serializers you can get crypto code info from "),t("code",[e._v("BasicProperties.Headers[CryptoCode]")]),e._v(" of RabbitMq messages or "),t("code",[e._v("UserProperties[CryptoCode]")]),e._v(" of Azure Service Bus messages.\nExamples can be found in unit tests.")]),e._v(" "),t("h4",{attrs:{id:"troubleshooting"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting"}},[e._v("#")]),e._v(" Troubleshooting")]),e._v(" "),t("p",[e._v("If you receive a 401 Unauthorized then your cookie data is not working. Check you are using the current cookie by opening the cookie file again - also check the date/time of the cookie file to ensure it is the latest cookie (generated when you launched NBXplorer).")]),e._v(" "),t("p",[e._v("If you receive a 404 or timeout then Postman cannot see the endpoint")]),e._v(" "),t("ul",[t("li",[e._v("are you using the correct Port ?")]),e._v(" "),t("li",[e._v("are you running postman on localhost ?")])]),e._v(" "),t("h2",{attrs:{id:"client-api"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#client-api"}},[e._v("#")]),e._v(" Client API")]),e._v(" "),t("p",[e._v("A better documentation is on the way, for now the only documentation is the client API in C# on "),t("a",{attrs:{href:"https://www.nuget.org/packages/NBxplorer.Client",target:"_blank",rel:"noopener noreferrer"}},[e._v("nuget"),t("OutboundLink")],1),e._v(".\nThe "),t("code",[e._v("ExplorerClient")]),e._v(" classes allows you to query unused addresses, and the UTXO of an HD PubKey.\nYou can take a look at "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer/blob/master/NBXplorer.Tests/UnitTest1.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("the tests"),t("OutboundLink")],1),e._v(" to see how it works.")]),e._v(" "),t("p",[e._v("There is a simple use case documented on "),t("a",{attrs:{href:"https://programmingblockchain.gitbooks.io/programmingblockchain/content/wallet/web-api.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("Blockchain Programming in C#"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"how-to-run-the-tests"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-run-the-tests"}},[e._v("#")]),e._v(" How to run the tests?")]),e._v(" "),t("p",[e._v("This is easy, from repo directory:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" NBXplorer.Tests\ndotnet "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("test")]),e._v("\n")])])]),t("p",[e._v("The tests can take long the first time, as it download Bitcoin Core binaries. (Between 5 and 10 minutes)")]),e._v(" "),t("h2",{attrs:{id:"how-to-add-support-to-my-altcoin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-add-support-to-my-altcoin"}},[e._v("#")]),e._v(" How to add support to my altcoin")]),e._v(" "),t("p",[e._v("First you need to add support for your altcoin to "),t("code",[e._v("NBitcoin.Altcoins")]),e._v(". (See "),t("a",{attrs:{href:"https://github.com/MetacoSA/NBitcoin/tree/master/NBitcoin.Altcoins",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1),e._v(").")]),e._v(" "),t("p",[e._v("Once this is done and "),t("code",[e._v("NBXplorer")]),e._v(" updated to use the last version of "),t("code",[e._v("NBitcoin.Altcoins")]),e._v(", follow "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer/blob/master/NBXplorer.Client/NBXplorerNetworkProvider.Litecoin.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("Litecoin example"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("p",[e._v("If you want to test if everything is working, modify "),t("a",{attrs:{href:"https://github.com/dgarage/NBXplorer/blob/master/NBXplorer.Tests/ServerTester.Environment.cs",target:"_blank",rel:"noopener noreferrer"}},[e._v("ServerTester.Environment.cs"),t("OutboundLink")],1),e._v(" to match your altcoin.")]),e._v(" "),t("p",[e._v("Then run the tests.")]),e._v(" "),t("h2",{attrs:{id:"licence"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#licence"}},[e._v("#")]),e._v(" Licence")]),e._v(" "),t("p",[e._v("This project is under MIT License.")]),e._v(" "),t("h2",{attrs:{id:"special-thanks"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#special-thanks"}},[e._v("#")]),e._v(" Special thanks")]),e._v(" "),t("p",[e._v("Special thanks to Digital Garage for allowing me to open source the project, which is based on an internal work I have done on Elements.")]),e._v(" "),t("p",[e._v("Thanks to the DG Lab Blockchain Team who had to fight with lots of bugs. (in particular kallewoof :p)")]),e._v(" "),t("p",[e._v("Thanks to Metaco SA, whose constant challenging projects refine my taste on what a perfect Bitcoin API should be.")])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/132.9c8da670.js b/assets/js/132.a45f8bd8.js similarity index 96% rename from assets/js/132.9c8da670.js rename to assets/js/132.a45f8bd8.js index 5a4467578a..39df433b22 100644 --- a/assets/js/132.9c8da670.js +++ b/assets/js/132.a45f8bd8.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[132],{771:function(e,t,r){"use strict";r.r(t);var o=r(9),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"btcpay-server-nip05-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-server-nip05-support"}},[e._v("#")]),e._v(" BTCPay Server NIP05 Support")]),e._v(" "),t("p",[e._v("This plugin allows your BTCPay Server to support the "),t("a",{attrs:{href:"https://github.com/nostr-protocol/nostr",target:"_blank",rel:"noopener noreferrer"}},[e._v("Nostr"),t("OutboundLink")],1),t("a",{attrs:{href:"https://github.com/nostr-protocol/nips/blob/master/05.md",target:"_blank",rel:"noopener noreferrer"}},[e._v(" NIP05 protocol"),t("OutboundLink")],1),e._v(" to verify accounts.")]),e._v(" "),t("h2",{attrs:{id:"usage"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usage"}},[e._v("#")]),e._v(" Usage")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Install the plugin")])]),e._v(" "),t("li",[t("p",[e._v('On a store you have owner access to, click on the new "NIP05" side navigation menu item')])]),e._v(" "),t("li",[t("p",[e._v("Specify a name and public key.\nNOTE: You will not be able to select the same name across different stores. The public key is in hex format and not "),t("code",[e._v("npub...")])])]),e._v(" "),t("li",[t("p",[e._v("Optionally include a set of relays that you primarily use so that client can discover your events more easily.")])]),e._v(" "),t("li",[t("p",[e._v("Alternatively, you can import this data by using one of the Nostr browser extensions such as Alby or Nos2x")])])]),e._v(" "),t("p",[e._v("Your NIP5 handle will be "),t("code",[e._v("name@yourbtcpayserver.domain")]),e._v(". If you have multiple domains mapped to the same btcpayserver, they will all be valid.")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[132],{772:function(e,t,r){"use strict";r.r(t);var o=r(9),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"btcpay-server-nip05-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-server-nip05-support"}},[e._v("#")]),e._v(" BTCPay Server NIP05 Support")]),e._v(" "),t("p",[e._v("This plugin allows your BTCPay Server to support the "),t("a",{attrs:{href:"https://github.com/nostr-protocol/nostr",target:"_blank",rel:"noopener noreferrer"}},[e._v("Nostr"),t("OutboundLink")],1),t("a",{attrs:{href:"https://github.com/nostr-protocol/nips/blob/master/05.md",target:"_blank",rel:"noopener noreferrer"}},[e._v(" NIP05 protocol"),t("OutboundLink")],1),e._v(" to verify accounts.")]),e._v(" "),t("h2",{attrs:{id:"usage"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usage"}},[e._v("#")]),e._v(" Usage")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Install the plugin")])]),e._v(" "),t("li",[t("p",[e._v('On a store you have owner access to, click on the new "NIP05" side navigation menu item')])]),e._v(" "),t("li",[t("p",[e._v("Specify a name and public key.\nNOTE: You will not be able to select the same name across different stores. The public key is in hex format and not "),t("code",[e._v("npub...")])])]),e._v(" "),t("li",[t("p",[e._v("Optionally include a set of relays that you primarily use so that client can discover your events more easily.")])]),e._v(" "),t("li",[t("p",[e._v("Alternatively, you can import this data by using one of the Nostr browser extensions such as Alby or Nos2x")])])]),e._v(" "),t("p",[e._v("Your NIP5 handle will be "),t("code",[e._v("name@yourbtcpayserver.domain")]),e._v(". If you have multiple domains mapped to the same btcpayserver, they will all be valid.")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/133.55d129fe.js b/assets/js/133.ef61935a.js similarity index 99% rename from assets/js/133.55d129fe.js rename to assets/js/133.ef61935a.js index 12bd8e88e3..3cfbbef0bd 100644 --- a/assets/js/133.55d129fe.js +++ b/assets/js/133.ef61935a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[133],{805:function(t,r,a){"use strict";a.r(r);var e=a(9),l=Object(e.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("div",{staticClass:"topics"},[r("h3",[t._v("Explore by topic")]),t._v(" "),r("ul",[r("li",[r("RouterLink",{attrs:{to:"/Guide/"}},[t._v("What is BTCPay Server")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/UseCase/"}},[t._v("Why BTCPay Server")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/TryItOut/"}},[t._v("How to deploy BTCPay Server")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/WalletSetup/"}},[t._v("Wallet Setup")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/LightningNetwork/"}},[t._v("Lightning Network")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/Apps/#point-of-sale-app"}},[t._v("How to setup POS")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/Development/GreenFieldExample/"}},[t._v("Greenfield API")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/FAQ/"}},[t._v("Frequently Asked Questions"),r("br"),t._v("and Common Issues")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/Contribute/"}},[t._v("How to contribute to BTCPay Server")])],1)])]),t._v(" "),r("svg",{attrs:{width:"0",height:"0",xmlns:"http://www.w3.org/2000/svg"}},[r("defs",[r("linearGradient",{attrs:{id:"spiral-gradient",x1:"81.36",y1:"311.35",x2:"541.35",y2:"311.35",gradientUnits:"userSpaceOnUse"}},[r("stop",{attrs:{offset:".18","stop-color":"#00f"}}),r("stop",{attrs:{offset:"1","stop-color":"#f0f"}})],1),t._v(" "),r("radialGradient",{attrs:{id:"acinq-a",cx:"47.833",cy:"51.834",r:"56.832"}},[r("stop",{attrs:{offset:"0","stop-color":"#fff"}}),r("stop",{attrs:{offset:"1","stop-color":"#fff","stop-opacity":"0"}})],1)],1),t._v(" "),r("symbol",{attrs:{id:"supporter-spiral",viewBox:"0 0 629 629"}},[r("path",{attrs:{d:"M326.4 572.09C201.2 572.09 141 503 112.48 445c-28.22-57.53-30.59-114.56-30.79-122.69-4.85-77 41-231.78 249.58-271.2a28.05 28.05 0 0 1 10.41 55.13c-213.12 40.28-204.44 206-204 213 0 .53.06 1.06.07 1.6.15 7.9 5.1 195.16 188.65 195.16 68.34 0 116.6-29.4 143.6-87.37 24.48-52.74 19.29-112.45-13.52-155.83-22.89-30.27-52.46-45-90.38-45-34.46 0-63.47 9.88-86.21 29.37A91.5 91.5 0 0 0 248 322.3c-1.41 25.4 7.14 49.36 24.07 67.49C287.27 406 305 413.9 326.4 413.9c27.46 0 45.52-9 53.66-26.81 8.38-18.3 3.61-38.93-.19-43.33-9.11-10-18.69-13.68-22.48-13-2.53.43-5.78 4.61-8.48 10.92a28 28 0 0 1-51.58-22c14.28-33.44 37.94-42 50.76-44.2 24.78-4.18 52.17 7.3 73.34 30.65s25.51 68.55 10.15 103.22C421.54 432 394.52 470 326.4 470c-36.72 0-69.67-14.49-95.29-41.92-27.47-29.4-41.34-68.08-39.11-108.89a149.1 149.1 0 0 1 51.31-104.6c33.19-28.45 74.48-42.87 122.71-42.87 55.12 0 101.85 23.25 135.12 67.23 45.36 60 52.9 141.71 19.66 213.3-25.35 54.67-79.68 119.84-194.4 119.84Z",fill:"url(#spiral-gradient)"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-bailliegifford",viewBox:"0 0 252.875 70.249"}},[r("path",{staticStyle:{fill:"var(--btcpay-body-text)","fill-opacity":"1",stroke:"var(--btcpay-body-text)","stroke-opacity":"1"},attrs:{d:"M366.764 291.907h4.554l-5.046 12.789h-4.553zM377.541 302.546h4.675l-.849 2.15h-9.229l5.046-12.789h4.554zM389.988 302.546h4.676l-.849 2.15h-9.229l5.045-12.789h4.554zM403.079 291.907h4.554l-5.046 12.789h-4.553zM418.795 302.487l-.871 2.209h-9.471l5.046-12.789h9.397l-.871 2.209h-4.844l-1.139 2.887h4.457l-.826 2.093h-4.457l-1.338 3.391zM445.115 294.349a6.207 6.207 0 0 0-2.213-.407c-3.344 0-4.898 3.391-5.35 4.535-.682 1.725-1.15 3.469.277 4.147.49.232 1.135.252 1.402.252l1.186-3.004h-1.648l.795-2.015h5.766l-2.4 6.084c-1.66.523-3.16.95-5.268.95-4.748 0-6.602-2.732-5.109-6.511 1.566-3.973 5.77-6.647 10.566-6.647 1.842 0 2.971.33 3.777.62l-1.781 1.996zM453.309 291.907h4.554l-5.045 12.789h-4.554zM458.684 304.696l5.045-12.789h9.398l-.871 2.209h-4.844l-1.269 3.217h4.457l-.871 2.209h-4.458l-2.033 5.154zM472.639 304.696l5.047-12.789h9.398l-.871 2.209h-4.846l-1.269 3.217h4.459l-.873 2.209h-4.457l-2.034 5.154z",transform:"translate(-293.5 -262.775)"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)","fill-opacity":"1","fill-rule":"evenodd",stroke:"var(--btcpay-body-text)","stroke-opacity":"1"},attrs:{d:"M335.139 302.643c.557 0 1.187 0 1.747-.252.576-.232 1.106-.717 1.489-1.686.336-.854.189-1.279-.211-1.492-.376-.213-1.006-.213-1.612-.213h-.63l-1.438 3.643h.655zm2.154-5.523c.46 0 .993 0 1.521-.232.496-.213.986-.659 1.33-1.531.283-.717.162-1.085-.181-1.259-.319-.175-.852-.175-1.409-.175h-.63l-1.262 3.198h.631v-.001zm2.832-5.213c1.187 0 2.578.097 3.531.504.954.407 1.47 1.124.966 2.403-.727 1.841-2.749 2.732-4.501 3.12.502.077 1.378.252 2.05.698.647.445 1.06 1.182.578 2.403-.443 1.124-1.742 2.636-4.352 3.294-.995.252-2.107.368-4.481.368h-4.651l5.045-12.79h5.815zM350.689 300.201h2.833l.017-3.605-2.85 3.605zm6.664-8.294.792 12.79h-4.651l-.017-2.597h-4.288l-2.066 2.597h-3.149l10.714-12.79h2.665zM492.998 302.875c.922 0 2.209-.504 3.793-4.515 1.451-3.682 1.238-4.612-.047-4.612-1.283 0-2.363.775-3.955 4.806-1.07 2.713-1.316 4.321.209 4.321zm4.59-11.143c3.561 0 6.08 1.841 4.299 6.356-1.482 3.759-4.936 6.802-9.707 6.802-4.555 0-5.779-2.791-4.295-6.55 1.65-4.185 5.635-6.608 9.703-6.608zM512.328 293.922l-1.469 3.721h.484c1.502 0 2.234-.445 2.793-1.86.582-1.473.25-1.86-1.324-1.86h-.484v-.001zm1.254-2.015c2.398 0 3.312.078 4.168.426.814.33 1.785 1.124 1.166 2.694-.58 1.473-2.047 2.732-4.277 3.353l1.916 6.317h-4.893l-.965-5.29h-.533l-2.088 5.29h-4.408l5.047-12.79h4.867zM528.418 293.961l-3.424 8.682h.387c1.115 0 2.955.368 4.906-4.573 1.619-4.108.264-4.108-1.385-4.108h-.484v-.001zm.811-2.054c2.254 0 4.336 0 5.549 1.163 1.461 1.396.748 3.818.334 4.864-.727 1.841-2.406 4.748-6.227 6.143-1.24.446-2.498.62-5.09.62h-4.166l5.047-12.79h4.553z","clip-rule":"evenodd",transform:"translate(-293.5 -262.775)"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)","fill-opacity":"1",stroke:"var(--btcpay-body-text)","stroke-opacity":"1"},attrs:{d:"M294 297.4c0-19.399 57.138-35.125 127.624-35.125 62.064 0 113.781 12.192 125.251 28.35-13.078-12.792-58.92-22.238-113.465-22.238-64.731 0-117.206 13.303-117.206 29.714 0 16.411 52.474 29.715 117.206 29.715 47.799 0 88.914-7.254 107.154-17.656-18.555 13.09-64.812 22.364-118.941 22.364C351.138 332.524 294 316.799 294 297.4z",transform:"translate(-293.5 -262.775)"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-coincards",viewBox:"0 0 64 32"}},[r("g",{attrs:{fill:"none"}},[r("path",{attrs:{d:"M32.7 5.9c-.2-1-1.3-1.7-2.3-1.4L7.7 9.9c-1 .2-1.7 1.3-1.4 2.3l3.1 12.9c.2 1 1.3 1.7 2.3 1.4l22.7-5.4c1-.2 1.7-1.3 1.4-2.3L32.7 5.9Z",fill:"#EF8022"}}),r("path",{attrs:{d:"M12.6 30.3c-.2.2-.5.3-.7.3l.8.5c.9.6 2.1.4 2.7-.5l3.1-4.4-5.9 4.1ZM2.3 19.5l-1 1.4c-.6.9-.4 2.1.5 2.7L8.1 28l-5.8-8.5ZM12.9 8.1l7.2-5-2.7-1.9c-.9-.6-2.1-.4-2.7.5l-5 7.2 3.2-.8Z",fill:"#F9F185"}}),r("path",{attrs:{d:"M9.7 29.4c.6.9 1.8 1.1 2.7.5l6.7-4.6-7.4 1.8c-1.3.3-2.6-.5-2.9-1.8L6 13.5l-3.3 2.3c-.9.6-1.1 1.8-.5 2.7l7.5 10.9Zm4.5-21.6L25.9 5l-1.3-2c-.6-.9-1.8-1.1-2.7-.5l-7.7 5.3Z",fill:"#FFC214"}}),r("path",{attrs:{d:"M11.9 24.8c-.7 0-1.4-.5-1.7-1.1l-1.5-3.2 1.1 4.6c.2.6.7 1.1 1.4 1.1h.3l17-4.1-16.2 2.7h-.4Z",fill:"#FFC214"}}),r("path",{attrs:{d:"M16 17.5s-1.1 1.2-2.5 1.2c-1.7 0-2.6-1.4-2.6-2.8 0-1.3.9-2.7 2.6-2.7 1.3 0 2.3 1 2.3 1l1.1-1.7s-.6-.7-1.9-1.1v-1.2h-1.1v1h-.6v-1h-1.1v1.1c-2.2.5-3.7 2.4-3.7 4.7 0 2.4 1.5 4.2 3.7 4.7v1.2h1.1v-1h.6V22H15v-1.3c1.4-.4 2.1-1.3 2.1-1.3L16 17.5ZM21 13.7c2.1 0 3.8 1.4 3.8 3.6 0 2.1-1.7 3.5-3.8 3.5-2.1 0-3.8-1.4-3.8-3.5s1.7-3.6 3.8-3.6Zm0 5.2c.8 0 1.5-.6 1.5-1.6s-.7-1.7-1.5-1.7-1.5.6-1.5 1.7c0 1 .7 1.6 1.5 1.6Zm4.3-5h2.3v6.7h-2.3v-6.7Zm0-2.6h2.2v1.8h-2.2v-1.8Zm3.2 2.6h2.2v1c.3-.5 1-1.2 2.1-1.2 1.4 0 2.4.6 2.4 2.5v4.4h-2.3v-4c0-.6-.2-.9-.7-.9-.7 0-1.1.4-1.3 1-.1.3-.1.6-.1.9v3h-2.3v-6.7Z",fill:"#FFF"}}),r("path",{attrs:{d:"M39.3 13.9c1.7 0 2.5 1 2.5 1l-.6.9s-.7-.8-1.8-.8c-1.3 0-2.3 1-2.3 2.4 0 1.3 1 2.4 2.3 2.4 1.2 0 2-.9 2-.9l.5.9s-.9 1.1-2.6 1.1c-2.1 0-3.5-1.5-3.5-3.5-.1-2 1.4-3.5 3.5-3.5Zm6.8 2.6h.3v-.1c0-1.1-.6-1.5-1.5-1.5-1 0-1.8.6-1.8.6l-.5-.9s1-.8 2.5-.8c1.7 0 2.6.9 2.6 2.6v4.2h-1.2v-1.1s-.5 1.3-2.1 1.3c-1.1 0-2.3-.7-2.3-2 0-2.2 2.9-2.3 4-2.3Zm-1.4 3.3c1.1 0 1.8-1.1 1.8-2.1v-.2h-.3c-1 0-2.7.1-2.7 1.3-.1.5.3 1 1.2 1Zm3.8-5.8h1.2v1.7c.3-1 1.1-1.7 2.1-1.7h.3v1.3h-.4c-.8 0-1.6.6-1.9 1.6-.1.4-.2.8-.2 1.2v2.7h-1.3V14h.2Zm6.8-.1c1.5 0 2 1 2 1v-3.5h1.3v9.2h-1.2v-1s-.5 1.2-2.2 1.2c-1.8 0-2.9-1.4-2.9-3.5s1.3-3.4 3-3.4Zm.2 5.8c1 0 1.9-.7 1.9-2.4 0-1.2-.6-2.4-1.9-2.4-1 0-1.9.9-1.9 2.4s.8 2.4 1.9 2.4Zm4.2-.8s.7.8 1.9.8c.5 0 1.1-.3 1.1-.8 0-1.2-3.4-1-3.4-3.1 0-1.2 1.1-1.9 2.4-1.9 1.5 0 2.1.7 2.1.7l-.5 1s-.6-.6-1.6-.6c-.5 0-1.1.2-1.1.8 0 1.2 3.4.9 3.4 3.1 0 1.1-.9 1.9-2.4 1.9-1.6 0-2.5-1-2.5-1l.6-.9Z",fill:"#EF8022"}})])]),t._v(" "),r("symbol",{attrs:{id:"supporter-acinq",viewBox:"0 0 103 107"}},[r("circle",{attrs:{fill:"url(#acinq-a)",cx:"47.833",cy:"51.833",r:"56.832"}}),r("g",[r("g",{attrs:{fill:"none","stroke-width":"6","stroke-linejoin":"round"}},[r("path",{attrs:{stroke:"#47BF94",d:"M4.493 79.67c-6.778-11.574 21.882-35.135 41.646-39.636 16.598-3.78 55.176 4.066 53.752 17.433"}}),r("path",{attrs:{stroke:"#359F7E",d:"M10.125 18.133c8.624-9.988 41.797 13.701 51.001 30.018 9.723 17.237 12.87 55.271-1.103 55.351"}}),r("path",{attrs:{stroke:"#49DAAA",d:"M69.826 4.107c12.025 5.964 3.838 38.632-11.184 57.28C47.846 74.79 11.659 91.904 4.493 79.67"}}),r("path",{attrs:{stroke:"#49DAAA",d:"M99.891 57.467C98.471 70.799 62.529 72.9 43.83 64.781c-17.92-7.783-42.47-36.5-33.706-46.648"}}),r("path",{attrs:{stroke:"#AAF0D3",d:"M60.023 103.502c-14.291.08-24.609-29.721-23.918-51.916.758-24.377 20.678-53.948 33.721-47.479"}})])])]),t._v(" "),r("symbol",{attrs:{id:"supporter-lunanode",viewBox:"0 0 194.219 193.977"}},[r("path",{staticStyle:{fill:"#004581","fill-opacity":"1","fill-rule":"evenodd",stroke:"none"},attrs:{d:"M3185.89 2995.8c-1.77 21.49-2.76 43.2-2.76 65.16 0 411.03 319.09 747.36 723.13 774.95l-618.54-641.7c-54.62-56.68-88.55-126.08-101.83-198.41M3960 2284.09c-270.37 0-508.4 138.15-647.57 347.65l23.25-22.42c76.82-74.06 176.93-109.95 276.2-108.13 99 1.77 197.53 41.2 271.5 117.59l-177.95 171.52c-26.66-27.31-62.22-41.38-98.02-42.14-36.12-.65-72.43 12.41-100.16 39.15l-37.98 36.6c-27.69 26.66-42.04 62.45-42.7 98.57-.65 36.07 12.36 72.48 39.11 100.21l745.68 773.56c305.71-104.45 525.52-394.17 525.52-735.29 0-29.89-1.73-59.34-5.04-88.32-19.44 54.57-51.41 105.56-95.79 148.35l-37.93 36.58c-76.86 74.07-176.93 110.05-276.16 108.18-99.32-1.77-198.13-41.38-272.19-118.25l-290.74-301.59 177.95-171.53 290.74 301.61c26.71 27.73 62.64 42.04 98.72 42.74 36.12.69 72.38-12.35 100.16-39.1l37.89-36.59c27.69-26.66 42.09-62.45 42.74-98.58.61-36.03-12.4-72.48-39.1-100.21l-440.73-457.23c-22.23-1.9-44.69-2.93-67.4-2.93",transform:"matrix(.125 0 0 -.125 -397.891 479.489)"}}),r("path",{staticStyle:{fill:"#3384b9","fill-opacity":"1","fill-rule":"evenodd",stroke:"none"},attrs:{d:"M4376.22 2292.8h360.66v433.41c-17.35-55.88-47.59-108.64-90.81-153.48l-269.85-279.93",transform:"matrix(.125 0 0 -.125 -397.891 479.489)"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-walletofsatoshi",viewBox:"0 0 313.1 76.32"}},[r("path",{attrs:{d:"M110.47 44.8H121c.84 0 1.22-.64.9-1.48l-17.6-42A2 2 0 0 0 102.22 0H87.63a2 2 0 0 0-2 1.34L66 48.11c-.32.84.06 1.48.83 1.48h13.7a1.42 1.42 0 0 1 1.32 1.93l-9.7 24.8 30.55-32.63A1 1 0 0 0 102 42H84.73a1.42 1.42 0 0 1-1.32-2l5.06-12.91 6.86-17.47 6.78 17.51h-7.54a1.42 1.42 0 0 0-1.32.9l-2.83 7.22a1.42 1.42 0 0 0 1.32 1.93H105a1.42 1.42 0 0 1 1.33.91l2.08 5.36a1.92 1.92 0 0 0 2.06 1.35Zm62.65 0h37.42a1.3 1.3 0 0 0 1.46-1.41V35.9a1.3 1.3 0 0 0-1.47-1.41h-26V1.41A1.35 1.35 0 0 0 183 0h-9.92a1.3 1.3 0 0 0-1.47 1.41v42a1.3 1.3 0 0 0 1.51 1.39Zm45.36 0h42a1.3 1.3 0 0 0 1.52-1.41V35.9a1.31 1.31 0 0 0-1.47-1.41h-30.59v-7.36h25.59a1.33 1.33 0 0 0 1.48-1.4v-7a1.33 1.33 0 0 0-1.48-1.41h-25.59v-7h30.59A1.3 1.3 0 0 0 262 8.89V1.41A1.3 1.3 0 0 0 260.53 0h-42A1.3 1.3 0 0 0 217 1.41v42a1.3 1.3 0 0 0 1.48 1.39ZM71.79 0H61.61a1.71 1.71 0 0 0-1.85 1.41L52.08 34.3 44.91 1.41A1.65 1.65 0 0 0 43.12 0H30.38a1.71 1.71 0 0 0-1.85 1.41L21.36 34.3 13.68 1.41A1.65 1.65 0 0 0 11.89 0H1.14C.24 0-.14.51.05 1.41l10.88 42a1.68 1.68 0 0 0 1.79 1.41H28.4a1.65 1.65 0 0 0 1.79-1.41l6.27-28.31 6.34 28.29a1.65 1.65 0 0 0 1.79 1.41H60.2a1.66 1.66 0 0 0 1.8-1.41l10.87-42C73.07.51 72.68 0 71.79 0Zm239.84 0h-43.52a1.3 1.3 0 0 0-1.47 1.41v7.48a1.3 1.3 0 0 0 1.47 1.41h15.29v33.09a1.3 1.3 0 0 0 1.48 1.41h10a1.33 1.33 0 0 0 1.47-1.41V10.3h15.3a1.3 1.3 0 0 0 1.47-1.41V1.41A1.3 1.3 0 0 0 311.63 0ZM127.76 44.8h37.42a1.3 1.3 0 0 0 1.47-1.41V35.9a1.3 1.3 0 0 0-1.47-1.41h-26V1.41a1.35 1.35 0 0 0-1.5-1.41h-9.92a1.3 1.3 0 0 0-1.47 1.41v42a1.3 1.3 0 0 0 1.47 1.39Zm-3.84 9.6h-11.53c-3.13 0-4.53 1.31-4.53 4.36v10.37c0 3.05 1.4 4.36 4.53 4.36h11.53c3.16 0 4.51-1.31 4.51-4.36V58.76c0-3.05-1.35-4.36-4.51-4.36Zm-1 12.95c0 1.48-.29 1.75-2.07 1.75h-5.51c-1.76 0-2.08-.27-2.08-1.75v-6.81c0-1.47.32-1.75 2.08-1.75h5.51c1.78 0 2.07.28 2.07 1.75Zm51.87-5.59h-8.75c-.89 0-1.16-.27-1.16-.95v-1.06c0-.68.27-1 1.16-1h6.7c.65 0 .89.28.89.85v.16a.55.55 0 0 0 .62.6h4a.55.55 0 0 0 .62-.6v-1.08c0-3.21-1.11-4.28-4.4-4.28H164c-3.19 0-4.51 1.31-4.51 4.36v2.84c0 3.06 1.32 4.36 4.51 4.36h8.74c.9 0 1.17.28 1.17 1v1.23c0 .68-.27.95-1.17.95h-7.34c-.62 0-.86-.27-.86-.85v-.16a.56.56 0 0 0-.62-.6h-4a.55.55 0 0 0-.62.6v1.12c0 3.22 1.08 4.28 4.4 4.28h11.2c3.19 0 4.51-1.31 4.51-4.36v-3c-.06-3.1-1.41-4.41-4.57-4.41Zm85.43 0h-8.75c-.89 0-1.16-.27-1.16-.95v-1.06c0-.68.27-1 1.16-1h6.7c.64 0 .89.28.89.85v.16a.55.55 0 0 0 .62.6h4a.55.55 0 0 0 .62-.6v-1.08c0-3.21-1.11-4.28-4.4-4.28h-10.48c-3.19 0-4.51 1.31-4.51 4.36v2.84c0 3.06 1.32 4.36 4.51 4.36h8.74c.89 0 1.16.28 1.16 1v1.23c0 .68-.27.95-1.16.95h-7.34c-.62 0-.86-.27-.86-.85v-.16a.57.57 0 0 0-.62-.6h-4.05a.55.55 0 0 0-.62.6v1.12c0 3.22 1.08 4.28 4.4 4.28h11.2c3.18 0 4.51-1.31 4.51-4.36v-3c0-3.1-1.33-4.41-4.51-4.41Zm26.65-7.36h-4.21a.56.56 0 0 0-.63.6v6.66h-9.2V55a.57.57 0 0 0-.65-.6H268a.55.55 0 0 0-.62.6v17.89a.55.55 0 0 0 .62.6h4.18a.57.57 0 0 0 .65-.6v-6.84h9.2v6.84a.56.56 0 0 0 .63.6h4.21a.55.55 0 0 0 .62-.6V55a.55.55 0 0 0-.57-.6Zm-137.62 0h-17.07a.55.55 0 0 0-.62.6v17.89a.55.55 0 0 0 .62.6h4.19a.58.58 0 0 0 .65-.6v-6.52h10.15a.57.57 0 0 0 .64-.6v-3.19a.57.57 0 0 0-.64-.6H137v-3.19h12.3a.55.55 0 0 0 .62-.6V55a.55.55 0 0 0-.62-.6Zm146.47 0h-4.18a.55.55 0 0 0-.62.6v17.89a.55.55 0 0 0 .62.6h4.18a.57.57 0 0 0 .65-.6V55a.57.57 0 0 0-.6-.6Zm-100.28.6a.83.83 0 0 0-.86-.57h-6.16a.83.83 0 0 0-.89.57l-7.42 17.89c-.14.36 0 .63.38.63h4.45a.8.8 0 0 0 .86-.57l1-2.68h9.1l1 2.68a.8.8 0 0 0 .87.57h4.69c.33 0 .49-.27.35-.63Zm-7 11 2.89-7.52 2.92 7.52Zm30.9-11.6H201a.55.55 0 0 0-.62.6v3.19a.55.55 0 0 0 .62.6h6.45v14.1a.55.55 0 0 0 .62.6h4.21a.56.56 0 0 0 .62-.6v-14.1h6.46a.55.55 0 0 0 .62-.6V55a.55.55 0 0 0-.64-.6Zm18.46 0h-11.52c-3.13 0-4.54 1.31-4.54 4.36v10.37c0 3.05 1.41 4.36 4.54 4.36h11.52c3.16 0 4.51-1.31 4.51-4.36V58.76c0-3.05-1.31-4.36-4.51-4.36Zm-.94 12.95c0 1.48-.3 1.75-2.08 1.75h-5.51c-1.75 0-2.07-.27-2.07-1.75v-6.81c0-1.47.32-1.75 2.07-1.75h5.51c1.78 0 2.08.28 2.08 1.75Z",fill:"#fad228",stroke:"#1e2127","stroke-width":"2"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-nomics",viewBox:"0 0 600 600"}},[r("path",{attrs:{d:"M273.56 133A136.81 136.81 0 0 0 0 136.86v326.28a136.8 136.8 0 0 0 233.57 96.75L326.44 467A136.81 136.81 0 0 0 600 463.14V136.86a136.8 136.8 0 0 0-233.57-96.75L273.56 133",fill:"#a0f"}}),r("ellipse",{attrs:{cx:"302.18",cy:"300.04",rx:"136.81",ry:"136.86",fill:"#fff"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-ivpn",viewBox:"0 0 84 29"}},[r("path",{attrs:{"fill-rule":"evenodd","clip-rule":"evenodd",d:"M6.75 0h6.03c.07 0 .15.03.2.1.04.05.06.13.05.2L8.6 27.43a.26.26 0 0 1-.24.22l-6.63.38H1.7a.25.25 0 0 1-.19-.08.26.26 0 0 1-.06-.22L5.2 5.05C5.12 1.67 1 .85.49.73-.06.59 0 0 0 0h6.75Zm32.32.12a.25.25 0 0 0-.22-.12h-6.5c-.1 0-.18.05-.23.14l-8.98 17.4L20.08.2a.25.25 0 0 0-.24-.21h-6.55a.25.25 0 0 0-.2.1.26.26 0 0 0-.05.2l4.85 26.05a.25.25 0 0 0 .26.2l7.57-.43c.08 0 .16-.06.2-.14L39.08.38a.26.26 0 0 0-.01-.26Zm20.27 5.5a6.8 6.8 0 0 0-.53-2.08c-.27-.6-.61-1.1-1.01-1.5-.4-.41-.8-.75-1.23-1A8.23 8.23 0 0 0 52.9 0H40.47a.25.25 0 0 0-.25.2l-4.01 24.6c-.01.07.01.14.06.2.05.05.11.08.18.08h.02l6.25-.36c.11 0 .2-.1.22-.21l.75-4.63h6.08c1.39-.09 2.7-.43 3.89-1.03a9.75 9.75 0 0 0 2.99-2.46 9.9 9.9 0 0 0 2-4.76l.56-3.3c.17-1.02.21-1.93.13-2.71Zm-7.21 5.87a2.53 2.53 0 0 1-1.1 1.66c-.27.18-.64.27-1.1.27H44.7l1.1-7h5.3c.45 0 .78.09.97.27.22.2.38.41.47.65.1.27.13.6.1.95l-.52 3.2ZM83.75 0h-6.32c-.12 0-.23.1-.25.22l-2.25 14.34L70.04.17a.25.25 0 0 0-.23-.17H63.5c-.12 0-.23.1-.25.22l-3.86 24.56c-.01.07.01.16.06.22.05.05.12.08.19.08l6.43-.39c.12 0 .21-.1.23-.22l1.62-10.36 3.4 10.08c.04.1.14.17.25.17l8.58-.52c.11 0 .2-.1.23-.22L84 .3a.27.27 0 0 0-.06-.22.24.24 0 0 0-.19-.09Z",fill:"#F34"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-strike",viewBox:"0 0 155 120"}},[r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{"fill-rule":"evenodd","clip-rule":"evenodd",d:"M7.06565 43.2477C1.90963 41.2685 -0.665684 35.4843 1.31353 30.3283C3.29274 25.1722 9.07699 22.5969 14.233 24.5761L51.4526 38.8634C51.4937 38.8798 51.535 38.896 51.5765 38.9119L70.2481 46.0792C75.4041 48.0584 81.1883 45.4831 83.1675 40.3271C85.1468 35.1711 82.5714 29.3868 77.4154 27.4076L77.4132 27.4068C77.4139 27.4064 77.4145 27.406 77.4151 27.4056L58.7436 20.2383C53.5876 18.2591 51.0123 12.4749 52.9915 7.31885C54.9707 2.16283 60.755 -0.412485 65.911 1.56673L120.828 22.6473C120.959 22.6977 121.089 22.7506 121.217 22.8059C121.453 22.8928 121.69 22.9815 121.926 23.0721C147.706 32.9681 160.583 61.8894 150.686 87.6695C140.79 113.45 111.869 126.326 86.089 116.43C85.5927 116.24 85.1011 116.042 84.6144 115.838C84.3783 115.766 84.1431 115.686 83.9091 115.596L30.0742 94.9308C24.9182 92.9516 22.3428 87.1673 24.3221 82.0113C26.3013 76.8553 32.0855 74.2799 37.2415 76.2592L55.9106 83.4256C55.9103 83.4242 55.9099 83.4229 55.9095 83.4215L55.9133 83.423C61.0694 85.4022 66.8536 82.8269 68.8328 77.6709C70.812 72.5148 68.2367 66.7306 63.0807 64.7514L54.6786 61.5261C54.6787 61.5257 54.6788 61.5252 54.6789 61.5247L7.06565 43.2477Z"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-hrf",viewBox:"0 0 3000 987.6"}},[r("path",{attrs:{d:"M1137.09 103.9v773.45h-51.44V515.96h-953.6v361.38H80.62V103.9h51.44v361.2h953.6V103.9h51.43zm-102.77 0h-51.44v258.19H234.94V103.9H183.5v309.05h850.82V103.9zm-696.29 0h-50.87v205.84h50.87V103.9zm593.05 0h-51.44v205.84h51.44V103.9zM183.5 877.34h51.44V619.16h747.94v258.19h51.44V567.72H183.5v309.62zm695.72 0h51.44V670.93h-51.44v206.41zm-592.47 0h51.44V670.93h-51.44v206.41z",fill:"#e12991"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{d:"M1422.94 103.88V331.3h-44.51v-94.22h-92.2v94.22h-44.83V103.88h44.83v90.32h92.2v-90.32h44.51zM1605.81 168.85V331.3h-41.91v-18.19c-9.75 14.62-26.64 22.74-48.41 22.74-34.44 0-61.4-24.04-61.4-67.25v-99.74H1496v94.54c0 22.1 13.32 33.47 32.16 33.47 20.47 0 35.74-12.02 35.74-40.29v-87.72h41.91zM1885.19 231.23V331.3h-41.91v-97.14c0-19.17-9.75-30.86-27.29-30.86-18.52 0-30.22 12.35-30.22 36.71v91.29h-41.91v-97.14c0-19.17-9.75-30.86-27.29-30.86-17.87 0-30.54 12.35-30.54 36.71v91.29h-41.91V168.85h41.91v17.22c9.1-13.64 24.37-21.77 45.16-21.77 20.14 0 35.09 8.45 44.18 23.39 10.07-14.62 26.32-23.39 48.41-23.39 37.04.01 61.41 26.32 61.41 66.93zM2086.24 168.85V331.3h-41.91v-19.17c-11.7 14.62-29.24 23.72-52.96 23.72-43.21 0-78.95-37.36-78.95-85.77s35.74-85.77 78.95-85.77c23.72 0 41.26 9.1 52.96 23.72v-19.17h41.91zm-41.91 81.23c0-27.29-19.17-45.81-45.16-45.81-25.66 0-44.83 18.52-44.83 45.81 0 27.29 19.17 45.81 44.83 45.81 25.99 0 45.16-18.52 45.16-45.81zM2275.93 231.56v99.74h-41.91v-94.54c0-22.09-13.32-33.46-32.16-33.46-20.47 0-35.74 12.02-35.74 40.29v87.72h-41.91V168.85h41.91v18.19c9.75-14.62 26.64-22.74 48.41-22.74 34.44.01 61.4 24.05 61.4 67.26zM1316.47 525.36h-30.25v78.95h-44.83V376.89h94.84c41.91 0 75.7 33.79 75.7 75.37 0 28.59-17.87 54.26-43.86 66.28l50.36 85.77h-48.41l-53.55-78.95zm-30.25-39.31h50c16.89 0 30.86-14.95 30.86-33.79s-13.97-33.46-30.86-33.46h-50v67.25zM1437.88 396.71c0-13.97 15.57-25.99 29.54-25.99 14.29 0 22.12 12.02 22.12 25.99s-11.7 25.67-25.99 25.67c-13.97 0-25.67-11.7-25.67-25.67zm4.88 45.16h41.91v162.45h-41.91V441.87zM1681.86 441.87v154.65c0 53.28-41.91 77.33-84.8 77.33-34.77 0-62.7-13.32-77-39.64l35.74-20.47c6.82 12.67 17.54 22.74 42.56 22.74 26.31 0 42.56-14.29 42.56-39.96v-17.54c-11.37 15.27-28.92 24.69-51.98 24.69-46.14 0-80.9-37.36-80.9-83.17 0-45.48 34.76-83.17 80.9-83.17 23.07 0 40.61 9.42 51.98 24.69v-20.14h40.94zm-40.94 78.62c0-25.67-19.17-44.18-45.49-44.18-26.31 0-45.48 18.52-45.48 44.18 0 25.99 19.17 44.51 45.48 44.51 26.32 0 45.49-18.52 45.49-44.51zM1871.55 504.57v99.74h-41.91v-94.54c0-22.09-13.32-33.46-32.16-33.46-20.47 0-35.74 12.02-35.74 40.29v87.72h-41.91V376.89h41.91v83.17c9.75-14.62 26.64-22.74 48.41-22.74 34.44 0 61.4 24.04 61.4 67.25zM1963.46 482.15v67.58c0 17.54 12.67 17.87 36.71 16.57v38.01c-58.81 6.5-78.62-10.72-78.62-54.58v-67.58h-28.27v-40.29h28.27v-32.81l41.91-12.67v45.48h36.71v40.29h-36.71zM2148.63 556.88c0 35.09-30.54 51.98-65.31 51.98-32.49 0-56.53-13.64-68.22-38.66l36.39-20.47c4.55 13.32 15.6 21.12 31.84 21.12 13.32 0 22.42-4.55 22.42-13.97 0-23.72-83.82-10.72-83.82-67.9 0-33.14 28.27-51.66 61.73-51.66 26.32 0 49.06 12.02 61.73 34.44l-35.74 19.49c-4.88-10.4-13.97-16.57-25.99-16.57-10.4 0-18.84 4.55-18.84 13.32-.01 24.04 83.81 9.1 83.81 68.88zM1286.22 692.79v53.93h96.11v42.89h-96.11v87.72h-44.83V649.9h143.54v42.88h-98.71zM1400.82 796.1c0-48.41 38.01-85.77 85.77-85.77s86.1 37.36 86.1 85.77-38.34 85.77-86.1 85.77c-47.76 0-85.77-37.36-85.77-85.77zm129.96 0c0-26.31-19.17-44.83-44.19-44.83-24.69 0-43.86 18.52-43.86 44.83 0 26.32 19.17 44.83 43.86 44.83 25.02.01 44.19-18.51 44.19-44.83zM1744.84 714.88v162.45h-41.91v-18.19c-9.75 14.62-26.64 22.74-48.41 22.74-34.44 0-61.4-24.04-61.4-67.25v-99.74h41.91v94.54c0 22.1 13.32 33.47 32.16 33.47 20.47 0 35.74-12.02 35.74-40.29v-87.72h41.91zM1934.86 777.58v99.74h-41.91v-94.54c0-22.09-13.32-33.46-32.16-33.46-20.47 0-35.74 12.02-35.74 40.29v87.72h-41.91V714.88h41.91v18.19c9.75-14.62 26.64-22.74 48.41-22.74 34.44 0 61.4 24.04 61.4 67.25zM2135.61 649.9v227.42h-41.91v-19.17c-11.7 14.95-28.92 23.72-52.63 23.72-43.54 0-79.27-37.36-79.27-85.77s35.74-85.77 79.27-85.77c23.72 0 40.94 8.77 52.63 23.72V649.9h41.91zm-41.91 146.2c0-27.29-19.17-45.81-44.84-45.81-25.99 0-45.16 18.52-45.16 45.81 0 27.29 19.17 45.81 45.16 45.81 25.67.01 44.84-18.51 44.84-45.81zM2337.35 714.88v162.45h-41.91v-19.17c-11.7 14.62-29.24 23.72-52.96 23.72-43.21 0-78.95-37.36-78.95-85.77s35.74-85.77 78.95-85.77c23.72 0 41.26 9.1 52.96 23.72v-19.17h41.91zm-41.91 81.22c0-27.29-19.17-45.81-45.16-45.81-25.66 0-44.83 18.52-44.83 45.81 0 27.29 19.17 45.81 44.83 45.81 25.99.01 45.16-18.51 45.16-45.81zM2433.46 755.17v67.58c0 17.54 12.67 17.87 36.71 16.57v38.01c-58.81 6.5-78.62-10.72-78.62-54.58v-67.58h-28.26v-40.29h28.26v-32.81l41.91-12.67v45.48h36.71v40.29h-36.71zM2494.84 669.72c0-13.97 11.7-25.99 25.67-25.99 14.29 0 25.99 12.02 25.99 25.99s-11.7 25.66-25.99 25.66c-13.97.01-25.67-11.69-25.67-25.66zm4.87 45.16h41.91v162.45h-41.91V714.88zM2565 796.1c0-48.41 38.01-85.77 85.77-85.77s86.1 37.36 86.1 85.77-38.34 85.77-86.1 85.77c-47.76 0-85.77-37.36-85.77-85.77zm129.96 0c0-26.31-19.17-44.83-44.19-44.83-24.69 0-43.86 18.52-43.86 44.83 0 26.32 19.17 44.83 43.86 44.83 25.02.01 44.19-18.51 44.19-44.83zM2911.62 777.58v99.74h-41.91v-94.54c0-22.09-13.32-33.46-32.16-33.46-20.47 0-35.74 12.02-35.74 40.29v87.72h-41.91V714.88h41.91v18.19c9.75-14.62 26.64-22.74 48.41-22.74 34.44 0 61.4 24.04 61.4 67.25z"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-esc",viewBox:"0 0 74.222 74.044"}},[r("g",{staticStyle:{fill:"var(--btcpay-body-text)"}},[r("path",{staticStyle:{"stroke-width":"1.91694"},attrs:{d:"M625.227 7403.82c-287.542-92.014-494.572-337.383-538.662-640.26-21.087-157.19-21.087-5869.689 0-6026.878 46.007-308.628 260.704-557.832 555.914-646.01C736.41 63.833 1046.955 60 3769.018 60s3032.608 3.834 3126.539 30.671c295.21 88.18 509.907 337.383 555.914 646.01 21.086 157.19 21.086 5869.69 0 6026.879-46.007 308.628-260.705 557.83-555.914 646.01-93.93 26.838-404.476 30.672-3134.207 28.755-2842.83 0-3036.442-1.917-3136.123-34.505zm6208.987-299.044c120.768-42.173 187.861-97.764 251.12-207.03l57.509-99.681V702.177l-57.509-99.681c-63.259-109.266-130.352-164.858-251.12-207.03-120.767-44.09-6009.625-44.09-6130.393 0-120.767 42.172-187.86 97.764-251.12 207.03l-57.508 99.68v6095.889l57.509 99.68c61.342 105.433 130.352 164.858 243.452 207.031 113.1 40.256 6021.127 42.173 6138.06 0z",transform:"matrix(.0098 0 0 .0098 .182 .285)"}}),r("path",{staticStyle:{"stroke-width":"1.91694"},attrs:{d:"M1934.5 4967.381c-272.206-55.591-492.654-249.203-582.75-511.824-32.59-97.764-36.423-162.94-36.423-705.436 0-542.496 3.834-607.672 36.422-705.436 74.761-216.615 241.535-391.057 456.233-475.403 103.515-42.173 139.937-44.09 529.077-46.007h419.811l46.007 53.675c59.425 69.01 59.425 136.103-1.917 195.528-46.007 47.924-49.84 47.924-398.725 47.924-433.23 0-513.741 19.17-646.01 151.439-113.1 113.1-134.186 180.193-134.186 425.562v185.944l59.425 11.501c32.588 5.751 291.376 11.502 575.084 11.502h513.741l38.339 49.84c51.758 65.177 51.758 122.685 0 187.861l-38.339 49.84h-513.741c-283.708 0-542.496 5.752-577.001 11.502l-61.342 13.419 5.75 224.283c7.668 207.03 11.502 230.033 61.343 302.877 69.01 107.35 185.943 187.86 302.877 212.781 51.758 11.502 247.286 21.087 431.313 21.087 329.715 0 335.465 0 381.472 47.923 61.342 59.425 61.342 126.519 1.917 195.529l-46.007 53.674-371.887 3.834c-203.196 1.917-406.393-5.75-450.482-13.419zM3677.004 2553.947c-208.947 55.59-368.053 189.777-461.984 389.14-42.172 92.013-49.84 134.186-49.84 279.874 0 157.19 5.75 185.943 63.259 300.96 70.927 143.771 184.027 254.954 325.88 323.964 67.094 32.588 145.689 46.007 312.463 57.508 251.12 17.253 289.459 28.755 379.555 105.432 228.117 191.695 147.605 565.5-139.937 649.845-70.927 21.086-197.445 28.754-481.153 28.754-379.555 0-387.223 0-427.48 44.09-57.507 61.342-55.59 147.605 7.669 207.03 49.84 46.007 49.84 46.007 492.655 46.007 412.143-1.917 452.4-3.834 550.163-44.09 153.356-61.342 293.293-191.694 368.054-345.05 57.508-115.017 63.26-143.771 63.26-300.96 0-157.19-5.752-185.944-63.26-300.961-69.01-143.771-184.027-254.954-325.88-323.964-69.011-32.588-141.855-46.007-312.463-57.508-164.857-11.502-243.452-24.92-300.96-53.675-237.702-120.767-283.709-415.977-93.931-611.506 97.764-101.598 195.529-118.85 638.343-118.85h389.14l38.339-49.84c59.425-74.762 51.758-147.606-19.17-207.031l-59.425-49.84-394.89 1.916c-279.875 0-427.48 9.585-498.407 28.755zM5630.372 4965.465c-299.043-57.509-546.33-297.127-613.423-594.254-26.837-109.266-26.837-1132.915 0-1242.18 69.01-302.878 314.38-538.663 621.091-594.254 174.442-32.588 745.692-26.837 812.785 7.668 84.346 42.173 107.35 153.356 47.924 230.033-26.837 36.422-57.509 38.34-435.147 47.924-392.974 9.585-410.226 13.419-504.157 61.342-113.1 59.426-193.611 157.19-230.033 279.874-38.34 124.602-38.34 1054.32 0 1178.922 36.422 120.768 122.684 226.2 235.784 281.791 88.18 46.007 111.183 47.924 484.987 53.675 368.054 5.75 394.891 9.584 437.064 47.923 23.003 21.087 42.173 61.343 42.173 92.014 0 153.355-49.84 170.608-473.486 168.691-187.86-1.917-379.555-9.585-425.562-19.17z",transform:"matrix(.0098 0 0 .0098 .182 .285)"}})])]),t._v(" "),r("symbol",{attrs:{id:"supporter-opensats",viewBox:"0 0 5220 720"}},[r("path",{attrs:{d:"M0 435.197L229.609 291.597V288.121L0 144.259V29.0508L334.901 245.894V333.824L0 550.798V435.197Z",fill:"#FF3300"}}),r("path",{attrs:{d:"M486.969 623.844H902.627V719.643H486.969V623.844Z",fill:"#FF3300"}}),r("path",{attrs:{d:"M993.879 291.2C993.879 106.422 1084.61 0 1214.37 0C1344.13 0 1434.86 106.422 1434.86 291.2C1434.86 479.061 1344.13 587.581 1214.37 587.581C1084.61 587.581 993.879 479.061 993.879 291.2ZM1345.12 291.2C1345.12 155.01 1293.16 75.9967 1214.37 75.9967C1135.58 75.9967 1083.62 155.01 1083.62 291.2C1083.62 430.473 1135.58 511.584 1214.37 511.584C1293.16 511.584 1344.85 430.473 1344.85 291.2H1345.12Z",fill:"#FF3300"}}),r("path",{attrs:{d:"M1593.29 154.29H1663.81L1670.37 205.37H1673.13C1711.31 169.634 1764.71 144.258 1814.44 144.258C1925.96 144.258 1988.02 228.713 1988.02 359.855C1988.02 504.111 1897.95 587.911 1797.77 587.911C1759.13 587.911 1713.54 568.829 1677.39 535.454H1675.29L1679.43 612.237V749.936H1593.29V154.29ZM1899.65 359.855C1899.65 271.269 1867.44 215.599 1791.21 215.599C1756.57 215.599 1717.93 232.713 1679.69 272.121V472.112C1714.79 503.914 1754.61 515.455 1781.57 515.455C1848.75 515.717 1899.65 459.851 1899.65 359.855Z",fill:"#FF3300"}}),r("path",{attrs:{d:"M2118.96 365.035C2118.96 227.336 2222.75 143.93 2335.98 143.93C2460.16 143.93 2530.82 225.434 2530.82 343.527C2530.67 359.209 2529.35 374.858 2526.88 390.345H2178.73V327.2H2473.22L2454.52 348.249C2454.52 256.449 2410.17 210.55 2338.47 210.55C2264.41 210.55 2203.66 265.17 2203.66 364.904C2203.66 468.833 2268.8 520.044 2359.79 520.044C2407.09 520.044 2445.08 505.75 2483.39 482.8L2513.56 537.29C2464.7 569.886 2407.32 587.378 2348.57 587.582C2220.39 587.582 2118.96 505.947 2118.96 365.035Z",fill:"#FF3300"}}),r("path",{attrs:{d:"M2658.41 154.29H2729.07L2735.63 221.697H2739.04C2781.55 178.289 2829.83 144.258 2895.17 144.258C2994.1 144.258 3039.17 205.042 3039.17 315.201V577.026H2952.9V326.152C2952.9 252.319 2928.11 218.222 2865.39 218.222C2819.47 218.222 2788.31 240.844 2744.68 285.563V577.026H2658.41V154.29Z",fill:"#FF3300"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{d:"M3208.36 504.308L3259.46 444.376C3303 486.486 3360.93 510.468 3421.5 511.455C3493.27 511.455 3533.03 478.669 3533.03 432.77C3533.03 377.362 3491.63 361.953 3435.41 338.217L3355.57 303.333C3297.64 280.514 3234.21 238.614 3234.21 155.143C3234.21 66.8186 3313.65 0.001814 3425.64 0.001814C3492.01 -0.442962 3555.93 25.0654 3603.75 71.0807L3558.87 126.554C3521.22 93.051 3472.3 74.9951 3421.9 75.9985C3362.2 75.9985 3322.11 103.604 3322.11 150.028C3322.11 199.206 3371.05 217.173 3420.98 236.516L3497.93 270.416C3569.04 298.087 3622.18 339.528 3622.18 422.344C3622.18 513.356 3545.36 587.583 3416.78 587.583C3339.11 587.998 3264.34 558.123 3208.36 504.308V504.308Z"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{d:"M3762.96 465.557C3762.96 370.741 3849.04 324.055 4062.7 308.186C4059.62 255.73 4031.54 213.896 3956.3 213.896C3905.13 213.896 3854.68 237.304 3813.28 261.5L3780.48 203.994C3827.98 174.684 3898.57 144.062 3971.78 144.062C4088.42 144.062 4148.91 210.945 4148.91 322.678V577.027H4077.73L4070.84 522.144H4068.08C4022.82 557.553 3963.97 587.715 3906.04 587.715C3825.16 587.584 3762.96 540.045 3762.96 465.557ZM4062.7 462.278V363.266C3896.79 375.134 3847.26 408.576 3847.26 459C3847.26 501.489 3885.38 519.063 3930.65 519.063C3975.91 519.063 4018.88 497.883 4062.7 462.278Z"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{d:"M4388.81 409.884V222.941H4272.17V158.813L4392.16 154.289L4403.44 20.2617H4475.02V154.289H4674.64V222.941H4475.02V410.146C4475.02 482.864 4500.73 518.076 4577.29 518.076C4610.27 517.981 4642.96 511.847 4673.73 499.979L4691.24 562.992C4648.39 578.951 4603.07 587.274 4557.35 587.581C4430.86 587.581 4388.81 516.043 4388.81 409.884Z"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{d:"M4818.71 521.815L4857.09 466.014C4909.9 502.948 4972.98 522.353 5037.43 521.487C5102.31 521.487 5133.34 495.259 5133.34 463.85C5133.34 433.95 5115.76 415 5009.22 393.034C4897.7 369.887 4845.21 331.2 4845.21 267.203C4845.21 196.518 4908.85 143.93 5025.95 143.93C5093.26 143.93 5157.55 170.158 5199.93 198.878L5159.45 252.646C5117.79 224.668 5068.79 209.592 5018.6 209.304C4955.62 209.304 4931.28 234.155 4931.28 263.138C4931.28 295.923 4965.07 309.037 5048.12 326.938C5185.89 357.101 5220.33 392.509 5220.33 458.736C5220.33 529.487 5151.71 587.582 5026.8 587.582C4952.47 586.641 4880.07 563.76 4818.71 521.815V521.815Z"}})])]),t._v(" "),r("div",{staticClass:"supporters"},[r("h3",[t._v("Our Supporters")]),t._v(" "),r("p",[t._v("\n The BTCPay Server Project is proudly supported by these entities through the\n "),r("a",{attrs:{href:"https://foundation.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("BTCPay Server Foundation")]),t._v(".\n ")]),t._v(" "),r("div",{staticClass:"logos"},[r("a",{attrs:{href:"https://spiral.xyz",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{staticStyle:{padding:"5px"},attrs:{role:"img",width:"100",height:"100"}},[r("use",{attrs:{href:"#supporter-spiral"}})]),t._v("\n Spiral\n ")]),t._v(" "),r("a",{attrs:{href:"https://opensats.org",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"120",height:"100"}},[r("use",{attrs:{href:"#supporter-opensats"}})]),t._v("\n OpenSats\n ")]),t._v(" "),r("a",{attrs:{href:"https://www.bailliegifford.com",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"110",height:"100"}},[r("use",{attrs:{href:"#supporter-bailliegifford"}})]),t._v("\n Baillie Gifford\n ")]),t._v(" "),r("a",{attrs:{href:"https://strike.me",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"55",height:"50"}},[r("use",{attrs:{href:"#supporter-strike"}})]),t._v("\n Strike\n ")]),t._v(" "),r("a",{attrs:{href:"https://hrf.org",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"110",height:"50"}},[r("use",{attrs:{href:"#supporter-hrf"}})]),t._v("\n HRF\n ")]),t._v(" "),r("a",{attrs:{href:"https://escapetoelsalvador.org/",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"100",height:"90"}},[r("use",{attrs:{href:"#supporter-esc"}})]),t._v("\n ESC\n ")]),t._v(" "),r("a",{attrs:{href:"https://www.lunanode.com/",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"100",height:"100"}},[r("use",{attrs:{href:"#supporter-lunanode"}})]),t._v("\n LunaNode\n ")]),t._v(" "),r("a",{attrs:{href:"https://walletofsatoshi.com/",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"100",height:"100"}},[r("use",{attrs:{href:"#supporter-walletofsatoshi"}})]),t._v("\n Wallet of Satoshi\n ")]),t._v(" "),r("a",{attrs:{href:"https://coincards.com/",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"130",height:"100"}},[r("use",{attrs:{href:"#supporter-coincards"}})]),t._v("\n Coincards\n ")]),t._v(" "),r("a",{attrs:{href:"https://www.ivpn.net/",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"100",height:"100"}},[r("use",{attrs:{href:"#supporter-ivpn"}})]),t._v("\n IVPN\n ")])]),t._v(" "),r("p",[t._v("If you'd like to support the project, please visit the "),r("a",{attrs:{href:"https://btcpayserver.org/donate/"}},[t._v("donation page")]),t._v(".")])])])}),[],!1,null,null,null);r.default=l.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[133],{779:function(t,r,a){"use strict";a.r(r);var e=a(9),l=Object(e.a)({},(function(){var t=this,r=t._self._c;return r("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[r("div",{staticClass:"topics"},[r("h3",[t._v("Explore by topic")]),t._v(" "),r("ul",[r("li",[r("RouterLink",{attrs:{to:"/Guide/"}},[t._v("What is BTCPay Server")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/UseCase/"}},[t._v("Why BTCPay Server")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/TryItOut/"}},[t._v("How to deploy BTCPay Server")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/WalletSetup/"}},[t._v("Wallet Setup")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/LightningNetwork/"}},[t._v("Lightning Network")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/Apps/#point-of-sale-app"}},[t._v("How to setup POS")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/Development/GreenFieldExample/"}},[t._v("Greenfield API")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/FAQ/"}},[t._v("Frequently Asked Questions"),r("br"),t._v("and Common Issues")])],1),t._v(" "),r("li",[r("RouterLink",{attrs:{to:"/Contribute/"}},[t._v("How to contribute to BTCPay Server")])],1)])]),t._v(" "),r("svg",{attrs:{width:"0",height:"0",xmlns:"http://www.w3.org/2000/svg"}},[r("defs",[r("linearGradient",{attrs:{id:"spiral-gradient",x1:"81.36",y1:"311.35",x2:"541.35",y2:"311.35",gradientUnits:"userSpaceOnUse"}},[r("stop",{attrs:{offset:".18","stop-color":"#00f"}}),r("stop",{attrs:{offset:"1","stop-color":"#f0f"}})],1),t._v(" "),r("radialGradient",{attrs:{id:"acinq-a",cx:"47.833",cy:"51.834",r:"56.832"}},[r("stop",{attrs:{offset:"0","stop-color":"#fff"}}),r("stop",{attrs:{offset:"1","stop-color":"#fff","stop-opacity":"0"}})],1)],1),t._v(" "),r("symbol",{attrs:{id:"supporter-spiral",viewBox:"0 0 629 629"}},[r("path",{attrs:{d:"M326.4 572.09C201.2 572.09 141 503 112.48 445c-28.22-57.53-30.59-114.56-30.79-122.69-4.85-77 41-231.78 249.58-271.2a28.05 28.05 0 0 1 10.41 55.13c-213.12 40.28-204.44 206-204 213 0 .53.06 1.06.07 1.6.15 7.9 5.1 195.16 188.65 195.16 68.34 0 116.6-29.4 143.6-87.37 24.48-52.74 19.29-112.45-13.52-155.83-22.89-30.27-52.46-45-90.38-45-34.46 0-63.47 9.88-86.21 29.37A91.5 91.5 0 0 0 248 322.3c-1.41 25.4 7.14 49.36 24.07 67.49C287.27 406 305 413.9 326.4 413.9c27.46 0 45.52-9 53.66-26.81 8.38-18.3 3.61-38.93-.19-43.33-9.11-10-18.69-13.68-22.48-13-2.53.43-5.78 4.61-8.48 10.92a28 28 0 0 1-51.58-22c14.28-33.44 37.94-42 50.76-44.2 24.78-4.18 52.17 7.3 73.34 30.65s25.51 68.55 10.15 103.22C421.54 432 394.52 470 326.4 470c-36.72 0-69.67-14.49-95.29-41.92-27.47-29.4-41.34-68.08-39.11-108.89a149.1 149.1 0 0 1 51.31-104.6c33.19-28.45 74.48-42.87 122.71-42.87 55.12 0 101.85 23.25 135.12 67.23 45.36 60 52.9 141.71 19.66 213.3-25.35 54.67-79.68 119.84-194.4 119.84Z",fill:"url(#spiral-gradient)"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-bailliegifford",viewBox:"0 0 252.875 70.249"}},[r("path",{staticStyle:{fill:"var(--btcpay-body-text)","fill-opacity":"1",stroke:"var(--btcpay-body-text)","stroke-opacity":"1"},attrs:{d:"M366.764 291.907h4.554l-5.046 12.789h-4.553zM377.541 302.546h4.675l-.849 2.15h-9.229l5.046-12.789h4.554zM389.988 302.546h4.676l-.849 2.15h-9.229l5.045-12.789h4.554zM403.079 291.907h4.554l-5.046 12.789h-4.553zM418.795 302.487l-.871 2.209h-9.471l5.046-12.789h9.397l-.871 2.209h-4.844l-1.139 2.887h4.457l-.826 2.093h-4.457l-1.338 3.391zM445.115 294.349a6.207 6.207 0 0 0-2.213-.407c-3.344 0-4.898 3.391-5.35 4.535-.682 1.725-1.15 3.469.277 4.147.49.232 1.135.252 1.402.252l1.186-3.004h-1.648l.795-2.015h5.766l-2.4 6.084c-1.66.523-3.16.95-5.268.95-4.748 0-6.602-2.732-5.109-6.511 1.566-3.973 5.77-6.647 10.566-6.647 1.842 0 2.971.33 3.777.62l-1.781 1.996zM453.309 291.907h4.554l-5.045 12.789h-4.554zM458.684 304.696l5.045-12.789h9.398l-.871 2.209h-4.844l-1.269 3.217h4.457l-.871 2.209h-4.458l-2.033 5.154zM472.639 304.696l5.047-12.789h9.398l-.871 2.209h-4.846l-1.269 3.217h4.459l-.873 2.209h-4.457l-2.034 5.154z",transform:"translate(-293.5 -262.775)"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)","fill-opacity":"1","fill-rule":"evenodd",stroke:"var(--btcpay-body-text)","stroke-opacity":"1"},attrs:{d:"M335.139 302.643c.557 0 1.187 0 1.747-.252.576-.232 1.106-.717 1.489-1.686.336-.854.189-1.279-.211-1.492-.376-.213-1.006-.213-1.612-.213h-.63l-1.438 3.643h.655zm2.154-5.523c.46 0 .993 0 1.521-.232.496-.213.986-.659 1.33-1.531.283-.717.162-1.085-.181-1.259-.319-.175-.852-.175-1.409-.175h-.63l-1.262 3.198h.631v-.001zm2.832-5.213c1.187 0 2.578.097 3.531.504.954.407 1.47 1.124.966 2.403-.727 1.841-2.749 2.732-4.501 3.12.502.077 1.378.252 2.05.698.647.445 1.06 1.182.578 2.403-.443 1.124-1.742 2.636-4.352 3.294-.995.252-2.107.368-4.481.368h-4.651l5.045-12.79h5.815zM350.689 300.201h2.833l.017-3.605-2.85 3.605zm6.664-8.294.792 12.79h-4.651l-.017-2.597h-4.288l-2.066 2.597h-3.149l10.714-12.79h2.665zM492.998 302.875c.922 0 2.209-.504 3.793-4.515 1.451-3.682 1.238-4.612-.047-4.612-1.283 0-2.363.775-3.955 4.806-1.07 2.713-1.316 4.321.209 4.321zm4.59-11.143c3.561 0 6.08 1.841 4.299 6.356-1.482 3.759-4.936 6.802-9.707 6.802-4.555 0-5.779-2.791-4.295-6.55 1.65-4.185 5.635-6.608 9.703-6.608zM512.328 293.922l-1.469 3.721h.484c1.502 0 2.234-.445 2.793-1.86.582-1.473.25-1.86-1.324-1.86h-.484v-.001zm1.254-2.015c2.398 0 3.312.078 4.168.426.814.33 1.785 1.124 1.166 2.694-.58 1.473-2.047 2.732-4.277 3.353l1.916 6.317h-4.893l-.965-5.29h-.533l-2.088 5.29h-4.408l5.047-12.79h4.867zM528.418 293.961l-3.424 8.682h.387c1.115 0 2.955.368 4.906-4.573 1.619-4.108.264-4.108-1.385-4.108h-.484v-.001zm.811-2.054c2.254 0 4.336 0 5.549 1.163 1.461 1.396.748 3.818.334 4.864-.727 1.841-2.406 4.748-6.227 6.143-1.24.446-2.498.62-5.09.62h-4.166l5.047-12.79h4.553z","clip-rule":"evenodd",transform:"translate(-293.5 -262.775)"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)","fill-opacity":"1",stroke:"var(--btcpay-body-text)","stroke-opacity":"1"},attrs:{d:"M294 297.4c0-19.399 57.138-35.125 127.624-35.125 62.064 0 113.781 12.192 125.251 28.35-13.078-12.792-58.92-22.238-113.465-22.238-64.731 0-117.206 13.303-117.206 29.714 0 16.411 52.474 29.715 117.206 29.715 47.799 0 88.914-7.254 107.154-17.656-18.555 13.09-64.812 22.364-118.941 22.364C351.138 332.524 294 316.799 294 297.4z",transform:"translate(-293.5 -262.775)"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-coincards",viewBox:"0 0 64 32"}},[r("g",{attrs:{fill:"none"}},[r("path",{attrs:{d:"M32.7 5.9c-.2-1-1.3-1.7-2.3-1.4L7.7 9.9c-1 .2-1.7 1.3-1.4 2.3l3.1 12.9c.2 1 1.3 1.7 2.3 1.4l22.7-5.4c1-.2 1.7-1.3 1.4-2.3L32.7 5.9Z",fill:"#EF8022"}}),r("path",{attrs:{d:"M12.6 30.3c-.2.2-.5.3-.7.3l.8.5c.9.6 2.1.4 2.7-.5l3.1-4.4-5.9 4.1ZM2.3 19.5l-1 1.4c-.6.9-.4 2.1.5 2.7L8.1 28l-5.8-8.5ZM12.9 8.1l7.2-5-2.7-1.9c-.9-.6-2.1-.4-2.7.5l-5 7.2 3.2-.8Z",fill:"#F9F185"}}),r("path",{attrs:{d:"M9.7 29.4c.6.9 1.8 1.1 2.7.5l6.7-4.6-7.4 1.8c-1.3.3-2.6-.5-2.9-1.8L6 13.5l-3.3 2.3c-.9.6-1.1 1.8-.5 2.7l7.5 10.9Zm4.5-21.6L25.9 5l-1.3-2c-.6-.9-1.8-1.1-2.7-.5l-7.7 5.3Z",fill:"#FFC214"}}),r("path",{attrs:{d:"M11.9 24.8c-.7 0-1.4-.5-1.7-1.1l-1.5-3.2 1.1 4.6c.2.6.7 1.1 1.4 1.1h.3l17-4.1-16.2 2.7h-.4Z",fill:"#FFC214"}}),r("path",{attrs:{d:"M16 17.5s-1.1 1.2-2.5 1.2c-1.7 0-2.6-1.4-2.6-2.8 0-1.3.9-2.7 2.6-2.7 1.3 0 2.3 1 2.3 1l1.1-1.7s-.6-.7-1.9-1.1v-1.2h-1.1v1h-.6v-1h-1.1v1.1c-2.2.5-3.7 2.4-3.7 4.7 0 2.4 1.5 4.2 3.7 4.7v1.2h1.1v-1h.6V22H15v-1.3c1.4-.4 2.1-1.3 2.1-1.3L16 17.5ZM21 13.7c2.1 0 3.8 1.4 3.8 3.6 0 2.1-1.7 3.5-3.8 3.5-2.1 0-3.8-1.4-3.8-3.5s1.7-3.6 3.8-3.6Zm0 5.2c.8 0 1.5-.6 1.5-1.6s-.7-1.7-1.5-1.7-1.5.6-1.5 1.7c0 1 .7 1.6 1.5 1.6Zm4.3-5h2.3v6.7h-2.3v-6.7Zm0-2.6h2.2v1.8h-2.2v-1.8Zm3.2 2.6h2.2v1c.3-.5 1-1.2 2.1-1.2 1.4 0 2.4.6 2.4 2.5v4.4h-2.3v-4c0-.6-.2-.9-.7-.9-.7 0-1.1.4-1.3 1-.1.3-.1.6-.1.9v3h-2.3v-6.7Z",fill:"#FFF"}}),r("path",{attrs:{d:"M39.3 13.9c1.7 0 2.5 1 2.5 1l-.6.9s-.7-.8-1.8-.8c-1.3 0-2.3 1-2.3 2.4 0 1.3 1 2.4 2.3 2.4 1.2 0 2-.9 2-.9l.5.9s-.9 1.1-2.6 1.1c-2.1 0-3.5-1.5-3.5-3.5-.1-2 1.4-3.5 3.5-3.5Zm6.8 2.6h.3v-.1c0-1.1-.6-1.5-1.5-1.5-1 0-1.8.6-1.8.6l-.5-.9s1-.8 2.5-.8c1.7 0 2.6.9 2.6 2.6v4.2h-1.2v-1.1s-.5 1.3-2.1 1.3c-1.1 0-2.3-.7-2.3-2 0-2.2 2.9-2.3 4-2.3Zm-1.4 3.3c1.1 0 1.8-1.1 1.8-2.1v-.2h-.3c-1 0-2.7.1-2.7 1.3-.1.5.3 1 1.2 1Zm3.8-5.8h1.2v1.7c.3-1 1.1-1.7 2.1-1.7h.3v1.3h-.4c-.8 0-1.6.6-1.9 1.6-.1.4-.2.8-.2 1.2v2.7h-1.3V14h.2Zm6.8-.1c1.5 0 2 1 2 1v-3.5h1.3v9.2h-1.2v-1s-.5 1.2-2.2 1.2c-1.8 0-2.9-1.4-2.9-3.5s1.3-3.4 3-3.4Zm.2 5.8c1 0 1.9-.7 1.9-2.4 0-1.2-.6-2.4-1.9-2.4-1 0-1.9.9-1.9 2.4s.8 2.4 1.9 2.4Zm4.2-.8s.7.8 1.9.8c.5 0 1.1-.3 1.1-.8 0-1.2-3.4-1-3.4-3.1 0-1.2 1.1-1.9 2.4-1.9 1.5 0 2.1.7 2.1.7l-.5 1s-.6-.6-1.6-.6c-.5 0-1.1.2-1.1.8 0 1.2 3.4.9 3.4 3.1 0 1.1-.9 1.9-2.4 1.9-1.6 0-2.5-1-2.5-1l.6-.9Z",fill:"#EF8022"}})])]),t._v(" "),r("symbol",{attrs:{id:"supporter-acinq",viewBox:"0 0 103 107"}},[r("circle",{attrs:{fill:"url(#acinq-a)",cx:"47.833",cy:"51.833",r:"56.832"}}),r("g",[r("g",{attrs:{fill:"none","stroke-width":"6","stroke-linejoin":"round"}},[r("path",{attrs:{stroke:"#47BF94",d:"M4.493 79.67c-6.778-11.574 21.882-35.135 41.646-39.636 16.598-3.78 55.176 4.066 53.752 17.433"}}),r("path",{attrs:{stroke:"#359F7E",d:"M10.125 18.133c8.624-9.988 41.797 13.701 51.001 30.018 9.723 17.237 12.87 55.271-1.103 55.351"}}),r("path",{attrs:{stroke:"#49DAAA",d:"M69.826 4.107c12.025 5.964 3.838 38.632-11.184 57.28C47.846 74.79 11.659 91.904 4.493 79.67"}}),r("path",{attrs:{stroke:"#49DAAA",d:"M99.891 57.467C98.471 70.799 62.529 72.9 43.83 64.781c-17.92-7.783-42.47-36.5-33.706-46.648"}}),r("path",{attrs:{stroke:"#AAF0D3",d:"M60.023 103.502c-14.291.08-24.609-29.721-23.918-51.916.758-24.377 20.678-53.948 33.721-47.479"}})])])]),t._v(" "),r("symbol",{attrs:{id:"supporter-lunanode",viewBox:"0 0 194.219 193.977"}},[r("path",{staticStyle:{fill:"#004581","fill-opacity":"1","fill-rule":"evenodd",stroke:"none"},attrs:{d:"M3185.89 2995.8c-1.77 21.49-2.76 43.2-2.76 65.16 0 411.03 319.09 747.36 723.13 774.95l-618.54-641.7c-54.62-56.68-88.55-126.08-101.83-198.41M3960 2284.09c-270.37 0-508.4 138.15-647.57 347.65l23.25-22.42c76.82-74.06 176.93-109.95 276.2-108.13 99 1.77 197.53 41.2 271.5 117.59l-177.95 171.52c-26.66-27.31-62.22-41.38-98.02-42.14-36.12-.65-72.43 12.41-100.16 39.15l-37.98 36.6c-27.69 26.66-42.04 62.45-42.7 98.57-.65 36.07 12.36 72.48 39.11 100.21l745.68 773.56c305.71-104.45 525.52-394.17 525.52-735.29 0-29.89-1.73-59.34-5.04-88.32-19.44 54.57-51.41 105.56-95.79 148.35l-37.93 36.58c-76.86 74.07-176.93 110.05-276.16 108.18-99.32-1.77-198.13-41.38-272.19-118.25l-290.74-301.59 177.95-171.53 290.74 301.61c26.71 27.73 62.64 42.04 98.72 42.74 36.12.69 72.38-12.35 100.16-39.1l37.89-36.59c27.69-26.66 42.09-62.45 42.74-98.58.61-36.03-12.4-72.48-39.1-100.21l-440.73-457.23c-22.23-1.9-44.69-2.93-67.4-2.93",transform:"matrix(.125 0 0 -.125 -397.891 479.489)"}}),r("path",{staticStyle:{fill:"#3384b9","fill-opacity":"1","fill-rule":"evenodd",stroke:"none"},attrs:{d:"M4376.22 2292.8h360.66v433.41c-17.35-55.88-47.59-108.64-90.81-153.48l-269.85-279.93",transform:"matrix(.125 0 0 -.125 -397.891 479.489)"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-walletofsatoshi",viewBox:"0 0 313.1 76.32"}},[r("path",{attrs:{d:"M110.47 44.8H121c.84 0 1.22-.64.9-1.48l-17.6-42A2 2 0 0 0 102.22 0H87.63a2 2 0 0 0-2 1.34L66 48.11c-.32.84.06 1.48.83 1.48h13.7a1.42 1.42 0 0 1 1.32 1.93l-9.7 24.8 30.55-32.63A1 1 0 0 0 102 42H84.73a1.42 1.42 0 0 1-1.32-2l5.06-12.91 6.86-17.47 6.78 17.51h-7.54a1.42 1.42 0 0 0-1.32.9l-2.83 7.22a1.42 1.42 0 0 0 1.32 1.93H105a1.42 1.42 0 0 1 1.33.91l2.08 5.36a1.92 1.92 0 0 0 2.06 1.35Zm62.65 0h37.42a1.3 1.3 0 0 0 1.46-1.41V35.9a1.3 1.3 0 0 0-1.47-1.41h-26V1.41A1.35 1.35 0 0 0 183 0h-9.92a1.3 1.3 0 0 0-1.47 1.41v42a1.3 1.3 0 0 0 1.51 1.39Zm45.36 0h42a1.3 1.3 0 0 0 1.52-1.41V35.9a1.31 1.31 0 0 0-1.47-1.41h-30.59v-7.36h25.59a1.33 1.33 0 0 0 1.48-1.4v-7a1.33 1.33 0 0 0-1.48-1.41h-25.59v-7h30.59A1.3 1.3 0 0 0 262 8.89V1.41A1.3 1.3 0 0 0 260.53 0h-42A1.3 1.3 0 0 0 217 1.41v42a1.3 1.3 0 0 0 1.48 1.39ZM71.79 0H61.61a1.71 1.71 0 0 0-1.85 1.41L52.08 34.3 44.91 1.41A1.65 1.65 0 0 0 43.12 0H30.38a1.71 1.71 0 0 0-1.85 1.41L21.36 34.3 13.68 1.41A1.65 1.65 0 0 0 11.89 0H1.14C.24 0-.14.51.05 1.41l10.88 42a1.68 1.68 0 0 0 1.79 1.41H28.4a1.65 1.65 0 0 0 1.79-1.41l6.27-28.31 6.34 28.29a1.65 1.65 0 0 0 1.79 1.41H60.2a1.66 1.66 0 0 0 1.8-1.41l10.87-42C73.07.51 72.68 0 71.79 0Zm239.84 0h-43.52a1.3 1.3 0 0 0-1.47 1.41v7.48a1.3 1.3 0 0 0 1.47 1.41h15.29v33.09a1.3 1.3 0 0 0 1.48 1.41h10a1.33 1.33 0 0 0 1.47-1.41V10.3h15.3a1.3 1.3 0 0 0 1.47-1.41V1.41A1.3 1.3 0 0 0 311.63 0ZM127.76 44.8h37.42a1.3 1.3 0 0 0 1.47-1.41V35.9a1.3 1.3 0 0 0-1.47-1.41h-26V1.41a1.35 1.35 0 0 0-1.5-1.41h-9.92a1.3 1.3 0 0 0-1.47 1.41v42a1.3 1.3 0 0 0 1.47 1.39Zm-3.84 9.6h-11.53c-3.13 0-4.53 1.31-4.53 4.36v10.37c0 3.05 1.4 4.36 4.53 4.36h11.53c3.16 0 4.51-1.31 4.51-4.36V58.76c0-3.05-1.35-4.36-4.51-4.36Zm-1 12.95c0 1.48-.29 1.75-2.07 1.75h-5.51c-1.76 0-2.08-.27-2.08-1.75v-6.81c0-1.47.32-1.75 2.08-1.75h5.51c1.78 0 2.07.28 2.07 1.75Zm51.87-5.59h-8.75c-.89 0-1.16-.27-1.16-.95v-1.06c0-.68.27-1 1.16-1h6.7c.65 0 .89.28.89.85v.16a.55.55 0 0 0 .62.6h4a.55.55 0 0 0 .62-.6v-1.08c0-3.21-1.11-4.28-4.4-4.28H164c-3.19 0-4.51 1.31-4.51 4.36v2.84c0 3.06 1.32 4.36 4.51 4.36h8.74c.9 0 1.17.28 1.17 1v1.23c0 .68-.27.95-1.17.95h-7.34c-.62 0-.86-.27-.86-.85v-.16a.56.56 0 0 0-.62-.6h-4a.55.55 0 0 0-.62.6v1.12c0 3.22 1.08 4.28 4.4 4.28h11.2c3.19 0 4.51-1.31 4.51-4.36v-3c-.06-3.1-1.41-4.41-4.57-4.41Zm85.43 0h-8.75c-.89 0-1.16-.27-1.16-.95v-1.06c0-.68.27-1 1.16-1h6.7c.64 0 .89.28.89.85v.16a.55.55 0 0 0 .62.6h4a.55.55 0 0 0 .62-.6v-1.08c0-3.21-1.11-4.28-4.4-4.28h-10.48c-3.19 0-4.51 1.31-4.51 4.36v2.84c0 3.06 1.32 4.36 4.51 4.36h8.74c.89 0 1.16.28 1.16 1v1.23c0 .68-.27.95-1.16.95h-7.34c-.62 0-.86-.27-.86-.85v-.16a.57.57 0 0 0-.62-.6h-4.05a.55.55 0 0 0-.62.6v1.12c0 3.22 1.08 4.28 4.4 4.28h11.2c3.18 0 4.51-1.31 4.51-4.36v-3c0-3.1-1.33-4.41-4.51-4.41Zm26.65-7.36h-4.21a.56.56 0 0 0-.63.6v6.66h-9.2V55a.57.57 0 0 0-.65-.6H268a.55.55 0 0 0-.62.6v17.89a.55.55 0 0 0 .62.6h4.18a.57.57 0 0 0 .65-.6v-6.84h9.2v6.84a.56.56 0 0 0 .63.6h4.21a.55.55 0 0 0 .62-.6V55a.55.55 0 0 0-.57-.6Zm-137.62 0h-17.07a.55.55 0 0 0-.62.6v17.89a.55.55 0 0 0 .62.6h4.19a.58.58 0 0 0 .65-.6v-6.52h10.15a.57.57 0 0 0 .64-.6v-3.19a.57.57 0 0 0-.64-.6H137v-3.19h12.3a.55.55 0 0 0 .62-.6V55a.55.55 0 0 0-.62-.6Zm146.47 0h-4.18a.55.55 0 0 0-.62.6v17.89a.55.55 0 0 0 .62.6h4.18a.57.57 0 0 0 .65-.6V55a.57.57 0 0 0-.6-.6Zm-100.28.6a.83.83 0 0 0-.86-.57h-6.16a.83.83 0 0 0-.89.57l-7.42 17.89c-.14.36 0 .63.38.63h4.45a.8.8 0 0 0 .86-.57l1-2.68h9.1l1 2.68a.8.8 0 0 0 .87.57h4.69c.33 0 .49-.27.35-.63Zm-7 11 2.89-7.52 2.92 7.52Zm30.9-11.6H201a.55.55 0 0 0-.62.6v3.19a.55.55 0 0 0 .62.6h6.45v14.1a.55.55 0 0 0 .62.6h4.21a.56.56 0 0 0 .62-.6v-14.1h6.46a.55.55 0 0 0 .62-.6V55a.55.55 0 0 0-.64-.6Zm18.46 0h-11.52c-3.13 0-4.54 1.31-4.54 4.36v10.37c0 3.05 1.41 4.36 4.54 4.36h11.52c3.16 0 4.51-1.31 4.51-4.36V58.76c0-3.05-1.31-4.36-4.51-4.36Zm-.94 12.95c0 1.48-.3 1.75-2.08 1.75h-5.51c-1.75 0-2.07-.27-2.07-1.75v-6.81c0-1.47.32-1.75 2.07-1.75h5.51c1.78 0 2.08.28 2.08 1.75Z",fill:"#fad228",stroke:"#1e2127","stroke-width":"2"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-nomics",viewBox:"0 0 600 600"}},[r("path",{attrs:{d:"M273.56 133A136.81 136.81 0 0 0 0 136.86v326.28a136.8 136.8 0 0 0 233.57 96.75L326.44 467A136.81 136.81 0 0 0 600 463.14V136.86a136.8 136.8 0 0 0-233.57-96.75L273.56 133",fill:"#a0f"}}),r("ellipse",{attrs:{cx:"302.18",cy:"300.04",rx:"136.81",ry:"136.86",fill:"#fff"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-ivpn",viewBox:"0 0 84 29"}},[r("path",{attrs:{"fill-rule":"evenodd","clip-rule":"evenodd",d:"M6.75 0h6.03c.07 0 .15.03.2.1.04.05.06.13.05.2L8.6 27.43a.26.26 0 0 1-.24.22l-6.63.38H1.7a.25.25 0 0 1-.19-.08.26.26 0 0 1-.06-.22L5.2 5.05C5.12 1.67 1 .85.49.73-.06.59 0 0 0 0h6.75Zm32.32.12a.25.25 0 0 0-.22-.12h-6.5c-.1 0-.18.05-.23.14l-8.98 17.4L20.08.2a.25.25 0 0 0-.24-.21h-6.55a.25.25 0 0 0-.2.1.26.26 0 0 0-.05.2l4.85 26.05a.25.25 0 0 0 .26.2l7.57-.43c.08 0 .16-.06.2-.14L39.08.38a.26.26 0 0 0-.01-.26Zm20.27 5.5a6.8 6.8 0 0 0-.53-2.08c-.27-.6-.61-1.1-1.01-1.5-.4-.41-.8-.75-1.23-1A8.23 8.23 0 0 0 52.9 0H40.47a.25.25 0 0 0-.25.2l-4.01 24.6c-.01.07.01.14.06.2.05.05.11.08.18.08h.02l6.25-.36c.11 0 .2-.1.22-.21l.75-4.63h6.08c1.39-.09 2.7-.43 3.89-1.03a9.75 9.75 0 0 0 2.99-2.46 9.9 9.9 0 0 0 2-4.76l.56-3.3c.17-1.02.21-1.93.13-2.71Zm-7.21 5.87a2.53 2.53 0 0 1-1.1 1.66c-.27.18-.64.27-1.1.27H44.7l1.1-7h5.3c.45 0 .78.09.97.27.22.2.38.41.47.65.1.27.13.6.1.95l-.52 3.2ZM83.75 0h-6.32c-.12 0-.23.1-.25.22l-2.25 14.34L70.04.17a.25.25 0 0 0-.23-.17H63.5c-.12 0-.23.1-.25.22l-3.86 24.56c-.01.07.01.16.06.22.05.05.12.08.19.08l6.43-.39c.12 0 .21-.1.23-.22l1.62-10.36 3.4 10.08c.04.1.14.17.25.17l8.58-.52c.11 0 .2-.1.23-.22L84 .3a.27.27 0 0 0-.06-.22.24.24 0 0 0-.19-.09Z",fill:"#F34"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-strike",viewBox:"0 0 155 120"}},[r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{"fill-rule":"evenodd","clip-rule":"evenodd",d:"M7.06565 43.2477C1.90963 41.2685 -0.665684 35.4843 1.31353 30.3283C3.29274 25.1722 9.07699 22.5969 14.233 24.5761L51.4526 38.8634C51.4937 38.8798 51.535 38.896 51.5765 38.9119L70.2481 46.0792C75.4041 48.0584 81.1883 45.4831 83.1675 40.3271C85.1468 35.1711 82.5714 29.3868 77.4154 27.4076L77.4132 27.4068C77.4139 27.4064 77.4145 27.406 77.4151 27.4056L58.7436 20.2383C53.5876 18.2591 51.0123 12.4749 52.9915 7.31885C54.9707 2.16283 60.755 -0.412485 65.911 1.56673L120.828 22.6473C120.959 22.6977 121.089 22.7506 121.217 22.8059C121.453 22.8928 121.69 22.9815 121.926 23.0721C147.706 32.9681 160.583 61.8894 150.686 87.6695C140.79 113.45 111.869 126.326 86.089 116.43C85.5927 116.24 85.1011 116.042 84.6144 115.838C84.3783 115.766 84.1431 115.686 83.9091 115.596L30.0742 94.9308C24.9182 92.9516 22.3428 87.1673 24.3221 82.0113C26.3013 76.8553 32.0855 74.2799 37.2415 76.2592L55.9106 83.4256C55.9103 83.4242 55.9099 83.4229 55.9095 83.4215L55.9133 83.423C61.0694 85.4022 66.8536 82.8269 68.8328 77.6709C70.812 72.5148 68.2367 66.7306 63.0807 64.7514L54.6786 61.5261C54.6787 61.5257 54.6788 61.5252 54.6789 61.5247L7.06565 43.2477Z"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-hrf",viewBox:"0 0 3000 987.6"}},[r("path",{attrs:{d:"M1137.09 103.9v773.45h-51.44V515.96h-953.6v361.38H80.62V103.9h51.44v361.2h953.6V103.9h51.43zm-102.77 0h-51.44v258.19H234.94V103.9H183.5v309.05h850.82V103.9zm-696.29 0h-50.87v205.84h50.87V103.9zm593.05 0h-51.44v205.84h51.44V103.9zM183.5 877.34h51.44V619.16h747.94v258.19h51.44V567.72H183.5v309.62zm695.72 0h51.44V670.93h-51.44v206.41zm-592.47 0h51.44V670.93h-51.44v206.41z",fill:"#e12991"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{d:"M1422.94 103.88V331.3h-44.51v-94.22h-92.2v94.22h-44.83V103.88h44.83v90.32h92.2v-90.32h44.51zM1605.81 168.85V331.3h-41.91v-18.19c-9.75 14.62-26.64 22.74-48.41 22.74-34.44 0-61.4-24.04-61.4-67.25v-99.74H1496v94.54c0 22.1 13.32 33.47 32.16 33.47 20.47 0 35.74-12.02 35.74-40.29v-87.72h41.91zM1885.19 231.23V331.3h-41.91v-97.14c0-19.17-9.75-30.86-27.29-30.86-18.52 0-30.22 12.35-30.22 36.71v91.29h-41.91v-97.14c0-19.17-9.75-30.86-27.29-30.86-17.87 0-30.54 12.35-30.54 36.71v91.29h-41.91V168.85h41.91v17.22c9.1-13.64 24.37-21.77 45.16-21.77 20.14 0 35.09 8.45 44.18 23.39 10.07-14.62 26.32-23.39 48.41-23.39 37.04.01 61.41 26.32 61.41 66.93zM2086.24 168.85V331.3h-41.91v-19.17c-11.7 14.62-29.24 23.72-52.96 23.72-43.21 0-78.95-37.36-78.95-85.77s35.74-85.77 78.95-85.77c23.72 0 41.26 9.1 52.96 23.72v-19.17h41.91zm-41.91 81.23c0-27.29-19.17-45.81-45.16-45.81-25.66 0-44.83 18.52-44.83 45.81 0 27.29 19.17 45.81 44.83 45.81 25.99 0 45.16-18.52 45.16-45.81zM2275.93 231.56v99.74h-41.91v-94.54c0-22.09-13.32-33.46-32.16-33.46-20.47 0-35.74 12.02-35.74 40.29v87.72h-41.91V168.85h41.91v18.19c9.75-14.62 26.64-22.74 48.41-22.74 34.44.01 61.4 24.05 61.4 67.26zM1316.47 525.36h-30.25v78.95h-44.83V376.89h94.84c41.91 0 75.7 33.79 75.7 75.37 0 28.59-17.87 54.26-43.86 66.28l50.36 85.77h-48.41l-53.55-78.95zm-30.25-39.31h50c16.89 0 30.86-14.95 30.86-33.79s-13.97-33.46-30.86-33.46h-50v67.25zM1437.88 396.71c0-13.97 15.57-25.99 29.54-25.99 14.29 0 22.12 12.02 22.12 25.99s-11.7 25.67-25.99 25.67c-13.97 0-25.67-11.7-25.67-25.67zm4.88 45.16h41.91v162.45h-41.91V441.87zM1681.86 441.87v154.65c0 53.28-41.91 77.33-84.8 77.33-34.77 0-62.7-13.32-77-39.64l35.74-20.47c6.82 12.67 17.54 22.74 42.56 22.74 26.31 0 42.56-14.29 42.56-39.96v-17.54c-11.37 15.27-28.92 24.69-51.98 24.69-46.14 0-80.9-37.36-80.9-83.17 0-45.48 34.76-83.17 80.9-83.17 23.07 0 40.61 9.42 51.98 24.69v-20.14h40.94zm-40.94 78.62c0-25.67-19.17-44.18-45.49-44.18-26.31 0-45.48 18.52-45.48 44.18 0 25.99 19.17 44.51 45.48 44.51 26.32 0 45.49-18.52 45.49-44.51zM1871.55 504.57v99.74h-41.91v-94.54c0-22.09-13.32-33.46-32.16-33.46-20.47 0-35.74 12.02-35.74 40.29v87.72h-41.91V376.89h41.91v83.17c9.75-14.62 26.64-22.74 48.41-22.74 34.44 0 61.4 24.04 61.4 67.25zM1963.46 482.15v67.58c0 17.54 12.67 17.87 36.71 16.57v38.01c-58.81 6.5-78.62-10.72-78.62-54.58v-67.58h-28.27v-40.29h28.27v-32.81l41.91-12.67v45.48h36.71v40.29h-36.71zM2148.63 556.88c0 35.09-30.54 51.98-65.31 51.98-32.49 0-56.53-13.64-68.22-38.66l36.39-20.47c4.55 13.32 15.6 21.12 31.84 21.12 13.32 0 22.42-4.55 22.42-13.97 0-23.72-83.82-10.72-83.82-67.9 0-33.14 28.27-51.66 61.73-51.66 26.32 0 49.06 12.02 61.73 34.44l-35.74 19.49c-4.88-10.4-13.97-16.57-25.99-16.57-10.4 0-18.84 4.55-18.84 13.32-.01 24.04 83.81 9.1 83.81 68.88zM1286.22 692.79v53.93h96.11v42.89h-96.11v87.72h-44.83V649.9h143.54v42.88h-98.71zM1400.82 796.1c0-48.41 38.01-85.77 85.77-85.77s86.1 37.36 86.1 85.77-38.34 85.77-86.1 85.77c-47.76 0-85.77-37.36-85.77-85.77zm129.96 0c0-26.31-19.17-44.83-44.19-44.83-24.69 0-43.86 18.52-43.86 44.83 0 26.32 19.17 44.83 43.86 44.83 25.02.01 44.19-18.51 44.19-44.83zM1744.84 714.88v162.45h-41.91v-18.19c-9.75 14.62-26.64 22.74-48.41 22.74-34.44 0-61.4-24.04-61.4-67.25v-99.74h41.91v94.54c0 22.1 13.32 33.47 32.16 33.47 20.47 0 35.74-12.02 35.74-40.29v-87.72h41.91zM1934.86 777.58v99.74h-41.91v-94.54c0-22.09-13.32-33.46-32.16-33.46-20.47 0-35.74 12.02-35.74 40.29v87.72h-41.91V714.88h41.91v18.19c9.75-14.62 26.64-22.74 48.41-22.74 34.44 0 61.4 24.04 61.4 67.25zM2135.61 649.9v227.42h-41.91v-19.17c-11.7 14.95-28.92 23.72-52.63 23.72-43.54 0-79.27-37.36-79.27-85.77s35.74-85.77 79.27-85.77c23.72 0 40.94 8.77 52.63 23.72V649.9h41.91zm-41.91 146.2c0-27.29-19.17-45.81-44.84-45.81-25.99 0-45.16 18.52-45.16 45.81 0 27.29 19.17 45.81 45.16 45.81 25.67.01 44.84-18.51 44.84-45.81zM2337.35 714.88v162.45h-41.91v-19.17c-11.7 14.62-29.24 23.72-52.96 23.72-43.21 0-78.95-37.36-78.95-85.77s35.74-85.77 78.95-85.77c23.72 0 41.26 9.1 52.96 23.72v-19.17h41.91zm-41.91 81.22c0-27.29-19.17-45.81-45.16-45.81-25.66 0-44.83 18.52-44.83 45.81 0 27.29 19.17 45.81 44.83 45.81 25.99.01 45.16-18.51 45.16-45.81zM2433.46 755.17v67.58c0 17.54 12.67 17.87 36.71 16.57v38.01c-58.81 6.5-78.62-10.72-78.62-54.58v-67.58h-28.26v-40.29h28.26v-32.81l41.91-12.67v45.48h36.71v40.29h-36.71zM2494.84 669.72c0-13.97 11.7-25.99 25.67-25.99 14.29 0 25.99 12.02 25.99 25.99s-11.7 25.66-25.99 25.66c-13.97.01-25.67-11.69-25.67-25.66zm4.87 45.16h41.91v162.45h-41.91V714.88zM2565 796.1c0-48.41 38.01-85.77 85.77-85.77s86.1 37.36 86.1 85.77-38.34 85.77-86.1 85.77c-47.76 0-85.77-37.36-85.77-85.77zm129.96 0c0-26.31-19.17-44.83-44.19-44.83-24.69 0-43.86 18.52-43.86 44.83 0 26.32 19.17 44.83 43.86 44.83 25.02.01 44.19-18.51 44.19-44.83zM2911.62 777.58v99.74h-41.91v-94.54c0-22.09-13.32-33.46-32.16-33.46-20.47 0-35.74 12.02-35.74 40.29v87.72h-41.91V714.88h41.91v18.19c9.75-14.62 26.64-22.74 48.41-22.74 34.44 0 61.4 24.04 61.4 67.25z"}})]),t._v(" "),r("symbol",{attrs:{id:"supporter-esc",viewBox:"0 0 74.222 74.044"}},[r("g",{staticStyle:{fill:"var(--btcpay-body-text)"}},[r("path",{staticStyle:{"stroke-width":"1.91694"},attrs:{d:"M625.227 7403.82c-287.542-92.014-494.572-337.383-538.662-640.26-21.087-157.19-21.087-5869.689 0-6026.878 46.007-308.628 260.704-557.832 555.914-646.01C736.41 63.833 1046.955 60 3769.018 60s3032.608 3.834 3126.539 30.671c295.21 88.18 509.907 337.383 555.914 646.01 21.086 157.19 21.086 5869.69 0 6026.879-46.007 308.628-260.705 557.83-555.914 646.01-93.93 26.838-404.476 30.672-3134.207 28.755-2842.83 0-3036.442-1.917-3136.123-34.505zm6208.987-299.044c120.768-42.173 187.861-97.764 251.12-207.03l57.509-99.681V702.177l-57.509-99.681c-63.259-109.266-130.352-164.858-251.12-207.03-120.767-44.09-6009.625-44.09-6130.393 0-120.767 42.172-187.86 97.764-251.12 207.03l-57.508 99.68v6095.889l57.509 99.68c61.342 105.433 130.352 164.858 243.452 207.031 113.1 40.256 6021.127 42.173 6138.06 0z",transform:"matrix(.0098 0 0 .0098 .182 .285)"}}),r("path",{staticStyle:{"stroke-width":"1.91694"},attrs:{d:"M1934.5 4967.381c-272.206-55.591-492.654-249.203-582.75-511.824-32.59-97.764-36.423-162.94-36.423-705.436 0-542.496 3.834-607.672 36.422-705.436 74.761-216.615 241.535-391.057 456.233-475.403 103.515-42.173 139.937-44.09 529.077-46.007h419.811l46.007 53.675c59.425 69.01 59.425 136.103-1.917 195.528-46.007 47.924-49.84 47.924-398.725 47.924-433.23 0-513.741 19.17-646.01 151.439-113.1 113.1-134.186 180.193-134.186 425.562v185.944l59.425 11.501c32.588 5.751 291.376 11.502 575.084 11.502h513.741l38.339 49.84c51.758 65.177 51.758 122.685 0 187.861l-38.339 49.84h-513.741c-283.708 0-542.496 5.752-577.001 11.502l-61.342 13.419 5.75 224.283c7.668 207.03 11.502 230.033 61.343 302.877 69.01 107.35 185.943 187.86 302.877 212.781 51.758 11.502 247.286 21.087 431.313 21.087 329.715 0 335.465 0 381.472 47.923 61.342 59.425 61.342 126.519 1.917 195.529l-46.007 53.674-371.887 3.834c-203.196 1.917-406.393-5.75-450.482-13.419zM3677.004 2553.947c-208.947 55.59-368.053 189.777-461.984 389.14-42.172 92.013-49.84 134.186-49.84 279.874 0 157.19 5.75 185.943 63.259 300.96 70.927 143.771 184.027 254.954 325.88 323.964 67.094 32.588 145.689 46.007 312.463 57.508 251.12 17.253 289.459 28.755 379.555 105.432 228.117 191.695 147.605 565.5-139.937 649.845-70.927 21.086-197.445 28.754-481.153 28.754-379.555 0-387.223 0-427.48 44.09-57.507 61.342-55.59 147.605 7.669 207.03 49.84 46.007 49.84 46.007 492.655 46.007 412.143-1.917 452.4-3.834 550.163-44.09 153.356-61.342 293.293-191.694 368.054-345.05 57.508-115.017 63.26-143.771 63.26-300.96 0-157.19-5.752-185.944-63.26-300.961-69.01-143.771-184.027-254.954-325.88-323.964-69.011-32.588-141.855-46.007-312.463-57.508-164.857-11.502-243.452-24.92-300.96-53.675-237.702-120.767-283.709-415.977-93.931-611.506 97.764-101.598 195.529-118.85 638.343-118.85h389.14l38.339-49.84c59.425-74.762 51.758-147.606-19.17-207.031l-59.425-49.84-394.89 1.916c-279.875 0-427.48 9.585-498.407 28.755zM5630.372 4965.465c-299.043-57.509-546.33-297.127-613.423-594.254-26.837-109.266-26.837-1132.915 0-1242.18 69.01-302.878 314.38-538.663 621.091-594.254 174.442-32.588 745.692-26.837 812.785 7.668 84.346 42.173 107.35 153.356 47.924 230.033-26.837 36.422-57.509 38.34-435.147 47.924-392.974 9.585-410.226 13.419-504.157 61.342-113.1 59.426-193.611 157.19-230.033 279.874-38.34 124.602-38.34 1054.32 0 1178.922 36.422 120.768 122.684 226.2 235.784 281.791 88.18 46.007 111.183 47.924 484.987 53.675 368.054 5.75 394.891 9.584 437.064 47.923 23.003 21.087 42.173 61.343 42.173 92.014 0 153.355-49.84 170.608-473.486 168.691-187.86-1.917-379.555-9.585-425.562-19.17z",transform:"matrix(.0098 0 0 .0098 .182 .285)"}})])]),t._v(" "),r("symbol",{attrs:{id:"supporter-opensats",viewBox:"0 0 5220 720"}},[r("path",{attrs:{d:"M0 435.197L229.609 291.597V288.121L0 144.259V29.0508L334.901 245.894V333.824L0 550.798V435.197Z",fill:"#FF3300"}}),r("path",{attrs:{d:"M486.969 623.844H902.627V719.643H486.969V623.844Z",fill:"#FF3300"}}),r("path",{attrs:{d:"M993.879 291.2C993.879 106.422 1084.61 0 1214.37 0C1344.13 0 1434.86 106.422 1434.86 291.2C1434.86 479.061 1344.13 587.581 1214.37 587.581C1084.61 587.581 993.879 479.061 993.879 291.2ZM1345.12 291.2C1345.12 155.01 1293.16 75.9967 1214.37 75.9967C1135.58 75.9967 1083.62 155.01 1083.62 291.2C1083.62 430.473 1135.58 511.584 1214.37 511.584C1293.16 511.584 1344.85 430.473 1344.85 291.2H1345.12Z",fill:"#FF3300"}}),r("path",{attrs:{d:"M1593.29 154.29H1663.81L1670.37 205.37H1673.13C1711.31 169.634 1764.71 144.258 1814.44 144.258C1925.96 144.258 1988.02 228.713 1988.02 359.855C1988.02 504.111 1897.95 587.911 1797.77 587.911C1759.13 587.911 1713.54 568.829 1677.39 535.454H1675.29L1679.43 612.237V749.936H1593.29V154.29ZM1899.65 359.855C1899.65 271.269 1867.44 215.599 1791.21 215.599C1756.57 215.599 1717.93 232.713 1679.69 272.121V472.112C1714.79 503.914 1754.61 515.455 1781.57 515.455C1848.75 515.717 1899.65 459.851 1899.65 359.855Z",fill:"#FF3300"}}),r("path",{attrs:{d:"M2118.96 365.035C2118.96 227.336 2222.75 143.93 2335.98 143.93C2460.16 143.93 2530.82 225.434 2530.82 343.527C2530.67 359.209 2529.35 374.858 2526.88 390.345H2178.73V327.2H2473.22L2454.52 348.249C2454.52 256.449 2410.17 210.55 2338.47 210.55C2264.41 210.55 2203.66 265.17 2203.66 364.904C2203.66 468.833 2268.8 520.044 2359.79 520.044C2407.09 520.044 2445.08 505.75 2483.39 482.8L2513.56 537.29C2464.7 569.886 2407.32 587.378 2348.57 587.582C2220.39 587.582 2118.96 505.947 2118.96 365.035Z",fill:"#FF3300"}}),r("path",{attrs:{d:"M2658.41 154.29H2729.07L2735.63 221.697H2739.04C2781.55 178.289 2829.83 144.258 2895.17 144.258C2994.1 144.258 3039.17 205.042 3039.17 315.201V577.026H2952.9V326.152C2952.9 252.319 2928.11 218.222 2865.39 218.222C2819.47 218.222 2788.31 240.844 2744.68 285.563V577.026H2658.41V154.29Z",fill:"#FF3300"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{d:"M3208.36 504.308L3259.46 444.376C3303 486.486 3360.93 510.468 3421.5 511.455C3493.27 511.455 3533.03 478.669 3533.03 432.77C3533.03 377.362 3491.63 361.953 3435.41 338.217L3355.57 303.333C3297.64 280.514 3234.21 238.614 3234.21 155.143C3234.21 66.8186 3313.65 0.001814 3425.64 0.001814C3492.01 -0.442962 3555.93 25.0654 3603.75 71.0807L3558.87 126.554C3521.22 93.051 3472.3 74.9951 3421.9 75.9985C3362.2 75.9985 3322.11 103.604 3322.11 150.028C3322.11 199.206 3371.05 217.173 3420.98 236.516L3497.93 270.416C3569.04 298.087 3622.18 339.528 3622.18 422.344C3622.18 513.356 3545.36 587.583 3416.78 587.583C3339.11 587.998 3264.34 558.123 3208.36 504.308V504.308Z"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{d:"M3762.96 465.557C3762.96 370.741 3849.04 324.055 4062.7 308.186C4059.62 255.73 4031.54 213.896 3956.3 213.896C3905.13 213.896 3854.68 237.304 3813.28 261.5L3780.48 203.994C3827.98 174.684 3898.57 144.062 3971.78 144.062C4088.42 144.062 4148.91 210.945 4148.91 322.678V577.027H4077.73L4070.84 522.144H4068.08C4022.82 557.553 3963.97 587.715 3906.04 587.715C3825.16 587.584 3762.96 540.045 3762.96 465.557ZM4062.7 462.278V363.266C3896.79 375.134 3847.26 408.576 3847.26 459C3847.26 501.489 3885.38 519.063 3930.65 519.063C3975.91 519.063 4018.88 497.883 4062.7 462.278Z"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{d:"M4388.81 409.884V222.941H4272.17V158.813L4392.16 154.289L4403.44 20.2617H4475.02V154.289H4674.64V222.941H4475.02V410.146C4475.02 482.864 4500.73 518.076 4577.29 518.076C4610.27 517.981 4642.96 511.847 4673.73 499.979L4691.24 562.992C4648.39 578.951 4603.07 587.274 4557.35 587.581C4430.86 587.581 4388.81 516.043 4388.81 409.884Z"}}),r("path",{staticStyle:{fill:"var(--btcpay-body-text)"},attrs:{d:"M4818.71 521.815L4857.09 466.014C4909.9 502.948 4972.98 522.353 5037.43 521.487C5102.31 521.487 5133.34 495.259 5133.34 463.85C5133.34 433.95 5115.76 415 5009.22 393.034C4897.7 369.887 4845.21 331.2 4845.21 267.203C4845.21 196.518 4908.85 143.93 5025.95 143.93C5093.26 143.93 5157.55 170.158 5199.93 198.878L5159.45 252.646C5117.79 224.668 5068.79 209.592 5018.6 209.304C4955.62 209.304 4931.28 234.155 4931.28 263.138C4931.28 295.923 4965.07 309.037 5048.12 326.938C5185.89 357.101 5220.33 392.509 5220.33 458.736C5220.33 529.487 5151.71 587.582 5026.8 587.582C4952.47 586.641 4880.07 563.76 4818.71 521.815V521.815Z"}})])]),t._v(" "),r("div",{staticClass:"supporters"},[r("h3",[t._v("Our Supporters")]),t._v(" "),r("p",[t._v("\n The BTCPay Server Project is proudly supported by these entities through the\n "),r("a",{attrs:{href:"https://foundation.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("BTCPay Server Foundation")]),t._v(".\n ")]),t._v(" "),r("div",{staticClass:"logos"},[r("a",{attrs:{href:"https://spiral.xyz",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{staticStyle:{padding:"5px"},attrs:{role:"img",width:"100",height:"100"}},[r("use",{attrs:{href:"#supporter-spiral"}})]),t._v("\n Spiral\n ")]),t._v(" "),r("a",{attrs:{href:"https://opensats.org",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"120",height:"100"}},[r("use",{attrs:{href:"#supporter-opensats"}})]),t._v("\n OpenSats\n ")]),t._v(" "),r("a",{attrs:{href:"https://www.bailliegifford.com",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"110",height:"100"}},[r("use",{attrs:{href:"#supporter-bailliegifford"}})]),t._v("\n Baillie Gifford\n ")]),t._v(" "),r("a",{attrs:{href:"https://strike.me",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"55",height:"50"}},[r("use",{attrs:{href:"#supporter-strike"}})]),t._v("\n Strike\n ")]),t._v(" "),r("a",{attrs:{href:"https://hrf.org",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"110",height:"50"}},[r("use",{attrs:{href:"#supporter-hrf"}})]),t._v("\n HRF\n ")]),t._v(" "),r("a",{attrs:{href:"https://escapetoelsalvador.org/",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"100",height:"90"}},[r("use",{attrs:{href:"#supporter-esc"}})]),t._v("\n ESC\n ")]),t._v(" "),r("a",{attrs:{href:"https://www.lunanode.com/",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"100",height:"100"}},[r("use",{attrs:{href:"#supporter-lunanode"}})]),t._v("\n LunaNode\n ")]),t._v(" "),r("a",{attrs:{href:"https://walletofsatoshi.com/",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"100",height:"100"}},[r("use",{attrs:{href:"#supporter-walletofsatoshi"}})]),t._v("\n Wallet of Satoshi\n ")]),t._v(" "),r("a",{attrs:{href:"https://coincards.com/",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"130",height:"100"}},[r("use",{attrs:{href:"#supporter-coincards"}})]),t._v("\n Coincards\n ")]),t._v(" "),r("a",{attrs:{href:"https://www.ivpn.net/",target:"_blank",rel:"noopener noreferrer"}},[r("svg",{attrs:{role:"img",width:"100",height:"100"}},[r("use",{attrs:{href:"#supporter-ivpn"}})]),t._v("\n IVPN\n ")])]),t._v(" "),r("p",[t._v("If you'd like to support the project, please visit the "),r("a",{attrs:{href:"https://btcpayserver.org/donate/"}},[t._v("donation page")]),t._v(".")])])])}),[],!1,null,null,null);r.default=l.exports}}]); \ No newline at end of file diff --git a/assets/js/134.2417d3b8.js b/assets/js/134.13b2640f.js similarity index 94% rename from assets/js/134.2417d3b8.js rename to assets/js/134.13b2640f.js index 2e48ba8cc8..39fb22d6d9 100644 --- a/assets/js/134.2417d3b8.js +++ b/assets/js/134.13b2640f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[134],{780:function(t,e,o){"use strict";o.r(e);var a=o(9),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"reporting-in-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#reporting-in-btcpay"}},[t._v("#")]),t._v(" Reporting in BTCPay")]),t._v(" "),e("p",[t._v("BTCPay Server offers several tools that make "),e("strong",[t._v("cryptocurrency bookkeeping")]),t._v(" easier.\nReporting will allow you to visualize and export CSV data of your store.")]),t._v(" "),e("p",[t._v("A report consist of table of tabular data along with some useful aggregates.")]),t._v(" "),e("p",[t._v("You can find the following reports:")]),t._v(" "),e("ul",[e("li",[t._v("On-Chain Wallets: Each line show you the on-chain transactions affecting your wallet.")]),t._v(" "),e("li",[t._v("Products Sold: Each line represents a quantity of item sold. This is useful if you are using Point of Sale or Crowdfunding.")]),t._v(" "),e("li",[t._v("Payments: Each line represents an accounted payment to an invoice.")])])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[134],{784:function(t,e,o){"use strict";o.r(e);var a=o(9),n=Object(a.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"reporting-in-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#reporting-in-btcpay"}},[t._v("#")]),t._v(" Reporting in BTCPay")]),t._v(" "),e("p",[t._v("BTCPay Server offers several tools that make "),e("strong",[t._v("cryptocurrency bookkeeping")]),t._v(" easier.\nReporting will allow you to visualize and export CSV data of your store.")]),t._v(" "),e("p",[t._v("A report consist of table of tabular data along with some useful aggregates.")]),t._v(" "),e("p",[t._v("You can find the following reports:")]),t._v(" "),e("ul",[e("li",[t._v("On-Chain Wallets: Each line show you the on-chain transactions affecting your wallet.")]),t._v(" "),e("li",[t._v("Products Sold: Each line represents a quantity of item sold. This is useful if you are using Point of Sale or Crowdfunding.")]),t._v(" "),e("li",[t._v("Payments: Each line represents an accounted payment to an invoice.")])])])}),[],!1,null,null,null);e.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/135.f6f0ddb9.js b/assets/js/135.f9a1f82a.js similarity index 96% rename from assets/js/135.f6f0ddb9.js rename to assets/js/135.f9a1f82a.js index 16aea00a33..16806442ea 100644 --- a/assets/js/135.f6f0ddb9.js +++ b/assets/js/135.f9a1f82a.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[135],{782:function(t,e,a){"use strict";a.r(e);var r=a(9),o=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"shopware-integration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#shopware-integration"}},[t._v("#")]),t._v(" Shopware integration")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("Please be aware that those two integrations are not maintained by the BTCPay Server team. If you have any questions, please go to their GitHub issues and contact them directly.")])]),t._v(" "),e("h2",{attrs:{id:"plugin-for-shopware-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#plugin-for-shopware-6"}},[t._v("#")]),t._v(" Plugin for Shopware 6")]),t._v(" "),e("p",[t._v("Find it on the "),e("a",{attrs:{href:"https://store.shopware.com/en/coinc71249255720f/accept-bitcoin-and-lightning-payments-via-btcpay-server.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Shopware store"),e("OutboundLink")],1),t._v(" or download it on "),e("a",{attrs:{href:"https://github.com/coincharge-io/CoinchargeBTCPayShopware",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"plugin-for-shopware-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#plugin-for-shopware-5"}},[t._v("#")]),t._v(" Plugin for Shopware 5")]),t._v(" "),e("p",[t._v("Download it on "),e("a",{attrs:{href:"https://github.com/lampsolutions/LampSBtcPayShopware",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[135],{785:function(t,e,a){"use strict";a.r(e);var r=a(9),o=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"shopware-integration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#shopware-integration"}},[t._v("#")]),t._v(" Shopware integration")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("Please be aware that those two integrations are not maintained by the BTCPay Server team. If you have any questions, please go to their GitHub issues and contact them directly.")])]),t._v(" "),e("h2",{attrs:{id:"plugin-for-shopware-6"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#plugin-for-shopware-6"}},[t._v("#")]),t._v(" Plugin for Shopware 6")]),t._v(" "),e("p",[t._v("Find it on the "),e("a",{attrs:{href:"https://store.shopware.com/en/coinc71249255720f/accept-bitcoin-and-lightning-payments-via-btcpay-server.html",target:"_blank",rel:"noopener noreferrer"}},[t._v("Shopware store"),e("OutboundLink")],1),t._v(" or download it on "),e("a",{attrs:{href:"https://github.com/coincharge-io/CoinchargeBTCPayShopware",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub"),e("OutboundLink")],1)]),t._v(" "),e("h2",{attrs:{id:"plugin-for-shopware-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#plugin-for-shopware-5"}},[t._v("#")]),t._v(" Plugin for Shopware 5")]),t._v(" "),e("p",[t._v("Download it on "),e("a",{attrs:{href:"https://github.com/lampsolutions/LampSBtcPayShopware",target:"_blank",rel:"noopener noreferrer"}},[t._v("GitHub"),e("OutboundLink")],1)])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/136.391ecddd.js b/assets/js/136.013d1533.js similarity index 97% rename from assets/js/136.391ecddd.js rename to assets/js/136.013d1533.js index 59ccfffde2..442f31308e 100644 --- a/assets/js/136.391ecddd.js +++ b/assets/js/136.013d1533.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[136],{783:function(e,t,r){"use strict";r.r(t);var o=r(9),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#support"}},[e._v("#")]),e._v(" Support")]),e._v(" "),t("p",[e._v("This project is open source and is not a company. Instead "),t("strong",[e._v("we rely on a network of contributors and users to provide support")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"free-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#free-support"}},[e._v("#")]),e._v(" Free support")]),e._v(" "),t("p",[e._v("Problem? Don't worry. Someone else has probably been through that before you.")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("First have a look at our "),t("RouterLink",{attrs:{to:"/"}},[e._v("user documentation")]),e._v(" and "),t("RouterLink",{attrs:{to:"/FAQ/"}},[e._v("Frequently Asked Questions")]),e._v(".")],1)]),e._v(" "),t("li",[t("p",[e._v("If your issue is not referenced there, or you want to request a new feature, please open a "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("github issue"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("li",[t("p",[e._v("If you have more general questions about BTCPay, the way it works and why you should use it, you're welcome on our "),t("a",{attrs:{href:"https://chat.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mattermost Chat"),t("OutboundLink")],1),e._v(" or "),t("a",{attrs:{href:"https://t.me/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Telegram"),t("OutboundLink")],1)])])]),e._v(" "),t("p",[e._v("Getting proper support also depends on how you formulate your questions. Read our "),t("RouterLink",{attrs:{to:"/Troubleshooting/"}},[e._v("troubleshooting guidelines")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"paid-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#paid-support"}},[e._v("#")]),e._v(" Paid support")]),e._v(" "),t("p",[e._v("As we are an Open Source project, someone in the community might want to help.\nTherefore we've facilitated a channel on our Mattermost to find these talents.")]),e._v(" "),t("p",[e._v("Check out our "),t("code",[e._v("Freelance")]),e._v(" channel on Mattermost.\n"),t("a",{attrs:{href:"https://chat.btcpayserver.org/btcpayserver/channels/freelance-jobs",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mattermost Chat"),t("OutboundLink")],1)]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[t("strong",[e._v("BTCPay Server is and will not guarantee or vouch for any support.")])])])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[136],{787:function(e,t,r){"use strict";r.r(t);var o=r(9),a=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#support"}},[e._v("#")]),e._v(" Support")]),e._v(" "),t("p",[e._v("This project is open source and is not a company. Instead "),t("strong",[e._v("we rely on a network of contributors and users to provide support")]),e._v(".")]),e._v(" "),t("h2",{attrs:{id:"free-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#free-support"}},[e._v("#")]),e._v(" Free support")]),e._v(" "),t("p",[e._v("Problem? Don't worry. Someone else has probably been through that before you.")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("First have a look at our "),t("RouterLink",{attrs:{to:"/"}},[e._v("user documentation")]),e._v(" and "),t("RouterLink",{attrs:{to:"/FAQ/"}},[e._v("Frequently Asked Questions")]),e._v(".")],1)]),e._v(" "),t("li",[t("p",[e._v("If your issue is not referenced there, or you want to request a new feature, please open a "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("github issue"),t("OutboundLink")],1),e._v(".")])]),e._v(" "),t("li",[t("p",[e._v("If you have more general questions about BTCPay, the way it works and why you should use it, you're welcome on our "),t("a",{attrs:{href:"https://chat.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mattermost Chat"),t("OutboundLink")],1),e._v(" or "),t("a",{attrs:{href:"https://t.me/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("Telegram"),t("OutboundLink")],1)])])]),e._v(" "),t("p",[e._v("Getting proper support also depends on how you formulate your questions. Read our "),t("RouterLink",{attrs:{to:"/Troubleshooting/"}},[e._v("troubleshooting guidelines")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"paid-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#paid-support"}},[e._v("#")]),e._v(" Paid support")]),e._v(" "),t("p",[e._v("As we are an Open Source project, someone in the community might want to help.\nTherefore we've facilitated a channel on our Mattermost to find these talents.")]),e._v(" "),t("p",[e._v("Check out our "),t("code",[e._v("Freelance")]),e._v(" channel on Mattermost.\n"),t("a",{attrs:{href:"https://chat.btcpayserver.org/btcpayserver/channels/freelance-jobs",target:"_blank",rel:"noopener noreferrer"}},[e._v("Mattermost Chat"),t("OutboundLink")],1)]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[t("strong",[e._v("BTCPay Server is and will not guarantee or vouch for any support.")])])])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/137.e8e3b557.js b/assets/js/137.5c92c3d0.js similarity index 98% rename from assets/js/137.e8e3b557.js rename to assets/js/137.5c92c3d0.js index 3490b3ea43..b2836958bc 100644 --- a/assets/js/137.e8e3b557.js +++ b/assets/js/137.5c92c3d0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[137],{784:function(e,t,a){"use strict";a.r(t);var r=a(9),i=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"tickettailor-plugin-for-btcpayserver"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tickettailor-plugin-for-btcpayserver"}},[e._v("#")]),e._v(" TicketTailor plugin for BTCPayServer")]),e._v(" "),t("p",[e._v("This plugin allows you to integrate "),t("a",{attrs:{href:"https://www.tickettailor.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("TicketTailor"),t("OutboundLink")],1),e._v(" with BTCPay Server.\nIt allows you to sell tickets for your events and accept payments in Bitcoin.")]),e._v(" "),t("h2",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("ol",[t("li",[e._v("Install the plugin from Plugins=>Add New=> TicketTailor")]),e._v(" "),t("li",[e._v("Restart BTCPay Server")]),e._v(" "),t("li",[e._v("Go to your Ticket Tailor account and add a "),t("a",{attrs:{href:"https://app.tickettailor.com/box-office/api#dpop=/box-office/api-key/add",target:"_blank",rel:"noopener noreferrer"}},[e._v("new API key"),t("OutboundLink")],1),e._v(" with "),t("code",[e._v("Admin")]),e._v(' role and "hide personal data from responses" unchecked.')]),e._v(" "),t("li",[e._v("Go back to your BTCPay Server, choose the store to integrate with and click on Ticket Tailor in the navigation.")]),e._v(" "),t("li",[e._v("Enter the API Key and save.")]),e._v(" "),t("li",[e._v("Now you should be able to select your Ticket tailor events in the dropdown. One selected, click save.")]),e._v(" "),t("li",[e._v('You should now have a "ticket purchase" button on your store\'s page. Clicking it will take you to the btcpayserver event purchase page.')])]),e._v(" "),t("h2",{attrs:{id:"flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#flow"}},[e._v("#")]),e._v(" Flow")]),e._v(" "),t("p",[e._v("When a customer goes to the ticket purchase page, they can enter a name and must enter an email. Ticket Tailor requires a full name, so we generate one if not specified.\nAfter the tickets are selected, the customer is redirected to the BTCPay Server checkout page, and a hold for the selected tickets is created to reserve the tickets for this customer. After the payment is sent, the customer is redirected to a custom receipt page where they can see their tickets. Tickets are only issued AFTER an invoice is settled. If an invoice is set to invalid or expired, the hold is deleted and the tickets are released for sale again.")]),e._v(" "),t("h2",{attrs:{id:"additional-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-configuration"}},[e._v("#")]),e._v(" Additional Configuration")]),e._v(" "),t("p",[e._v("You should configure the "),t("RouterLink",{attrs:{to:"/Notifications/#store-emails"}},[e._v("SMTP email settings in the store")]),e._v(" so that users receive the ticket link by email after an invoice is settled.\nYou're also able to override ticket names, prices and description on the BTCPay Server side.")],1),e._v(" "),t("h2",{attrs:{id:"secret-tickets"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#secret-tickets"}},[e._v("#")]),e._v(" Secret Tickets")]),e._v(" "),t("p",[e._v("You can configure a ticket on ticket tailor to require an access code. BTCPay Server allows you to add "),t("code",[e._v("?accessCode=XXXX")]),e._v(" to the ticket purchase page url to allow customers to view and purchase these secret tickets.")])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[137],{786:function(e,t,a){"use strict";a.r(t);var r=a(9),i=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"tickettailor-plugin-for-btcpayserver"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#tickettailor-plugin-for-btcpayserver"}},[e._v("#")]),e._v(" TicketTailor plugin for BTCPayServer")]),e._v(" "),t("p",[e._v("This plugin allows you to integrate "),t("a",{attrs:{href:"https://www.tickettailor.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("TicketTailor"),t("OutboundLink")],1),e._v(" with BTCPay Server.\nIt allows you to sell tickets for your events and accept payments in Bitcoin.")]),e._v(" "),t("h2",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("ol",[t("li",[e._v("Install the plugin from Plugins=>Add New=> TicketTailor")]),e._v(" "),t("li",[e._v("Restart BTCPay Server")]),e._v(" "),t("li",[e._v("Go to your Ticket Tailor account and add a "),t("a",{attrs:{href:"https://app.tickettailor.com/box-office/api#dpop=/box-office/api-key/add",target:"_blank",rel:"noopener noreferrer"}},[e._v("new API key"),t("OutboundLink")],1),e._v(" with "),t("code",[e._v("Admin")]),e._v(' role and "hide personal data from responses" unchecked.')]),e._v(" "),t("li",[e._v("Go back to your BTCPay Server, choose the store to integrate with and click on Ticket Tailor in the navigation.")]),e._v(" "),t("li",[e._v("Enter the API Key and save.")]),e._v(" "),t("li",[e._v("Now you should be able to select your Ticket tailor events in the dropdown. One selected, click save.")]),e._v(" "),t("li",[e._v('You should now have a "ticket purchase" button on your store\'s page. Clicking it will take you to the btcpayserver event purchase page.')])]),e._v(" "),t("h2",{attrs:{id:"flow"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#flow"}},[e._v("#")]),e._v(" Flow")]),e._v(" "),t("p",[e._v("When a customer goes to the ticket purchase page, they can enter a name and must enter an email. Ticket Tailor requires a full name, so we generate one if not specified.\nAfter the tickets are selected, the customer is redirected to the BTCPay Server checkout page, and a hold for the selected tickets is created to reserve the tickets for this customer. After the payment is sent, the customer is redirected to a custom receipt page where they can see their tickets. Tickets are only issued AFTER an invoice is settled. If an invoice is set to invalid or expired, the hold is deleted and the tickets are released for sale again.")]),e._v(" "),t("h2",{attrs:{id:"additional-configuration"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-configuration"}},[e._v("#")]),e._v(" Additional Configuration")]),e._v(" "),t("p",[e._v("You should configure the "),t("RouterLink",{attrs:{to:"/Notifications/#store-emails"}},[e._v("SMTP email settings in the store")]),e._v(" so that users receive the ticket link by email after an invoice is settled.\nYou're also able to override ticket names, prices and description on the BTCPay Server side.")],1),e._v(" "),t("h2",{attrs:{id:"secret-tickets"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#secret-tickets"}},[e._v("#")]),e._v(" Secret Tickets")]),e._v(" "),t("p",[e._v("You can configure a ticket on ticket tailor to require an access code. BTCPay Server allows you to add "),t("code",[e._v("?accessCode=XXXX")]),e._v(" to the ticket purchase page url to allow customers to view and purchase these secret tickets.")])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/assets/js/138.27123c36.js b/assets/js/138.87e82a44.js similarity index 99% rename from assets/js/138.27123c36.js rename to assets/js/138.87e82a44.js index acee2e5f18..ec2dd94fdd 100644 --- a/assets/js/138.27123c36.js +++ b/assets/js/138.87e82a44.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[138],{787:function(e,t,a){"use strict";a.r(t);var r=a(9),i=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"btctransmuter-docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#btctransmuter-docs"}},[e._v("#")]),e._v(" BtcTransmuter Docs")]),e._v(" "),t("h2",{attrs:{id:"introduction-what-is-btctransmuter"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction-what-is-btctransmuter"}},[e._v("#")]),e._v(" Introduction - What is BtcTransmuter?")]),e._v(" "),t("p",[e._v("BtcTransmuter is a free, open-source & self-hosted tool that allows you to configure actions that execute automatically upon specified conditions. Its primary focus is the integration of cryptocurrency services to help users manage their funds and business workflow.")]),e._v(" "),t("h2",{attrs:{id:"how-does-it-work"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-does-it-work"}},[e._v("#")]),e._v(" How does it work?")]),e._v(" "),t("p",[e._v("There are 3 main components in BtcTransmuter - External Services, Recipes and Extensions.")]),e._v(" "),t("ul",[t("li",[e._v("External services integrated with third parties, such as a BTCPayServer instance or a Cryptocurrency Exchange.")]),e._v(" "),t("li",[e._v("Recipes is a set of instructions created by the user: What to execute and when. The execution part is called a Recipe Action while the condition is called a Recipe Trigger. An action could be "),t("code",[e._v("Send an Email using the SMTP External Service")]),e._v(" and the trigger being "),t("code",[e._v("If a new invoice was created on my BtcPay External Service")])]),e._v(" "),t("li",[e._v("Extensions provide a way to add more external service types, actions and triggers without needing to modify the original code.")])]),e._v(" "),t("h2",{attrs:{id:"can-i-use-this-in-production"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#can-i-use-this-in-production"}},[e._v("#")]),e._v(" Can I use this in production")]),e._v(" "),t("p",[e._v("This project is still in early development and most likely has some bugs and quirks that need to be ironed out. The project is considered to be in ALPHA state, meaning not all desired functionality has been implemented and there can be breaking changes.")]),e._v(" "),t("h2",{attrs:{id:"how-do-i-deploy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-do-i-deploy"}},[e._v("#")]),e._v(" How do I deploy?")]),e._v(" "),t("p",[e._v("If you set up BTCPay using any "),t("RouterLink",{attrs:{to:"/Docker/"}},[e._v("dockerized install method")]),e._v(", you can enable BTC Transmuter easily.")],1),e._v(" "),t("p",[e._v("First, "),t("a",{attrs:{href:"https://github.com/JeffVandrewJr/patron/blob/master/SSH.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("SSH"),t("OutboundLink")],1),e._v(" into your server.\nThen run the following commands:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(';opt-add-btctransmuter"')]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n")])])]),t("p",[e._v("If you have trouble starting your server after running the setup command, verify you have "),t("RouterLink",{attrs:{to:"/FAQ/FAQ-Deployment/#how-can-i-modify-or-deactivate-environment-variables"}},[e._v("added the environment variable")]),e._v(" correctly to enable Transmuter.")],1),e._v(" "),t("p",[e._v("Once completed, your Transmuter will be available at your configured BTCPay website under "),t("code",[e._v("/btctransmuter/")]),e._v(", where the first account to register becomes the Transmuter admin. Open that link in your browser and you’ll see the homepage.")]),e._v(" "),t("h2",{attrs:{id:"what-extensions-are-provided"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-extensions-are-provided"}},[e._v("#")]),e._v(" What extensions are provided?")]),e._v(" "),t("p",[e._v("You can see a list of built-in extensions once you log into your transmuter application under "),t("code",[e._v("/extensions")]),e._v(".")]),e._v(" "),t("p",[e._v("Currently there are 12 extensions that come bundled with the main application:")]),e._v(" "),t("ul",[t("li",[e._v("Tor - Provides TOR access to your Transmuter app")]),e._v(" "),t("li",[e._v("Presets - Provides one page wizards for quick setups of common scenarios")]),e._v(" "),t("li",[e._v("BtcPayServer - Provides you a way to interact with BTCPayServer stores")]),e._v(" "),t("li",[e._v("Email - Provides you with a way to check a POP3 for incoming emails and a way to send Email via SMTP")]),e._v(" "),t("li",[e._v("Exchange - Provides you a way to connect to a variety of exchanges and place orders on them")]),e._v(" "),t("li",[e._v("Lightning - Provides you interoperability with lightning nodes to be able to do basic channel and invoice management")]),e._v(" "),t("li",[e._v("NBXplorer - Provides you ways to detect incoming funds, send funds, and generate addresses.")]),e._v(" "),t("li",[e._v("Operators - Lets you create conditional workflows")]),e._v(" "),t("li",[e._v("Recipe - Lets you manage existing or create recipes with your workflows")]),e._v(" "),t("li",[e._v("Timer - Run X every Y")]),e._v(" "),t("li",[e._v("WebHook - Trigger Recipes with an http call or execute external web hooks with a recipe")])]),e._v(" "),t("h2",{attrs:{id:"what-preset-recipes-are-provided"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-preset-recipes-are-provided"}},[e._v("#")]),e._v(" What preset recipes are provided?")]),e._v(" "),t("p",[e._v("Currently there are three preset recipes that you can enable easily. In addition to the list below, you can create your own recipes for automating other tasks.")]),e._v(" "),t("ol",[t("li",[e._v("On-chain Forwarder - Forward funds from a wallet elsewhere")]),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/Transmuter/EmailReceiptsPreset/"}},[e._v("BTCPay Email Receipts")]),e._v(" - Send an email when a BTCPay invoice gets paid")],1),e._v(" "),t("li",[e._v("Fiat Conversion - Convert incoming money to fiat on an exchange by market selling when BTCPay invoice statuses change.")]),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/Transmuter/DCA/"}},[e._v("Dollar Cost Average")]),e._v(" - Schedule daily purchases of Bitcoin")],1)]),e._v(" "),t("h2",{attrs:{id:"how-do-i-write-an-extension"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-do-i-write-an-extension"}},[e._v("#")]),e._v(" How do I write an extension?")]),e._v(" "),t("p",[e._v("An extension must be its own .net core class library project that references "),t("code",[e._v("BtcTransmuter.Abstractions")]),e._v("\nThere must be a class implementing "),t("code",[e._v("BtcTransmuterExtension")]),e._v(" in this library. This file bootstraps the plugin name and adds all the services to system on startup.")]),e._v(" "),t("h3",{attrs:{id:"adding-a-trigger"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adding-a-trigger"}},[e._v("#")]),e._v(" Adding a Trigger")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Implement "),t("code",[e._v("BaseTrigger")]),e._v(" This class will be used to transport the event data")])]),e._v(" "),t("li",[t("p",[e._v("Implement "),t("code",[e._v("BaseTriggerHandler")]),e._v(" This handles:")]),e._v(" "),t("ul",[t("li",[e._v("Describing the trigger to the main system.")]),e._v(" "),t("li",[e._v("Telling the main UI how to create/edit a recipe trigger using it.")]),e._v(" "),t("li",[e._v("The logic needed to see if a trigger is...triggered.")])]),e._v(" "),t("p",[e._v("You will see that "),t("code",[e._v("BaseTriggerHandler")]),e._v(" has 2 generic arguments, a "),t("code",[e._v("Data")]),e._v(" and "),t("code",[e._v("Parameters")]),e._v(" "),t("code",[e._v("Data")]),e._v(" is the trigger that that was detected, while "),t("code",[e._v("Parameters")]),e._v(" is the data from a Recipe to see if it triggers its actions.")])]),e._v(" "),t("li",[t("p",[e._v("Implement a Partial View (named as the same value as the property "),t("code",[e._v("ViewPartial")]),e._v(" in the "),t("code",[e._v("BaseTriggerHandler")]),e._v(" implementation)\nThis handles displaying the trigger settings in a recipe")])]),e._v(" "),t("li",[t("p",[e._v("Implement a Controller that allows a user to create/edit the necessary data to set the trigger on a recipe.")])])]),e._v(" "),t("h3",{attrs:{id:"adding-an-action"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adding-an-action"}},[e._v("#")]),e._v(" Adding an Action")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Implement "),t("code",[e._v("BaseActionHandler")]),e._v(" This handles:")]),e._v(" "),t("ul",[t("li",[e._v("Describing the action to the main system.")]),e._v(" "),t("li",[e._v("Telling the main UI how to create/edit a recipe action using it.")]),e._v(" "),t("li",[e._v("The logic needed to execute the action")])]),e._v(" "),t("p",[e._v("You will see that "),t("code",[e._v("BaseActionHandler")]),e._v(" has a generic argument, "),t("code",[e._v("Data")]),e._v(" "),t("code",[e._v("Data")]),e._v(" is the type of the action that holds the payload needed to exeucte the action through the instructions of recipe action")])]),e._v(" "),t("li",[t("p",[e._v("Implement a Partial View (named as the same value as the property "),t("code",[e._v("ViewPartial")]),e._v(" in the "),t("code",[e._v("BaseActionHandler")]),e._v(" implementation)\nThis handles displaying the action settings in a recipe")])]),e._v(" "),t("li",[t("p",[e._v("Implement a Controller that allows a user to create/edit the necessary data to set the action on a recipe.")])])]),e._v(" "),t("h3",{attrs:{id:"adding-an-external-service"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adding-an-external-service"}},[e._v("#")]),e._v(" Adding an External Service")]),e._v(" "),t("ul",[t("li",[e._v("Implement "),t("code",[e._v("BaseExternalService")]),e._v(" & "),t("code",[e._v("IExternalServiceDescriptor")])]),e._v(" "),t("li",[e._v("Implement a Partial View (named as the same value as the property "),t("code",[e._v("ViewPartial")]),e._v(" in the "),t("code",[e._v("IExternalServiceDescriptor")]),e._v(" implementation)")]),e._v(" "),t("li",[e._v("Implement a Controller that allows a user to create/edit the necessary data for an external service.")])])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[138],{789:function(e,t,a){"use strict";a.r(t);var r=a(9),i=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"btctransmuter-docs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#btctransmuter-docs"}},[e._v("#")]),e._v(" BtcTransmuter Docs")]),e._v(" "),t("h2",{attrs:{id:"introduction-what-is-btctransmuter"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction-what-is-btctransmuter"}},[e._v("#")]),e._v(" Introduction - What is BtcTransmuter?")]),e._v(" "),t("p",[e._v("BtcTransmuter is a free, open-source & self-hosted tool that allows you to configure actions that execute automatically upon specified conditions. Its primary focus is the integration of cryptocurrency services to help users manage their funds and business workflow.")]),e._v(" "),t("h2",{attrs:{id:"how-does-it-work"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-does-it-work"}},[e._v("#")]),e._v(" How does it work?")]),e._v(" "),t("p",[e._v("There are 3 main components in BtcTransmuter - External Services, Recipes and Extensions.")]),e._v(" "),t("ul",[t("li",[e._v("External services integrated with third parties, such as a BTCPayServer instance or a Cryptocurrency Exchange.")]),e._v(" "),t("li",[e._v("Recipes is a set of instructions created by the user: What to execute and when. The execution part is called a Recipe Action while the condition is called a Recipe Trigger. An action could be "),t("code",[e._v("Send an Email using the SMTP External Service")]),e._v(" and the trigger being "),t("code",[e._v("If a new invoice was created on my BtcPay External Service")])]),e._v(" "),t("li",[e._v("Extensions provide a way to add more external service types, actions and triggers without needing to modify the original code.")])]),e._v(" "),t("h2",{attrs:{id:"can-i-use-this-in-production"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#can-i-use-this-in-production"}},[e._v("#")]),e._v(" Can I use this in production")]),e._v(" "),t("p",[e._v("This project is still in early development and most likely has some bugs and quirks that need to be ironed out. The project is considered to be in ALPHA state, meaning not all desired functionality has been implemented and there can be breaking changes.")]),e._v(" "),t("h2",{attrs:{id:"how-do-i-deploy"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-do-i-deploy"}},[e._v("#")]),e._v(" How do I deploy?")]),e._v(" "),t("p",[e._v("If you set up BTCPay using any "),t("RouterLink",{attrs:{to:"/Docker/"}},[e._v("dockerized install method")]),e._v(", you can enable BTC Transmuter easily.")],1),e._v(" "),t("p",[e._v("First, "),t("a",{attrs:{href:"https://github.com/JeffVandrewJr/patron/blob/master/SSH.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("SSH"),t("OutboundLink")],1),e._v(" into your server.\nThen run the following commands:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("export")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token assign-left variable"}},[e._v("BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("=")]),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"'),t("span",{pre:!0,attrs:{class:"token variable"}},[e._v("$BTCPAYGEN_ADDITIONAL_FRAGMENTS")]),e._v(';opt-add-btctransmuter"')]),e._v("\n\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v(" ./btcpay-setup.sh -i\n")])])]),t("p",[e._v("If you have trouble starting your server after running the setup command, verify you have "),t("RouterLink",{attrs:{to:"/FAQ/FAQ-Deployment/#how-can-i-modify-or-deactivate-environment-variables"}},[e._v("added the environment variable")]),e._v(" correctly to enable Transmuter.")],1),e._v(" "),t("p",[e._v("Once completed, your Transmuter will be available at your configured BTCPay website under "),t("code",[e._v("/btctransmuter/")]),e._v(", where the first account to register becomes the Transmuter admin. Open that link in your browser and you’ll see the homepage.")]),e._v(" "),t("h2",{attrs:{id:"what-extensions-are-provided"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-extensions-are-provided"}},[e._v("#")]),e._v(" What extensions are provided?")]),e._v(" "),t("p",[e._v("You can see a list of built-in extensions once you log into your transmuter application under "),t("code",[e._v("/extensions")]),e._v(".")]),e._v(" "),t("p",[e._v("Currently there are 12 extensions that come bundled with the main application:")]),e._v(" "),t("ul",[t("li",[e._v("Tor - Provides TOR access to your Transmuter app")]),e._v(" "),t("li",[e._v("Presets - Provides one page wizards for quick setups of common scenarios")]),e._v(" "),t("li",[e._v("BtcPayServer - Provides you a way to interact with BTCPayServer stores")]),e._v(" "),t("li",[e._v("Email - Provides you with a way to check a POP3 for incoming emails and a way to send Email via SMTP")]),e._v(" "),t("li",[e._v("Exchange - Provides you a way to connect to a variety of exchanges and place orders on them")]),e._v(" "),t("li",[e._v("Lightning - Provides you interoperability with lightning nodes to be able to do basic channel and invoice management")]),e._v(" "),t("li",[e._v("NBXplorer - Provides you ways to detect incoming funds, send funds, and generate addresses.")]),e._v(" "),t("li",[e._v("Operators - Lets you create conditional workflows")]),e._v(" "),t("li",[e._v("Recipe - Lets you manage existing or create recipes with your workflows")]),e._v(" "),t("li",[e._v("Timer - Run X every Y")]),e._v(" "),t("li",[e._v("WebHook - Trigger Recipes with an http call or execute external web hooks with a recipe")])]),e._v(" "),t("h2",{attrs:{id:"what-preset-recipes-are-provided"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#what-preset-recipes-are-provided"}},[e._v("#")]),e._v(" What preset recipes are provided?")]),e._v(" "),t("p",[e._v("Currently there are three preset recipes that you can enable easily. In addition to the list below, you can create your own recipes for automating other tasks.")]),e._v(" "),t("ol",[t("li",[e._v("On-chain Forwarder - Forward funds from a wallet elsewhere")]),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/Transmuter/EmailReceiptsPreset/"}},[e._v("BTCPay Email Receipts")]),e._v(" - Send an email when a BTCPay invoice gets paid")],1),e._v(" "),t("li",[e._v("Fiat Conversion - Convert incoming money to fiat on an exchange by market selling when BTCPay invoice statuses change.")]),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/Transmuter/DCA/"}},[e._v("Dollar Cost Average")]),e._v(" - Schedule daily purchases of Bitcoin")],1)]),e._v(" "),t("h2",{attrs:{id:"how-do-i-write-an-extension"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-do-i-write-an-extension"}},[e._v("#")]),e._v(" How do I write an extension?")]),e._v(" "),t("p",[e._v("An extension must be its own .net core class library project that references "),t("code",[e._v("BtcTransmuter.Abstractions")]),e._v("\nThere must be a class implementing "),t("code",[e._v("BtcTransmuterExtension")]),e._v(" in this library. This file bootstraps the plugin name and adds all the services to system on startup.")]),e._v(" "),t("h3",{attrs:{id:"adding-a-trigger"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adding-a-trigger"}},[e._v("#")]),e._v(" Adding a Trigger")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Implement "),t("code",[e._v("BaseTrigger")]),e._v(" This class will be used to transport the event data")])]),e._v(" "),t("li",[t("p",[e._v("Implement "),t("code",[e._v("BaseTriggerHandler")]),e._v(" This handles:")]),e._v(" "),t("ul",[t("li",[e._v("Describing the trigger to the main system.")]),e._v(" "),t("li",[e._v("Telling the main UI how to create/edit a recipe trigger using it.")]),e._v(" "),t("li",[e._v("The logic needed to see if a trigger is...triggered.")])]),e._v(" "),t("p",[e._v("You will see that "),t("code",[e._v("BaseTriggerHandler")]),e._v(" has 2 generic arguments, a "),t("code",[e._v("Data")]),e._v(" and "),t("code",[e._v("Parameters")]),e._v(" "),t("code",[e._v("Data")]),e._v(" is the trigger that that was detected, while "),t("code",[e._v("Parameters")]),e._v(" is the data from a Recipe to see if it triggers its actions.")])]),e._v(" "),t("li",[t("p",[e._v("Implement a Partial View (named as the same value as the property "),t("code",[e._v("ViewPartial")]),e._v(" in the "),t("code",[e._v("BaseTriggerHandler")]),e._v(" implementation)\nThis handles displaying the trigger settings in a recipe")])]),e._v(" "),t("li",[t("p",[e._v("Implement a Controller that allows a user to create/edit the necessary data to set the trigger on a recipe.")])])]),e._v(" "),t("h3",{attrs:{id:"adding-an-action"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adding-an-action"}},[e._v("#")]),e._v(" Adding an Action")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Implement "),t("code",[e._v("BaseActionHandler")]),e._v(" This handles:")]),e._v(" "),t("ul",[t("li",[e._v("Describing the action to the main system.")]),e._v(" "),t("li",[e._v("Telling the main UI how to create/edit a recipe action using it.")]),e._v(" "),t("li",[e._v("The logic needed to execute the action")])]),e._v(" "),t("p",[e._v("You will see that "),t("code",[e._v("BaseActionHandler")]),e._v(" has a generic argument, "),t("code",[e._v("Data")]),e._v(" "),t("code",[e._v("Data")]),e._v(" is the type of the action that holds the payload needed to exeucte the action through the instructions of recipe action")])]),e._v(" "),t("li",[t("p",[e._v("Implement a Partial View (named as the same value as the property "),t("code",[e._v("ViewPartial")]),e._v(" in the "),t("code",[e._v("BaseActionHandler")]),e._v(" implementation)\nThis handles displaying the action settings in a recipe")])]),e._v(" "),t("li",[t("p",[e._v("Implement a Controller that allows a user to create/edit the necessary data to set the action on a recipe.")])])]),e._v(" "),t("h3",{attrs:{id:"adding-an-external-service"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#adding-an-external-service"}},[e._v("#")]),e._v(" Adding an External Service")]),e._v(" "),t("ul",[t("li",[e._v("Implement "),t("code",[e._v("BaseExternalService")]),e._v(" & "),t("code",[e._v("IExternalServiceDescriptor")])]),e._v(" "),t("li",[e._v("Implement a Partial View (named as the same value as the property "),t("code",[e._v("ViewPartial")]),e._v(" in the "),t("code",[e._v("IExternalServiceDescriptor")]),e._v(" implementation)")]),e._v(" "),t("li",[e._v("Implement a Controller that allows a user to create/edit the necessary data for an external service.")])])])}),[],!1,null,null,null);t.default=i.exports}}]); \ No newline at end of file diff --git a/assets/js/139.684b3948.js b/assets/js/139.37ed5b15.js similarity index 97% rename from assets/js/139.684b3948.js rename to assets/js/139.37ed5b15.js index e01424ac81..2605b8d967 100644 --- a/assets/js/139.684b3948.js +++ b/assets/js/139.37ed5b15.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[139],{788:function(e,t,a){"use strict";a.r(t);var o=a(9),r=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"trocador"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#trocador"}},[e._v("#")]),e._v(" Trocador")]),e._v(" "),t("p",[e._v("A plugin for BTCPay Server for users to pay invoices at checkout using a different cryptocurrency. Trocador is an exchange aggregator that offers excellent rates to users while providing them strong privacy.")]),e._v(" "),t("h2",{attrs:{id:"use-cases-and-features"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-cases-and-features"}},[e._v("#")]),e._v(" Use Cases and Features")]),e._v(" "),t("ul",[t("li",[e._v("Allow customers to pay with whichever asset they prefer.")]),e._v(" "),t("li",[e._v("Settle these purchases in your wallet of choice (Bitcoin, Monero, etc).")]),e._v(" "),t("li",[e._v('Choose a custom plugin name that is displayed to the user (default is "Altcoins Trocador").')]),e._v(" "),t("li",[e._v("Choose a default payment currency that is shown to the user (eg: Ethereum), and the user can choose a different one.")]),e._v(" "),t("li",[e._v("Optionally show Trocador to the customer first in the invoice by default.")]),e._v(" "),t("li",[e._v("Optionally provide a referral code to earn a portion of the volume.")])]),e._v(" "),t("h2",{attrs:{id:"caveats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#caveats"}},[e._v("#")]),e._v(" Caveats")]),e._v(" "),t("p",[t("strong",[e._v("We recommend setting the invoice expiry timer to at least 120 minutes.")]),e._v(' This can be done by clicking on "Settings", and then editing the value in General for "Invoice expires if the full amount has not been paid after …" to 120 or larger. Most exchanges complete in about 10 minutes but the slowest may take up to a day, depending on network congestion and/or exchange delays.')]),e._v(" "),t("p",[e._v("We recommend not selecting lightning network as the default wallet to receive payments from Trocador, as this may worsen conversion rates and reduce the number of coins accepted.")]),e._v(" "),t("h2",{attrs:{id:"compatibility"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#compatibility"}},[e._v("#")]),e._v(" Compatibility")]),e._v(" "),t("p",[e._v("We recommend only enabling one checkout plugin (eg: only enabling Trocador, not also enabling SideShift and/or FixedFloat).")]),e._v(" "),t("h2",{attrs:{id:"how-to-activate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-activate"}},[e._v("#")]),e._v(" How to activate")]),e._v(" "),t("p",[e._v('In the server dashboard, click on "Manage Plugins", then click the "Install" button after Trocador.')])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[139],{793:function(e,t,a){"use strict";a.r(t);var o=a(9),r=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"trocador"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#trocador"}},[e._v("#")]),e._v(" Trocador")]),e._v(" "),t("p",[e._v("A plugin for BTCPay Server for users to pay invoices at checkout using a different cryptocurrency. Trocador is an exchange aggregator that offers excellent rates to users while providing them strong privacy.")]),e._v(" "),t("h2",{attrs:{id:"use-cases-and-features"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#use-cases-and-features"}},[e._v("#")]),e._v(" Use Cases and Features")]),e._v(" "),t("ul",[t("li",[e._v("Allow customers to pay with whichever asset they prefer.")]),e._v(" "),t("li",[e._v("Settle these purchases in your wallet of choice (Bitcoin, Monero, etc).")]),e._v(" "),t("li",[e._v('Choose a custom plugin name that is displayed to the user (default is "Altcoins Trocador").')]),e._v(" "),t("li",[e._v("Choose a default payment currency that is shown to the user (eg: Ethereum), and the user can choose a different one.")]),e._v(" "),t("li",[e._v("Optionally show Trocador to the customer first in the invoice by default.")]),e._v(" "),t("li",[e._v("Optionally provide a referral code to earn a portion of the volume.")])]),e._v(" "),t("h2",{attrs:{id:"caveats"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#caveats"}},[e._v("#")]),e._v(" Caveats")]),e._v(" "),t("p",[t("strong",[e._v("We recommend setting the invoice expiry timer to at least 120 minutes.")]),e._v(' This can be done by clicking on "Settings", and then editing the value in General for "Invoice expires if the full amount has not been paid after …" to 120 or larger. Most exchanges complete in about 10 minutes but the slowest may take up to a day, depending on network congestion and/or exchange delays.')]),e._v(" "),t("p",[e._v("We recommend not selecting lightning network as the default wallet to receive payments from Trocador, as this may worsen conversion rates and reduce the number of coins accepted.")]),e._v(" "),t("h2",{attrs:{id:"compatibility"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#compatibility"}},[e._v("#")]),e._v(" Compatibility")]),e._v(" "),t("p",[e._v("We recommend only enabling one checkout plugin (eg: only enabling Trocador, not also enabling SideShift and/or FixedFloat).")]),e._v(" "),t("h2",{attrs:{id:"how-to-activate"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#how-to-activate"}},[e._v("#")]),e._v(" How to activate")]),e._v(" "),t("p",[e._v('In the server dashboard, click on "Manage Plugins", then click the "Install" button after Trocador.')])])}),[],!1,null,null,null);t.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/14.014cc1a2.js b/assets/js/14.d3ad31ae.js similarity index 86% rename from assets/js/14.014cc1a2.js rename to assets/js/14.d3ad31ae.js index 4627ef0ccb..861bd0ce89 100644 --- a/assets/js/14.014cc1a2.js +++ b/assets/js/14.d3ad31ae.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{529:function(A,t,e){A.exports=e.p+"assets/img/1.1317fcf2.png"},530:function(A,t,e){A.exports=e.p+"assets/img/2.00f4500f.png"},531:function(A,t,e){A.exports=e.p+"assets/img/3.3c4c0b97.png"},532:function(A,t,e){A.exports=e.p+"assets/img/4.21661a93.png"},533:function(A,t,e){A.exports=e.p+"assets/img/5.9bc4d4fd.png"},534:function(A,t,e){A.exports=e.p+"assets/img/6.05eb51af.png"},535:function(A,t,e){A.exports=e.p+"assets/img/7.683a8418.png"},536:function(A,t,e){A.exports=e.p+"assets/img/8.64846216.png"},537:function(A,t){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABIMAAACsCAYAAADovmwHAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAABduSURBVHhe7d3/c131fefx/VvAYL4lNgUMQTbbTTAE6hgxbLCWzYR13eCmS0qYsqEayMLWC2zDOIEW6MSZ0dpu49pJsedCvBNBih1PusIpI+8OmBaUDSsbvIpxI0DRjCbSzHvv59xzpXuvji6+krFsncdz5jEDusdX917pF73m3HP/1aWXXhoAAAAAlIMxCAAAAKBEjEEAAAAAJWIMAgAAACgRYxAAAABAiRiDAAAAAErEGAQAAABQIsYgAAAAgBIxBgEAAACUiDEIAAAAoESMQQAAAAAlYgwCAAAAKBFjEAAAAECJGIMAAAAASmReY9CnV6yMGz53S9y8/otxS/cGAAAAAAqk7SRtKGlLKdpYFkPHY1B68OmJXHn1tbFs2bK44IILAAAAACiQtpO0oaQt5VwZhDoeg9KalZ5E0RMEAAAAYLa0paRNpWhrOds6HoPSkuWMIAAAAIDTl7aUtKkUbS1nW8djUHq/W9GTAgAAAGBuaVMp2lrONmMQAAAAwFlgDAIAAAAoEWMQAAAAQIkYgwAAAABKxBgEAAAAUCLGIAAAAIASMQYBAAAAlIgxCAAAAKBEjEEAAAAAJWIMAgAAACgRYxAAAABAiRiDAAAAAErEGAQAAABQIsYgAAAAgBIxBgEAAACUiDEIAAAAoESMQQAAAAAlYgwCAAAAKBFjEAAAAECJGIMAAAAASsQYtGAPRP/JiDjZHw8U3g4Ftr1e/aWJeH1bwW0AAADwCTIGtbH2/u9G/+BwnBqfzP5wz5ocjw9PDMXBPQ9HT3acMei89UB/pB/dnH2SP1NjEAAAAIvEGFRobXyz/73IJqCpiRgdPhqv9u+O7ZWDMXh0OEYnpmLqrZ3RnR1rDDpv5WPQR0dfjO3bt8/2zIP5z/gTYAwCAABgkRiDCjywfySmqn+oT40ciifv7io4Zm2sXVv/b2PQeSsfg072P1B8+yfJGAQAAMAiMQa16t4Zb6UlaPxwbO0quH2WmTGo9+4no//t0ZhI/77a1MRoDA/0xb2F97M27t8xEMOjE9nwVD06JkaHY2DH/bF21rEdHt91dzxZeSNOjNWPTe9u+zBOvNEfT93TfGxX9TFX3jgR9XfCtX/MdZuj8m714InX4unC4x6JA6PV20cPxCPTX+vk+W6LbCp5fVvL12tqO8rrsW36a7WfwdSR57Ln/uzAzPNpO7ac7hjUsyuGqg966tje2NxyW9fWwzFevY/RQ1uiq/HrLa9rOsNs7MT/ju335cdMj0HpdRmME9MHTsb4iTei8kTP9H3N3OejsefgUMvP9UQMznoNa6/fsb0bY+39O2JgeOZ3Mh3/RuWJ/C2Ojbri3r7qz+fUeO2MuIIaX8v5/d4AAABwLjAGtdi491j2x+27lc2Ft8+Wj0EfjcRI9S/j94cORiV7m9Hu6H/z19kf7eNHnmt5u1FPbDsyVr1tKsaOD+THV2LgeP61I9ta/ljv5Piu2Hp4vPrX+VgcH6jkb3mqPpZXh6qP783Y2d1wv5v/Ot7KDj0eA5V03PaoDByPsTR8jOxve6ZT9863qt95Il57uuDMqUcORNqCZkaWTp/v/MageH1P9bbx7PkM9u+O3f0vxbbNzf+2SQdnBvX0Ha0+26k4trfh96Jra6SXOk6+HL0NI0hX7/54L40kkx/E8GB/7E6v68GjMXzq5/Fc/bh8DDo5MhKT+ePNflaVgXgv3efUSOx/YOY+s/t9+rUYnxiJoVdr95lew8H30zeaird2djccW3v9Jo69EyOTEzHyxuzjR/Y3P+ee6uOpvnLx6yN74rGvb4pNmx6K7/7P2lslR3/27dh059qZ4xfwewMAAMDiMwa1qP2NXv1DvH4Gx8fKh4j0B3Z/b9PZIWkE2ZVOKYmh2NUwwtTPJjn5cuvxXdH7crqz8Ti8dWZk6ez45+JI9Vv+9rWnG44rkj+2liEj6dk1VH02rQNDi/wMqplrJ83Ycuij6mN6Nyr5ENPp8533GDQ1FZMj/bOez5w6eptYTzY0xdSx2Js9r/roNhL9vY2PfXPsPZatIi1fb5GPQTFefR49zbd1bTmUjWkfHdrS9PX0Pbtan1v9TLahXQ0/h/z1i4k42tdyhlHXljhUu/PYMv31+2L/SPVrTWdyJT2x55etxy7w9wYAAIBFZwxqkv9R3DQ0fJz6GNQ8+NQ9kN14MvobzvJ4Lq01cxx/QVf1D/m0Jby+bXo46ez4/C1aJw/EN6eva1Rg495I50CltxLNuq17V/W7Ve8zve2q9bZpXfH0axPVg95qPtvogi2RbUHH9sbG/GudPt95j0ExGgceaT62rXwMmqtZbzHrqT6ubA/aG1/LBq6CATB/XWcPOS3yMaj4uPbPv1n+3JuuWZX/+6YRZ8bs12/u7zfr2AX/3gAAALDYjEFNFjAGnXo5egtunz0GFf3x3qj1/jo9Pr3l50j2lp3sbUoDe+KxP1rfckZOVf3MlHZ93BiRvx2saRjYejgmql8b2lU/O6Tzxz/vMWiO8WNO+Rg016eJPd5yfaWk+7kj2Qg0lQasordE5a/r0b42ZwUlbY/rZAzKX4+iMeho3+yfe9Wcr9+7lZZrInXHrrTuNL6u+eNu22k+bgAAABaHMahF7W/debxNbI6xo/MxqPWP9U6Pr8kuNjwwHB9kF/idiomRwdhxf8N1X/I/6o//bPYIMu3xe2aOL5SfhdQwImw93Hq20Hwe/zzHoDbfo1BHbxOr+1r86P+l7//bOPJswZCTv64f+ylhbY8rfv61C0inaw99OHNh6npNz73T1++C2Lz3WPYWr5FXvxsPbUrXDPp6fKf/nWz4arpOUv64F/Z7AwAAwGIyBrW4r3ZqUMOZLR9nnmPQHGcSzb690+NbdK2Pb+wYiOPZ1X3/JQ5syQeM/I/603+exTZnHyuWP7+upyN759jrjW/5ms/jbzdm5GerLMoY1BW9/SMxFeMxll7P8SPxXOtb3z6hMairtz9G0o8wv2jztx9Kg03yrfjpqeqxCxyD0qe9fePF4fhtuikr/7S3vnubzy46Q783AAAALB5jUKvNlUjzRtEFcou1HyKKrhmUnT3TwTV0Oj2+UM+eSNcCnji8tfb/9+2PNHsVXQC6I/kFjNOgkj7taqLgE8Y6f/ztxoz8mkSLMAbVB5ns0+E27410nejx6mNs+iS0/HU93WsGne4YVLvu0i9jT8vFpi+4oDdePhNjUE/15zg5EUd33N3+9+hM/d4AAACwaIxBs+SfElVt/K09cX+7izBnOh+D6tfaGT20peUP7/qna01U/45vOPOi0+OLdPXF0XRkfQyqf+pVjFf/bcsnTnWkO3bW1qDYm0afidfi6dYRrePHnw8+o4diS+snVmUf8Z46y2NQV2/UPvjscGzNH1PtrVWtr9/myE6WmhqKPXe3uW5Qh2NQ7fCj0dfyeqx94h+y13bBY1D2xY/i1Scb3kpY6Ez93gAAALBYjEFFuu6NXW+OVf/QrzY5HieGBuNgZXts390frw6ma7aMxbH99QFhHmPQ9NuNpmLs+EBUsmutVGLgeO17zjrbpKPjt8Xg+IkYerU/dtev4VJ93G+8Pxnp4873Nz6O/NOxqk8y3h86OH2/BweH4sT4ey2PeW71M4ImJuY6I6bT51t93fan46u3vVc/fnf0Dx6PscmReC+dnnMGx6C5LiC9/ZkH87NfumJL9nnsrR+Bn3/M+sTR6Gs4Y6d+BlFMvh9DByvZfe3ufzWGTvzfeKH+mnY4BtWGp8bXY3tUBtLrMRZj6We40DGoe2sM/Dp9h5bS7/8blXii8YykM/R7AwAAwOIwBs2pK+5+shKDw6eaLtY7NTEWH54Yiv+xtX4my3zGoKQr7n3mQLx9arz6J3V2z7VrtOy4P9Y2Hdfp8ffEtoHhODU2kY0HWdU/6E8NDzRfQLpu7f2xo3r86MTMEDA5fiqGB3bFg0Vv6yqUX0g62n20e6fPtyeeqLwRJ+ov/tREjJ2oXQS79pqeuTFozvL768o+Rr7ozKaqnl2R9qCpoV1Ng1bX3U9G/9sNvzvVxz86/Pextf6adjgGZa9H/9szP6eG1yO7ztVCxqCu3tj7i7GYHDseg/27Z8awNPAcPZ59Ml36OP2mTxo7I783AAAALAZjEGdA/tao0QPxSOHtnMseSUve1FDsmnU9opra+NbJJ+wBAABwLjMGsXD5NYHerTR8BDnnifsi+wC9NmdVbdx7LB3g7V8AAABLhDGIBeqJvqMTEVNvxU5vDzoP5R/V/9E/xBNFn57X1Rv92UeoDcSft94GAADAeckYxDx0x4PPpGvK7I7+N38d6cLQI/297T+SnHNW/ZpI2cWpv/1QbNq0KTZ9/bH4q8rBGMouPD4WR3xyGAAAwJJhDGIe7osX3qtdOHhqYjTe7n9i1qeBcX7peXhPDDRdLH0qJsZOxfBgJb5zz8d93DwAAADnE2MQAAAAQIkYgwAAAABKxBgEAAAAUCLGIAAAAIASMQYBAAAAlIgxCAAAAKBEjEEAAAAAJWIMAgAAACgRYxAAAABAiRiDAAAAAErEGAQAAABQIsYgAAAAgBIxBrW46aab4wd/ty/+aeid+OWxEwAAAABnVdok0jaRNoqi7WKhjEEN0oucXvCfvHIwPvjww5AkSZIkSZpvzz///LxUKpV48Uf7s43ikxiEjEEN0uqWhiBJkiRJkqSFload4eHheUuDUNoqijaMhTAGNUiLmzOCJEmSJEnSmWihY1A6QyhtFUUbxkIYgxqk9+VJkiRJkiSdiRY6BqV/n7aKog1jIYxBDYxBkiRJkiTpTGUMas8YJEmSJEmSllTGoPaMQZIkSZIkaUllDGrPGCRJkiRJkpZUxqD2jEGSJEmSJGlJZQxqzxgkSZIkSZKWVMag9oxBkiRJkiRpSWUMas8YJEmSJEmSllTGoPaW1Bj0i76vZY+v0fq7vhL3PLonXhud+5hmj8fL2ZGTcfIfd8YDv//lWJfftv6u/xj3PvHj+EV2e7v7qt+HJEmSJEk62xmD2lt6Y9BXvhuHf3UyRnJvHvhe/PFdG2Ld15+P96rHTP7mX6ZvG/nVYDz1lQ3x5WcHG772QUxUjxv76bfi33ZvjD/+q0PxZvb14Rj88c74s794OX6Vfbfi79d4H5IkSZIk6exnDGpv6Y1Bm3dOn7lTb/KlLdXH/Y3YdTL/wnTvxLbNG2Jj3zv5/8904LG74pY/3R9j+f8XNdf3kyRJkiRJi5cxqL1SjEHxyuPVx/3N2Ddr2TEGSZIkSZK01Godg1588cWm/29UdJsxqMX5NQZNxm/e/Xk89dUvxYb/9rOCYWfuMWjslcfj9u6N8Z/2Dc/5li9jkCRJkiRJ516NY9DRo0fjzjvvjO9973tNg0+SvpZuS8c0ft0Y1OKcH4Oqj6/JnV+N3r95PfLrR7c09xgUMRFHdz0UG+7YEOs23BcP9R2Kod9M5rfVKvx+yX85mB8hSZIkSZLOdq1nBhUNQnMNQYkxqEV64EVPaCHO6BjUekHnf34ptnzlS7H+a9+Pf27ecqq1G4NqTf7m/8Tf9z0WmzbcFbfcsSn+9IX3on43hd8v+cDloyVJkiRJWqxax6CkcRBqNwQlxqAW5/wYVPS2rdEX4r7uu+LhV1rXoI8fg6abPBWHn7kv1nX/SezMH+6c30+SJEmSJC1aRWNQUh+E2g1BiTGoxXk5BsXBeLj6uGePPh2MQanJn0Rv9X4efqX2v8YgSZIkSZLOveYag5I0ArUbghJjUIvzcgw6sSf+sPq4e19awJlBqfwMo0d/WvtfY5AkSZIkSede7cag02EManHOj0Et1/B553+9EI/+/l1xy11PxcBpXzPoeDz/rWfib37883iz4X7StYfWfXXn9LWHir5fzQdzfgKZJEmSJEn6ZDMGtbf0xqDq42vyxf8Q9zy6Jw6/P2sJqjbXGPR+vPIXD8aX7/rS9P2s2/CHce93XopfNqw8hd8v83i8nB8jSZIkSZLObsag9pbUGCRJkiRJkmQMas8YJEmSJEmSllTGoPaMQZIkSZIkaUllDGrPGCRJkiRJkpZUxqD2jEGSJEmSJGlJZQxqzxgkSZIkSZKWVMag9oxBkiRJkiRpSWUMas8YJEmSJEmSllTGoPaMQZIkSZIkaUllDGrvnBiD/mnonfjgww/zH5kkSZIkSdL8W+gYVKlUsq2iaMNYCGNQgx/83b74ySsH8x+ZJEmSJEnS/FvoGPTij/ZnW0XRhrEQxqAGN910c7a4pUHIGUKSJEmSJGkhpTFoPtIZQWkIShtF2iqKNoyFMAa1SC9yWt3SC57elwcAAABwNqVNIm0Tn8QQlBiDAAAAAErEGAQAAABQIsYgAAAAgBIxBgEAAACUiDEIAAAAoESMQQAAAAAlYgwCAAAAKBFjUJHLlsc1//Uzse6Ha+L2yg1x+7418YW+a+O6WwuOPVNWfjpu3nFlXF50GwAAAMAZYgxqdfUVceOeNbH+uSvjyn+9LC6sfu3CFRfHinuuiCuWFxx/hiz78qpYbwwCAAAAPmHGoBZX/vnquP3ZT8fFBbfVXBE3VlbFVVdfHr/732tnDt24sXbbxXdcGTd9/4ba2UQ/vD4++wcXZ2NS7d9dFFf9WcPZRg23X/rVVfF7P8jPQPrb1VVXx+/k/+6yP7gmfi//N93fvzZW37Esvz8AAACAzhmDmlwen9u3Oj7774tuq0tjUFes23l9rLmtduZQ9vU1K+Pze6tfW3dh9v/LblwRN/9wdfybnvq/WxaX33lpXHJZ7f+X3XF1rNu3Kq6qn220cVXc3nJm0IU918T6Pavimutq/7/8zqvj1n3XxXVrZo4BAAAA6IQxqNFNV8atletj9U0Ft01LY9ANcfO9zWfoXN57fXzh0UubvnbVk2tmfW1Gup+G71UwBl21dU3c/EeN3+fi6Oqrfu+mrwEAAACcPmNQo9Meg2Yfc9XW/O1hrbZeUTtm+UWx8oFVccvfronbfpDeCrYmutuOQZfE6h0F91d1a+8l+TEAAAAAnTEGNam9TWzmrV1F5h6D2o00K59YHeufXRGXr6h/7ePODKqNQfXrEQEAAACcCcagJsti1V+uifVPfepjLiA9ewz61H/uyi48fVHD12YUDDufWRmfbzsG1R7L3G8zAwAAAOicMajVTSvj1r1rYt2TK2LF9EfLXxSX3Lo8LsmOKR6DsgtI71sda+9dHhdlF4W+MC7+7KVxRXax52Vx7bM3xLotl8WydOxly+Pav1wdt+9ruJ90segfroprrs7/vyq7gHT1mBv+3UW1f7d8WSy/9dK4fOXMMQAAAACdMAYVuPC6y2L1M11x2978Oj3pI9/7roxPZbfPMQZVLVu3Im7MP27+9sqauO2vPxPXf6F224W3rGz52PnL4vptjfdzUaz6dld0p9v3XjP90fLLv/w78fn6v6u6re/quOoz9X8DAAAA0BljEAAAAECJGIMAAAAASsQYBAAAAFAixiAAAACAEjEGAQAAAJSIMQgAAACgRIxBAAAAACViDAIAAAAoEWMQAAAAQIkYgwAAAABKxBgEAAAAUCLGIAAAAIASMQYBAAAAlIgxCAAAAKBEjEEAAAAAJWIMAgAAACgRYxAAAABAiRiDAAAAAErEGAQAAABQIsYgAAAAgBIxBgEAAACUiDEIAAAAoESMQQAAAAAlYgwCAAAAKBFjEAAAAECJGIMAAAAASsQYBAAAAFAixiAAAACAEjEGAQAAAJSIMQgAAACgRIxBAAAAACViDAIAAAAoEWMQAAAAQIkYgwAAAABKxBgEAAAAUCLGIAAAAIASMQYBAAAAlIgxCAAAAKBEztsx6Ob1X4xly5YVPikAAAAAZktbStpUiraWs63jMeiGz90SV159beETAwAAAGC2tKWkTaVoaznbOh6DPr1iZbZkpSfhDCEAAACAuaXtJG0oaUtJm0rR1nK2dTwGJenBpzUrPZH0fjcAAAAAZkvbSdpQzpUhKJnXGAQAAADA+ckYBAAAAFAixiAAAACAEjEGAQAAAJTGpfH/AdqGpEfrZ7WBAAAAAElFTkSuQmCC"},538:function(A,t,e){A.exports=e.p+"assets/img/10.60d36a50.png"},539:function(A,t,e){A.exports=e.p+"assets/img/11.746ef9f1.png"},540:function(A,t,e){A.exports=e.p+"assets/img/12.761f7a03.png"},785:function(A,t,e){"use strict";e.r(t);var s=e(9),a=Object(s.a)({},(function(){var A=this,t=A._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":A.$parent.slotKey}},[t("h2",{attrs:{id:"dollar-cost-averaging-automation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dollar-cost-averaging-automation"}},[A._v("#")]),A._v(" Dollar Cost Averaging Automation")]),A._v(" "),t("p",[A._v("This guide shows how to setup Transmuter to automate DCA Bitcoin purchases.")]),A._v(" "),t("h2",{attrs:{id:"why-use-transmuter-instead-of-dedicated-dca-services"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#why-use-transmuter-instead-of-dedicated-dca-services"}},[A._v("#")]),A._v(" Why use Transmuter instead of dedicated DCA services?")]),A._v(" "),t("p",[A._v("You get to configure everything specifically to your needs and there is no additional cost beyond the selected exchange's fees, which are usually lower than dedicated DCA providers.")]),A._v(" "),t("h2",{attrs:{id:"setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setup"}},[A._v("#")]),A._v(" Setup")]),A._v(" "),t("ul",[t("li",[A._v('Create a new External Service of type "Exchange External Service"\n'),t("img",{attrs:{src:e(529),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}}),A._v(" "),t("img",{attrs:{src:e(530),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}}),A._v(" "),t("img",{attrs:{src:e(531),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("Configure it with the API keys from your exchange account.\n"),t("img",{attrs:{src:e(532),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}}),A._v(" "),t("img",{attrs:{src:e(533),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}}),A._v(" "),t("img",{attrs:{src:e(534),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}}),A._v(" "),t("img",{attrs:{src:e(535),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("In Transmuter, create a Preset > Dollar Cost Average.\n"),t("img",{attrs:{src:e(536),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("Select the configured exchange account\n"),t("img",{attrs:{src:e(537),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("Set how often to DCA\n"),t("img",{attrs:{src:e(538),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("Set the exchange order book and the amount to DCA with on each trade\n"),t("img",{attrs:{src:e(539),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("Create, confirm and enable the newly generated recipe!\n"),t("img",{attrs:{src:e(540),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})])])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[14],{546:function(A,t,e){A.exports=e.p+"assets/img/1.1317fcf2.png"},547:function(A,t,e){A.exports=e.p+"assets/img/2.00f4500f.png"},548:function(A,t,e){A.exports=e.p+"assets/img/3.3c4c0b97.png"},549:function(A,t,e){A.exports=e.p+"assets/img/4.21661a93.png"},550:function(A,t,e){A.exports=e.p+"assets/img/5.9bc4d4fd.png"},551:function(A,t,e){A.exports=e.p+"assets/img/6.05eb51af.png"},552:function(A,t,e){A.exports=e.p+"assets/img/7.683a8418.png"},553:function(A,t,e){A.exports=e.p+"assets/img/8.64846216.png"},554:function(A,t){A.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAABIMAAACsCAYAAADovmwHAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAABduSURBVHhe7d3/c131fefx/VvAYL4lNgUMQTbbTTAE6hgxbLCWzYR13eCmS0qYsqEayMLWC2zDOIEW6MSZ0dpu49pJsedCvBNBih1PusIpI+8OmBaUDSsbvIpxI0DRjCbSzHvv59xzpXuvji6+krFsncdz5jEDusdX917pF73m3HP/1aWXXhoAAAAAlIMxCAAAAKBEjEEAAAAAJWIMAgAAACgRYxAAAABAiRiDAAAAAErEGAQAAABQIsYgAAAAgBIxBgEAAACUiDEIAAAAoESMQQAAAAAlYgwCAAAAKBFjEAAAAECJGIMAAAAASmReY9CnV6yMGz53S9y8/otxS/cGAAAAAAqk7SRtKGlLKdpYFkPHY1B68OmJXHn1tbFs2bK44IILAAAAACiQtpO0oaQt5VwZhDoeg9KalZ5E0RMEAAAAYLa0paRNpWhrOds6HoPSkuWMIAAAAIDTl7aUtKkUbS1nW8djUHq/W9GTAgAAAGBuaVMp2lrONmMQAAAAwFlgDAIAAAAoEWMQAAAAQIkYgwAAAABKxBgEAAAAUCLGIAAAAIASMQYBAAAAlIgxCAAAAKBEjEEAAAAAJWIMAgAAACgRYxAAAABAiRiDAAAAAErEGAQAAABQIsYgAAAAgBIxBgEAAACUiDEIAAAAoESMQQAAAAAlYgwCAAAAKBFjEAAAAECJGIMAAAAASsQYtGAPRP/JiDjZHw8U3g4Ftr1e/aWJeH1bwW0AAADwCTIGtbH2/u9G/+BwnBqfzP5wz5ocjw9PDMXBPQ9HT3acMei89UB/pB/dnH2SP1NjEAAAAIvEGFRobXyz/73IJqCpiRgdPhqv9u+O7ZWDMXh0OEYnpmLqrZ3RnR1rDDpv5WPQR0dfjO3bt8/2zIP5z/gTYAwCAABgkRiDCjywfySmqn+oT40ciifv7io4Zm2sXVv/b2PQeSsfg072P1B8+yfJGAQAAMAiMQa16t4Zb6UlaPxwbO0quH2WmTGo9+4no//t0ZhI/77a1MRoDA/0xb2F97M27t8xEMOjE9nwVD06JkaHY2DH/bF21rEdHt91dzxZeSNOjNWPTe9u+zBOvNEfT93TfGxX9TFX3jgR9XfCtX/MdZuj8m714InX4unC4x6JA6PV20cPxCPTX+vk+W6LbCp5fVvL12tqO8rrsW36a7WfwdSR57Ln/uzAzPNpO7ac7hjUsyuGqg966tje2NxyW9fWwzFevY/RQ1uiq/HrLa9rOsNs7MT/ju335cdMj0HpdRmME9MHTsb4iTei8kTP9H3N3OejsefgUMvP9UQMznoNa6/fsb0bY+39O2JgeOZ3Mh3/RuWJ/C2Ojbri3r7qz+fUeO2MuIIaX8v5/d4AAABwLjAGtdi491j2x+27lc2Ft8+Wj0EfjcRI9S/j94cORiV7m9Hu6H/z19kf7eNHnmt5u1FPbDsyVr1tKsaOD+THV2LgeP61I9ta/ljv5Piu2Hp4vPrX+VgcH6jkb3mqPpZXh6qP783Y2d1wv5v/Ot7KDj0eA5V03PaoDByPsTR8jOxve6ZT9863qt95Il57uuDMqUcORNqCZkaWTp/v/MageH1P9bbx7PkM9u+O3f0vxbbNzf+2SQdnBvX0Ha0+26k4trfh96Jra6SXOk6+HL0NI0hX7/54L40kkx/E8GB/7E6v68GjMXzq5/Fc/bh8DDo5MhKT+ePNflaVgXgv3efUSOx/YOY+s/t9+rUYnxiJoVdr95lew8H30zeaird2djccW3v9Jo69EyOTEzHyxuzjR/Y3P+ee6uOpvnLx6yN74rGvb4pNmx6K7/7P2lslR3/27dh059qZ4xfwewMAAMDiMwa1qP2NXv1DvH4Gx8fKh4j0B3Z/b9PZIWkE2ZVOKYmh2NUwwtTPJjn5cuvxXdH7crqz8Ti8dWZk6ez45+JI9Vv+9rWnG44rkj+2liEj6dk1VH02rQNDi/wMqplrJ83Ycuij6mN6Nyr5ENPp8533GDQ1FZMj/bOez5w6eptYTzY0xdSx2Js9r/roNhL9vY2PfXPsPZatIi1fb5GPQTFefR49zbd1bTmUjWkfHdrS9PX0Pbtan1v9TLahXQ0/h/z1i4k42tdyhlHXljhUu/PYMv31+2L/SPVrTWdyJT2x55etxy7w9wYAAIBFZwxqkv9R3DQ0fJz6GNQ8+NQ9kN14MvobzvJ4Lq01cxx/QVf1D/m0Jby+bXo46ez4/C1aJw/EN6eva1Rg495I50CltxLNuq17V/W7Ve8zve2q9bZpXfH0axPVg95qPtvogi2RbUHH9sbG/GudPt95j0ExGgceaT62rXwMmqtZbzHrqT6ubA/aG1/LBq6CATB/XWcPOS3yMaj4uPbPv1n+3JuuWZX/+6YRZ8bs12/u7zfr2AX/3gAAALDYjEFNFjAGnXo5egtunz0GFf3x3qj1/jo9Pr3l50j2lp3sbUoDe+KxP1rfckZOVf3MlHZ93BiRvx2saRjYejgmql8b2lU/O6Tzxz/vMWiO8WNO+Rg016eJPd5yfaWk+7kj2Qg0lQasordE5a/r0b42ZwUlbY/rZAzKX4+iMeho3+yfe9Wcr9+7lZZrInXHrrTuNL6u+eNu22k+bgAAABaHMahF7W/debxNbI6xo/MxqPWP9U6Pr8kuNjwwHB9kF/idiomRwdhxf8N1X/I/6o//bPYIMu3xe2aOL5SfhdQwImw93Hq20Hwe/zzHoDbfo1BHbxOr+1r86P+l7//bOPJswZCTv64f+ylhbY8rfv61C0inaw99OHNh6npNz73T1++C2Lz3WPYWr5FXvxsPbUrXDPp6fKf/nWz4arpOUv64F/Z7AwAAwGIyBrW4r3ZqUMOZLR9nnmPQHGcSzb690+NbdK2Pb+wYiOPZ1X3/JQ5syQeM/I/603+exTZnHyuWP7+upyN759jrjW/5ms/jbzdm5GerLMoY1BW9/SMxFeMxll7P8SPxXOtb3z6hMairtz9G0o8wv2jztx9Kg03yrfjpqeqxCxyD0qe9fePF4fhtuikr/7S3vnubzy46Q783AAAALB5jUKvNlUjzRtEFcou1HyKKrhmUnT3TwTV0Oj2+UM+eSNcCnji8tfb/9+2PNHsVXQC6I/kFjNOgkj7taqLgE8Y6f/ztxoz8mkSLMAbVB5ns0+E27410nejx6mNs+iS0/HU93WsGne4YVLvu0i9jT8vFpi+4oDdePhNjUE/15zg5EUd33N3+9+hM/d4AAACwaIxBs+SfElVt/K09cX+7izBnOh+D6tfaGT20peUP7/qna01U/45vOPOi0+OLdPXF0XRkfQyqf+pVjFf/bcsnTnWkO3bW1qDYm0afidfi6dYRrePHnw8+o4diS+snVmUf8Z46y2NQV2/UPvjscGzNH1PtrVWtr9/myE6WmhqKPXe3uW5Qh2NQ7fCj0dfyeqx94h+y13bBY1D2xY/i1Scb3kpY6Ez93gAAALBYjEFFuu6NXW+OVf/QrzY5HieGBuNgZXts390frw6ma7aMxbH99QFhHmPQ9NuNpmLs+EBUsmutVGLgeO17zjrbpKPjt8Xg+IkYerU/dtev4VJ93G+8Pxnp4873Nz6O/NOxqk8y3h86OH2/BweH4sT4ey2PeW71M4ImJuY6I6bT51t93fan46u3vVc/fnf0Dx6PscmReC+dnnMGx6C5LiC9/ZkH87NfumJL9nnsrR+Bn3/M+sTR6Gs4Y6d+BlFMvh9DByvZfe3ufzWGTvzfeKH+mnY4BtWGp8bXY3tUBtLrMRZj6We40DGoe2sM/Dp9h5bS7/8blXii8YykM/R7AwAAwOIwBs2pK+5+shKDw6eaLtY7NTEWH54Yiv+xtX4my3zGoKQr7n3mQLx9arz6J3V2z7VrtOy4P9Y2Hdfp8ffEtoHhODU2kY0HWdU/6E8NDzRfQLpu7f2xo3r86MTMEDA5fiqGB3bFg0Vv6yqUX0g62n20e6fPtyeeqLwRJ+ov/tREjJ2oXQS79pqeuTFozvL768o+Rr7ozKaqnl2R9qCpoV1Ng1bX3U9G/9sNvzvVxz86/Pextf6adjgGZa9H/9szP6eG1yO7ztVCxqCu3tj7i7GYHDseg/27Z8awNPAcPZ59Ml36OP2mTxo7I783AAAALAZjEGdA/tao0QPxSOHtnMseSUve1FDsmnU9opra+NbJJ+wBAABwLjMGsXD5NYHerTR8BDnnifsi+wC9NmdVbdx7LB3g7V8AAABLhDGIBeqJvqMTEVNvxU5vDzoP5R/V/9E/xBNFn57X1Rv92UeoDcSft94GAADAeckYxDx0x4PPpGvK7I7+N38d6cLQI/297T+SnHNW/ZpI2cWpv/1QbNq0KTZ9/bH4q8rBGMouPD4WR3xyGAAAwJJhDGIe7osX3qtdOHhqYjTe7n9i1qeBcX7peXhPDDRdLH0qJsZOxfBgJb5zz8d93DwAAADnE2MQAAAAQIkYgwAAAABKxBgEAAAAUCLGIAAAAIASMQYBAAAAlIgxCAAAAKBEjEEAAAAAJWIMAgAAACgRYxAAAABAiRiDAAAAAErEGAQAAABQIsYgAAAAgBIxBrW46aab4wd/ty/+aeid+OWxEwAAAABnVdok0jaRNoqi7WKhjEEN0oucXvCfvHIwPvjww5AkSZIkSZpvzz///LxUKpV48Uf7s43ikxiEjEEN0uqWhiBJkiRJkqSFload4eHheUuDUNoqijaMhTAGNUiLmzOCJEmSJEnSmWihY1A6QyhtFUUbxkIYgxqk9+VJkiRJkiSdiRY6BqV/n7aKog1jIYxBDYxBkiRJkiTpTGUMas8YJEmSJEmSllTGoPaMQZIkSZIkaUllDGrPGCRJkiRJkpZUxqD2jEGSJEmSJGlJZQxqzxgkSZIkSZKWVMag9oxBkiRJkiRpSWUMas8YJEmSJEmSllTGoPaW1Bj0i76vZY+v0fq7vhL3PLonXhud+5hmj8fL2ZGTcfIfd8YDv//lWJfftv6u/xj3PvHj+EV2e7v7qt+HJEmSJEk62xmD2lt6Y9BXvhuHf3UyRnJvHvhe/PFdG2Ld15+P96rHTP7mX6ZvG/nVYDz1lQ3x5WcHG772QUxUjxv76bfi33ZvjD/+q0PxZvb14Rj88c74s794OX6Vfbfi79d4H5IkSZIk6exnDGpv6Y1Bm3dOn7lTb/KlLdXH/Y3YdTL/wnTvxLbNG2Jj3zv5/8904LG74pY/3R9j+f8XNdf3kyRJkiRJi5cxqL1SjEHxyuPVx/3N2Ddr2TEGSZIkSZK01Godg1588cWm/29UdJsxqMX5NQZNxm/e/Xk89dUvxYb/9rOCYWfuMWjslcfj9u6N8Z/2Dc/5li9jkCRJkiRJ516NY9DRo0fjzjvvjO9973tNg0+SvpZuS8c0ft0Y1OKcH4Oqj6/JnV+N3r95PfLrR7c09xgUMRFHdz0UG+7YEOs23BcP9R2Kod9M5rfVKvx+yX85mB8hSZIkSZLOdq1nBhUNQnMNQYkxqEV64EVPaCHO6BjUekHnf34ptnzlS7H+a9+Pf27ecqq1G4NqTf7m/8Tf9z0WmzbcFbfcsSn+9IX3on43hd8v+cDloyVJkiRJWqxax6CkcRBqNwQlxqAW5/wYVPS2rdEX4r7uu+LhV1rXoI8fg6abPBWHn7kv1nX/SezMH+6c30+SJEmSJC1aRWNQUh+E2g1BiTGoxXk5BsXBeLj6uGePPh2MQanJn0Rv9X4efqX2v8YgSZIkSZLOveYag5I0ArUbghJjUIvzcgw6sSf+sPq4e19awJlBqfwMo0d/WvtfY5AkSZIkSede7cag02EManHOj0Et1/B553+9EI/+/l1xy11PxcBpXzPoeDz/rWfib37883iz4X7StYfWfXXn9LWHir5fzQdzfgKZJEmSJEn6ZDMGtbf0xqDq42vyxf8Q9zy6Jw6/P2sJqjbXGPR+vPIXD8aX7/rS9P2s2/CHce93XopfNqw8hd8v83i8nB8jSZIkSZLObsag9pbUGCRJkiRJkmQMas8YJEmSJEmSllTGoPaMQZIkSZIkaUllDGrPGCRJkiRJkpZUxqD2jEGSJEmSJGlJZQxqzxgkSZIkSZKWVMag9oxBkiRJkiRpSWUMas8YJEmSJEmSllTGoPaMQZIkSZIkaUllDGrvnBiD/mnonfjgww/zH5kkSZIkSdL8W+gYVKlUsq2iaMNYCGNQgx/83b74ySsH8x+ZJEmSJEnS/FvoGPTij/ZnW0XRhrEQxqAGN910c7a4pUHIGUKSJEmSJGkhpTFoPtIZQWkIShtF2iqKNoyFMAa1SC9yWt3SC57elwcAAABwNqVNIm0Tn8QQlBiDAAAAAErEGAQAAABQIsYgAAAAgBIxBgEAAACUiDEIAAAAoESMQQAAAAAlYgwCAAAAKBFjUJHLlsc1//Uzse6Ha+L2yg1x+7418YW+a+O6WwuOPVNWfjpu3nFlXF50GwAAAMAZYgxqdfUVceOeNbH+uSvjyn+9LC6sfu3CFRfHinuuiCuWFxx/hiz78qpYbwwCAAAAPmHGoBZX/vnquP3ZT8fFBbfVXBE3VlbFVVdfHr/732tnDt24sXbbxXdcGTd9/4ba2UQ/vD4++wcXZ2NS7d9dFFf9WcPZRg23X/rVVfF7P8jPQPrb1VVXx+/k/+6yP7gmfi//N93fvzZW37Esvz8AAACAzhmDmlwen9u3Oj7774tuq0tjUFes23l9rLmtduZQ9vU1K+Pze6tfW3dh9v/LblwRN/9wdfybnvq/WxaX33lpXHJZ7f+X3XF1rNu3Kq6qn220cVXc3nJm0IU918T6Pavimutq/7/8zqvj1n3XxXVrZo4BAAAA6IQxqNFNV8atletj9U0Ft01LY9ANcfO9zWfoXN57fXzh0UubvnbVk2tmfW1Gup+G71UwBl21dU3c/EeN3+fi6Oqrfu+mrwEAAACcPmNQo9Meg2Yfc9XW/O1hrbZeUTtm+UWx8oFVccvfronbfpDeCrYmutuOQZfE6h0F91d1a+8l+TEAAAAAnTEGNam9TWzmrV1F5h6D2o00K59YHeufXRGXr6h/7ePODKqNQfXrEQEAAACcCcagJsti1V+uifVPfepjLiA9ewz61H/uyi48fVHD12YUDDufWRmfbzsG1R7L3G8zAwAAAOicMajVTSvj1r1rYt2TK2LF9EfLXxSX3Lo8LsmOKR6DsgtI71sda+9dHhdlF4W+MC7+7KVxRXax52Vx7bM3xLotl8WydOxly+Pav1wdt+9ruJ90segfroprrs7/vyq7gHT1mBv+3UW1f7d8WSy/9dK4fOXMMQAAAACdMAYVuPC6y2L1M11x2978Oj3pI9/7roxPZbfPMQZVLVu3Im7MP27+9sqauO2vPxPXf6F224W3rGz52PnL4vptjfdzUaz6dld0p9v3XjP90fLLv/w78fn6v6u6re/quOoz9X8DAAAA0BljEAAAAECJGIMAAAAASsQYBAAAAFAixiAAAACAEjEGAQAAAJSIMQgAAACgRIxBAAAAACViDAIAAAAoEWMQAAAAQIkYgwAAAABKxBgEAAAAUCLGIAAAAIASMQYBAAAAlIgxCAAAAKBEjEEAAAAAJWIMAgAAACgRYxAAAABAiRiDAAAAAErEGAQAAABQIsYgAAAAgBIxBgEAAACUiDEIAAAAoESMQQAAAAAlYgwCAAAAKBFjEAAAAECJGIMAAAAASsQYBAAAAFAixiAAAACAEjEGAQAAAJSIMQgAAACgRIxBAAAAACViDAIAAAAoEWMQAAAAQIkYgwAAAABKxBgEAAAAUCLGIAAAAIASMQYBAAAAlIgxCAAAAKBEztsx6Ob1X4xly5YVPikAAAAAZktbStpUiraWs63jMeiGz90SV159beETAwAAAGC2tKWkTaVoaznbOh6DPr1iZbZkpSfhDCEAAACAuaXtJG0oaUtJm0rR1nK2dTwGJenBpzUrPZH0fjcAAAAAZkvbSdpQzpUhKJnXGAQAAADA+ckYBAAAAFAixiAAAACAEjEGAQAAAJTGpfH/AdqGpEfrZ7WBAAAAAElFTkSuQmCC"},555:function(A,t,e){A.exports=e.p+"assets/img/10.60d36a50.png"},556:function(A,t,e){A.exports=e.p+"assets/img/11.746ef9f1.png"},557:function(A,t,e){A.exports=e.p+"assets/img/12.761f7a03.png"},788:function(A,t,e){"use strict";e.r(t);var s=e(9),a=Object(s.a)({},(function(){var A=this,t=A._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":A.$parent.slotKey}},[t("h2",{attrs:{id:"dollar-cost-averaging-automation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dollar-cost-averaging-automation"}},[A._v("#")]),A._v(" Dollar Cost Averaging Automation")]),A._v(" "),t("p",[A._v("This guide shows how to setup Transmuter to automate DCA Bitcoin purchases.")]),A._v(" "),t("h2",{attrs:{id:"why-use-transmuter-instead-of-dedicated-dca-services"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#why-use-transmuter-instead-of-dedicated-dca-services"}},[A._v("#")]),A._v(" Why use Transmuter instead of dedicated DCA services?")]),A._v(" "),t("p",[A._v("You get to configure everything specifically to your needs and there is no additional cost beyond the selected exchange's fees, which are usually lower than dedicated DCA providers.")]),A._v(" "),t("h2",{attrs:{id:"setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setup"}},[A._v("#")]),A._v(" Setup")]),A._v(" "),t("ul",[t("li",[A._v('Create a new External Service of type "Exchange External Service"\n'),t("img",{attrs:{src:e(546),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}}),A._v(" "),t("img",{attrs:{src:e(547),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}}),A._v(" "),t("img",{attrs:{src:e(548),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("Configure it with the API keys from your exchange account.\n"),t("img",{attrs:{src:e(549),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}}),A._v(" "),t("img",{attrs:{src:e(550),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}}),A._v(" "),t("img",{attrs:{src:e(551),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}}),A._v(" "),t("img",{attrs:{src:e(552),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("In Transmuter, create a Preset > Dollar Cost Average.\n"),t("img",{attrs:{src:e(553),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("Select the configured exchange account\n"),t("img",{attrs:{src:e(554),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("Set how often to DCA\n"),t("img",{attrs:{src:e(555),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("Set the exchange order book and the amount to DCA with on each trade\n"),t("img",{attrs:{src:e(556),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})]),A._v(" "),t("li",[A._v("Create, confirm and enable the newly generated recipe!\n"),t("img",{attrs:{src:e(557),alt:"./DCA_assets/1.png",title:"./DCA_assets/1.png"}})])])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/140.0846c6df.js b/assets/js/140.83d44ce0.js similarity index 99% rename from assets/js/140.0846c6df.js rename to assets/js/140.83d44ce0.js index d14b470781..af00baa7b8 100644 --- a/assets/js/140.0846c6df.js +++ b/assets/js/140.83d44ce0.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[140],{789:function(e,t,r){"use strict";r.r(t);var o=r(9),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"troubleshooting-an-issue-in-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting-an-issue-in-btcpay-server"}},[e._v("#")]),e._v(" Troubleshooting an issue in BTCPay Server")]),e._v(" "),t("p",[e._v("Facing a problem is never fun. This document explains the most common workflow and steps you should take to "),t("strong",[e._v("identify the issue")]),e._v(" you're having more easily and hopefully solve it yourself or with community help.")]),e._v(" "),t("p",[e._v("Identifying the problem is crucial.")]),e._v(" "),t("h2",{attrs:{id:"1-replicating-the-issue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#1-replicating-the-issue"}},[e._v("#")]),e._v(" 1. Replicating the issue")]),e._v(" "),t("p",[e._v("First and foremost, try to determine when the issue happens.\nTry to replicate the problem.\nTry to update and restart your server to verify you can reproduce your issue.\nIf you think it will describe your issue better, take a screenshot.")]),e._v(" "),t("h3",{attrs:{id:"11-updating-the-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#11-updating-the-server"}},[e._v("#")]),e._v(" 1.1 Updating the server")]),e._v(" "),t("p",[e._v("Check "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-can-i-see-my-btcpay-version"}},[e._v("your version of BTCPay")]),e._v(".\nIf it is much older than the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/releases",target:"_blank",rel:"noopener noreferrer"}},[e._v("latest version"),t("OutboundLink")],1),e._v(" of BTCPay, "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-update-btcpay-server"}},[e._v("updating your server")]),e._v(" may resolve the issue.")],1),e._v(" "),t("h3",{attrs:{id:"12-restarting-the-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#12-restarting-the-server"}},[e._v("#")]),e._v(" 1.2 Restarting the server")]),e._v(" "),t("p",[e._v("Restarting your server is an easy way to solve many of the most common BTCPay Server issues.\nYou may need to "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-ssh-into-my-btcpay-running-on-vps"}},[e._v("SSH into your server")]),e._v(" to restart it.")],1),e._v(" "),t("h3",{attrs:{id:"13-restarting-a-service"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#13-restarting-a-service"}},[e._v("#")]),e._v(" 1.3 Restarting a service")]),e._v(" "),t("p",[e._v("Some issues you may only need to restart a particular service in your BTCPay Server deployment.\nSuch as restarting the letsencrypt container to renew the SSL certificate.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" restart letsencrypt-nginx-proxy-companion\n")])])]),t("p",[e._v("Use "),t("code",[e._v("docker ps")]),e._v(" to find the name of a different service you would like to restart.")]),e._v(" "),t("h2",{attrs:{id:"2-looking-through-the-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#2-looking-through-the-logs"}},[e._v("#")]),e._v(" 2. Looking through the logs")]),e._v(" "),t("p",[e._v("Logs can provide an essential piece of information.\nIn the next few paragraphs, we will describe how to get the "),t("strong",[e._v("log information for various parts of BTCPay")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"21-btcpay-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#21-btcpay-logs"}},[e._v("#")]),e._v(" 2.1 BTCPay Logs")]),e._v(" "),t("p",[e._v("Since the v1.0.3.8, you can easily access BTCPay Server logs from the front-end.\nIf you are a server admin, go to "),t("strong",[e._v("Server Settings > Logs")]),e._v(" and open the logs file.\nIf you don't know what a particular error in the logs means, make sure to mention it when troubleshooting.")]),e._v(" "),t("p",[e._v("If you would like more detailed logs and you're using a Docker deployment, you can view logs of specific Docker containers using the command line.\nSee these "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-ssh-into-my-btcpay-running-on-vps"}},[e._v("instructions to ssh")]),e._v(" into an instance of BTCPay running on a VPS.")],1),e._v(" "),t("p",[e._v("Below is a general list of the container names used for BTCPay.")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("LOGS FOR")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("CONTAINER NAME")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("BTCPayServer")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("generated_btcpayserver_1")])]),e._v(" "),t("tr",[t("td",[e._v("NBXplorer")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("generated_nbxplorer_1")])]),e._v(" "),t("tr",[t("td",[e._v("Bitcoind")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("btcpayserver_bitcoind")])]),e._v(" "),t("tr",[t("td",[e._v("Postgres")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("generated_postgres_1")])]),e._v(" "),t("tr",[t("td",[e._v("proxy")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("letsencrypt-nginx-proxy-companion")])]),e._v(" "),t("tr",[t("td",[e._v("Nginx")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("nginx-gen")])]),e._v(" "),t("tr",[t("td",[e._v("Nginx")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("nginx")])]),e._v(" "),t("tr",[t("td",[e._v("Core Lightning (CLN)")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("btcpayserver_clightning_bitcoin")])]),e._v(" "),t("tr",[t("td",[e._v("LND")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("btcpayserver_lnd_bitcoin")])]),e._v(" "),t("tr",[t("td",[e._v("RTL")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("generated_lnd_bitcoin_rtl_1")])]),e._v(" "),t("tr",[t("td",[e._v("Thunderhub")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("generated_bitcoin_thub_1")])]),e._v(" "),t("tr",[t("td",[e._v("LibrePatron")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("librepatron")])]),e._v(" "),t("tr",[t("td",[e._v("Tor")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("tor-gen")])]),e._v(" "),t("tr",[t("td",[e._v("Tor")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("tor")])])])]),e._v(" "),t("p",[e._v("Run the commands below to print logs by container name.\nReplace the container name to view other container logs.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("ps")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" logs --tail "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("100")]),e._v(" generated_btcpayserver_1\n")])])]),t("h3",{attrs:{id:"22-lightning-network-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#22-lightning-network-logs"}},[e._v("#")]),e._v(" 2.2 Lightning Network Logs")]),e._v(" "),t("p",[e._v("Use the following if you're having a problem with the Lightning Network.")]),e._v(" "),t("h3",{attrs:{id:"221-lightning-network-lnd-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#221-lightning-network-lnd-docker"}},[e._v("#")]),e._v(" 2.2.1 - Lightning Network LND - Docker")]),e._v(" "),t("p",[e._v("There are a few ways to access your LND logs when using Docker.\nFirst log in as root:")]),e._v(" "),t("p",[t("code",[e._v("sudo su -")])]),e._v(" "),t("p",[e._v("Navigate to the correct directory:")]),e._v(" "),t("p",[t("code",[e._v("cd btcpayserver-docker")])]),e._v(" "),t("p",[e._v("Find container name:")]),e._v(" "),t("p",[t("code",[e._v("docker ps")])]),e._v(" "),t("p",[e._v("Print logs by container name:")]),e._v(" "),t("p",[t("code",[e._v("docker logs --tail 100 btcpayserver_lnd_bitcoin")])]),e._v(" "),t("p",[e._v("Alternatively, you can quickly print logs by using container ID (only the first unique ID characters are needed, such as the two furthest left characters):")]),e._v(" "),t("p",[t("code",[e._v("docker logs 'add your container ID '")])]),e._v(" "),t("p",[e._v("If for any reason you need more logs")]),e._v(" "),t("p",[t("code",[e._v("sudo su -")])]),e._v(" "),t("p",[t("code",[e._v("cd /var/lib/docker/volumes/generated_lnd_bitcoin_datadir/_data/logs/bitcoin/mainnet/")])]),e._v(" "),t("p",[e._v("inside that directory do "),t("code",[e._v("ls")])]),e._v(" "),t("p",[e._v("You will see something like "),t("code",[e._v("lnd.log lnd.log.13 lnd.log.15 lnd.log.16.gz lnd.log.17.gz")])]),e._v(" "),t("p",[e._v("To access uncompressed logs of those logs do "),t("code",[e._v("cat lnd.log")]),e._v(" or if you want another one, use "),t("code",[e._v("cat lnd.log.15")])]),e._v(" "),t("p",[e._v("To access compressed logs in .gzip use "),t("code",[e._v("gzip -d lnd.log.16.gz")]),e._v(" (in this case we're accessing lnd.log.16.gz)")]),e._v(" "),t("p",[e._v("This should give you a new file, where you can do "),t("code",[e._v("cat lnd.log.16")])]),e._v(" "),t("p",[e._v("In case the above does not work, you may need to use install gzip first "),t("code",[e._v("sudo apt-get install gzip")])]),e._v(" "),t("h3",{attrs:{id:"222-lightning-network-core-lightning-cln-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#222-lightning-network-core-lightning-cln-docker"}},[e._v("#")]),e._v(" 2.2.2 - Lightning Network Core Lightning (CLN) - Docker")]),e._v(" "),t("p",[t("code",[e._v("sudo su -")])]),e._v(" "),t("p",[t("code",[e._v("docker ps")])]),e._v(" "),t("p",[e._v("Find the Core Lightning (CLN) container ID.")]),e._v(" "),t("p",[e._v("docker logs 'add your container ID here'")]),e._v(" "),t("p",[e._v("alternatively, use this")]),e._v(" "),t("p",[t("code",[e._v("docker logs --tail 100 btcpayserver_clightning_bitcoin")])]),e._v(" "),t("p",[e._v("You can also get log information with Core Lightning (CLN) cli command.")]),e._v(" "),t("p",[t("code",[e._v("bitcoin-lightning-cli.sh getlog")])]),e._v(" "),t("h2",{attrs:{id:"23-bitcoin-node-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#23-bitcoin-node-logs"}},[e._v("#")]),e._v(" 2.3 - Bitcoin Node Logs")]),e._v(" "),t("p",[e._v("In addition to "),t("a",{attrs:{href:"#2-looking-through-the-logs"}},[e._v("looking at logs")]),e._v(" of your Bitcoind container, you can also use any of the "),t("a",{attrs:{href:"https://developer.bitcoin.org/reference/rpc/index.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("bitcoin-cli commands"),t("OutboundLink")],1),e._v(" to obtain information from your bitcoin node.\nBTCPay includes a script to allow you to communicate with your Bitcoin node easily.")]),e._v(" "),t("p",[e._v("Inside the "),t("code",[e._v("btcpayserver-docker")]),e._v(" folder, get the blockchain information using your node:")]),e._v(" "),t("p",[t("code",[e._v("bitcoin-cli.sh getblockchaininfo")])]),e._v(" "),t("h2",{attrs:{id:"3-finding-a-solution-yourself-google-faq-github-issues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#3-finding-a-solution-yourself-google-faq-github-issues"}},[e._v("#")]),e._v(" 3. Finding a solution yourself (Google, FAQ, GitHub issues)")]),e._v(" "),t("p",[e._v("Even though setups differ, the chances that someone else experienced the same issue as yours are pretty high.\nTake a few moments, Google around and see if you can solve it yourself.")]),e._v(" "),t("h3",{attrs:{id:"31-btcpay-faq"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#31-btcpay-faq"}},[e._v("#")]),e._v(" 3.1 BTCPay FAQ")]),e._v(" "),t("p",[e._v("We try to document the most common issues on the "),t("RouterLink",{attrs:{to:"/FAQ/"}},[e._v("Frequently Asked Questions page")]),e._v(".\nTake a look there and see if your question is recorded.")],1),e._v(" "),t("h3",{attrs:{id:"32-github"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#32-github"}},[e._v("#")]),e._v(" 3.2 GitHub")]),e._v(" "),t("p",[e._v("When there's an advanced technical issue, users usually open an issue on GitHub.\nTake a look at the BTCPay GitHub repository and browse "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues?q=is%3Aissue+is%3Aclosed",target:"_blank",rel:"noopener noreferrer"}},[e._v("search the closed issues"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"33-mattermost"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#33-mattermost"}},[e._v("#")]),e._v(" 3.3 Mattermost")]),e._v(" "),t("p",[e._v("Mattermost chat platform is great for similar issues, other users experienced before you.\nOn the top right-hand corner, click on the search and enter your query.")]),e._v(" "),t("h2",{attrs:{id:"4-asking-for-help"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#4-asking-for-help"}},[e._v("#")]),e._v(" 4. Asking for help")]),e._v(" "),t("p",[e._v("If you're unable to solve the problem yourself, do not worry.\nThere's an amid community ready to help you.")]),e._v(" "),t("p",[e._v("The better you describe the problem, the higher are the chances of getting a timely fix.\nBe concise and provide as much relevant information as possible.\nBe sure to include the "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-can-i-see-my-btcpay-version"}},[e._v("version you're using")]),e._v(" and describe your BTCPay Deployment Setup.\nTry to explain what you're trying to do and what's the issue.\nIf you can provide the logs.\nIf you think it's relevant, feel free to include a screenshot.")],1),e._v(" "),t("p",[e._v("Here's a good example of how to ask a question.")]),e._v(" "),t("blockquote",[t("p",[e._v("I'm having a problem with XYZ. I can replicate the problem. My BTCPay version is 0.100.31, and I deployed my server on Digital Ocean by following Docker deployment guide. I've searched through the FAQ and closed GitHub issues, but there's no solution to my problem. My BTCPay Setup is XYZ, and the issue is occurring when I do XYZ. Here are the logs I was able to get from my BTCPay instance. You can see the error in the image I attached.")])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Please note:")]),e._v(" "),t("p",[e._v("The community will not provide extensive support for custom deployments.\nI.e. variations of "),t("RouterLink",{attrs:{to:"/Deployment/ManualDeployment/"}},[e._v("Manual Deployments")]),e._v(" are expected to be used only for development purposes and by users with technical literacy with the ability to "),t("strong",[e._v("resolve deployment and maintenance issues on their own")]),e._v(". This includes "),t("RouterLink",{attrs:{to:"/Deployment/HardwareAsAService/"}},[e._v("Hardware-As-A-Service")]),e._v(" products (Nodl, RaspiBlitz, Umbrel, etc ...)")],1)]),e._v(" "),t("h3",{attrs:{id:"41-asking-the-community-general-problems"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#41-asking-the-community-general-problems"}},[e._v("#")]),e._v(" 4.1 Asking the community (general problems)")]),e._v(" "),t("p",[e._v("For quick answers to fundamental problems, it's best to post a question in #support channel on "),t("a",{attrs:{href:"https://chat.btcpayserver.org/btcpayserver/channels/support",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay Mattermost"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"42-opening-an-issue-on-github-advanced-problems"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#42-opening-an-issue-on-github-advanced-problems"}},[e._v("#")]),e._v(" 4.2 Opening an Issue on GitHub (advanced problems)")]),e._v(" "),t("p",[e._v("If you have a custom build setup and are facing a complex problem, "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("open an issue on GitHub"),t("OutboundLink")],1),e._v(" so that developers can help you out.")]),e._v(" "),t("h3",{attrs:{id:"43-premium-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#43-premium-support"}},[e._v("#")]),e._v(" 4.3 Premium Support")]),e._v(" "),t("p",[e._v("Some community members provide paid support.\nIf you want a quicker help, check out the list of "),t("RouterLink",{attrs:{to:"/Support/"}},[e._v("members providing premium support")]),e._v(".")],1),e._v(" "),t("h3",{attrs:{id:"44-lightning-network-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#44-lightning-network-support"}},[e._v("#")]),e._v(" 4.4 Lightning Network Support")]),e._v(" "),t("p",[e._v("If you're facing a technical problem with your Lightning Network implementation, you may want to ask questions in their respective communities.")]),e._v(" "),t("h4",{attrs:{id:"441-lnd-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#441-lnd-support"}},[e._v("#")]),e._v(" 4.4.1 LND Support")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/lightningnetwork/lnd/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("LND GitHub"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://lightningcommunity.slack.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("Lightning Community on Slack"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"442-core-lightning-cln-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#442-core-lightning-cln-support"}},[e._v("#")]),e._v(" 4.4.2 Core Lightning (CLN) Support")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/ElementsProject/lightning/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("CLN GitHub"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://t.me/lightningd",target:"_blank",rel:"noopener noreferrer"}},[e._v("CLN Telegram Group"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://lightning.readthedocs.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("CLN docs"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[140],{791:function(e,t,r){"use strict";r.r(t);var o=r(9),n=Object(o.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"troubleshooting-an-issue-in-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#troubleshooting-an-issue-in-btcpay-server"}},[e._v("#")]),e._v(" Troubleshooting an issue in BTCPay Server")]),e._v(" "),t("p",[e._v("Facing a problem is never fun. This document explains the most common workflow and steps you should take to "),t("strong",[e._v("identify the issue")]),e._v(" you're having more easily and hopefully solve it yourself or with community help.")]),e._v(" "),t("p",[e._v("Identifying the problem is crucial.")]),e._v(" "),t("h2",{attrs:{id:"1-replicating-the-issue"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#1-replicating-the-issue"}},[e._v("#")]),e._v(" 1. Replicating the issue")]),e._v(" "),t("p",[e._v("First and foremost, try to determine when the issue happens.\nTry to replicate the problem.\nTry to update and restart your server to verify you can reproduce your issue.\nIf you think it will describe your issue better, take a screenshot.")]),e._v(" "),t("h3",{attrs:{id:"11-updating-the-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#11-updating-the-server"}},[e._v("#")]),e._v(" 1.1 Updating the server")]),e._v(" "),t("p",[e._v("Check "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-can-i-see-my-btcpay-version"}},[e._v("your version of BTCPay")]),e._v(".\nIf it is much older than the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/releases",target:"_blank",rel:"noopener noreferrer"}},[e._v("latest version"),t("OutboundLink")],1),e._v(" of BTCPay, "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-update-btcpay-server"}},[e._v("updating your server")]),e._v(" may resolve the issue.")],1),e._v(" "),t("h3",{attrs:{id:"12-restarting-the-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#12-restarting-the-server"}},[e._v("#")]),e._v(" 1.2 Restarting the server")]),e._v(" "),t("p",[e._v("Restarting your server is an easy way to solve many of the most common BTCPay Server issues.\nYou may need to "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-ssh-into-my-btcpay-running-on-vps"}},[e._v("SSH into your server")]),e._v(" to restart it.")],1),e._v(" "),t("h3",{attrs:{id:"13-restarting-a-service"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#13-restarting-a-service"}},[e._v("#")]),e._v(" 1.3 Restarting a service")]),e._v(" "),t("p",[e._v("Some issues you may only need to restart a particular service in your BTCPay Server deployment.\nSuch as restarting the letsencrypt container to renew the SSL certificate.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" restart letsencrypt-nginx-proxy-companion\n")])])]),t("p",[e._v("Use "),t("code",[e._v("docker ps")]),e._v(" to find the name of a different service you would like to restart.")]),e._v(" "),t("h2",{attrs:{id:"2-looking-through-the-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#2-looking-through-the-logs"}},[e._v("#")]),e._v(" 2. Looking through the logs")]),e._v(" "),t("p",[e._v("Logs can provide an essential piece of information.\nIn the next few paragraphs, we will describe how to get the "),t("strong",[e._v("log information for various parts of BTCPay")]),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"21-btcpay-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#21-btcpay-logs"}},[e._v("#")]),e._v(" 2.1 BTCPay Logs")]),e._v(" "),t("p",[e._v("Since the v1.0.3.8, you can easily access BTCPay Server logs from the front-end.\nIf you are a server admin, go to "),t("strong",[e._v("Server Settings > Logs")]),e._v(" and open the logs file.\nIf you don't know what a particular error in the logs means, make sure to mention it when troubleshooting.")]),e._v(" "),t("p",[e._v("If you would like more detailed logs and you're using a Docker deployment, you can view logs of specific Docker containers using the command line.\nSee these "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-to-ssh-into-my-btcpay-running-on-vps"}},[e._v("instructions to ssh")]),e._v(" into an instance of BTCPay running on a VPS.")],1),e._v(" "),t("p",[e._v("Below is a general list of the container names used for BTCPay.")]),e._v(" "),t("table",[t("thead",[t("tr",[t("th",[e._v("LOGS FOR")]),e._v(" "),t("th",{staticStyle:{"text-align":"center"}},[e._v("CONTAINER NAME")])])]),e._v(" "),t("tbody",[t("tr",[t("td",[e._v("BTCPayServer")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("generated_btcpayserver_1")])]),e._v(" "),t("tr",[t("td",[e._v("NBXplorer")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("generated_nbxplorer_1")])]),e._v(" "),t("tr",[t("td",[e._v("Bitcoind")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("btcpayserver_bitcoind")])]),e._v(" "),t("tr",[t("td",[e._v("Postgres")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("generated_postgres_1")])]),e._v(" "),t("tr",[t("td",[e._v("proxy")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("letsencrypt-nginx-proxy-companion")])]),e._v(" "),t("tr",[t("td",[e._v("Nginx")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("nginx-gen")])]),e._v(" "),t("tr",[t("td",[e._v("Nginx")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("nginx")])]),e._v(" "),t("tr",[t("td",[e._v("Core Lightning (CLN)")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("btcpayserver_clightning_bitcoin")])]),e._v(" "),t("tr",[t("td",[e._v("LND")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("btcpayserver_lnd_bitcoin")])]),e._v(" "),t("tr",[t("td",[e._v("RTL")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("generated_lnd_bitcoin_rtl_1")])]),e._v(" "),t("tr",[t("td",[e._v("Thunderhub")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("generated_bitcoin_thub_1")])]),e._v(" "),t("tr",[t("td",[e._v("LibrePatron")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("librepatron")])]),e._v(" "),t("tr",[t("td",[e._v("Tor")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("tor-gen")])]),e._v(" "),t("tr",[t("td",[e._v("Tor")]),e._v(" "),t("td",{staticStyle:{"text-align":"center"}},[e._v("tor")])])])]),e._v(" "),t("p",[e._v("Run the commands below to print logs by container name.\nReplace the container name to view other container logs.")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[t("span",{pre:!0,attrs:{class:"token function"}},[e._v("sudo")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("su")]),e._v(" -\n"),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v("cd")]),e._v(" btcpayserver-docker\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("ps")]),e._v("\n"),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("docker")]),e._v(" logs --tail "),t("span",{pre:!0,attrs:{class:"token number"}},[e._v("100")]),e._v(" generated_btcpayserver_1\n")])])]),t("h3",{attrs:{id:"22-lightning-network-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#22-lightning-network-logs"}},[e._v("#")]),e._v(" 2.2 Lightning Network Logs")]),e._v(" "),t("p",[e._v("Use the following if you're having a problem with the Lightning Network.")]),e._v(" "),t("h3",{attrs:{id:"221-lightning-network-lnd-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#221-lightning-network-lnd-docker"}},[e._v("#")]),e._v(" 2.2.1 - Lightning Network LND - Docker")]),e._v(" "),t("p",[e._v("There are a few ways to access your LND logs when using Docker.\nFirst log in as root:")]),e._v(" "),t("p",[t("code",[e._v("sudo su -")])]),e._v(" "),t("p",[e._v("Navigate to the correct directory:")]),e._v(" "),t("p",[t("code",[e._v("cd btcpayserver-docker")])]),e._v(" "),t("p",[e._v("Find container name:")]),e._v(" "),t("p",[t("code",[e._v("docker ps")])]),e._v(" "),t("p",[e._v("Print logs by container name:")]),e._v(" "),t("p",[t("code",[e._v("docker logs --tail 100 btcpayserver_lnd_bitcoin")])]),e._v(" "),t("p",[e._v("Alternatively, you can quickly print logs by using container ID (only the first unique ID characters are needed, such as the two furthest left characters):")]),e._v(" "),t("p",[t("code",[e._v("docker logs 'add your container ID '")])]),e._v(" "),t("p",[e._v("If for any reason you need more logs")]),e._v(" "),t("p",[t("code",[e._v("sudo su -")])]),e._v(" "),t("p",[t("code",[e._v("cd /var/lib/docker/volumes/generated_lnd_bitcoin_datadir/_data/logs/bitcoin/mainnet/")])]),e._v(" "),t("p",[e._v("inside that directory do "),t("code",[e._v("ls")])]),e._v(" "),t("p",[e._v("You will see something like "),t("code",[e._v("lnd.log lnd.log.13 lnd.log.15 lnd.log.16.gz lnd.log.17.gz")])]),e._v(" "),t("p",[e._v("To access uncompressed logs of those logs do "),t("code",[e._v("cat lnd.log")]),e._v(" or if you want another one, use "),t("code",[e._v("cat lnd.log.15")])]),e._v(" "),t("p",[e._v("To access compressed logs in .gzip use "),t("code",[e._v("gzip -d lnd.log.16.gz")]),e._v(" (in this case we're accessing lnd.log.16.gz)")]),e._v(" "),t("p",[e._v("This should give you a new file, where you can do "),t("code",[e._v("cat lnd.log.16")])]),e._v(" "),t("p",[e._v("In case the above does not work, you may need to use install gzip first "),t("code",[e._v("sudo apt-get install gzip")])]),e._v(" "),t("h3",{attrs:{id:"222-lightning-network-core-lightning-cln-docker"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#222-lightning-network-core-lightning-cln-docker"}},[e._v("#")]),e._v(" 2.2.2 - Lightning Network Core Lightning (CLN) - Docker")]),e._v(" "),t("p",[t("code",[e._v("sudo su -")])]),e._v(" "),t("p",[t("code",[e._v("docker ps")])]),e._v(" "),t("p",[e._v("Find the Core Lightning (CLN) container ID.")]),e._v(" "),t("p",[e._v("docker logs 'add your container ID here'")]),e._v(" "),t("p",[e._v("alternatively, use this")]),e._v(" "),t("p",[t("code",[e._v("docker logs --tail 100 btcpayserver_clightning_bitcoin")])]),e._v(" "),t("p",[e._v("You can also get log information with Core Lightning (CLN) cli command.")]),e._v(" "),t("p",[t("code",[e._v("bitcoin-lightning-cli.sh getlog")])]),e._v(" "),t("h2",{attrs:{id:"23-bitcoin-node-logs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#23-bitcoin-node-logs"}},[e._v("#")]),e._v(" 2.3 - Bitcoin Node Logs")]),e._v(" "),t("p",[e._v("In addition to "),t("a",{attrs:{href:"#2-looking-through-the-logs"}},[e._v("looking at logs")]),e._v(" of your Bitcoind container, you can also use any of the "),t("a",{attrs:{href:"https://developer.bitcoin.org/reference/rpc/index.html",target:"_blank",rel:"noopener noreferrer"}},[e._v("bitcoin-cli commands"),t("OutboundLink")],1),e._v(" to obtain information from your bitcoin node.\nBTCPay includes a script to allow you to communicate with your Bitcoin node easily.")]),e._v(" "),t("p",[e._v("Inside the "),t("code",[e._v("btcpayserver-docker")]),e._v(" folder, get the blockchain information using your node:")]),e._v(" "),t("p",[t("code",[e._v("bitcoin-cli.sh getblockchaininfo")])]),e._v(" "),t("h2",{attrs:{id:"3-finding-a-solution-yourself-google-faq-github-issues"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#3-finding-a-solution-yourself-google-faq-github-issues"}},[e._v("#")]),e._v(" 3. Finding a solution yourself (Google, FAQ, GitHub issues)")]),e._v(" "),t("p",[e._v("Even though setups differ, the chances that someone else experienced the same issue as yours are pretty high.\nTake a few moments, Google around and see if you can solve it yourself.")]),e._v(" "),t("h3",{attrs:{id:"31-btcpay-faq"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#31-btcpay-faq"}},[e._v("#")]),e._v(" 3.1 BTCPay FAQ")]),e._v(" "),t("p",[e._v("We try to document the most common issues on the "),t("RouterLink",{attrs:{to:"/FAQ/"}},[e._v("Frequently Asked Questions page")]),e._v(".\nTake a look there and see if your question is recorded.")],1),e._v(" "),t("h3",{attrs:{id:"32-github"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#32-github"}},[e._v("#")]),e._v(" 3.2 GitHub")]),e._v(" "),t("p",[e._v("When there's an advanced technical issue, users usually open an issue on GitHub.\nTake a look at the BTCPay GitHub repository and browse "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues?q=is%3Aissue+is%3Aclosed",target:"_blank",rel:"noopener noreferrer"}},[e._v("search the closed issues"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"33-mattermost"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#33-mattermost"}},[e._v("#")]),e._v(" 3.3 Mattermost")]),e._v(" "),t("p",[e._v("Mattermost chat platform is great for similar issues, other users experienced before you.\nOn the top right-hand corner, click on the search and enter your query.")]),e._v(" "),t("h2",{attrs:{id:"4-asking-for-help"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#4-asking-for-help"}},[e._v("#")]),e._v(" 4. Asking for help")]),e._v(" "),t("p",[e._v("If you're unable to solve the problem yourself, do not worry.\nThere's an amid community ready to help you.")]),e._v(" "),t("p",[e._v("The better you describe the problem, the higher are the chances of getting a timely fix.\nBe concise and provide as much relevant information as possible.\nBe sure to include the "),t("RouterLink",{attrs:{to:"/FAQ/ServerSettings/#how-can-i-see-my-btcpay-version"}},[e._v("version you're using")]),e._v(" and describe your BTCPay Deployment Setup.\nTry to explain what you're trying to do and what's the issue.\nIf you can provide the logs.\nIf you think it's relevant, feel free to include a screenshot.")],1),e._v(" "),t("p",[e._v("Here's a good example of how to ask a question.")]),e._v(" "),t("blockquote",[t("p",[e._v("I'm having a problem with XYZ. I can replicate the problem. My BTCPay version is 0.100.31, and I deployed my server on Digital Ocean by following Docker deployment guide. I've searched through the FAQ and closed GitHub issues, but there's no solution to my problem. My BTCPay Setup is XYZ, and the issue is occurring when I do XYZ. Here are the logs I was able to get from my BTCPay instance. You can see the error in the image I attached.")])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("Please note:")]),e._v(" "),t("p",[e._v("The community will not provide extensive support for custom deployments.\nI.e. variations of "),t("RouterLink",{attrs:{to:"/Deployment/ManualDeployment/"}},[e._v("Manual Deployments")]),e._v(" are expected to be used only for development purposes and by users with technical literacy with the ability to "),t("strong",[e._v("resolve deployment and maintenance issues on their own")]),e._v(". This includes "),t("RouterLink",{attrs:{to:"/Deployment/HardwareAsAService/"}},[e._v("Hardware-As-A-Service")]),e._v(" products (Nodl, RaspiBlitz, Umbrel, etc ...)")],1)]),e._v(" "),t("h3",{attrs:{id:"41-asking-the-community-general-problems"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#41-asking-the-community-general-problems"}},[e._v("#")]),e._v(" 4.1 Asking the community (general problems)")]),e._v(" "),t("p",[e._v("For quick answers to fundamental problems, it's best to post a question in #support channel on "),t("a",{attrs:{href:"https://chat.btcpayserver.org/btcpayserver/channels/support",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay Mattermost"),t("OutboundLink")],1),e._v(".")]),e._v(" "),t("h3",{attrs:{id:"42-opening-an-issue-on-github-advanced-problems"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#42-opening-an-issue-on-github-advanced-problems"}},[e._v("#")]),e._v(" 4.2 Opening an Issue on GitHub (advanced problems)")]),e._v(" "),t("p",[e._v("If you have a custom build setup and are facing a complex problem, "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("open an issue on GitHub"),t("OutboundLink")],1),e._v(" so that developers can help you out.")]),e._v(" "),t("h3",{attrs:{id:"43-premium-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#43-premium-support"}},[e._v("#")]),e._v(" 4.3 Premium Support")]),e._v(" "),t("p",[e._v("Some community members provide paid support.\nIf you want a quicker help, check out the list of "),t("RouterLink",{attrs:{to:"/Support/"}},[e._v("members providing premium support")]),e._v(".")],1),e._v(" "),t("h3",{attrs:{id:"44-lightning-network-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#44-lightning-network-support"}},[e._v("#")]),e._v(" 4.4 Lightning Network Support")]),e._v(" "),t("p",[e._v("If you're facing a technical problem with your Lightning Network implementation, you may want to ask questions in their respective communities.")]),e._v(" "),t("h4",{attrs:{id:"441-lnd-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#441-lnd-support"}},[e._v("#")]),e._v(" 4.4.1 LND Support")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/lightningnetwork/lnd/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("LND GitHub"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://lightningcommunity.slack.com",target:"_blank",rel:"noopener noreferrer"}},[e._v("Lightning Community on Slack"),t("OutboundLink")],1)])]),e._v(" "),t("h4",{attrs:{id:"442-core-lightning-cln-support"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#442-core-lightning-cln-support"}},[e._v("#")]),e._v(" 4.4.2 Core Lightning (CLN) Support")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://github.com/ElementsProject/lightning/issues",target:"_blank",rel:"noopener noreferrer"}},[e._v("CLN GitHub"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://t.me/lightningd",target:"_blank",rel:"noopener noreferrer"}},[e._v("CLN Telegram Group"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://lightning.readthedocs.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("CLN docs"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/141.6a7b41a5.js b/assets/js/141.510dc274.js similarity index 98% rename from assets/js/141.6a7b41a5.js rename to assets/js/141.510dc274.js index 77b7aae0a6..8587207ef9 100644 --- a/assets/js/141.6a7b41a5.js +++ b/assets/js/141.510dc274.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[141],{790:function(t,e,r){"use strict";r.r(e);var o=r(9),a=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"try-out-btcpay-server"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#try-out-btcpay-server"}},[t._v("#")]),t._v(" Try out BTCPay server")]),t._v(" "),e("p",[t._v("Before you start using BTCPay Server in production, you can try it and see if it fits your needs.")]),t._v(" "),e("p",[t._v("On this page you will see various ways to test out the software on mainnet and testnet.")]),t._v(" "),e("h2",{attrs:{id:"our-mainnet-demo-server"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#our-mainnet-demo-server"}},[t._v("#")]),t._v(" Our mainnet demo server")]),t._v(" "),e("p",[t._v("We host our server on "),e("a",{attrs:{href:"https://mainnet.demo.btcpayserver.org/login",target:"_blank",rel:"noopener noreferrer"}},[t._v("mainnet.demo.btcpayserver.org"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[t._v("Feel free to register to it, create a store and a wallet and play around.")]),t._v(" "),e("p",[t._v("This instance should only be used for testing things out. We do not guarantee uptime.")]),t._v(" "),e("h2",{attrs:{id:"our-testnet-demo-server"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#our-testnet-demo-server"}},[t._v("#")]),t._v(" Our Testnet demo server")]),t._v(" "),e("p",[t._v("If you're familiar with testnet and want to test BTCPay through it, check "),e("a",{attrs:{href:"https://testnet.demo.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("testnet.demo.btcpayserver.org"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[t._v("For more information see "),e("RouterLink",{attrs:{to:"/Development/TestnetDemo/"}},[t._v("testnet documentation")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"third-party-hosts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#third-party-hosts"}},[t._v("#")]),t._v(" Third-party hosts")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/Deployment/ThirdPartyHosting/"}},[t._v("Third-party hosts")]),t._v(" provide hosted solutions, in most cases free of charge, in case you don't want to self-host a server.")],1),t._v(" "),e("p",[t._v("While most of them can be used in-production, you can also use them to try things out. They're similar to our demo server, but provide better uptime and reliability.")]),t._v(" "),e("p",[t._v("For full lists of third-party hosts to pick from, "),e("a",{attrs:{href:"https://directory.btcpayserver.org/filter/hosts",target:"_blank",rel:"noopener noreferrer"}},[t._v("see our hosts directory"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"start-testing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#start-testing"}},[t._v("#")]),t._v(" Start testing")]),t._v(" "),e("p",[t._v("Once you pick up a server to use, the steps are the same, regardless of which option you've opted for.")]),t._v(" "),e("p",[t._v("Click on the following links for detailed instructions on how to:")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/RegisterAccount/"}},[t._v("Register an account")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/CreateStore/"}},[t._v("Create a store")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/WalletSetup/"}},[t._v("Create a wallet")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/WhatsNext/"}},[t._v("Start exploring")])],1)]),t._v(" "),e("h3",{attrs:{id:"btcpay-server-in-action"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-server-in-action"}},[t._v("#")]),t._v(" BTCPay Server in action")]),t._v(" "),e("p",[t._v("Below, you will find options to see the BTCPay server in action. Through our own POS on our demo or through the eyes of actual merchants in the wild!")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"https://mainnet.demo.btcpayserver.org/apps/87kj5yKay8mB4UUZcJhZH5TqDKMD3CznjwLjiu1oYZXe/pos",target:"_blank",rel:"noopener noreferrer"}},[t._v("Point of Sale Demo"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://directory.btcpayserver.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("In-production stores"),e("OutboundLink")],1)])]),t._v(" "),e("h2",{attrs:{id:"questions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#questions"}},[t._v("#")]),t._v(" Questions")]),t._v(" "),e("p",[t._v("If you have questions about BTCPay Server, check our documentation, "),e("RouterLink",{attrs:{to:"/FAQ/"}},[t._v("Frequently asked questions page")]),t._v(".")],1),t._v(" "),e("p",[t._v("Join the "),e("a",{attrs:{href:"https://chat.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("community chat"),e("OutboundLink")],1),t._v(" on Mattermost by downloading "),e("a",{attrs:{href:"https://mattermost.com/download/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Mattermost app"),e("OutboundLink")],1),t._v(", or on "),e("a",{attrs:{href:"https://t.me/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[t._v("Telegram"),e("OutboundLink")],1),t._v(" in case you need further help or help or want to hang around with like-minded people.")])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[141],{792:function(t,e,r){"use strict";r.r(e);var o=r(9),a=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"try-out-btcpay-server"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#try-out-btcpay-server"}},[t._v("#")]),t._v(" Try out BTCPay server")]),t._v(" "),e("p",[t._v("Before you start using BTCPay Server in production, you can try it and see if it fits your needs.")]),t._v(" "),e("p",[t._v("On this page you will see various ways to test out the software on mainnet and testnet.")]),t._v(" "),e("h2",{attrs:{id:"our-mainnet-demo-server"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#our-mainnet-demo-server"}},[t._v("#")]),t._v(" Our mainnet demo server")]),t._v(" "),e("p",[t._v("We host our server on "),e("a",{attrs:{href:"https://mainnet.demo.btcpayserver.org/login",target:"_blank",rel:"noopener noreferrer"}},[t._v("mainnet.demo.btcpayserver.org"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[t._v("Feel free to register to it, create a store and a wallet and play around.")]),t._v(" "),e("p",[t._v("This instance should only be used for testing things out. We do not guarantee uptime.")]),t._v(" "),e("h2",{attrs:{id:"our-testnet-demo-server"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#our-testnet-demo-server"}},[t._v("#")]),t._v(" Our Testnet demo server")]),t._v(" "),e("p",[t._v("If you're familiar with testnet and want to test BTCPay through it, check "),e("a",{attrs:{href:"https://testnet.demo.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("testnet.demo.btcpayserver.org"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[t._v("For more information see "),e("RouterLink",{attrs:{to:"/Development/TestnetDemo/"}},[t._v("testnet documentation")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"third-party-hosts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#third-party-hosts"}},[t._v("#")]),t._v(" Third-party hosts")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/Deployment/ThirdPartyHosting/"}},[t._v("Third-party hosts")]),t._v(" provide hosted solutions, in most cases free of charge, in case you don't want to self-host a server.")],1),t._v(" "),e("p",[t._v("While most of them can be used in-production, you can also use them to try things out. They're similar to our demo server, but provide better uptime and reliability.")]),t._v(" "),e("p",[t._v("For full lists of third-party hosts to pick from, "),e("a",{attrs:{href:"https://directory.btcpayserver.org/filter/hosts",target:"_blank",rel:"noopener noreferrer"}},[t._v("see our hosts directory"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"start-testing"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#start-testing"}},[t._v("#")]),t._v(" Start testing")]),t._v(" "),e("p",[t._v("Once you pick up a server to use, the steps are the same, regardless of which option you've opted for.")]),t._v(" "),e("p",[t._v("Click on the following links for detailed instructions on how to:")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/RegisterAccount/"}},[t._v("Register an account")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/CreateStore/"}},[t._v("Create a store")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/WalletSetup/"}},[t._v("Create a wallet")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/WhatsNext/"}},[t._v("Start exploring")])],1)]),t._v(" "),e("h3",{attrs:{id:"btcpay-server-in-action"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-server-in-action"}},[t._v("#")]),t._v(" BTCPay Server in action")]),t._v(" "),e("p",[t._v("Below, you will find options to see the BTCPay server in action. Through our own POS on our demo or through the eyes of actual merchants in the wild!")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"https://mainnet.demo.btcpayserver.org/apps/87kj5yKay8mB4UUZcJhZH5TqDKMD3CznjwLjiu1oYZXe/pos",target:"_blank",rel:"noopener noreferrer"}},[t._v("Point of Sale Demo"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://directory.btcpayserver.org",target:"_blank",rel:"noopener noreferrer"}},[t._v("In-production stores"),e("OutboundLink")],1)])]),t._v(" "),e("h2",{attrs:{id:"questions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#questions"}},[t._v("#")]),t._v(" Questions")]),t._v(" "),e("p",[t._v("If you have questions about BTCPay Server, check our documentation, "),e("RouterLink",{attrs:{to:"/FAQ/"}},[t._v("Frequently asked questions page")]),t._v(".")],1),t._v(" "),e("p",[t._v("Join the "),e("a",{attrs:{href:"https://chat.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[t._v("community chat"),e("OutboundLink")],1),t._v(" on Mattermost by downloading "),e("a",{attrs:{href:"https://mattermost.com/download/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Mattermost app"),e("OutboundLink")],1),t._v(", or on "),e("a",{attrs:{href:"https://t.me/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[t._v("Telegram"),e("OutboundLink")],1),t._v(" in case you need further help or help or want to hang around with like-minded people.")])])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/142.d4e5d067.js b/assets/js/142.336286f1.js similarity index 99% rename from assets/js/142.d4e5d067.js rename to assets/js/142.336286f1.js index 5624d1246a..44e332e2d9 100644 --- a/assets/js/142.d4e5d067.js +++ b/assets/js/142.336286f1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[142],{792:function(e,a,t){"use strict";t.r(a);var s=t(9),r=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"how-to-verify-release-signatures"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-verify-release-signatures"}},[e._v("#")]),e._v(" How to verify release signatures")]),e._v(" "),a("h2",{attrs:{id:"introduction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),a("p",[e._v("Downloading binaries from the internet might be dangerous. When you download a release of BTCPayServer Vault on our "),a("a",{attrs:{href:"https://github.com/btcpayserver/BTCPayServer.Vault/releases",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub releases page"),a("OutboundLink")],1),e._v(", you only ensure that the uploader had access to our GitHub repository.")]),e._v(" "),a("p",[e._v("This might be fine, but sometimes you download the same binaries from a different source, or you want additional assurance that those binaries are signed by the developers of the project. (In this case, Nicolas Dorier)")]),e._v(" "),a("p",[e._v("If you do not care about who signed the executable and verifying the integrity of the files you downloaded, you don't have to read this document.")]),e._v(" "),a("h2",{attrs:{id:"checking-pgp-signatures"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#checking-pgp-signatures"}},[e._v("#")]),e._v(" Checking PGP signatures"),a("a",{attrs:{name:"pgp"}})]),e._v(" "),a("p",[e._v("For this you need the "),a("code",[e._v("gpg")]),e._v(" tool, make sure it is installed on your machine.")]),e._v(" "),a("p",[e._v("On the "),a("a",{attrs:{href:"https://github.com/btcpayserver/BTCPayServer.Vault/releases/latest",target:"_blank",rel:"noopener noreferrer"}},[e._v("release page"),a("OutboundLink")],1),e._v(", download:")]),e._v(" "),a("ol",[a("li",[e._v("The release binary of your choice.")]),e._v(" "),a("li",[e._v("The "),a("code",[e._v("SHA256SUMS.asc")]),e._v(" file")])]),e._v(" "),a("h3",{attrs:{id:"importing-nicolas-dorier-pgp-keys-only-first-time"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#importing-nicolas-dorier-pgp-keys-only-first-time"}},[e._v("#")]),e._v(" Importing Nicolas Dorier pgp keys (only first time)")]),e._v(" "),a("p",[e._v("This step should be done only one time. It ensures your system knows Nicolas Dorier's PGP keys.")]),e._v(" "),a("p",[e._v("Nicolas Dorier has a "),a("a",{attrs:{href:"https://keybase.io/NicolasDorier",target:"_blank",rel:"noopener noreferrer"}},[e._v("keybase"),a("OutboundLink")],1),e._v(" account that allow you to verify that his identity is linked to several well-known social media accounts.\nAnd as you can see on his profile page, the PGP key "),a("code",[e._v("62FE 8564 7DED DA2E")]),e._v(" is linked to his keybase identity.")]),e._v(" "),a("p",[e._v("You can import this key from keybase:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" https://keybase.io/nicolasdorier/pgp_keys.asc "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" gpg --import\n")])])]),a("p",[e._v("or")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("keybase pgp pull nicolasdorier\n")])])]),a("p",[e._v("Alternatively, you can just download the file via the browser and run:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("gpg --import pgp_keys.asc\n")])])]),a("p",[e._v("This step won't have to be repeated the next time you need to check a signature.")]),e._v(" "),a("h3",{attrs:{id:"checking-the-actual-pgp-signature"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#checking-the-actual-pgp-signature"}},[e._v("#")]),e._v(" Checking the actual PGP signature")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("sha256sum --check SHA256SUMS.asc --ignore-missing\n")])])]),a("p",[e._v("You should see that the file you downloaded has the right hash:")]),e._v(" "),a("div",{staticClass:"language-text extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("BTCPayServerVault-1.0.7-setup.exe: OK\n")])])]),a("p",[e._v("If you are on Windows you can check the hashes are identical manually:")]),e._v(" "),a("div",{staticClass:"language-powershell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-powershell"}},[a("code",[e._v("certUtil "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("hashfile BTCPayServerVault-1"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("0"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("7-setup"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("exe SHA256\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("type")]),e._v(" SHA256SUMS"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("asc\n")])])]),a("p",[e._v("If you are on macOS:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("shasum -a "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("256")]),e._v(" --check SHA256SUMS.asc\n")])])]),a("p",[e._v("You should see that the file you downloaded has the right hash:")]),e._v(" "),a("div",{staticClass:"language-text extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("BTCPayServerVault-osx-x64-1.0.7.dmg: OK\n")])])]),a("p",[e._v("Then check the actual signature:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("gpg --verify SHA256SUMS.asc\n")])])]),a("p",[e._v("Which should output something like:")]),e._v(" "),a("div",{staticClass:"language-text extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v('gpg: Signature made Thu Dec 5 20:40:47 2019 JST\ngpg: using RSA key 62FE85647DEDDA2E\ngpg: Good signature from "BTCPayServer Vault <nicolas.dorier@gmail.com>" [unknown]\ngpg: WARNING: This key is not certified with a trusted signature!\ngpg: There is no indication that the signature belongs to the owner.\nPrimary key fingerprint: 7121 BDE3 555D 9BE0 6BDD C681 62FE 8564 7DED DA2E\n')])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[142],{794:function(e,a,t){"use strict";t.r(a);var s=t(9),r=Object(s.a)({},(function(){var e=this,a=e._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[a("h1",{attrs:{id:"how-to-verify-release-signatures"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#how-to-verify-release-signatures"}},[e._v("#")]),e._v(" How to verify release signatures")]),e._v(" "),a("h2",{attrs:{id:"introduction"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),a("p",[e._v("Downloading binaries from the internet might be dangerous. When you download a release of BTCPayServer Vault on our "),a("a",{attrs:{href:"https://github.com/btcpayserver/BTCPayServer.Vault/releases",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub releases page"),a("OutboundLink")],1),e._v(", you only ensure that the uploader had access to our GitHub repository.")]),e._v(" "),a("p",[e._v("This might be fine, but sometimes you download the same binaries from a different source, or you want additional assurance that those binaries are signed by the developers of the project. (In this case, Nicolas Dorier)")]),e._v(" "),a("p",[e._v("If you do not care about who signed the executable and verifying the integrity of the files you downloaded, you don't have to read this document.")]),e._v(" "),a("h2",{attrs:{id:"checking-pgp-signatures"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#checking-pgp-signatures"}},[e._v("#")]),e._v(" Checking PGP signatures"),a("a",{attrs:{name:"pgp"}})]),e._v(" "),a("p",[e._v("For this you need the "),a("code",[e._v("gpg")]),e._v(" tool, make sure it is installed on your machine.")]),e._v(" "),a("p",[e._v("On the "),a("a",{attrs:{href:"https://github.com/btcpayserver/BTCPayServer.Vault/releases/latest",target:"_blank",rel:"noopener noreferrer"}},[e._v("release page"),a("OutboundLink")],1),e._v(", download:")]),e._v(" "),a("ol",[a("li",[e._v("The release binary of your choice.")]),e._v(" "),a("li",[e._v("The "),a("code",[e._v("SHA256SUMS.asc")]),e._v(" file")])]),e._v(" "),a("h3",{attrs:{id:"importing-nicolas-dorier-pgp-keys-only-first-time"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#importing-nicolas-dorier-pgp-keys-only-first-time"}},[e._v("#")]),e._v(" Importing Nicolas Dorier pgp keys (only first time)")]),e._v(" "),a("p",[e._v("This step should be done only one time. It ensures your system knows Nicolas Dorier's PGP keys.")]),e._v(" "),a("p",[e._v("Nicolas Dorier has a "),a("a",{attrs:{href:"https://keybase.io/NicolasDorier",target:"_blank",rel:"noopener noreferrer"}},[e._v("keybase"),a("OutboundLink")],1),e._v(" account that allow you to verify that his identity is linked to several well-known social media accounts.\nAnd as you can see on his profile page, the PGP key "),a("code",[e._v("62FE 8564 7DED DA2E")]),e._v(" is linked to his keybase identity.")]),e._v(" "),a("p",[e._v("You can import this key from keybase:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[a("span",{pre:!0,attrs:{class:"token function"}},[e._v("curl")]),e._v(" https://keybase.io/nicolasdorier/pgp_keys.asc "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("|")]),e._v(" gpg --import\n")])])]),a("p",[e._v("or")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("keybase pgp pull nicolasdorier\n")])])]),a("p",[e._v("Alternatively, you can just download the file via the browser and run:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("gpg --import pgp_keys.asc\n")])])]),a("p",[e._v("This step won't have to be repeated the next time you need to check a signature.")]),e._v(" "),a("h3",{attrs:{id:"checking-the-actual-pgp-signature"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#checking-the-actual-pgp-signature"}},[e._v("#")]),e._v(" Checking the actual PGP signature")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("sha256sum --check SHA256SUMS.asc --ignore-missing\n")])])]),a("p",[e._v("You should see that the file you downloaded has the right hash:")]),e._v(" "),a("div",{staticClass:"language-text extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("BTCPayServerVault-1.0.7-setup.exe: OK\n")])])]),a("p",[e._v("If you are on Windows you can check the hashes are identical manually:")]),e._v(" "),a("div",{staticClass:"language-powershell extra-class"},[a("pre",{pre:!0,attrs:{class:"language-powershell"}},[a("code",[e._v("certUtil "),a("span",{pre:!0,attrs:{class:"token operator"}},[e._v("-")]),e._v("hashfile BTCPayServerVault-1"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("0"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("7-setup"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("exe SHA256\n"),a("span",{pre:!0,attrs:{class:"token function"}},[e._v("type")]),e._v(" SHA256SUMS"),a("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(".")]),e._v("asc\n")])])]),a("p",[e._v("If you are on macOS:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("shasum -a "),a("span",{pre:!0,attrs:{class:"token number"}},[e._v("256")]),e._v(" --check SHA256SUMS.asc\n")])])]),a("p",[e._v("You should see that the file you downloaded has the right hash:")]),e._v(" "),a("div",{staticClass:"language-text extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v("BTCPayServerVault-osx-x64-1.0.7.dmg: OK\n")])])]),a("p",[e._v("Then check the actual signature:")]),e._v(" "),a("div",{staticClass:"language-bash extra-class"},[a("pre",{pre:!0,attrs:{class:"language-bash"}},[a("code",[e._v("gpg --verify SHA256SUMS.asc\n")])])]),a("p",[e._v("Which should output something like:")]),e._v(" "),a("div",{staticClass:"language-text extra-class"},[a("pre",{pre:!0,attrs:{class:"language-text"}},[a("code",[e._v('gpg: Signature made Thu Dec 5 20:40:47 2019 JST\ngpg: using RSA key 62FE85647DEDDA2E\ngpg: Good signature from "BTCPayServer Vault <nicolas.dorier@gmail.com>" [unknown]\ngpg: WARNING: This key is not certified with a trusted signature!\ngpg: There is no indication that the signature belongs to the owner.\nPrimary key fingerprint: 7121 BDE3 555D 9BE0 6BDD C681 62FE 8564 7DED DA2E\n')])])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/143.aabdd48d.js b/assets/js/143.ae6c6215.js similarity index 95% rename from assets/js/143.aabdd48d.js rename to assets/js/143.ae6c6215.js index 1c2e3d563f..b928f27631 100644 --- a/assets/js/143.aabdd48d.js +++ b/assets/js/143.ae6c6215.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[143],{798:function(t,e,a){"use strict";a.r(e);var r=a(9),o=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"3-wallet-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#3-wallet-setup"}},[t._v("#")]),t._v(" (3) Wallet Setup")]),t._v(" "),e("p",[t._v("After "),e("RouterLink",{attrs:{to:"/RegisterAccount/"}},[t._v("account registration")]),t._v(" and "),e("RouterLink",{attrs:{to:"/CreateStore/"}},[t._v("store creation")]),t._v(", it's time to configure a wallet in your BTCPay Server, so that you can start receiving payments into it.")],1),t._v(" "),e("p",[t._v("There are two ways to set up a wallet in BTCPay Server:")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/ConnectWallet/"}},[t._v("Connect an existing wallet")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/CreateWallet/"}},[t._v("Create a new wallet")])],1)]),t._v(" "),e("p",[t._v("There are many options on how set up a wallet with your BTCPay Server. It's up to you to decide what works best for your use-case. Once you configure a wallet, you're all set. The next step, is to "),e("RouterLink",{attrs:{to:"/WhatsNext/"}},[t._v("start exploring the features")]),t._v(".")],1),t._v(" "),e("p",[e("strong",[e("em",[t._v("Proceed to the next step - "),e("RouterLink",{attrs:{to:"/WhatsNext/"}},[t._v("What's Next?")]),t._v(".")],1)])])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[143],{800:function(t,e,a){"use strict";a.r(e);var r=a(9),o=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"3-wallet-setup"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#3-wallet-setup"}},[t._v("#")]),t._v(" (3) Wallet Setup")]),t._v(" "),e("p",[t._v("After "),e("RouterLink",{attrs:{to:"/RegisterAccount/"}},[t._v("account registration")]),t._v(" and "),e("RouterLink",{attrs:{to:"/CreateStore/"}},[t._v("store creation")]),t._v(", it's time to configure a wallet in your BTCPay Server, so that you can start receiving payments into it.")],1),t._v(" "),e("p",[t._v("There are two ways to set up a wallet in BTCPay Server:")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/ConnectWallet/"}},[t._v("Connect an existing wallet")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/CreateWallet/"}},[t._v("Create a new wallet")])],1)]),t._v(" "),e("p",[t._v("There are many options on how set up a wallet with your BTCPay Server. It's up to you to decide what works best for your use-case. Once you configure a wallet, you're all set. The next step, is to "),e("RouterLink",{attrs:{to:"/WhatsNext/"}},[t._v("start exploring the features")]),t._v(".")],1),t._v(" "),e("p",[e("strong",[e("em",[t._v("Proceed to the next step - "),e("RouterLink",{attrs:{to:"/WhatsNext/"}},[t._v("What's Next?")]),t._v(".")],1)])])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/144.048f8b76.js b/assets/js/144.3cfe9a91.js similarity index 99% rename from assets/js/144.048f8b76.js rename to assets/js/144.3cfe9a91.js index f9804dcea1..4f22da2560 100644 --- a/assets/js/144.048f8b76.js +++ b/assets/js/144.3cfe9a91.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[144],{800:function(t,e,r){"use strict";r.r(e);var o=r(9),a=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"4-whats-next"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#4-whats-next"}},[t._v("#")]),t._v(" (4) What's Next?")]),t._v(" "),e("p",[t._v("After you've connected your wallet to your BTCPay, you can explore various built in tools in the software. See the full list of Use Cases "),e("RouterLink",{attrs:{to:"/UseCase/"}},[t._v("here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"creating-the-point-of-sale-app"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-the-point-of-sale-app"}},[t._v("#")]),t._v(" Creating the Point of Sale App")]),t._v(" "),e("p",[t._v("BTCPay has a PoS app which you can use to receive payments from your customers directly or to receive donations. To "),e("strong",[t._v("create the POS app")]),t._v(", you need to have a store created in BTCPay. View PoS instructions "),e("RouterLink",{attrs:{to:"/Apps/#point-of-sale-app"}},[t._v("here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"creating-the-crowdfund-app"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-the-crowdfund-app"}},[t._v("#")]),t._v(" Creating the Crowdfund App")]),t._v(" "),e("p",[t._v("Create a "),e("strong",[t._v("crowdfunding campaign using BTCPay")]),t._v(". Unlike traditional crowdfunding platforms, the creator of the campaign is the owner of the platform. Funds go directly to the creator’s wallet without any fees. View Crowdfund instructions "),e("RouterLink",{attrs:{to:"/Apps/#crowdfunding-app"}},[t._v("here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"creating-the-payment-request"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-the-payment-request"}},[t._v("#")]),t._v(" Creating the Payment Request")]),t._v(" "),e("p",[t._v("Create "),e("strong",[t._v("custom invoices which can be shared with others")]),t._v(", by sending a link to your payment request. Users can pay the request at any time. BTCPay automatically updates the BTC exchange rate at the time of payment. View Payment Request instructions "),e("RouterLink",{attrs:{to:"/PaymentRequests/"}},[t._v("here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"creating-the-pay-button"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-the-pay-button"}},[t._v("#")]),t._v(" Creating the Pay Button")]),t._v(" "),e("p",[e("strong",[t._v("Pay buttons")]),t._v(" are great when you have a fixed amount for a product or a donation. You can easily embed the button into HTML. When the customer or a visitor clicks on the button, BTCPay displays a checkout page and an invoice for them. View Pay Button instructions "),e("RouterLink",{attrs:{to:"/Apps/#payment-button"}},[t._v("here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"connecting-your-btcpay-store-to-your-e-commerce-platform"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#connecting-your-btcpay-store-to-your-e-commerce-platform"}},[t._v("#")]),t._v(" Connecting your BTCPay store to your e-commerce platform")]),t._v(" "),e("p",[t._v("Depending on the CMS you're using, you can easily connect BTCPay to your online store. Currently, BTCPay offers following integrations :")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/WooCommerce/"}},[t._v("WooCommerce")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/Shopify/"}},[t._v("Shopify")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/Drupal/"}},[t._v("Drupal")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/Magento/"}},[t._v("Magneto")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/PrestaShop/"}},[t._v("PrestaShop")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/CustomIntegration/"}},[t._v("Custom integration")])],1)]),t._v(" "),e("h2",{attrs:{id:"connecting-additional-btcpay-services"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#connecting-additional-btcpay-services"}},[t._v("#")]),t._v(" Connecting Additional BTCPay Services")]),t._v(" "),e("p",[t._v("Additional free, open-source plugins can be used with your BTCPay.")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"https://github.com/JeffVandrewJr/patron",target:"_blank",rel:"noopener noreferrer"}},[t._v("LibrePatron"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://github.com/btcpayserver/btcTransmuter/blob/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("BTC Transmuter"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("LibrePatron is a self-hosted, censorship-free, Patreon alternative")]),t._v(". LibrePatron uses BTCPay Server to receive Bitcoin payments on a recurring basis. Funds go directly to the creator's wallet. View LibrePatron instructions "),e("a",{attrs:{href:"https://blog.btcpayserver.org/librepatron-patreon-alternative/",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[e("strong",[t._v("BTC Transmuter is a self-hosted service that allows you to automate your money and other tasks using BTCPay")]),t._v(". Create custom, automated processes using crypto service triggers based on BTCPay. Common use-cases are fiat integration, payment forwarding and email automation. Open lightning channels, detect payments and more, using blockchain data from your own nodes in BTCPay. View BTC Transmuter documentation "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcTransmuter/blob/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"join-the-btcpay-community"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#join-the-btcpay-community"}},[t._v("#")]),t._v(" Join The BTCPay Community")]),t._v(" "),e("p",[t._v("BTCPay Server is an open-source project, not a company. We rely on a network of diverse contributors and users to provide support for numerous use-cases. Join us in improving, learning, and building BTCPay.")]),t._v(" "),e("p",[t._v("If you have questions, try searching our "),e("RouterLink",{attrs:{to:"/FAQ/"}},[t._v("FAQ Section")]),t._v(" or join the "),e("RouterLink",{attrs:{to:"/Community/"}},[t._v("BTCPay Community")]),t._v(" and share questions and ideas for improvement.")],1),t._v(" "),e("p",[t._v("If you are a developer take a look at the "),e("RouterLink",{attrs:{to:"/Development/LocalDevelopment/"}},[t._v("Local Development")]),t._v(" guide and help us with any "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("open issues"),e("OutboundLink")],1),t._v(" on Github. If you would like to contribute to BTCPay in other ways, check out the "),e("RouterLink",{attrs:{to:"/Contribute/"}},[t._v("Contribution Guide")]),t._v(" for ideas.")],1)])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[144],{805:function(t,e,r){"use strict";r.r(e);var o=r(9),a=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"4-whats-next"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#4-whats-next"}},[t._v("#")]),t._v(" (4) What's Next?")]),t._v(" "),e("p",[t._v("After you've connected your wallet to your BTCPay, you can explore various built in tools in the software. See the full list of Use Cases "),e("RouterLink",{attrs:{to:"/UseCase/"}},[t._v("here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"creating-the-point-of-sale-app"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-the-point-of-sale-app"}},[t._v("#")]),t._v(" Creating the Point of Sale App")]),t._v(" "),e("p",[t._v("BTCPay has a PoS app which you can use to receive payments from your customers directly or to receive donations. To "),e("strong",[t._v("create the POS app")]),t._v(", you need to have a store created in BTCPay. View PoS instructions "),e("RouterLink",{attrs:{to:"/Apps/#point-of-sale-app"}},[t._v("here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"creating-the-crowdfund-app"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-the-crowdfund-app"}},[t._v("#")]),t._v(" Creating the Crowdfund App")]),t._v(" "),e("p",[t._v("Create a "),e("strong",[t._v("crowdfunding campaign using BTCPay")]),t._v(". Unlike traditional crowdfunding platforms, the creator of the campaign is the owner of the platform. Funds go directly to the creator’s wallet without any fees. View Crowdfund instructions "),e("RouterLink",{attrs:{to:"/Apps/#crowdfunding-app"}},[t._v("here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"creating-the-payment-request"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-the-payment-request"}},[t._v("#")]),t._v(" Creating the Payment Request")]),t._v(" "),e("p",[t._v("Create "),e("strong",[t._v("custom invoices which can be shared with others")]),t._v(", by sending a link to your payment request. Users can pay the request at any time. BTCPay automatically updates the BTC exchange rate at the time of payment. View Payment Request instructions "),e("RouterLink",{attrs:{to:"/PaymentRequests/"}},[t._v("here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"creating-the-pay-button"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#creating-the-pay-button"}},[t._v("#")]),t._v(" Creating the Pay Button")]),t._v(" "),e("p",[e("strong",[t._v("Pay buttons")]),t._v(" are great when you have a fixed amount for a product or a donation. You can easily embed the button into HTML. When the customer or a visitor clicks on the button, BTCPay displays a checkout page and an invoice for them. View Pay Button instructions "),e("RouterLink",{attrs:{to:"/Apps/#payment-button"}},[t._v("here")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"connecting-your-btcpay-store-to-your-e-commerce-platform"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#connecting-your-btcpay-store-to-your-e-commerce-platform"}},[t._v("#")]),t._v(" Connecting your BTCPay store to your e-commerce platform")]),t._v(" "),e("p",[t._v("Depending on the CMS you're using, you can easily connect BTCPay to your online store. Currently, BTCPay offers following integrations :")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/WooCommerce/"}},[t._v("WooCommerce")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/Shopify/"}},[t._v("Shopify")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/Drupal/"}},[t._v("Drupal")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/Magento/"}},[t._v("Magneto")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/PrestaShop/"}},[t._v("PrestaShop")])],1),t._v(" "),e("li",[e("RouterLink",{attrs:{to:"/CustomIntegration/"}},[t._v("Custom integration")])],1)]),t._v(" "),e("h2",{attrs:{id:"connecting-additional-btcpay-services"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#connecting-additional-btcpay-services"}},[t._v("#")]),t._v(" Connecting Additional BTCPay Services")]),t._v(" "),e("p",[t._v("Additional free, open-source plugins can be used with your BTCPay.")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"https://github.com/JeffVandrewJr/patron",target:"_blank",rel:"noopener noreferrer"}},[t._v("LibrePatron"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://github.com/btcpayserver/btcTransmuter/blob/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("BTC Transmuter"),e("OutboundLink")],1)])]),t._v(" "),e("p",[e("strong",[t._v("LibrePatron is a self-hosted, censorship-free, Patreon alternative")]),t._v(". LibrePatron uses BTCPay Server to receive Bitcoin payments on a recurring basis. Funds go directly to the creator's wallet. View LibrePatron instructions "),e("a",{attrs:{href:"https://blog.btcpayserver.org/librepatron-patreon-alternative/",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("p",[e("strong",[t._v("BTC Transmuter is a self-hosted service that allows you to automate your money and other tasks using BTCPay")]),t._v(". Create custom, automated processes using crypto service triggers based on BTCPay. Common use-cases are fiat integration, payment forwarding and email automation. Open lightning channels, detect payments and more, using blockchain data from your own nodes in BTCPay. View BTC Transmuter documentation "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcTransmuter/blob/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[t._v("here"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("h2",{attrs:{id:"join-the-btcpay-community"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#join-the-btcpay-community"}},[t._v("#")]),t._v(" Join The BTCPay Community")]),t._v(" "),e("p",[t._v("BTCPay Server is an open-source project, not a company. We rely on a network of diverse contributors and users to provide support for numerous use-cases. Join us in improving, learning, and building BTCPay.")]),t._v(" "),e("p",[t._v("If you have questions, try searching our "),e("RouterLink",{attrs:{to:"/FAQ/"}},[t._v("FAQ Section")]),t._v(" or join the "),e("RouterLink",{attrs:{to:"/Community/"}},[t._v("BTCPay Community")]),t._v(" and share questions and ideas for improvement.")],1),t._v(" "),e("p",[t._v("If you are a developer take a look at the "),e("RouterLink",{attrs:{to:"/Development/LocalDevelopment/"}},[t._v("Local Development")]),t._v(" guide and help us with any "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues",target:"_blank",rel:"noopener noreferrer"}},[t._v("open issues"),e("OutboundLink")],1),t._v(" on Github. If you would like to contribute to BTCPay in other ways, check out the "),e("RouterLink",{attrs:{to:"/Contribute/"}},[t._v("Contribution Guide")]),t._v(" for ideas.")],1)])}),[],!1,null,null,null);e.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/15.5fcef896.js b/assets/js/15.b6366a74.js similarity index 88% rename from assets/js/15.5fcef896.js rename to assets/js/15.b6366a74.js index d3b806e5e4..fc2f20fb0e 100644 --- a/assets/js/15.5fcef896.js +++ b/assets/js/15.b6366a74.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{577:function(e,t,o){e.exports=o.p+"assets/img/img_1.6bc7d880.png"},578:function(e,t,o){e.exports=o.p+"assets/img/img_2.9f8b0cc3.png"},579:function(e,t,o){e.exports=o.p+"assets/img/img_3.2595db17.png"},580:function(e,t,o){e.exports=o.p+"assets/img/coinselection.4c853f71.png"},581:function(e,t,o){e.exports=o.p+"assets/img/img.9710314c.png"},582:function(e,t,o){e.exports=o.p+"assets/img/img_4.c8000fea.png"},583:function(e,t,o){e.exports=o.p+"assets/img/scientist_mode.66645705.png"},584:function(e,t,o){e.exports=o.p+"assets/img/img_5.a8ef891b.png"},585:function(e,t,o){e.exports=o.p+"assets/img/img_6.745de6b7.png"},586:function(e,t,o){e.exports=o.p+"assets/img/img_7.0d3fb434.png"},587:function(e,t,o){e.exports=o.p+"assets/img/img_8.34595a5a.png"},588:function(e,t,o){e.exports=o.p+"assets/img/img_9.6da23178.png"},795:function(e,t,o){"use strict";o.r(t);var i=o(9),n=Object(i.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"the-btcpay-server-coinjoin-plugin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#the-btcpay-server-coinjoin-plugin"}},[e._v("#")]),e._v(" The BTCPay Server Coinjoin plugin")]),e._v(" "),t("p",[e._v("This plugin allows every BTCPay Server instance to integrate with the Wabisabi coinjoin protocol developed by "),t("a",{attrs:{href:"https://zksnacks.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("zkSNACKS"),t("OutboundLink")],1),e._v(" ("),t("a",{attrs:{href:"https://wasabiwallet.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Wasabi Wallet"),t("OutboundLink")],1),e._v(").")]),e._v(" "),t("p",{attrs:{align:"center"}},[t("a",{attrs:{href:"http://www.youtube.com/watch?feature=player_embedded&v=zGVCrwMKKn0\n",target:"_blank"}},[t("img",{attrs:{src:"http://img.youtube.com/vi/zGVCrwMKKn0/0.jpg",border:"10"}})])]),e._v(" "),t("h2",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("p",[e._v("First ensure that your BTCPay Server instance is at least version 1.8.0 and that NBXplorer is at least 2.3.58. If you are using the recommended Docker deployment method, it is as simple as "),t("RouterLink",{attrs:{to:"/Wabisabi/https://docs.btcpayserver.org/FAQ/ServerSettings/#how-to-update-btcpay-server"}},[e._v("one-click")]),e._v(".")],1),e._v(" "),t("p",[e._v('Then, you will need to log in as an admin, click on "Manage plugins" in the side navigation, and click on "Install" on the "Coinjoin" plugin in the list. BTCPay Server will then ask you to restart in order to load the plugin.')]),e._v(" "),t("p",[e._v('After the restart, there should be a new navigation item in the side navigation, "Coinjoin", and the dashboard should have additional elements related to coinjoins.\n'),t("img",{attrs:{src:o(577),alt:"./img_1.png",title:"./img_1.png"}})]),e._v(" "),t("h2",{attrs:{id:"usage"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usage"}},[e._v("#")]),e._v(" Usage")]),e._v(" "),t("p",[e._v("Your store needs to have a Bitcoin wallet configured and it needs to be set up as a "),t("RouterLink",{attrs:{to:"/Wabisabi/https://docs.btcpayserver.org/CreateWallet/#hot-wallet"}},[e._v("hot wallet")]),e._v(". Only native segwit (and potentially taproot) wallets will be able to join coinjoin rounds.")],1),e._v(" "),t("p",[e._v('The easiest way to get started is to click on "Coinjoin" in the side navigation, choose the default "zkSNACKS" coordinator and click "save". BTCPay Server will automatically join coinjoin rounds and progress to enhancing the privacy of your wallet.\n'),t("img",{attrs:{src:o(578),alt:"./img_2.png",title:"./img_2.png"}}),e._v('\nCoinjoin transactions will appear in the transactions list in your wallet as they happen, and will have at least 2 labels, "coinjoin", and the name of the coordinator.\n'),t("img",{attrs:{src:o(579),alt:"./img_3.png",title:"./img_3.png"}})]),e._v(" "),t("h2",{attrs:{id:"spending-privately"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#spending-privately"}},[e._v("#")]),e._v(" Spending privately")]),e._v(" "),t("p",[e._v('Coins which have gained some level of privacy will have an "anonset" label when using the BTCPay wallet coin selection feature. If you hover over the label, it will tell you the score it has gained.')]),e._v(" "),t("figure",[t("img",{attrs:{src:o(580),alt:"./coinselection.png",title:"./coinselection.png"}})]),e._v(" "),t("p",[e._v("It is up to you to use the coin selection feature correctly to make the best of your earned privacy on your coins.")]),e._v(" "),t("p",[e._v("Ideally you:")]),e._v(" "),t("ul",[t("li",[e._v("select the least amount of coins possible")]),e._v(" "),t("li",[e._v("select the highest level of privacy coins")]),e._v(" "),t("li",[e._v("ideally use coins from different transactions")]),e._v(" "),t("li",[e._v("spend entire coins to prevent change")])]),e._v(" "),t("p",[e._v("We realize this is a complex selection and are working on an easier UI to help with this. As an initial experiment, we have added an action to let us attempt to select coins based on your sending amounts.\n"),t("img",{attrs:{src:o(581),alt:"./img.png",title:"./img.png"}})]),e._v(" "),t("p",[e._v("But the best way to spend privately is to use our unique "),t("strong",[e._v("payment batching feature")]),e._v(", by utilizing BTCPay Server's "),t("RouterLink",{attrs:{to:"/Wabisabi/https://docs.btcpayserver.org/Payouts/"}},[e._v("Payout")]),e._v(' system. Simply set the destination and amount and click on "Schedule transaction", and the payment will be embedded directly inside the next coinjoin that can fulfill it.\n'),t("img",{attrs:{src:o(582),alt:"./img_4.png",title:"./img_4.png"}})],1),e._v(" "),t("h2",{attrs:{id:"pleb-mode-vs-scientist-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pleb-mode-vs-scientist-mode"}},[e._v("#")]),e._v(" Pleb mode vs Scientist mode")]),e._v(" "),t("p",[e._v("Pleb mode comes with a curated set of configurations aimed to get you off the ground with coinjoining. Scientist mode is for those who want to experiment with different configurations and fine tune their coinjoin experience.")]),e._v(" "),t("p",[e._v("Scientist mode allows you to configure the following:")]),e._v(" "),t("ul",[t("li",[e._v("Anonscore target: What level of privacy you want to achieve. The higher the number, the more privacy you will gain, but the longer (and more expensive due to mining fees) it will take to achieve it. The pleb mode default is 5.")]),e._v(" "),t("li",[e._v("Coinsolidations: When this is turned on, the plugin will attempt to add many coins in comparison to usual. The maximum number of coins that can be added by this plugin is a random number computed for each round between 10 and 30. When coinsolidation mode is on, the likelihood to keep adding coins to the max number is probabilistic change of 90%, else it is current number of coins divided by the max number of coins. The pleb mode default is off.")]),e._v(" "),t("li",[e._v("Batched payments: When this is turned on, the plugin will attempt to batch BTC on-chain Payouts that are in the "),t("code",[e._v("AwaitingPayment")]),e._v(" state. Please note that if the coordinator you are connected to does not allow creating outputs of the payout's address format ( such as a non segwit or taproot address), these payments will not be processed. The pleb mode default is on.")]),e._v(" "),t("li",[e._v("Cross mixing: Cross mixing allows you to mix your coins across multiple coordinators in parallel, bringing you the privacy benefits of multiple coordinator liquidity pools. The default option is "),t("code",[e._v("When Free")]),e._v(" (pleb mode default), which means it will only remix coins on different coordinators if they are below the free threshold and will not be charged a coordinator fee. The other option is "),t("code",[e._v("Always")]),e._v(", which will mix coins across coordinators regardless of the fee. The last option is "),t("code",[e._v("Never")]),e._v(", which will not mix coins across coordinators.")]),e._v(" "),t("li",[e._v("Continuous coinjoins: When this is turned on, the plugin will attempt to join coinjoins even if all your coins are private. The chance to join is a random chance as defined by the value divided by 100 and then as a percentage. This means that if you enter "),t("code",[e._v("100")]),e._v(", there is a 1% chance of coinjoining every round. The pleb mode default is 0.")]),e._v(" "),t("li",[e._v("Send to other wallet: If you have other stores configured with an onchain wallet, with the same address format type, you can choose to send your coinjoin outputs to that wallet. This is useful if you want to keep your privacy gains separate from your main wallet, and can even send them directly to a hardware wallet! The pleb mode default is off.")]),e._v(" "),t("li",[e._v("Label coin selection: You are able to specify which labels will allow or disallow coins from joining coinjoins. If you exclude labels A,B, and C, then coins with those labels will not be used in coinjoins. If you include labels D, E, and F, then only coins with either of those labels will be used in coinjoins.")])]),e._v(" "),t("figure",[t("img",{attrs:{src:o(583),alt:"./img_4.png",title:"./img_4.png"}})]),e._v(" "),t("h2",{attrs:{id:"additional-coordinators"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-coordinators"}},[e._v("#")]),e._v(" Additional Coordinators")]),e._v(" "),t("p",[e._v("We realize that the weakest link in these coinjoin protocols is the centralized coordinator aspect, and so have opted to support multiple coordinators, in parallel, from the get-go. You can discover additional coordinators over Nostr, or you can add a coordinator manually by using the link at the bottom.\n"),t("img",{attrs:{src:o(584),alt:"./img_5.png",title:"./img_5.png"}})]),e._v(" "),t("p",[e._v('Please be cautious as some coordinators may be malicious in nature. Once a coordinator has been added and a coinjoin round has been discovered, you can click on "Coordinator Config" to see what their fees and round requirements are set to, but be aware that a coordinator can change these at will. The plugin tracks if the minimum inputs per round, the coordination fee or the free threshold has changed and will not join rounds that are worse off than the one visible when you enabled the coordinator. You can accept the new terms by clicking on "Accept new terms" and the plugin will join rounds using the new parameters.')]),e._v(" "),t("figure",[t("img",{attrs:{src:o(585),alt:"./img_6.png",title:"./img_6.png"}})]),e._v(" "),t("p",[e._v("Ideally, the minimum number of inputs is 50 and the fee is below 1% (the default is 0.3%).")]),e._v(" "),t("h2",{attrs:{id:"running-a-coordinator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#running-a-coordinator"}},[e._v("#")]),e._v(" Running a coordinator")]),e._v(" "),t("p",[e._v('In the spirit of "be the change you want to see in the world", this plugin ships with the ability to run your own coordinator (and publish it over Nostr for discoverability). This feature is still considered experimental, and may have '),t("a",{attrs:{href:"./https://bitcoinmagazine.com/technical/is-bitcoin-next-after-tornado-cash"}},[e._v("legal repercussions for operating a coordinator")]),e._v(".\n"),t("img",{attrs:{src:o(586),alt:"./img_7.png",title:"./img_7.png"}})]),e._v(" "),t("figure",[t("img",{attrs:{src:o(587),alt:"./img_8.png",title:"./img_8.png"}})]),e._v(" "),t("p",[e._v("By default, the coordinator is configured to donate its generated fees to the "),t("a",{attrs:{href:"https://hrf.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("human rights foundation"),t("OutboundLink")],1),e._v(", and "),t("a",{attrs:{href:"https://opensats.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("opensats"),t("OutboundLink")],1),e._v(", along with a hardcoded plugin development fee split to continue expanding and maintaining the plugin. You can configure these using the "),t("code",[e._v("CoordinatorSplits")]),e._v(" json key.\nThe format is as follows:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('[\n {\n "Ratio": 1.0,\n "Type": "hrf"\n },\n {\n "Ratio": 1.0,\n "Type": "opensats",\n "Value": "btcpayserver"\n }\n]\n')])])]),t("ul",[t("li",[e._v("If Type is "),t("code",[e._v("hrf")]),e._v(", the value of the fee equivalent to its ratio will be donated to the human rights foundation.")]),e._v(" "),t("li",[e._v("If Type is "),t("code",[e._v("opensats")]),e._v(", you must specify which project on its website will receive the value of the fee equivalent to its ratio. Available projects values are the file names listed "),t("a",{attrs:{href:"https://github.com/OpenSats/website/tree/master/./projects",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("If Type is "),t("code",[e._v("btcpaybutton")]),e._v(", you must specify a url to a BTCPay Server instance store's "),t("RouterLink",{attrs:{to:"/Apps/#payment-button"}},[e._v("payment button")]),e._v(". This must be enabled. The value usually looks as follows: "),t("code",[e._v("https://yourbtcpayserver.com/api/v1/invoices?storeId=yourstoreId¤cy=BTC")])],1),e._v(" "),t("li",[e._v("If Type is "),t("code",[e._v("btcpaypos")]),e._v(", you must specify a url to a BTCPay Server instance store's "),t("RouterLink",{attrs:{to:"/Apps/#point-of-sale-app"}},[e._v("point of sale")]),e._v(". The "),t("code",[e._v("Custom payments")]),e._v(" option must be enabled. The value usually looks as follows: "),t("code",[e._v("https://yourbtcpayserver.com/apps/appid/pos")])],1)]),e._v(" "),t("p",[e._v("One enabled, the local coordinator appears in the coinjoin configuration of your store, and, if you configures the nostr settings, published to a relay so that others may discover the coordinator.\n"),t("img",{attrs:{src:o(588),alt:"./img_9.png",title:"./img_9.png"}})])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[15],{594:function(e,t,o){e.exports=o.p+"assets/img/img_1.6bc7d880.png"},595:function(e,t,o){e.exports=o.p+"assets/img/img_2.9f8b0cc3.png"},596:function(e,t,o){e.exports=o.p+"assets/img/img_3.2595db17.png"},597:function(e,t,o){e.exports=o.p+"assets/img/coinselection.4c853f71.png"},598:function(e,t,o){e.exports=o.p+"assets/img/img.9710314c.png"},599:function(e,t,o){e.exports=o.p+"assets/img/img_4.c8000fea.png"},600:function(e,t,o){e.exports=o.p+"assets/img/scientist_mode.66645705.png"},601:function(e,t,o){e.exports=o.p+"assets/img/img_5.a8ef891b.png"},602:function(e,t,o){e.exports=o.p+"assets/img/img_6.745de6b7.png"},603:function(e,t,o){e.exports=o.p+"assets/img/img_7.0d3fb434.png"},604:function(e,t,o){e.exports=o.p+"assets/img/img_8.34595a5a.png"},605:function(e,t,o){e.exports=o.p+"assets/img/img_9.6da23178.png"},798:function(e,t,o){"use strict";o.r(t);var i=o(9),n=Object(i.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"the-btcpay-server-coinjoin-plugin"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#the-btcpay-server-coinjoin-plugin"}},[e._v("#")]),e._v(" The BTCPay Server Coinjoin plugin")]),e._v(" "),t("p",[e._v("This plugin allows every BTCPay Server instance to integrate with the Wabisabi coinjoin protocol developed by "),t("a",{attrs:{href:"https://zksnacks.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("zkSNACKS"),t("OutboundLink")],1),e._v(" ("),t("a",{attrs:{href:"https://wasabiwallet.io/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Wasabi Wallet"),t("OutboundLink")],1),e._v(").")]),e._v(" "),t("p",{attrs:{align:"center"}},[t("a",{attrs:{href:"http://www.youtube.com/watch?feature=player_embedded&v=zGVCrwMKKn0\n",target:"_blank"}},[t("img",{attrs:{src:"http://img.youtube.com/vi/zGVCrwMKKn0/0.jpg",border:"10"}})])]),e._v(" "),t("h2",{attrs:{id:"installation"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#installation"}},[e._v("#")]),e._v(" Installation")]),e._v(" "),t("p",[e._v("First ensure that your BTCPay Server instance is at least version 1.8.0 and that NBXplorer is at least 2.3.58. If you are using the recommended Docker deployment method, it is as simple as "),t("RouterLink",{attrs:{to:"/Wabisabi/https://docs.btcpayserver.org/FAQ/ServerSettings/#how-to-update-btcpay-server"}},[e._v("one-click")]),e._v(".")],1),e._v(" "),t("p",[e._v('Then, you will need to log in as an admin, click on "Manage plugins" in the side navigation, and click on "Install" on the "Coinjoin" plugin in the list. BTCPay Server will then ask you to restart in order to load the plugin.')]),e._v(" "),t("p",[e._v('After the restart, there should be a new navigation item in the side navigation, "Coinjoin", and the dashboard should have additional elements related to coinjoins.\n'),t("img",{attrs:{src:o(594),alt:"./img_1.png",title:"./img_1.png"}})]),e._v(" "),t("h2",{attrs:{id:"usage"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#usage"}},[e._v("#")]),e._v(" Usage")]),e._v(" "),t("p",[e._v("Your store needs to have a Bitcoin wallet configured and it needs to be set up as a "),t("RouterLink",{attrs:{to:"/Wabisabi/https://docs.btcpayserver.org/CreateWallet/#hot-wallet"}},[e._v("hot wallet")]),e._v(". Only native segwit (and potentially taproot) wallets will be able to join coinjoin rounds.")],1),e._v(" "),t("p",[e._v('The easiest way to get started is to click on "Coinjoin" in the side navigation, choose the default "zkSNACKS" coordinator and click "save". BTCPay Server will automatically join coinjoin rounds and progress to enhancing the privacy of your wallet.\n'),t("img",{attrs:{src:o(595),alt:"./img_2.png",title:"./img_2.png"}}),e._v('\nCoinjoin transactions will appear in the transactions list in your wallet as they happen, and will have at least 2 labels, "coinjoin", and the name of the coordinator.\n'),t("img",{attrs:{src:o(596),alt:"./img_3.png",title:"./img_3.png"}})]),e._v(" "),t("h2",{attrs:{id:"spending-privately"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#spending-privately"}},[e._v("#")]),e._v(" Spending privately")]),e._v(" "),t("p",[e._v('Coins which have gained some level of privacy will have an "anonset" label when using the BTCPay wallet coin selection feature. If you hover over the label, it will tell you the score it has gained.')]),e._v(" "),t("figure",[t("img",{attrs:{src:o(597),alt:"./coinselection.png",title:"./coinselection.png"}})]),e._v(" "),t("p",[e._v("It is up to you to use the coin selection feature correctly to make the best of your earned privacy on your coins.")]),e._v(" "),t("p",[e._v("Ideally you:")]),e._v(" "),t("ul",[t("li",[e._v("select the least amount of coins possible")]),e._v(" "),t("li",[e._v("select the highest level of privacy coins")]),e._v(" "),t("li",[e._v("ideally use coins from different transactions")]),e._v(" "),t("li",[e._v("spend entire coins to prevent change")])]),e._v(" "),t("p",[e._v("We realize this is a complex selection and are working on an easier UI to help with this. As an initial experiment, we have added an action to let us attempt to select coins based on your sending amounts.\n"),t("img",{attrs:{src:o(598),alt:"./img.png",title:"./img.png"}})]),e._v(" "),t("p",[e._v("But the best way to spend privately is to use our unique "),t("strong",[e._v("payment batching feature")]),e._v(", by utilizing BTCPay Server's "),t("RouterLink",{attrs:{to:"/Wabisabi/https://docs.btcpayserver.org/Payouts/"}},[e._v("Payout")]),e._v(' system. Simply set the destination and amount and click on "Schedule transaction", and the payment will be embedded directly inside the next coinjoin that can fulfill it.\n'),t("img",{attrs:{src:o(599),alt:"./img_4.png",title:"./img_4.png"}})],1),e._v(" "),t("h2",{attrs:{id:"pleb-mode-vs-scientist-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pleb-mode-vs-scientist-mode"}},[e._v("#")]),e._v(" Pleb mode vs Scientist mode")]),e._v(" "),t("p",[e._v("Pleb mode comes with a curated set of configurations aimed to get you off the ground with coinjoining. Scientist mode is for those who want to experiment with different configurations and fine tune their coinjoin experience.")]),e._v(" "),t("p",[e._v("Scientist mode allows you to configure the following:")]),e._v(" "),t("ul",[t("li",[e._v("Anonscore target: What level of privacy you want to achieve. The higher the number, the more privacy you will gain, but the longer (and more expensive due to mining fees) it will take to achieve it. The pleb mode default is 5.")]),e._v(" "),t("li",[e._v("Coinsolidations: When this is turned on, the plugin will attempt to add many coins in comparison to usual. The maximum number of coins that can be added by this plugin is a random number computed for each round between 10 and 30. When coinsolidation mode is on, the likelihood to keep adding coins to the max number is probabilistic change of 90%, else it is current number of coins divided by the max number of coins. The pleb mode default is off.")]),e._v(" "),t("li",[e._v("Batched payments: When this is turned on, the plugin will attempt to batch BTC on-chain Payouts that are in the "),t("code",[e._v("AwaitingPayment")]),e._v(" state. Please note that if the coordinator you are connected to does not allow creating outputs of the payout's address format ( such as a non segwit or taproot address), these payments will not be processed. The pleb mode default is on.")]),e._v(" "),t("li",[e._v("Cross mixing: Cross mixing allows you to mix your coins across multiple coordinators in parallel, bringing you the privacy benefits of multiple coordinator liquidity pools. The default option is "),t("code",[e._v("When Free")]),e._v(" (pleb mode default), which means it will only remix coins on different coordinators if they are below the free threshold and will not be charged a coordinator fee. The other option is "),t("code",[e._v("Always")]),e._v(", which will mix coins across coordinators regardless of the fee. The last option is "),t("code",[e._v("Never")]),e._v(", which will not mix coins across coordinators.")]),e._v(" "),t("li",[e._v("Continuous coinjoins: When this is turned on, the plugin will attempt to join coinjoins even if all your coins are private. The chance to join is a random chance as defined by the value divided by 100 and then as a percentage. This means that if you enter "),t("code",[e._v("100")]),e._v(", there is a 1% chance of coinjoining every round. The pleb mode default is 0.")]),e._v(" "),t("li",[e._v("Send to other wallet: If you have other stores configured with an onchain wallet, with the same address format type, you can choose to send your coinjoin outputs to that wallet. This is useful if you want to keep your privacy gains separate from your main wallet, and can even send them directly to a hardware wallet! The pleb mode default is off.")]),e._v(" "),t("li",[e._v("Label coin selection: You are able to specify which labels will allow or disallow coins from joining coinjoins. If you exclude labels A,B, and C, then coins with those labels will not be used in coinjoins. If you include labels D, E, and F, then only coins with either of those labels will be used in coinjoins.")])]),e._v(" "),t("figure",[t("img",{attrs:{src:o(600),alt:"./img_4.png",title:"./img_4.png"}})]),e._v(" "),t("h2",{attrs:{id:"additional-coordinators"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-coordinators"}},[e._v("#")]),e._v(" Additional Coordinators")]),e._v(" "),t("p",[e._v("We realize that the weakest link in these coinjoin protocols is the centralized coordinator aspect, and so have opted to support multiple coordinators, in parallel, from the get-go. You can discover additional coordinators over Nostr, or you can add a coordinator manually by using the link at the bottom.\n"),t("img",{attrs:{src:o(601),alt:"./img_5.png",title:"./img_5.png"}})]),e._v(" "),t("p",[e._v('Please be cautious as some coordinators may be malicious in nature. Once a coordinator has been added and a coinjoin round has been discovered, you can click on "Coordinator Config" to see what their fees and round requirements are set to, but be aware that a coordinator can change these at will. The plugin tracks if the minimum inputs per round, the coordination fee or the free threshold has changed and will not join rounds that are worse off than the one visible when you enabled the coordinator. You can accept the new terms by clicking on "Accept new terms" and the plugin will join rounds using the new parameters.')]),e._v(" "),t("figure",[t("img",{attrs:{src:o(602),alt:"./img_6.png",title:"./img_6.png"}})]),e._v(" "),t("p",[e._v("Ideally, the minimum number of inputs is 50 and the fee is below 1% (the default is 0.3%).")]),e._v(" "),t("h2",{attrs:{id:"running-a-coordinator"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#running-a-coordinator"}},[e._v("#")]),e._v(" Running a coordinator")]),e._v(" "),t("p",[e._v('In the spirit of "be the change you want to see in the world", this plugin ships with the ability to run your own coordinator (and publish it over Nostr for discoverability). This feature is still considered experimental, and may have '),t("a",{attrs:{href:"./https://bitcoinmagazine.com/technical/is-bitcoin-next-after-tornado-cash"}},[e._v("legal repercussions for operating a coordinator")]),e._v(".\n"),t("img",{attrs:{src:o(603),alt:"./img_7.png",title:"./img_7.png"}})]),e._v(" "),t("figure",[t("img",{attrs:{src:o(604),alt:"./img_8.png",title:"./img_8.png"}})]),e._v(" "),t("p",[e._v("By default, the coordinator is configured to donate its generated fees to the "),t("a",{attrs:{href:"https://hrf.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("human rights foundation"),t("OutboundLink")],1),e._v(", and "),t("a",{attrs:{href:"https://opensats.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("opensats"),t("OutboundLink")],1),e._v(", along with a hardcoded plugin development fee split to continue expanding and maintaining the plugin. You can configure these using the "),t("code",[e._v("CoordinatorSplits")]),e._v(" json key.\nThe format is as follows:")]),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v('[\n {\n "Ratio": 1.0,\n "Type": "hrf"\n },\n {\n "Ratio": 1.0,\n "Type": "opensats",\n "Value": "btcpayserver"\n }\n]\n')])])]),t("ul",[t("li",[e._v("If Type is "),t("code",[e._v("hrf")]),e._v(", the value of the fee equivalent to its ratio will be donated to the human rights foundation.")]),e._v(" "),t("li",[e._v("If Type is "),t("code",[e._v("opensats")]),e._v(", you must specify which project on its website will receive the value of the fee equivalent to its ratio. Available projects values are the file names listed "),t("a",{attrs:{href:"https://github.com/OpenSats/website/tree/master/./projects",target:"_blank",rel:"noopener noreferrer"}},[e._v("here"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("If Type is "),t("code",[e._v("btcpaybutton")]),e._v(", you must specify a url to a BTCPay Server instance store's "),t("RouterLink",{attrs:{to:"/Apps/#payment-button"}},[e._v("payment button")]),e._v(". This must be enabled. The value usually looks as follows: "),t("code",[e._v("https://yourbtcpayserver.com/api/v1/invoices?storeId=yourstoreId¤cy=BTC")])],1),e._v(" "),t("li",[e._v("If Type is "),t("code",[e._v("btcpaypos")]),e._v(", you must specify a url to a BTCPay Server instance store's "),t("RouterLink",{attrs:{to:"/Apps/#point-of-sale-app"}},[e._v("point of sale")]),e._v(". The "),t("code",[e._v("Custom payments")]),e._v(" option must be enabled. The value usually looks as follows: "),t("code",[e._v("https://yourbtcpayserver.com/apps/appid/pos")])],1)]),e._v(" "),t("p",[e._v("One enabled, the local coordinator appears in the coinjoin configuration of your store, and, if you configures the nostr settings, published to a relay so that others may discover the coordinator.\n"),t("img",{attrs:{src:o(605),alt:"./img_9.png",title:"./img_9.png"}})])])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/18.cc9e10a2.js b/assets/js/18.665c17dc.js similarity index 87% rename from assets/js/18.cc9e10a2.js rename to assets/js/18.665c17dc.js index 5f425a6857..1180bd9b05 100644 --- a/assets/js/18.cc9e10a2.js +++ b/assets/js/18.665c17dc.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{352:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab8.caba6b24.jpg"},353:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab9.9fe549e0.jpg"},354:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab11.98d02cd0.jpg"},355:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab12.98886f2f.jpg"},356:function(e,t,r){e.exports=r.p+"assets/img/configureserver.2ac5dd86.png"},357:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab15.daa701f0.jpg"},358:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab2.433d3d4e.jpg"},359:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab4.57768232.jpg"},360:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab19.cdd371a4.jpg"},361:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab23.fc6acdd0.jpg"},701:function(e,t,r){"use strict";r.r(t);var a=r(9),o=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"dream-lab-network-btcpay-server-web-deployment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dream-lab-network-btcpay-server-web-deployment"}},[e._v("#")]),e._v(" Dream Lab Network BTCPay Server web deployment.")]),e._v(" "),t("p",[e._v("In this guide, we will walk you through the initial setup of your Dream Lab Network BTCPay Server web deployment.\nDream Lab offers a variety of services. From domains, dedicated game servers, VPS servers, and now BTCPay Server as a service.\nThey've built multiple plans and configurations for BTCPay Server, hosted in North America, with expansion to other locations on their premise.")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/_hGwRFpx4A0/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=_hGwRFpx4A0",title:"BTCPay Server - DreamLab Web-Deployment","data-id":"_hGwRFpx4A0"}},[t("iframe",{attrs:{title:"BTCPay Server - DreamLab Web-Deployment","data-src":"https://www.youtube-nocookie.com/embed/_hGwRFpx4A0?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("h2",{attrs:{id:"1-pick-the-server-that-fits-your-needs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#1-pick-the-server-that-fits-your-needs"}},[e._v("#")]),e._v(" 1. Pick the server that fits your needs")]),e._v(" "),t("p",[e._v("On the Dream Lab website, in the top menu, go to "),t("code",[e._v("Services")]),e._v(" and click on "),t("code",[e._v("BTCPay Servers")]),e._v(".")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(352),alt:"DreamLab Network signup",title:"DreamLab Network signup"}})]),e._v(" "),t("p",[e._v("Next, pick a plan suited to your BTCPay Server needs.\nThey offer three different plans.")]),e._v(" "),t("ul",[t("li",[e._v("Basic")]),e._v(" "),t("li",[e._v("Advanced")]),e._v(" "),t("li",[e._v("Shared")])]),e._v(" "),t("p",[e._v("They've enlisted what the difference between every plan is, so we won't list those out.\nThat said, we do believe that going with the "),t("code",[e._v("Basic plan")]),e._v(" should be sufficient for starting a store.\nA Shared host is not something recommended for business purposes. This plan doesn't give you your own VPS. However, you could start a server and get acquainted with the software hosted for you!")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(353),alt:"DreamLab Network Plan",title:"DreamLab Network Plan"}})]),e._v(" "),t("h2",{attrs:{id:"2-configure-your-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#2-configure-your-btcpay-server"}},[e._v("#")]),e._v(" 2. Configure your BTCPay Server")]),e._v(" "),t("p",[e._v("First, off they show you the basic setup of your node.\nAll the technical specs are listed.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(354),alt:"DreamLab Network techspecs",title:"DreamLab Network techspecs"}})]),e._v(" "),t("p",[e._v("Choose the billing cycle that fits you.\nNext, configure your server.")]),e._v(" "),t("h3",{attrs:{id:"hostname"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hostname"}},[e._v("#")]),e._v(" Hostname")]),e._v(" "),t("p",[e._v("This is where you set the domain name. You can leave this as-is and use the generated address or provide it with a domain of your own.\nDon't forget that if you set your domain, you need to create an A record that points to your VPS IP address.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(355),alt:"DreamLab Network domain",title:"DreamLab Network domain"}})]),e._v(" "),t("h3",{attrs:{id:"configurable-options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configurable-options"}},[e._v("#")]),e._v(" Configurable Options")]),e._v(" "),t("p",[e._v("Next up, "),t("code",[e._v("configurable options")]),e._v(". Here is where you set the BTCPay Server configuration. You get to set how and what you want your node to run.")]),e._v(" "),t("ul",[t("li",[e._v("BTCPay Server Mainnet Pruned 6 or 3 months Bitcoin only.")]),e._v(" "),t("li",[e._v("BTCPay Server Mainnet Pruned 6 or 3 months Bitcoin & Lightning (clightning)")]),e._v(" "),t("li",[e._v("BTCPay Server Mainnet Pruned 6 or 3 months Bitcoin & Lightning (clightning) & BTCPay Configurator.")]),e._v(" "),t("li",[e._v("BTCPay Server Testnet Pruned 6 or 3 months Bitcoin only.")]),e._v(" "),t("li",[e._v("BTCPay Server Testnet Pruned 6 or 3 months Bitcoin & Lightning (clightning)")]),e._v(" "),t("li",[e._v("BTCPay Server Regnet Pruned 6 or 3 months Bitcoin only.")]),e._v(" "),t("li",[e._v("BTCPay Server Regnet Pruned 6 or 3 months Bitcoin & Lightning (clightning)")])]),e._v(" "),t("p",[e._v("And the CPU is set to AMD. There are no other options as of writing.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(356),alt:"DreamLab Network setup",title:"DreamLab Network setup"}})]),e._v(" "),t("h3",{attrs:{id:"addition-information"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addition-information"}},[e._v("#")]),e._v(" Addition Information")]),e._v(" "),t("p",[e._v("Here you have the option to set an operating system.\nThis, as of writing, is locked to ubuntu 20.04 x86.\nAnd for the ISO Disk option, there's none to take.")]),e._v(" "),t("p",[e._v("Click "),t("code",[e._v("Continue")]),e._v(" to go to the payment page.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(357),alt:"DreamLab Network OS",title:"DreamLab Network OS"}})]),e._v(" "),t("h3",{attrs:{id:"review-checkout"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#review-checkout"}},[e._v("#")]),e._v(" Review & Checkout")]),e._v(" "),t("p",[e._v("Now, all there is left for you is to go over the setup one more time.\nAnd if all is well, you might have a Promo code you can apply, and after that, it is over to the Checkout.")]),e._v(" "),t("p",[e._v("On the checkout page, you get to set your account information.\nAfter filling up all of the requested information, note you only have to fill out the requested fields.\nClick the Bitcoin or another option if preferred to pay by fiat.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(358),alt:"DreamLab Network Checkout",title:"DreamLab Network Checkout"}})]),e._v(" "),t("h2",{attrs:{id:"3-client-area-dream-lab-network"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#3-client-area-dream-lab-network"}},[e._v("#")]),e._v(" 3. Client Area Dream Lab Network")]),e._v(" "),t("p",[e._v("You are now logged in to Dream Lab their "),t("code",[e._v("Client Area")]),e._v(".\nAnd as you may notice, you have one service up. This is your new BTCPay Server.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(359),alt:"DreamLab Network Services",title:"DreamLab Network Services"}})]),e._v(" "),t("p",[e._v("If you scroll or look below, a tile states "),t("code",[e._v("Your Active Products")]),e._v(".\nHere again, you will see your active deployment of the BTCPay Server on Dream Lab Networks.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(360),alt:"DreamLab Network services2",title:"DreamLab Network services2"}})]),e._v(" "),t("p",[e._v("When you click on your server in the "),t("code",[e._v("Your Active Products")]),e._v(" tile, you will be redirected to the managing page for your VPS.\nHere you will find analytics on your VPS, the current subscription, and options to manage your VPS.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(361),alt:"DreamLab Network manage vps",title:"DreamLab Network manage vps"}})]),e._v(" "),t("h2",{attrs:{id:"4-start-your-first-store"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#4-start-your-first-store"}},[e._v("#")]),e._v(" 4. Start your first store.")]),e._v(" "),t("p",[e._v("After all the above steps are completed, the server shows in services.\nClick on services, and click on the BTCPay Basic server link underneath or go to the domain you specified.\nYou will be prompted to create the first account on your new BTCPay Server. Make sure to have the Administrator account checked.")]),e._v(" "),t("p",[e._v("You are now ready to set up your first store!\nTo follow more on setting up your store, follow along in this "),t("RouterLink",{attrs:{to:"/RegisterAccount/"}},[e._v("Guide")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"5-welcome-to-your-btcpay-server-dashboard"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#5-welcome-to-your-btcpay-server-dashboard"}},[e._v("#")]),e._v(" 5. Welcome to your BTCPay Server dashboard")]),e._v(" "),t("p",[e._v("You are now inside your new BTCPay Server.\nThe bitcoin wallet is still missing. You can follow along in "),t("RouterLink",{attrs:{to:"/WalletSetup/"}},[e._v("this wallet setup guide")])],1),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If there are questions about your node, the deployment, or updates, please reach out to the support of "),t("a",{attrs:{href:"https://dreamlabnetwork.solutions",target:"_blank",rel:"noopener noreferrer"}},[e._v("Dream Lab Network solutions"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[18],{351:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab8.caba6b24.jpg"},352:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab9.9fe549e0.jpg"},353:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab11.98d02cd0.jpg"},354:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab12.98886f2f.jpg"},355:function(e,t,r){e.exports=r.p+"assets/img/configureserver.2ac5dd86.png"},356:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab15.daa701f0.jpg"},357:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab2.433d3d4e.jpg"},358:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab4.57768232.jpg"},359:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab19.cdd371a4.jpg"},360:function(e,t,r){e.exports=r.p+"assets/img/btcpaydreamlab23.fc6acdd0.jpg"},701:function(e,t,r){"use strict";r.r(t);var a=r(9),o=Object(a.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"dream-lab-network-btcpay-server-web-deployment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#dream-lab-network-btcpay-server-web-deployment"}},[e._v("#")]),e._v(" Dream Lab Network BTCPay Server web deployment.")]),e._v(" "),t("p",[e._v("In this guide, we will walk you through the initial setup of your Dream Lab Network BTCPay Server web deployment.\nDream Lab offers a variety of services. From domains, dedicated game servers, VPS servers, and now BTCPay Server as a service.\nThey've built multiple plans and configurations for BTCPay Server, hosted in North America, with expansion to other locations on their premise.")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/_hGwRFpx4A0/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=_hGwRFpx4A0",title:"BTCPay Server - DreamLab Web-Deployment","data-id":"_hGwRFpx4A0"}},[t("iframe",{attrs:{title:"BTCPay Server - DreamLab Web-Deployment","data-src":"https://www.youtube-nocookie.com/embed/_hGwRFpx4A0?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("h2",{attrs:{id:"1-pick-the-server-that-fits-your-needs"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#1-pick-the-server-that-fits-your-needs"}},[e._v("#")]),e._v(" 1. Pick the server that fits your needs")]),e._v(" "),t("p",[e._v("On the Dream Lab website, in the top menu, go to "),t("code",[e._v("Services")]),e._v(" and click on "),t("code",[e._v("BTCPay Servers")]),e._v(".")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(351),alt:"DreamLab Network signup",title:"DreamLab Network signup"}})]),e._v(" "),t("p",[e._v("Next, pick a plan suited to your BTCPay Server needs.\nThey offer three different plans.")]),e._v(" "),t("ul",[t("li",[e._v("Basic")]),e._v(" "),t("li",[e._v("Advanced")]),e._v(" "),t("li",[e._v("Shared")])]),e._v(" "),t("p",[e._v("They've enlisted what the difference between every plan is, so we won't list those out.\nThat said, we do believe that going with the "),t("code",[e._v("Basic plan")]),e._v(" should be sufficient for starting a store.\nA Shared host is not something recommended for business purposes. This plan doesn't give you your own VPS. However, you could start a server and get acquainted with the software hosted for you!")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(352),alt:"DreamLab Network Plan",title:"DreamLab Network Plan"}})]),e._v(" "),t("h2",{attrs:{id:"2-configure-your-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#2-configure-your-btcpay-server"}},[e._v("#")]),e._v(" 2. Configure your BTCPay Server")]),e._v(" "),t("p",[e._v("First, off they show you the basic setup of your node.\nAll the technical specs are listed.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(353),alt:"DreamLab Network techspecs",title:"DreamLab Network techspecs"}})]),e._v(" "),t("p",[e._v("Choose the billing cycle that fits you.\nNext, configure your server.")]),e._v(" "),t("h3",{attrs:{id:"hostname"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hostname"}},[e._v("#")]),e._v(" Hostname")]),e._v(" "),t("p",[e._v("This is where you set the domain name. You can leave this as-is and use the generated address or provide it with a domain of your own.\nDon't forget that if you set your domain, you need to create an A record that points to your VPS IP address.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(354),alt:"DreamLab Network domain",title:"DreamLab Network domain"}})]),e._v(" "),t("h3",{attrs:{id:"configurable-options"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#configurable-options"}},[e._v("#")]),e._v(" Configurable Options")]),e._v(" "),t("p",[e._v("Next up, "),t("code",[e._v("configurable options")]),e._v(". Here is where you set the BTCPay Server configuration. You get to set how and what you want your node to run.")]),e._v(" "),t("ul",[t("li",[e._v("BTCPay Server Mainnet Pruned 6 or 3 months Bitcoin only.")]),e._v(" "),t("li",[e._v("BTCPay Server Mainnet Pruned 6 or 3 months Bitcoin & Lightning (clightning)")]),e._v(" "),t("li",[e._v("BTCPay Server Mainnet Pruned 6 or 3 months Bitcoin & Lightning (clightning) & BTCPay Configurator.")]),e._v(" "),t("li",[e._v("BTCPay Server Testnet Pruned 6 or 3 months Bitcoin only.")]),e._v(" "),t("li",[e._v("BTCPay Server Testnet Pruned 6 or 3 months Bitcoin & Lightning (clightning)")]),e._v(" "),t("li",[e._v("BTCPay Server Regnet Pruned 6 or 3 months Bitcoin only.")]),e._v(" "),t("li",[e._v("BTCPay Server Regnet Pruned 6 or 3 months Bitcoin & Lightning (clightning)")])]),e._v(" "),t("p",[e._v("And the CPU is set to AMD. There are no other options as of writing.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(355),alt:"DreamLab Network setup",title:"DreamLab Network setup"}})]),e._v(" "),t("h3",{attrs:{id:"addition-information"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#addition-information"}},[e._v("#")]),e._v(" Addition Information")]),e._v(" "),t("p",[e._v("Here you have the option to set an operating system.\nThis, as of writing, is locked to ubuntu 20.04 x86.\nAnd for the ISO Disk option, there's none to take.")]),e._v(" "),t("p",[e._v("Click "),t("code",[e._v("Continue")]),e._v(" to go to the payment page.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(356),alt:"DreamLab Network OS",title:"DreamLab Network OS"}})]),e._v(" "),t("h3",{attrs:{id:"review-checkout"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#review-checkout"}},[e._v("#")]),e._v(" Review & Checkout")]),e._v(" "),t("p",[e._v("Now, all there is left for you is to go over the setup one more time.\nAnd if all is well, you might have a Promo code you can apply, and after that, it is over to the Checkout.")]),e._v(" "),t("p",[e._v("On the checkout page, you get to set your account information.\nAfter filling up all of the requested information, note you only have to fill out the requested fields.\nClick the Bitcoin or another option if preferred to pay by fiat.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(357),alt:"DreamLab Network Checkout",title:"DreamLab Network Checkout"}})]),e._v(" "),t("h2",{attrs:{id:"3-client-area-dream-lab-network"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#3-client-area-dream-lab-network"}},[e._v("#")]),e._v(" 3. Client Area Dream Lab Network")]),e._v(" "),t("p",[e._v("You are now logged in to Dream Lab their "),t("code",[e._v("Client Area")]),e._v(".\nAnd as you may notice, you have one service up. This is your new BTCPay Server.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(358),alt:"DreamLab Network Services",title:"DreamLab Network Services"}})]),e._v(" "),t("p",[e._v("If you scroll or look below, a tile states "),t("code",[e._v("Your Active Products")]),e._v(".\nHere again, you will see your active deployment of the BTCPay Server on Dream Lab Networks.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(359),alt:"DreamLab Network services2",title:"DreamLab Network services2"}})]),e._v(" "),t("p",[e._v("When you click on your server in the "),t("code",[e._v("Your Active Products")]),e._v(" tile, you will be redirected to the managing page for your VPS.\nHere you will find analytics on your VPS, the current subscription, and options to manage your VPS.")]),e._v(" "),t("figure",[t("img",{attrs:{src:r(360),alt:"DreamLab Network manage vps",title:"DreamLab Network manage vps"}})]),e._v(" "),t("h2",{attrs:{id:"4-start-your-first-store"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#4-start-your-first-store"}},[e._v("#")]),e._v(" 4. Start your first store.")]),e._v(" "),t("p",[e._v("After all the above steps are completed, the server shows in services.\nClick on services, and click on the BTCPay Basic server link underneath or go to the domain you specified.\nYou will be prompted to create the first account on your new BTCPay Server. Make sure to have the Administrator account checked.")]),e._v(" "),t("p",[e._v("You are now ready to set up your first store!\nTo follow more on setting up your store, follow along in this "),t("RouterLink",{attrs:{to:"/RegisterAccount/"}},[e._v("Guide")]),e._v(".")],1),e._v(" "),t("h2",{attrs:{id:"5-welcome-to-your-btcpay-server-dashboard"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#5-welcome-to-your-btcpay-server-dashboard"}},[e._v("#")]),e._v(" 5. Welcome to your BTCPay Server dashboard")]),e._v(" "),t("p",[e._v("You are now inside your new BTCPay Server.\nThe bitcoin wallet is still missing. You can follow along in "),t("RouterLink",{attrs:{to:"/WalletSetup/"}},[e._v("this wallet setup guide")])],1),e._v(" "),t("div",{staticClass:"custom-block tip"},[t("p",{staticClass:"custom-block-title"},[e._v("TIP")]),e._v(" "),t("p",[e._v("If there are questions about your node, the deployment, or updates, please reach out to the support of "),t("a",{attrs:{href:"https://dreamlabnetwork.solutions",target:"_blank",rel:"noopener noreferrer"}},[e._v("Dream Lab Network solutions"),t("OutboundLink")],1)])])])}),[],!1,null,null,null);t.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/19.31958e97.js b/assets/js/19.caa480c9.js similarity index 74% rename from assets/js/19.31958e97.js rename to assets/js/19.caa480c9.js index 9e82cc3ca5..225c76a7c9 100644 --- a/assets/js/19.31958e97.js +++ b/assets/js/19.caa480c9.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{259:function(t,e,a){t.exports=a.p+"assets/img/payouts-status3-options-appr.2f1b2d15.jpg"},647:function(t,e,a){t.exports=a.p+"assets/img/invoices-details.19bfdb69.jpg"},648:function(t,e,a){t.exports=a.p+"assets/img/issue-refund.ad313350.jpg"},649:function(t,e,a){t.exports=a.p+"assets/img/issue-refund-payment-option.ba17b34c.jpg"},650:function(t,e,a){t.exports=a.p+"assets/img/issue-refund-amount.d6751041.jpg"},651:function(t,e,a){t.exports=a.p+"assets/img/claimingside.b4816192.jpg"},652:function(t,e,a){t.exports=a.p+"assets/img/payouts-status4-options-sign3-adv.96d0e967.jpg"},653:function(t,e,a){t.exports=a.p+"assets/img/payout-status-succesfull.7513d4bc.jpg"},654:function(t,e,a){t.exports=a.p+"assets/img/payouts-status5-completed1.b5295c02.jpg"},655:function(t,e,a){t.exports=a.p+"assets/img/claiment-completed1.4e877454.jpg"},804:function(t,e,a){"use strict";a.r(e);var r=a(9),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"refunds"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#refunds"}},[t._v("#")]),t._v(" Refunds")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("If you are looking for information about requesting a refund from a merchant, please refer to this "),e("RouterLink",{attrs:{to:"/FAQ/General/#what-if-i-have-a-problem-with-a-paid-invoice"}},[t._v("FAQ")])],1)]),t._v(" "),e("p",[e("strong",[t._v("Refunds")]),t._v(" are one of the applications built on top of the "),e("RouterLink",{attrs:{to:"/PullPayments/"}},[t._v("Pull Payments")]),t._v(" feature.")],1),t._v(" "),e("p",[t._v("On this page, we will walk you through the process of issuing a refund.\nThere are a short few steps to create the refund for the customer.")]),t._v(" "),e("h2",{attrs:{id:"create-a-refund"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#create-a-refund"}},[t._v("#")]),t._v(" Create a refund")]),t._v(" "),e("ol",[e("li",[t._v("To refund an invoice, go in the "),e("code",[t._v("Invoices")]),t._v(" page and click "),e("code",[t._v("Details")]),t._v(" on the invoice.")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(647),alt:"BTCPay Server refund feature",title:"BTCPay Server refund feature"}})]),t._v(" "),e("ol",{attrs:{start:"2"}},[e("li",[t._v("Click "),e("code",[t._v("Issue a refund")])])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(648),alt:"BTCPay Server refund feature",title:"BTCPay Server refund feature"}})]),t._v(" "),e("ol",{attrs:{start:"3"}},[e("li",[t._v("Select refund's payment method")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(649),alt:"BTCPay Server refund feature",title:"BTCPay Server refund feature"}})]),t._v(" "),e("ol",{attrs:{start:"4"}},[e("li",[t._v("Select the "),e("code",[t._v("amount")]),t._v(" you want to refund")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(650),alt:"BTCPay Server refund feature",title:"BTCPay Server refund feature"}})]),t._v(" "),e("ol",{attrs:{start:"5"}},[e("li",[t._v("Share the link of this page with your customer")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(651),alt:"BTCPay Server refund feature",title:"BTCPay Server refund feature"}})]),t._v(" "),e("h2",{attrs:{id:"processing-refund"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#processing-refund"}},[t._v("#")]),t._v(" Processing refund")]),t._v(" "),e("p",[t._v("Once a customer clicks on the link you've provided adds their refund bitcoin address and claims the invoice, the next step is to process a refund.")]),t._v(" "),e("ol",[e("li",[t._v("Go to the "),e("code",[t._v("Payouts")]),t._v(" tab in your sidebar.")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(259),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})]),t._v(" "),e("ol",{attrs:{start:"2"}},[e("li",[t._v("Select the Payouts you want to process, go to actions and select "),e("code",[t._v("Approve and send")])])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(259),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})]),t._v(" "),e("ol",{attrs:{start:"3"}},[e("li",[t._v("Sign and broadcast the transactions.")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(652),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})]),t._v(" "),e("ol",{attrs:{start:"4"}},[e("li",[t._v("The payout has now been signed and is in progress, awaiting confirmation on the blockchain. This is reflected to the claimant in their view.")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(653),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})]),t._v(" "),e("ol",{attrs:{start:"5"}},[e("li",[t._v("After the transaction has been confirmed on the blockchain, the status of the payout will be "),e("code",[t._v("completed")]),t._v(".")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(654),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})]),t._v(" "),e("p",[t._v("Customer's view after the refund has been successfully processed.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(655),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[19],{259:function(t,e,a){t.exports=a.p+"assets/img/payouts-status3-options-appr.2f1b2d15.jpg"},509:function(t,e,a){t.exports=a.p+"assets/img/invoices-details.19bfdb69.jpg"},510:function(t,e,a){t.exports=a.p+"assets/img/issue-refund.ad313350.jpg"},511:function(t,e,a){t.exports=a.p+"assets/img/issue-refund-payment-option.ba17b34c.jpg"},512:function(t,e,a){t.exports=a.p+"assets/img/issue-refund-amount.d6751041.jpg"},513:function(t,e,a){t.exports=a.p+"assets/img/claimingside.b4816192.jpg"},514:function(t,e,a){t.exports=a.p+"assets/img/payouts-status4-options-sign3-adv.96d0e967.jpg"},515:function(t,e,a){t.exports=a.p+"assets/img/payout-status-succesfull.7513d4bc.jpg"},516:function(t,e,a){t.exports=a.p+"assets/img/payouts-status5-completed1.b5295c02.jpg"},517:function(t,e,a){t.exports=a.p+"assets/img/claiment-completed1.4e877454.jpg"},778:function(t,e,a){"use strict";a.r(e);var r=a(9),s=Object(r.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"refunds"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#refunds"}},[t._v("#")]),t._v(" Refunds")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("If you are looking for information about requesting a refund from a merchant, please refer to this "),e("RouterLink",{attrs:{to:"/FAQ/General/#what-if-i-have-a-problem-with-a-paid-invoice"}},[t._v("FAQ")])],1)]),t._v(" "),e("p",[e("strong",[t._v("Refunds")]),t._v(" are one of the applications built on top of the "),e("RouterLink",{attrs:{to:"/PullPayments/"}},[t._v("Pull Payments")]),t._v(" feature.")],1),t._v(" "),e("p",[t._v("On this page, we will walk you through the process of issuing a refund.\nThere are a short few steps to create the refund for the customer.")]),t._v(" "),e("h2",{attrs:{id:"create-a-refund"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#create-a-refund"}},[t._v("#")]),t._v(" Create a refund")]),t._v(" "),e("ol",[e("li",[t._v("To refund an invoice, go in the "),e("code",[t._v("Invoices")]),t._v(" page and click "),e("code",[t._v("Details")]),t._v(" on the invoice.")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(509),alt:"BTCPay Server refund feature",title:"BTCPay Server refund feature"}})]),t._v(" "),e("ol",{attrs:{start:"2"}},[e("li",[t._v("Click "),e("code",[t._v("Issue a refund")])])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(510),alt:"BTCPay Server refund feature",title:"BTCPay Server refund feature"}})]),t._v(" "),e("ol",{attrs:{start:"3"}},[e("li",[t._v("Select refund's payment method")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(511),alt:"BTCPay Server refund feature",title:"BTCPay Server refund feature"}})]),t._v(" "),e("ol",{attrs:{start:"4"}},[e("li",[t._v("Select the "),e("code",[t._v("amount")]),t._v(" you want to refund")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(512),alt:"BTCPay Server refund feature",title:"BTCPay Server refund feature"}})]),t._v(" "),e("ol",{attrs:{start:"5"}},[e("li",[t._v("Share the link of this page with your customer")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(513),alt:"BTCPay Server refund feature",title:"BTCPay Server refund feature"}})]),t._v(" "),e("h2",{attrs:{id:"processing-refund"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#processing-refund"}},[t._v("#")]),t._v(" Processing refund")]),t._v(" "),e("p",[t._v("Once a customer clicks on the link you've provided adds their refund bitcoin address and claims the invoice, the next step is to process a refund.")]),t._v(" "),e("ol",[e("li",[t._v("Go to the "),e("code",[t._v("Payouts")]),t._v(" tab in your sidebar.")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(259),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})]),t._v(" "),e("ol",{attrs:{start:"2"}},[e("li",[t._v("Select the Payouts you want to process, go to actions and select "),e("code",[t._v("Approve and send")])])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(259),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})]),t._v(" "),e("ol",{attrs:{start:"3"}},[e("li",[t._v("Sign and broadcast the transactions.")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(514),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})]),t._v(" "),e("ol",{attrs:{start:"4"}},[e("li",[t._v("The payout has now been signed and is in progress, awaiting confirmation on the blockchain. This is reflected to the claimant in their view.")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(515),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})]),t._v(" "),e("ol",{attrs:{start:"5"}},[e("li",[t._v("After the transaction has been confirmed on the blockchain, the status of the payout will be "),e("code",[t._v("completed")]),t._v(".")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(516),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})]),t._v(" "),e("p",[t._v("Customer's view after the refund has been successfully processed.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(517),alt:"BTCPay Server Payouts tab",title:"BTCPay Server Payouts tab"}})])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/20.b7cc46dc.js b/assets/js/20.81960154.js similarity index 75% rename from assets/js/20.b7cc46dc.js rename to assets/js/20.81960154.js index 4fbd31f7e6..d28613673d 100644 --- a/assets/js/20.b7cc46dc.js +++ b/assets/js/20.81960154.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{311:function(t,e,r){t.exports=r.p+"assets/img/ContributeCloneRepo.4df4c253.jpg"},312:function(t,e,r){t.exports=r.p+"assets/img/ContributeCloneRepo2.70d12ce3.jpg"},313:function(t,e,r){t.exports=r.p+"assets/img/ContributeCreateBranch.7d45e1e5.jpg"},314:function(t,e,r){t.exports=r.p+"assets/img/ContributeCreateBranch2.05759e70.jpg"},315:function(t,e,r){t.exports=r.p+"assets/img/ContributeFindFile.0bdf3b61.jpg"},316:function(t,e,r){t.exports=r.p+"assets/img/ContributeCommit.aadec825.jpg"},317:function(t,e,r){t.exports=r.p+"assets/img/ContributeCommit2.e2985a43.jpg"},318:function(t,e,r){t.exports=r.p+"assets/img/ContributeCreatePR.67d68a78.jpg"},319:function(t,e,r){t.exports=r.p+"assets/img/ContributeOpenPR.bacee510.jpg"},693:function(t,e,r){"use strict";r.r(e);var i=r(9),o=Object(i.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"contribute-to-the-software-stack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#contribute-to-the-software-stack"}},[t._v("#")]),t._v(" Contribute to the software stack")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("If you have trouble finding a string or contributing to the software stack, ask the "),e("RouterLink",{attrs:{to:"/Community/"}},[t._v("community")])],1),t._v(" "),e("p",[t._v("If your textual change is significant "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues/new/choose",target:"_blank",rel:"noopener noreferrer"}},[t._v("open an issue on GitHub"),e("OutboundLink")],1),t._v(" and explain what you'd like to change and why.")])]),t._v(" "),e("h2",{attrs:{id:"step-1"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-1"}},[t._v("#")]),t._v(" "),e("strong",[t._v("Step 1")])]),t._v(" "),e("p",[t._v("Fork/Clone the main repository ("),e("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/",target:"_blank",rel:"noopener noreferrer"}},[t._v("BTCPay Server"),e("OutboundLink")],1),t._v(") using Github and publish it.")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(311),alt:"ContributeCloneRepo",title:"ContributeCloneRepo"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:r(312),alt:"ContributeCloneRepo2",title:"ContributeCloneRepo2"}})]),t._v(" "),e("h2",{attrs:{id:"step-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-2"}},[t._v("#")]),t._v(" "),e("strong",[t._v("Step 2")])]),t._v(" "),e("p",[t._v("Create a branch and name it (for example what file you're working on).")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(313),alt:"ContributeCreateBranch",title:"ContributeCreateBranch"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:r(314),alt:"ContributeCreateBranch2",title:"ContributeCreateBranch2"}})]),t._v(" "),e("h2",{attrs:{id:"step-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-3"}},[t._v("#")]),t._v(" "),e("strong",[t._v("Step 3")])]),t._v(" "),e("p",[t._v("Now open your branch in your file explorer.")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(315),alt:"ContributeFindFile",title:"ContributeFindFile"}})]),t._v(" "),e("p",[t._v("You're all set!\nOpen the file you wish to edit and work on it.\nOnce finished, save it.")]),t._v(" "),e("h2",{attrs:{id:"step-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-4"}},[t._v("#")]),t._v(" "),e("strong",[t._v("Step 4")])]),t._v(" "),e("p",[t._v("Once your changes are saved, return to Github Desktop.\nSee your changes on the right hand side.")]),t._v(" "),e("p",[t._v("Name your contribution and describe it.\nClick the "),e("code",[t._v("Commit")]),t._v(" button in the bottom left.")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(316),alt:"ContributeCommit",title:"ContributeCommit"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:r(317),alt:"ContributeCommit2",title:"ContributeCommit2"}})]),t._v(" "),e("h2",{attrs:{id:"step-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-5"}},[t._v("#")]),t._v(" "),e("strong",[t._v("Step 5")])]),t._v(" "),e("p",[t._v("Next, create a "),e("code",[t._v("Pull Request")]),t._v(" by clicking the "),e("code",[t._v("Create Pull Request")]),t._v(" button on the right to open a browser page.")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(318),alt:"ContributeCreatePR",title:"ContributeCreatePR"}})]),t._v(" "),e("p",[t._v("Then describe what your "),e("code",[t._v("Pull Request")]),t._v(" changes, give it a title, and click "),e("code",[t._v("Create Pull Request")]),t._v(".")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(319),alt:"ContributeOpenPR",title:"ContributeOpenPR"}})]),t._v(" "),e("p",[t._v("Once your pull request is submitted, it has to be reviewed by the maintainers and contributors. If it gets accepted - congratulations, you've made your first contribution.")])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[20],{310:function(t,e,r){t.exports=r.p+"assets/img/ContributeCloneRepo.4df4c253.jpg"},311:function(t,e,r){t.exports=r.p+"assets/img/ContributeCloneRepo2.70d12ce3.jpg"},312:function(t,e,r){t.exports=r.p+"assets/img/ContributeCreateBranch.7d45e1e5.jpg"},313:function(t,e,r){t.exports=r.p+"assets/img/ContributeCreateBranch2.05759e70.jpg"},314:function(t,e,r){t.exports=r.p+"assets/img/ContributeFindFile.0bdf3b61.jpg"},315:function(t,e,r){t.exports=r.p+"assets/img/ContributeCommit.aadec825.jpg"},316:function(t,e,r){t.exports=r.p+"assets/img/ContributeCommit2.e2985a43.jpg"},317:function(t,e,r){t.exports=r.p+"assets/img/ContributeCreatePR.67d68a78.jpg"},318:function(t,e,r){t.exports=r.p+"assets/img/ContributeOpenPR.bacee510.jpg"},691:function(t,e,r){"use strict";r.r(e);var i=r(9),o=Object(i.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"contribute-to-the-software-stack"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#contribute-to-the-software-stack"}},[t._v("#")]),t._v(" Contribute to the software stack")]),t._v(" "),e("div",{staticClass:"custom-block tip"},[e("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),e("p",[t._v("If you have trouble finding a string or contributing to the software stack, ask the "),e("RouterLink",{attrs:{to:"/Community/"}},[t._v("community")])],1),t._v(" "),e("p",[t._v("If your textual change is significant "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues/new/choose",target:"_blank",rel:"noopener noreferrer"}},[t._v("open an issue on GitHub"),e("OutboundLink")],1),t._v(" and explain what you'd like to change and why.")])]),t._v(" "),e("h2",{attrs:{id:"step-1"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-1"}},[t._v("#")]),t._v(" "),e("strong",[t._v("Step 1")])]),t._v(" "),e("p",[t._v("Fork/Clone the main repository ("),e("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/",target:"_blank",rel:"noopener noreferrer"}},[t._v("BTCPay Server"),e("OutboundLink")],1),t._v(") using Github and publish it.")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(310),alt:"ContributeCloneRepo",title:"ContributeCloneRepo"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:r(311),alt:"ContributeCloneRepo2",title:"ContributeCloneRepo2"}})]),t._v(" "),e("h2",{attrs:{id:"step-2"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-2"}},[t._v("#")]),t._v(" "),e("strong",[t._v("Step 2")])]),t._v(" "),e("p",[t._v("Create a branch and name it (for example what file you're working on).")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(312),alt:"ContributeCreateBranch",title:"ContributeCreateBranch"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:r(313),alt:"ContributeCreateBranch2",title:"ContributeCreateBranch2"}})]),t._v(" "),e("h2",{attrs:{id:"step-3"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-3"}},[t._v("#")]),t._v(" "),e("strong",[t._v("Step 3")])]),t._v(" "),e("p",[t._v("Now open your branch in your file explorer.")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(314),alt:"ContributeFindFile",title:"ContributeFindFile"}})]),t._v(" "),e("p",[t._v("You're all set!\nOpen the file you wish to edit and work on it.\nOnce finished, save it.")]),t._v(" "),e("h2",{attrs:{id:"step-4"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-4"}},[t._v("#")]),t._v(" "),e("strong",[t._v("Step 4")])]),t._v(" "),e("p",[t._v("Once your changes are saved, return to Github Desktop.\nSee your changes on the right hand side.")]),t._v(" "),e("p",[t._v("Name your contribution and describe it.\nClick the "),e("code",[t._v("Commit")]),t._v(" button in the bottom left.")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(315),alt:"ContributeCommit",title:"ContributeCommit"}})]),t._v(" "),e("figure",[e("img",{attrs:{src:r(316),alt:"ContributeCommit2",title:"ContributeCommit2"}})]),t._v(" "),e("h2",{attrs:{id:"step-5"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#step-5"}},[t._v("#")]),t._v(" "),e("strong",[t._v("Step 5")])]),t._v(" "),e("p",[t._v("Next, create a "),e("code",[t._v("Pull Request")]),t._v(" by clicking the "),e("code",[t._v("Create Pull Request")]),t._v(" button on the right to open a browser page.")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(317),alt:"ContributeCreatePR",title:"ContributeCreatePR"}})]),t._v(" "),e("p",[t._v("Then describe what your "),e("code",[t._v("Pull Request")]),t._v(" changes, give it a title, and click "),e("code",[t._v("Create Pull Request")]),t._v(".")]),t._v(" "),e("figure",[e("img",{attrs:{src:r(318),alt:"ContributeOpenPR",title:"ContributeOpenPR"}})]),t._v(" "),e("p",[t._v("Once your pull request is submitted, it has to be reviewed by the maintainers and contributors. If it gets accepted - congratulations, you've made your first contribution.")])])}),[],!1,null,null,null);e.default=o.exports}}]); \ No newline at end of file diff --git a/assets/js/21.148cbf1b.js b/assets/js/21.5260132f.js similarity index 90% rename from assets/js/21.148cbf1b.js rename to assets/js/21.5260132f.js index 227f9d4d2b..74eca98e16 100644 --- a/assets/js/21.148cbf1b.js +++ b/assets/js/21.5260132f.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{240:function(e,t,a){e.exports=a.p+"assets/img/BroadcastConfirm.fde15efd.png"},321:function(e,t,a){e.exports=a.p+"assets/img/MainMenu.c6ee0a71.png"},322:function(e,t,a){e.exports=a.p+"assets/img/CreateNewWallet.b9662283.png"},323:function(e,t,a){e.exports=a.p+"assets/img/HotWallet.3334a95d.png"},324:function(e,t,a){e.exports=a.p+"assets/img/WalletSettings.20aa817c.png"},325:function(e,t,a){e.exports=a.p+"assets/img/AdvancedSettings.46859536.png"},326:function(e,t,a){e.exports=a.p+"assets/img/ServerSettings.6a6d7e35.png"},327:function(e,t,a){e.exports=a.p+"assets/img/WalletSend.b3bed5a9.png"},328:function(e,t,a){e.exports=a.p+"assets/img/SignTransaction.ddb5258c.png"},695:function(e,t,a){"use strict";a.r(t);var r=a(9),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"create-a-new-wallet"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-wallet"}},[e._v("#")]),e._v(" Create a new wallet")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#hot-wallet"}},[e._v("Hot Wallet")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#watch-only-wallet"}},[e._v("Watch-only wallet")])])]),e._v(" "),t("h3",{attrs:{id:"hot-wallet"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hot-wallet"}},[e._v("#")]),e._v(" Hot Wallet")]),e._v(" "),t("p",[e._v("If you do not have an existing wallet, you can generate a new one within your BTCPay Server. Whether you have an existing wallet or not, the quickest way to get a wallet connected to your store is to create a new wallet. You can always replace it with an alternative wallet after receiving a few small payments to your server, if you just want to get your store ready quickly.")]),e._v(" "),t("p",[e._v("This type of wallet is also necessary to use features such as "),t("RouterLink",{attrs:{to:"/Payjoin/"}},[e._v("Payjoin")]),e._v(" and "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues/1282",target:"_blank",rel:"noopener noreferrer"}},[e._v("Liquid"),t("OutboundLink")],1),e._v(".")],1),e._v(" "),t("p",[e._v("After creating a store, you'll be able to attach a wallet by first navigating to the sidebar or slide-out menu and clicking/tapping the "),t("strong",[e._v("Bitcoin")]),e._v(" button under the "),t("strong",[e._v("Wallets")]),e._v(" header. Alternatively, you can find the option to "),t("strong",[e._v("Set up a wallet")]),e._v(" on the Dashboard.")]),e._v(" "),t("figure",[t("img",{attrs:{src:a(321),alt:"Main Menu",title:"Main Menu"}})]),e._v(" "),t("p",[e._v("You'll focus on the "),t("strong",[e._v("I don't have a wallet")]),e._v(" section for a hot wallet and click the "),t("strong",[e._v("Create a new wallet")]),e._v(" button.")]),e._v(" "),t("figure",[t("img",{attrs:{src:a(322),alt:"New Wallet",title:"New Wallet"}})]),e._v(" "),t("p",[e._v("There will be two options on the proceeding page, and in this case, we'll select the "),t("strong",[e._v("Hot wallet")]),e._v(" button.")]),e._v(" "),t("figure",[t("img",{attrs:{src:a(323),alt:"Create Wallet",title:"Create Wallet"}})]),e._v(" "),t("p",[e._v("For most people, the default options, including "),t("strong",[e._v("Address Type")]),e._v(" (Segwit), should work well for most applications, and it's recommended not to change it unless you're sure of what you're doing. The "),t("strong",[e._v("Payjoin")]),e._v(" feature is optional, and you can learn more about it at the link "),t("a",{attrs:{href:"#hot-wallet"}},[e._v("above")]),e._v(".")]),e._v(" "),t("p",[e._v("Find out more about advanced settings "),t("a",{attrs:{href:"#advanced-settings"}},[e._v("here")]),e._v(".")]),e._v(" "),t("figure",[t("img",{attrs:{src:a(324),alt:"Wallet Settings",title:"Wallet Settings"}})]),e._v(" "),t("h4",{attrs:{id:"recovery-seed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recovery-seed"}},[e._v("#")]),e._v(" Recovery Seed")]),e._v(" "),t("p",[e._v("The last step to creating a hot wallet is making sure you document your recovery seed. After you've done so, tick the checkbox that says "),t("em",[e._v("I have written down my recovery phrase and stored it in a secure location")]),e._v(" and click the "),t("strong",[e._v("Done")]),e._v(" button.")]),e._v(" "),t("h4",{attrs:{id:"advanced-settings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advanced-settings"}},[e._v("#")]),e._v(" Advanced Settings")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Optional "),t("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki#from-mnemonic-to-seed",target:"_blank",rel:"noopener noreferrer"}},[e._v("BIP39"),t("OutboundLink")],1),e._v(" passphrase")]),e._v(" "),t("ul",[t("li",[e._v("You can add a passphrase for your hot wallet's mnemonic for an additional layer of security.")])])]),e._v(" "),t("li",[t("p",[e._v("Import keys to RPC")]),e._v(" "),t("ul",[t("li",[e._v("This is for more advanced applications of BTCPay Server. Importing your keys to RPC will allow users to leverage "),t("a",{attrs:{href:"https://developer.bitcoin.org/reference/rpc/index.html#wallet-rpcs",target:"_blank",rel:"noopener noreferrer"}},[e._v("bitcoind Wallet RPCs"),t("OutboundLink")],1),e._v(" on the imported wallet.")])])])]),e._v(" "),t("figure",[t("img",{attrs:{src:a(325),alt:"Advanced Settings",title:"Advanced Settings"}})]),e._v(" "),t("h4",{attrs:{id:"requirements-to-create-wallets"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#requirements-to-create-wallets"}},[e._v("#")]),e._v(" Requirements to create wallets")]),e._v(" "),t("p",[e._v("If are using a "),t("RouterLink",{attrs:{to:"/Deployment/ThirdPartyHosting/"}},[e._v("third-party host")]),e._v(", this option needs to be explicitly enabled by the server admin. Generating a new wallet in an environment you are not sure is trustworthy, is discouraged.")],1),e._v(" "),t("p",[e._v('By default, you need to be a server admin to use the create wallet feature. This is because server admins are able to extract the private key easily. If for some reason (such as allowing individuals that trust you enough with their store), you can enable the hot wallet for non-admins from Server Settings > Policies > "Allow non-admins to create hot wallets for their stores".')]),e._v(" "),t("p",[e._v("Understand that anyone with access to your recovery seed can also access and steal all your funds (current AND future funds!), since a private key is derived from a recovery seed. Securely back up your seed by writing it down and keep it in a safe place. Do not photograph it or store it in a digital format. Do not rely solely on your server for storing your recovery seed, always keep a backup copy.")]),e._v(" "),t("figure",[t("img",{attrs:{src:a(326),alt:"BTCPay Server settings",title:"BTCPay Server settings"}})]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("When a new wallet is generated, BTCPay Server will show you a twelve word recovery seed. After the initial display, the recovery seed is wiped from the server, unless a the hot wallet option is enabled.")])]),e._v(" "),t("h4",{attrs:{id:"spending-funds-with-btcpay-hot-wallet"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#spending-funds-with-btcpay-hot-wallet"}},[e._v("#")]),e._v(" Spending funds with BTCPay Hot Wallet")]),e._v(" "),t("p",[e._v("Once you've received funds to your wallet and decide to spend them, you can automatically sign the transaction inside BTCPay Server.")]),e._v(" "),t("ol",[t("li",[e._v("In BTCPay Server, go to > Wallets > Bitcoin > Send")]),e._v(" "),t("li",[e._v("Fill in the Destination address and the Amount")]),e._v(" "),t("li",[e._v("Adjust the transaction settings, including fee rate, confirmation time preference, and if you'd like transaction fees to be subtracted from the amount you're sending")]),e._v(" "),t("li",[e._v("Sign the transaction")]),e._v(" "),t("li",[e._v("Review the transaction")]),e._v(" "),t("li",[e._v("Broadcast the transaction")])]),e._v(" "),t("p",[t("img",{attrs:{src:a(327),alt:"BTCPay Server Send page",title:"BTCPay Server Send page"}}),e._v(" "),t("img",{attrs:{src:a(240),alt:"BTCPay Server Transaction Review and Broadcast page",title:"BTCPay Server Transaction Review and Broadcast page"}})]),e._v(" "),t("h4",{attrs:{id:"security-implications"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#security-implications"}},[e._v("#")]),e._v(" Security Implications")]),e._v(" "),t("p",[e._v("Storing private keys on a public server comes with risks. This is similar to the risks of running and using the "),t("RouterLink",{attrs:{to:"/LightningNetwork/"}},[e._v("Lightning Network")]),e._v(" (except that you can recover funds with a backup).\n"),t("strong",[e._v("Please, ALWAYS be sure to back up any seed that is generated by this feature and to never leave money you cannot afford to lose spendable by those private keys")]),e._v(".")],1),e._v(" "),t("h4",{attrs:{id:"reducing-risk"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reducing-risk"}},[e._v("#")]),e._v(" Reducing risk")]),e._v(" "),t("p",[e._v("As mentioned above, the create wallet functionality includes the risk of funds being stolen if the server or account is compromised. To mitigate this risk, we advise you to:")]),e._v(" "),t("ul",[t("li",[e._v("Enable two factor or U2F authentication")]),e._v(" "),t("li",[e._v("Occasionally move funds to your cold storage either manually or by configuring "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcTransmuter/blob/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTC Transmuter"),t("OutboundLink")],1),e._v(" with automatic payment forwarding.")])]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("Do not give anyone else access to your server's SSH keys or server account credentials when using a hot wallet. Anyone with access to your account can spend the funds from your hot wallet. If you need to allow account access to employees, developers, etc. use an "),t("RouterLink",{attrs:{to:"/ConnectWallet/#connect-an-existing-wallet"}},[e._v("existing wallet")]),e._v(" instead.")],1)]),e._v(" "),t("h3",{attrs:{id:"watch-only-wallet"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#watch-only-wallet"}},[e._v("#")]),e._v(" Watch-only wallet")]),e._v(" "),t("p",[e._v('Like the hot wallet, the watch-only wallet can instantly get your store connected to a wallet. In contrast, this option does not store the private keys on the server. As a result, the wallet becomes "watch-only" for any received funds.')]),e._v(" "),t("p",[e._v("There are several routes you can take to spend funds with this type of wallet including importing the seed words into a hardware wallet to sign your transactions using the "),t("RouterLink",{attrs:{to:"/Vault/"}},[e._v("BTCPay Server Vault application")]),e._v(", "),t("RouterLink",{attrs:{to:"/Wallet/#psbt"}},[e._v("PSBT")]),e._v(", or the least recommended manually providing your seed words every time.")],1),e._v(" "),t("figure",[t("img",{attrs:{src:a(328),alt:"BTCPay Server Transaction Signing Options",title:"BTCPay Server Transaction Signing Options"}})]),e._v(" "),t("p",[e._v("Alternatively, you can spend funds in another external wallet where you have imported your BTCPay Server-produced seed words. If you import your seed words into an external wallet, you can also use a PSBT to spend the funds, assuming the wallet supports it. This option will be available on the wallet's send page. Be sure to consider the "),t("RouterLink",{attrs:{to:"/FAQ/Wallet/#missing-payments-in-my-software-or-hardware-wallet"}},[e._v("gap limit issue")]),e._v(" if you're using an external wallet with your watch-only wallet.")],1)])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[21],{240:function(e,t,a){e.exports=a.p+"assets/img/BroadcastConfirm.fde15efd.png"},320:function(e,t,a){e.exports=a.p+"assets/img/MainMenu.c6ee0a71.png"},321:function(e,t,a){e.exports=a.p+"assets/img/CreateNewWallet.b9662283.png"},322:function(e,t,a){e.exports=a.p+"assets/img/HotWallet.3334a95d.png"},323:function(e,t,a){e.exports=a.p+"assets/img/WalletSettings.20aa817c.png"},324:function(e,t,a){e.exports=a.p+"assets/img/AdvancedSettings.46859536.png"},325:function(e,t,a){e.exports=a.p+"assets/img/ServerSettings.6a6d7e35.png"},326:function(e,t,a){e.exports=a.p+"assets/img/WalletSend.b3bed5a9.png"},327:function(e,t,a){e.exports=a.p+"assets/img/SignTransaction.ddb5258c.png"},693:function(e,t,a){"use strict";a.r(t);var r=a(9),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"create-a-new-wallet"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-a-new-wallet"}},[e._v("#")]),e._v(" Create a new wallet")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"#hot-wallet"}},[e._v("Hot Wallet")])]),e._v(" "),t("li",[t("a",{attrs:{href:"#watch-only-wallet"}},[e._v("Watch-only wallet")])])]),e._v(" "),t("h3",{attrs:{id:"hot-wallet"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#hot-wallet"}},[e._v("#")]),e._v(" Hot Wallet")]),e._v(" "),t("p",[e._v("If you do not have an existing wallet, you can generate a new one within your BTCPay Server. Whether you have an existing wallet or not, the quickest way to get a wallet connected to your store is to create a new wallet. You can always replace it with an alternative wallet after receiving a few small payments to your server, if you just want to get your store ready quickly.")]),e._v(" "),t("p",[e._v("This type of wallet is also necessary to use features such as "),t("RouterLink",{attrs:{to:"/Payjoin/"}},[e._v("Payjoin")]),e._v(" and "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues/1282",target:"_blank",rel:"noopener noreferrer"}},[e._v("Liquid"),t("OutboundLink")],1),e._v(".")],1),e._v(" "),t("p",[e._v("After creating a store, you'll be able to attach a wallet by first navigating to the sidebar or slide-out menu and clicking/tapping the "),t("strong",[e._v("Bitcoin")]),e._v(" button under the "),t("strong",[e._v("Wallets")]),e._v(" header. Alternatively, you can find the option to "),t("strong",[e._v("Set up a wallet")]),e._v(" on the Dashboard.")]),e._v(" "),t("figure",[t("img",{attrs:{src:a(320),alt:"Main Menu",title:"Main Menu"}})]),e._v(" "),t("p",[e._v("You'll focus on the "),t("strong",[e._v("I don't have a wallet")]),e._v(" section for a hot wallet and click the "),t("strong",[e._v("Create a new wallet")]),e._v(" button.")]),e._v(" "),t("figure",[t("img",{attrs:{src:a(321),alt:"New Wallet",title:"New Wallet"}})]),e._v(" "),t("p",[e._v("There will be two options on the proceeding page, and in this case, we'll select the "),t("strong",[e._v("Hot wallet")]),e._v(" button.")]),e._v(" "),t("figure",[t("img",{attrs:{src:a(322),alt:"Create Wallet",title:"Create Wallet"}})]),e._v(" "),t("p",[e._v("For most people, the default options, including "),t("strong",[e._v("Address Type")]),e._v(" (Segwit), should work well for most applications, and it's recommended not to change it unless you're sure of what you're doing. The "),t("strong",[e._v("Payjoin")]),e._v(" feature is optional, and you can learn more about it at the link "),t("a",{attrs:{href:"#hot-wallet"}},[e._v("above")]),e._v(".")]),e._v(" "),t("p",[e._v("Find out more about advanced settings "),t("a",{attrs:{href:"#advanced-settings"}},[e._v("here")]),e._v(".")]),e._v(" "),t("figure",[t("img",{attrs:{src:a(323),alt:"Wallet Settings",title:"Wallet Settings"}})]),e._v(" "),t("h4",{attrs:{id:"recovery-seed"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#recovery-seed"}},[e._v("#")]),e._v(" Recovery Seed")]),e._v(" "),t("p",[e._v("The last step to creating a hot wallet is making sure you document your recovery seed. After you've done so, tick the checkbox that says "),t("em",[e._v("I have written down my recovery phrase and stored it in a secure location")]),e._v(" and click the "),t("strong",[e._v("Done")]),e._v(" button.")]),e._v(" "),t("h4",{attrs:{id:"advanced-settings"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#advanced-settings"}},[e._v("#")]),e._v(" Advanced Settings")]),e._v(" "),t("ul",[t("li",[t("p",[e._v("Optional "),t("a",{attrs:{href:"https://github.com/bitcoin/bips/blob/master/bip-0039.mediawiki#from-mnemonic-to-seed",target:"_blank",rel:"noopener noreferrer"}},[e._v("BIP39"),t("OutboundLink")],1),e._v(" passphrase")]),e._v(" "),t("ul",[t("li",[e._v("You can add a passphrase for your hot wallet's mnemonic for an additional layer of security.")])])]),e._v(" "),t("li",[t("p",[e._v("Import keys to RPC")]),e._v(" "),t("ul",[t("li",[e._v("This is for more advanced applications of BTCPay Server. Importing your keys to RPC will allow users to leverage "),t("a",{attrs:{href:"https://developer.bitcoin.org/reference/rpc/index.html#wallet-rpcs",target:"_blank",rel:"noopener noreferrer"}},[e._v("bitcoind Wallet RPCs"),t("OutboundLink")],1),e._v(" on the imported wallet.")])])])]),e._v(" "),t("figure",[t("img",{attrs:{src:a(324),alt:"Advanced Settings",title:"Advanced Settings"}})]),e._v(" "),t("h4",{attrs:{id:"requirements-to-create-wallets"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#requirements-to-create-wallets"}},[e._v("#")]),e._v(" Requirements to create wallets")]),e._v(" "),t("p",[e._v("If are using a "),t("RouterLink",{attrs:{to:"/Deployment/ThirdPartyHosting/"}},[e._v("third-party host")]),e._v(", this option needs to be explicitly enabled by the server admin. Generating a new wallet in an environment you are not sure is trustworthy, is discouraged.")],1),e._v(" "),t("p",[e._v('By default, you need to be a server admin to use the create wallet feature. This is because server admins are able to extract the private key easily. If for some reason (such as allowing individuals that trust you enough with their store), you can enable the hot wallet for non-admins from Server Settings > Policies > "Allow non-admins to create hot wallets for their stores".')]),e._v(" "),t("p",[e._v("Understand that anyone with access to your recovery seed can also access and steal all your funds (current AND future funds!), since a private key is derived from a recovery seed. Securely back up your seed by writing it down and keep it in a safe place. Do not photograph it or store it in a digital format. Do not rely solely on your server for storing your recovery seed, always keep a backup copy.")]),e._v(" "),t("figure",[t("img",{attrs:{src:a(325),alt:"BTCPay Server settings",title:"BTCPay Server settings"}})]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("When a new wallet is generated, BTCPay Server will show you a twelve word recovery seed. After the initial display, the recovery seed is wiped from the server, unless a the hot wallet option is enabled.")])]),e._v(" "),t("h4",{attrs:{id:"spending-funds-with-btcpay-hot-wallet"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#spending-funds-with-btcpay-hot-wallet"}},[e._v("#")]),e._v(" Spending funds with BTCPay Hot Wallet")]),e._v(" "),t("p",[e._v("Once you've received funds to your wallet and decide to spend them, you can automatically sign the transaction inside BTCPay Server.")]),e._v(" "),t("ol",[t("li",[e._v("In BTCPay Server, go to > Wallets > Bitcoin > Send")]),e._v(" "),t("li",[e._v("Fill in the Destination address and the Amount")]),e._v(" "),t("li",[e._v("Adjust the transaction settings, including fee rate, confirmation time preference, and if you'd like transaction fees to be subtracted from the amount you're sending")]),e._v(" "),t("li",[e._v("Sign the transaction")]),e._v(" "),t("li",[e._v("Review the transaction")]),e._v(" "),t("li",[e._v("Broadcast the transaction")])]),e._v(" "),t("p",[t("img",{attrs:{src:a(326),alt:"BTCPay Server Send page",title:"BTCPay Server Send page"}}),e._v(" "),t("img",{attrs:{src:a(240),alt:"BTCPay Server Transaction Review and Broadcast page",title:"BTCPay Server Transaction Review and Broadcast page"}})]),e._v(" "),t("h4",{attrs:{id:"security-implications"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#security-implications"}},[e._v("#")]),e._v(" Security Implications")]),e._v(" "),t("p",[e._v("Storing private keys on a public server comes with risks. This is similar to the risks of running and using the "),t("RouterLink",{attrs:{to:"/LightningNetwork/"}},[e._v("Lightning Network")]),e._v(" (except that you can recover funds with a backup).\n"),t("strong",[e._v("Please, ALWAYS be sure to back up any seed that is generated by this feature and to never leave money you cannot afford to lose spendable by those private keys")]),e._v(".")],1),e._v(" "),t("h4",{attrs:{id:"reducing-risk"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#reducing-risk"}},[e._v("#")]),e._v(" Reducing risk")]),e._v(" "),t("p",[e._v("As mentioned above, the create wallet functionality includes the risk of funds being stolen if the server or account is compromised. To mitigate this risk, we advise you to:")]),e._v(" "),t("ul",[t("li",[e._v("Enable two factor or U2F authentication")]),e._v(" "),t("li",[e._v("Occasionally move funds to your cold storage either manually or by configuring "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcTransmuter/blob/master/README.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTC Transmuter"),t("OutboundLink")],1),e._v(" with automatic payment forwarding.")])]),e._v(" "),t("div",{staticClass:"custom-block danger"},[t("p",{staticClass:"custom-block-title"},[e._v("DANGER")]),e._v(" "),t("p",[e._v("Do not give anyone else access to your server's SSH keys or server account credentials when using a hot wallet. Anyone with access to your account can spend the funds from your hot wallet. If you need to allow account access to employees, developers, etc. use an "),t("RouterLink",{attrs:{to:"/ConnectWallet/#connect-an-existing-wallet"}},[e._v("existing wallet")]),e._v(" instead.")],1)]),e._v(" "),t("h3",{attrs:{id:"watch-only-wallet"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#watch-only-wallet"}},[e._v("#")]),e._v(" Watch-only wallet")]),e._v(" "),t("p",[e._v('Like the hot wallet, the watch-only wallet can instantly get your store connected to a wallet. In contrast, this option does not store the private keys on the server. As a result, the wallet becomes "watch-only" for any received funds.')]),e._v(" "),t("p",[e._v("There are several routes you can take to spend funds with this type of wallet including importing the seed words into a hardware wallet to sign your transactions using the "),t("RouterLink",{attrs:{to:"/Vault/"}},[e._v("BTCPay Server Vault application")]),e._v(", "),t("RouterLink",{attrs:{to:"/Wallet/#psbt"}},[e._v("PSBT")]),e._v(", or the least recommended manually providing your seed words every time.")],1),e._v(" "),t("figure",[t("img",{attrs:{src:a(327),alt:"BTCPay Server Transaction Signing Options",title:"BTCPay Server Transaction Signing Options"}})]),e._v(" "),t("p",[e._v("Alternatively, you can spend funds in another external wallet where you have imported your BTCPay Server-produced seed words. If you import your seed words into an external wallet, you can also use a PSBT to spend the funds, assuming the wallet supports it. This option will be available on the wallet's send page. Be sure to consider the "),t("RouterLink",{attrs:{to:"/FAQ/Wallet/#missing-payments-in-my-software-or-hardware-wallet"}},[e._v("gap limit issue")]),e._v(" if you're using an external wallet with your watch-only wallet.")],1)])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/22.5483a7b8.js b/assets/js/22.1baef0db.js similarity index 93% rename from assets/js/22.5483a7b8.js rename to assets/js/22.1baef0db.js index 163141a399..6bab867605 100644 --- a/assets/js/22.5483a7b8.js +++ b/assets/js/22.1baef0db.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{593:function(t,e,a){t.exports=a.p+"assets/img/WalletTransactions.c905309a.jpg"},594:function(t,e,a){t.exports=a.p+"assets/img/WalletSend.f65f1a74.jpg"},595:function(t,e,a){t.exports=a.p+"assets/img/WalletRBF.2dea1e29.jpg"},596:function(t,e,a){t.exports=a.p+"assets/img/CoinSelection.9d40e6ee.jpg"},597:function(t,e,a){t.exports=a.p+"assets/img/ScanWallet.61243593.jpg"},598:function(t,e,a){t.exports=a.p+"assets/img/WalletReceive.cb4b9f39.jpg"},599:function(t,e,a){t.exports=a.p+"assets/img/WalletRescan.1d081027.jpg"},600:function(t,e,a){t.exports=a.p+"assets/img/WalletRescanProgress.05a8b0f7.jpg"},601:function(t,e,a){t.exports=a.p+"assets/img/btcpayserverwalletsettings1.97911174.jpg"},797:function(t,e,a){"use strict";a.r(e);var n=a(9),s=Object(n.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"btcpay-server-wallet"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-server-wallet"}},[t._v("#")]),t._v(" BTCPay Server Wallet")]),t._v(" "),e("p",[t._v("BTCPay Server has a built in, "),e("strong",[t._v("full-node reliant wallet")]),t._v(" that allows for easy funds management.")]),t._v(" "),e("p",[t._v("Each "),e("RouterLink",{attrs:{to:"/CreateStore/"}},[t._v("store")]),t._v("'s configured cryptocurrency has a separate wallet displayed under Wallets in the menu bar.")],1),t._v(" "),e("h2",{attrs:{id:"wallet-features"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#wallet-features"}},[t._v("#")]),t._v(" Wallet features")]),t._v(" "),e("p",[t._v("The wallet contains the following features:")]),t._v(" "),e("ol",[e("li",[t._v("Transactions")]),t._v(" "),e("li",[t._v("Send")]),t._v(" "),e("li",[t._v("Receive")]),t._v(" "),e("li",[t._v("Rescan")]),t._v(" "),e("li",[t._v("Pull payments")]),t._v(" "),e("li",[t._v("Payouts")]),t._v(" "),e("li",[t._v("PSBT")]),t._v(" "),e("li",[t._v("Settings")])]),t._v(" "),e("h3",{attrs:{id:"transactions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transactions"}},[t._v("#")]),t._v(" Transactions")]),t._v(" "),e("p",[t._v("An overview of the incoming (green), outgoing (red) and unconfirmed (grayed out) "),e("strong",[t._v("transactions")]),t._v(" displayed together with timestamps and balances, sorted by date. You can click on the transaction ID to view the transaction details on the block explorer.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(593),alt:"Individual Wallet",title:"Individual Wallet"}})]),t._v(" "),e("h4",{attrs:{id:"transaction-labels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transaction-labels"}},[t._v("#")]),t._v(" Transaction Labels")]),t._v(" "),e("p",[t._v("The table below lists the various "),e("strong",[t._v("transaction labels used by BTCPay")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Transaction Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("app")]),t._v(" "),e("td",[t._v("Payment was received through an app created invoice")])]),t._v(" "),e("tr",[e("td",[t._v("invoice")]),t._v(" "),e("td",[t._v("Payment was received through an invoice")])]),t._v(" "),e("tr",[e("td",[t._v("payjoin")]),t._v(" "),e("td",[t._v("Not paid, invoice timer still has not expired")])]),t._v(" "),e("tr",[e("td",[t._v("payjoin-exposed")]),t._v(" "),e("td",[t._v("UTXO was exposed through an invoice payjoin proposal")])]),t._v(" "),e("tr",[e("td",[t._v("payment-request")]),t._v(" "),e("td",[t._v("Payment was received through a payment request")])]),t._v(" "),e("tr",[e("td",[t._v("payout")]),t._v(" "),e("td",[t._v("Payment was sent through a payout or refund")])])])]),t._v(" "),e("p",[t._v("You can also create your own "),e("RouterLink",{attrs:{to:"/FAQ/Wallet/#how-to-add-custom-labels-and-comments-to-transactions"}},[t._v("custom transaction labels and comments")]),t._v(".")],1),t._v(" "),e("h3",{attrs:{id:"send"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#send"}},[t._v("#")]),t._v(" Send")]),t._v(" "),e("p",[t._v("The Send function allows "),e("strong",[t._v("spending of the funds from the BTCPay wallet")]),t._v(".")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(594),alt:"Send from the Wallet",title:"Send from the Wallet"}})]),t._v(" "),e("h4",{attrs:{id:"signing-a-transaction-spending"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#signing-a-transaction-spending"}},[t._v("#")]),t._v(" Signing a transaction (spending)")]),t._v(" "),e("p",[t._v("To spend the funds, you are required to "),e("strong",[t._v("sign")]),t._v(" the transaction. Transactions can be signed with:")]),t._v(" "),e("ul",[e("li",[t._v("Hardware Wallet")]),t._v(" "),e("li",[t._v("Wallet supporting PSBT")]),t._v(" "),e("li",[t._v("HD private key or recovery seed")]),t._v(" "),e("li",[t._v("Hot Wallet")])]),t._v(" "),e("h5",{attrs:{id:"signing-with-hd-private-key-or-mnemonic-seed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#signing-with-hd-private-key-or-mnemonic-seed"}},[t._v("#")]),t._v(" Signing with HD Private Key or mnemonic seed")]),t._v(" "),e("p",[t._v("If you set up an "),e("RouterLink",{attrs:{to:"/WalletSetup/#use-an-existing-wallet"}},[t._v("existing wallet with your BTCPay Server")]),t._v(", you can spend the funds by inputting your private key into an appropriate field. Make sure to set a proper "),e("code",[t._v("AccountKeyPath")]),t._v(" in Wallet > Settings otherwise you won't be able to spend.")],1),t._v(" "),e("h5",{attrs:{id:"signing-with-a-wallet-supporting-psbt"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#signing-with-a-wallet-supporting-psbt"}},[t._v("#")]),t._v(" Signing with a wallet supporting PSBT")]),t._v(" "),e("p",[t._v("PSBT ("),e("strong",[t._v("Partially Signed Bitcoin transactions")]),t._v(") is an interchange format for Bitcoin transactions that are not fully signed yet.\nPSBT is supported in BTCPay Server and can be signed with compatible hardware and software wallets.")]),t._v(" "),e("p",[t._v("The construction of a fully signed Bitcoin transaction goes through the following steps:")]),t._v(" "),e("ul",[e("li",[t._v("A PSBT gets constructed with certain inputs and outputs, but no signatures")]),t._v(" "),e("li",[t._v("The exported PSBT can be imported by a wallet that supports this format")]),t._v(" "),e("li",[t._v("The transaction data can be inspected and signed using the wallet")]),t._v(" "),e("li",[t._v("The signed PSBT file gets exported from the wallet and imported with BTCPay Server")]),t._v(" "),e("li",[t._v("BTCPay Server produces the final Bitcoin transaction")]),t._v(" "),e("li",[t._v("You verify the result and broadcast it to the network")])]),t._v(" "),e("p",[t._v("Check this tutorial on how to "),e("RouterLink",{attrs:{to:"/ColdCardWallet/#spending-from-btcpay-server-wallet-with-coldcard-psbt"}},[t._v("sign a PSBT transaction with ColdCard Hardware Wallet")]),t._v(", completely offline/air-gapped.")],1),t._v(" "),e("h5",{attrs:{id:"signing-with-a-hardware-wallet"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#signing-with-a-hardware-wallet"}},[t._v("#")]),t._v(" Signing with a hardware wallet")]),t._v(" "),e("p",[t._v("BTCPay Server has built-in hardware wallet support allowing you to "),e("strong",[t._v("use your hardware wallet with BTCPay")]),t._v(", without leaking information to third-party apps or servers.")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/HardwareWalletIntegration/"}},[t._v("Check instructions")]),t._v(" on how to set up and sign with a "),e("a",{attrs:{href:"https://github.com/bitcoin-core/HWI#device-support",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible hardware wallet"),e("OutboundLink")],1),t._v(".")],1),t._v(" "),e("h5",{attrs:{id:"signing-with-a-hot-wallet"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#signing-with-a-hot-wallet"}},[t._v("#")]),t._v(" Signing with a hot wallet")]),t._v(" "),e("p",[t._v("If you "),e("RouterLink",{attrs:{to:"/CreateWallet/"}},[t._v("created a new wallet")]),t._v(" when setting up your store and enabled it as a "),e("RouterLink",{attrs:{to:"/CreateWallet/#hot-wallet"}},[t._v("hot wallet")]),t._v(", since version 1.2.0, we've added an option that when a "),e("RouterLink",{attrs:{to:"/CreateWallet/#hot-wallet"}},[t._v("hot wallet")]),t._v(" is created, it'll automatically use the seed stored on a server to sign.")],1),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("DANGER")]),t._v(" "),e("p",[t._v("Using the hot wallet feature comes with security implications; please be sure to read and understand them over at the "),e("RouterLink",{attrs:{to:"/CreateWallet/#security-implications"}},[t._v("Hot Wallet documentation")])],1)]),t._v(" "),e("h4",{attrs:{id:"advanced-settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#advanced-settings"}},[t._v("#")]),t._v(" Advanced Settings")]),t._v(" "),e("p",[t._v("Certain wallet features are available for advanced users. Toggle the "),e("code",[t._v("Advanced Settings")]),t._v(" within the "),e("code",[t._v("Send")]),t._v(" tab to preview them.")]),t._v(" "),e("h5",{attrs:{id:"dont-create-utxo-change"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dont-create-utxo-change"}},[t._v("#")]),t._v(" Don't create UTXO change")]),t._v(" "),e("p",[t._v("This option is available in the "),e("code",[t._v("Advanced mode")]),t._v(" of the "),e("code",[t._v("Send")]),t._v(" page.")]),t._v(" "),e("p",[t._v("It is a privacy enhancing feature which is useful when you're sending funds to another wallet of yours or to an exchange. It makes sure that no change UTXO is created by "),e("strong",[t._v("rounding up")]),t._v(" the amount sent.")]),t._v(" "),e("p",[t._v("By default this feature is disabled, so if your wallet has a UTXO of "),e("code",[t._v("1.1 BTC")]),t._v(" and you input an amount equal to "),e("code",[t._v("1.0 BTC")]),t._v(", the resulting transaction will have two outputs "),e("code",[t._v("0.1 BTC")]),t._v(" of change, and "),e("code",[t._v("1.0 BTC")]),t._v(" to your destination.")]),t._v(" "),e("p",[t._v("Blockchain analysis will understand that those "),e("code",[t._v("0.1 BTC")]),t._v(" of change belong to the same entity which controlled "),e("code",[t._v("1.1 BTC")]),t._v(" before, and can track the future purchase you make under the same pattern.")]),t._v(" "),e("p",[t._v("By enabling this feature, BTCPay Server wallet will round up the amount sent to "),e("code",[t._v("1.1 BTC")]),t._v(" such that no change output is sent back to you.")]),t._v(" "),e("p",[t._v("Warning: Despite the fact, in this example, that you entered "),e("code",[t._v("1.0")]),t._v(" in the amount field, the amount that will really be sent to your destination will be "),e("code",[t._v("1.1 BTC")]),t._v(".")]),t._v(" "),e("h5",{attrs:{id:"rbf-replace-by-fee"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rbf-replace-by-fee"}},[t._v("#")]),t._v(" RBF (Replace-By-Fee)")]),t._v(" "),e("p",[t._v("Replace-By-Fee (RBF) is a Bitcoin protocol feature that allows you to replace a previously broadcast transaction (while unconfirmed). This allows randomizing your wallet's transaction fingerprint, or simply for replacing it with a higher fee rate to move the transaction higher in the queue of confirmation (mining) priority. This will effectively replace the original transaction as the higher fee rate will be prioritized and once confirmed, invalidating the original one (double spend).")]),t._v(" "),e("p",[t._v("Press the "),e("code",[t._v("Advanced Settings")]),t._v(" button to view the RBF options:")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(595),alt:"RBF Options",title:"RBF Options"}})]),t._v(" "),e("ul",[e("li",[t._v("Option 1 (Enabled by Default): Allow the transaction to be replaced automatically for randomization of transaction fingerprint (increased privacy)")]),t._v(" "),e("li",[t._v("Option 2: Yes, Allow the transaction to be replaced explicitly (not replaced by default)")]),t._v(" "),e("li",[t._v("Option 3: No, Do not allow the transaction to be replaced (ignore replacement)")])]),t._v(" "),e("h5",{attrs:{id:"coin-selection"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#coin-selection"}},[t._v("#")]),t._v(" Coin Selection")]),t._v(" "),e("p",[t._v("Coin selection is an advanced "),e("strong",[t._v("privacy-enhancing feature")]),t._v(" that allows you to "),e("strong",[t._v("specifically select coins")]),t._v(" that you would like to spend when crafting a transaction. For example, paying with coins that are fresh from a coinjoin mix.")]),t._v(" "),e("p",[t._v("To make the selection easier, coin-selection works natively with the wallet labels feature. This allows you to label any incoming funds for smoother UTXO management and spending.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(596),alt:"Coin Selection",title:"Coin Selection"}})]),t._v(" "),e("h5",{attrs:{id:"other-features"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#other-features"}},[t._v("#")]),t._v(" Other features")]),t._v(" "),e("h6",{attrs:{id:"camera-qr-scan"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#camera-qr-scan"}},[t._v("#")]),t._v(" Camera QR scan")]),t._v(" "),e("p",[t._v("Scan option in wallet (camera icon in send screen) lets you "),e("strong",[t._v("use your device’s camera to scan a QR code containing an address or BIP21 payment link")]),t._v(". It auto-populates the sending information so that you don’t have to manually copy-paste an address and amount.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(597),alt:"QR Scan",title:"QR Scan"}})]),t._v(" "),e("h6",{attrs:{id:"paste-bip21-address"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paste-bip21-address"}},[t._v("#")]),t._v(" Paste BIP21 address")]),t._v(" "),e("p",[t._v("This option "),e("strong",[t._v("decodes a BIP21 payment link")]),t._v(". It's useful when you're trying to pay a "),e("RouterLink",{attrs:{to:"/Payjoin/"}},[t._v("Payjoin")]),t._v(" invoice.")],1),t._v(" "),e("h3",{attrs:{id:"receive"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#receive"}},[t._v("#")]),t._v(" Receive")]),t._v(" "),e("p",[t._v("The Receive tab "),e("strong",[t._v("generates an unused address which can be used to receive payments")]),t._v(". The same can be achieved by generating an invoice (Invoices > Create new invoice).")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(598),alt:"Wallet Receive",title:"Wallet Receive"}})]),t._v(" "),e("h3",{attrs:{id:"pull-payments"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pull-payments"}},[t._v("#")]),t._v(" Pull Payments")]),t._v(" "),e("p",[t._v("This feature gives you the ability to "),e("strong",[t._v("create a Pull Payment")]),t._v(", so that an outside individual may request to "),e("code",[t._v("pull")]),t._v(" funds from your wallet.")]),t._v(" "),e("p",[t._v("For more information, see "),e("RouterLink",{attrs:{to:"/PullPayments/"}},[t._v("Pull Payments")]),t._v(".")],1),t._v(" "),e("h3",{attrs:{id:"payouts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#payouts"}},[t._v("#")]),t._v(" Payouts")]),t._v(" "),e("p",[t._v("This section lets you manage Pull Payments and gives you the ability to "),e("strong",[t._v("accept or decline payouts requested by outside individuals")]),t._v(".")]),t._v(" "),e("p",[t._v("For more information, see "),e("RouterLink",{attrs:{to:"/PullPayments/#approve-and-pay-a-payout"}},[t._v("Payouts")]),t._v(".")],1),t._v(" "),e("h3",{attrs:{id:"re-scan"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#re-scan"}},[t._v("#")]),t._v(" Re-scan")]),t._v(" "),e("p",[t._v("The Rescan relies on Bitcoin Core 0.17.0's "),e("code",[t._v("scantxoutset")]),t._v(" to "),e("strong",[t._v("scan the current state of the blockchain")]),t._v(" (called UTXO Set) for coins belonging to the configured derivation scheme.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(599),alt:"Wallet Rescan",title:"Wallet Rescan"}})]),t._v(" "),e("p",[t._v("Wallet re-scan solves two critical problems for BTCPay users:")]),t._v(" "),e("ol",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#missing-payments-in-my-software-or-hardware-wallet"}},[t._v("Gap limit")])],1),t._v(" "),e("li",[t._v("Importing a previously used wallet")])]),t._v(" "),e("p",[e("strong",[t._v("Gap limit")]),t._v(": Most wallets typically have the address gap limit set to 20. This means that if a merchant receives 21 or more consecutive unpaid invoices, those wallets show the incorrect balance and some transactions may not be visible.")]),t._v(" "),e("p",[e("strong",[t._v("Wallet import")]),t._v(": When users add a derivation scheme of a wallet that had transactions in the past (previously used wallet), BTCPay won't be able to show the balance and transactions from the past.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(600),alt:"Wallet rescan progress",title:"Wallet rescan progress"}})]),t._v(" "),e("p",[t._v("Re-scan is a feature that solves both of these problems. Once the scan is complete, BTCPay Server will show the correct balance, along with the past transactions of the wallet.")]),t._v(" "),e("p",[t._v("Wallet re-scan requires access to the full node which means that this function is only available for server owners.")]),t._v(" "),e("p",[t._v("Users who use a third-party host should use a newly generated xpub key and also use an external wallet like Electrum which allows them to increase the gap limit.")]),t._v(" "),e("h3",{attrs:{id:"settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#settings"}},[t._v("#")]),t._v(" Settings")]),t._v(" "),e("p",[t._v("In the top right corner of your "),e("code",[t._v("wallet")]),t._v(" you will find the "),e("code",[t._v("wallet settings")]),t._v(".\nIn the wallet settings tab you can adjust certain settings. If you've configured your wallet by "),e("RouterLink",{attrs:{to:"/CreateWallet/"}},[t._v("creating a new wallet")]),t._v(" or using an existing wallet via the "),e("RouterLink",{attrs:{to:"/HardwareWalletIntegration/"}},[t._v("hardware wallet integration")]),t._v(" these settings will be pre-configured.")],1),t._v(" "),e("p",[t._v("If you manually added the extended public key from an external wallet, you'd need to adjust "),e("code",[t._v("AccountKeyPath")]),t._v(" that you can find in your external wallet, for example "),e("code",[t._v("m/84'/0'/0'")]),t._v(" to be able to spend from the BTCPay Wallet.")]),t._v(" "),e("p",[t._v("In "),e("code",[t._v("wallet settings")]),t._v(" you will also find the "),e("code",[t._v("speed policy")]),t._v(" for the specific store.\nThere are 2 main settings under "),e("code",[t._v("Payment")]),t._v(", "),e("RouterLink",{attrs:{to:"/FAQ/Stores/#payment-invalid-if-transactions-fails-to-confirm--minutes-after-invoice-expiration"}},[t._v("Payment invalid if transaction fails to confirm in ... after invoice creation")]),t._v(" and "),e("RouterLink",{attrs:{to:"/FAQ/Stores/#consider-the-invoice-confirmed-when-the-payment-transaction"}},[t._v("Consider the invoice confirmed when the payment transaction...")]),t._v(". The latter lets you set the number of confirmations required to be recognized as settled.")],1),t._v(" "),e("figure",[e("img",{attrs:{src:a(601),alt:"Wallet settings",title:"Wallet settings"}})])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[22],{610:function(t,e,a){t.exports=a.p+"assets/img/WalletTransactions.c905309a.jpg"},611:function(t,e,a){t.exports=a.p+"assets/img/WalletSend.f65f1a74.jpg"},612:function(t,e,a){t.exports=a.p+"assets/img/WalletRBF.2dea1e29.jpg"},613:function(t,e,a){t.exports=a.p+"assets/img/CoinSelection.9d40e6ee.jpg"},614:function(t,e,a){t.exports=a.p+"assets/img/ScanWallet.61243593.jpg"},615:function(t,e,a){t.exports=a.p+"assets/img/WalletReceive.cb4b9f39.jpg"},616:function(t,e,a){t.exports=a.p+"assets/img/WalletRescan.1d081027.jpg"},617:function(t,e,a){t.exports=a.p+"assets/img/WalletRescanProgress.05a8b0f7.jpg"},618:function(t,e,a){t.exports=a.p+"assets/img/btcpayserverwalletsettings1.97911174.jpg"},801:function(t,e,a){"use strict";a.r(e);var n=a(9),s=Object(n.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"btcpay-server-wallet"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#btcpay-server-wallet"}},[t._v("#")]),t._v(" BTCPay Server Wallet")]),t._v(" "),e("p",[t._v("BTCPay Server has a built in, "),e("strong",[t._v("full-node reliant wallet")]),t._v(" that allows for easy funds management.")]),t._v(" "),e("p",[t._v("Each "),e("RouterLink",{attrs:{to:"/CreateStore/"}},[t._v("store")]),t._v("'s configured cryptocurrency has a separate wallet displayed under Wallets in the menu bar.")],1),t._v(" "),e("h2",{attrs:{id:"wallet-features"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#wallet-features"}},[t._v("#")]),t._v(" Wallet features")]),t._v(" "),e("p",[t._v("The wallet contains the following features:")]),t._v(" "),e("ol",[e("li",[t._v("Transactions")]),t._v(" "),e("li",[t._v("Send")]),t._v(" "),e("li",[t._v("Receive")]),t._v(" "),e("li",[t._v("Rescan")]),t._v(" "),e("li",[t._v("Pull payments")]),t._v(" "),e("li",[t._v("Payouts")]),t._v(" "),e("li",[t._v("PSBT")]),t._v(" "),e("li",[t._v("Settings")])]),t._v(" "),e("h3",{attrs:{id:"transactions"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transactions"}},[t._v("#")]),t._v(" Transactions")]),t._v(" "),e("p",[t._v("An overview of the incoming (green), outgoing (red) and unconfirmed (grayed out) "),e("strong",[t._v("transactions")]),t._v(" displayed together with timestamps and balances, sorted by date. You can click on the transaction ID to view the transaction details on the block explorer.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(610),alt:"Individual Wallet",title:"Individual Wallet"}})]),t._v(" "),e("h4",{attrs:{id:"transaction-labels"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#transaction-labels"}},[t._v("#")]),t._v(" Transaction Labels")]),t._v(" "),e("p",[t._v("The table below lists the various "),e("strong",[t._v("transaction labels used by BTCPay")]),t._v(".")]),t._v(" "),e("table",[e("thead",[e("tr",[e("th",[t._v("Transaction Type")]),t._v(" "),e("th",[t._v("Description")])])]),t._v(" "),e("tbody",[e("tr",[e("td",[t._v("app")]),t._v(" "),e("td",[t._v("Payment was received through an app created invoice")])]),t._v(" "),e("tr",[e("td",[t._v("invoice")]),t._v(" "),e("td",[t._v("Payment was received through an invoice")])]),t._v(" "),e("tr",[e("td",[t._v("payjoin")]),t._v(" "),e("td",[t._v("Not paid, invoice timer still has not expired")])]),t._v(" "),e("tr",[e("td",[t._v("payjoin-exposed")]),t._v(" "),e("td",[t._v("UTXO was exposed through an invoice payjoin proposal")])]),t._v(" "),e("tr",[e("td",[t._v("payment-request")]),t._v(" "),e("td",[t._v("Payment was received through a payment request")])]),t._v(" "),e("tr",[e("td",[t._v("payout")]),t._v(" "),e("td",[t._v("Payment was sent through a payout or refund")])])])]),t._v(" "),e("p",[t._v("You can also create your own "),e("RouterLink",{attrs:{to:"/FAQ/Wallet/#how-to-add-custom-labels-and-comments-to-transactions"}},[t._v("custom transaction labels and comments")]),t._v(".")],1),t._v(" "),e("h3",{attrs:{id:"send"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#send"}},[t._v("#")]),t._v(" Send")]),t._v(" "),e("p",[t._v("The Send function allows "),e("strong",[t._v("spending of the funds from the BTCPay wallet")]),t._v(".")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(611),alt:"Send from the Wallet",title:"Send from the Wallet"}})]),t._v(" "),e("h4",{attrs:{id:"signing-a-transaction-spending"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#signing-a-transaction-spending"}},[t._v("#")]),t._v(" Signing a transaction (spending)")]),t._v(" "),e("p",[t._v("To spend the funds, you are required to "),e("strong",[t._v("sign")]),t._v(" the transaction. Transactions can be signed with:")]),t._v(" "),e("ul",[e("li",[t._v("Hardware Wallet")]),t._v(" "),e("li",[t._v("Wallet supporting PSBT")]),t._v(" "),e("li",[t._v("HD private key or recovery seed")]),t._v(" "),e("li",[t._v("Hot Wallet")])]),t._v(" "),e("h5",{attrs:{id:"signing-with-hd-private-key-or-mnemonic-seed"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#signing-with-hd-private-key-or-mnemonic-seed"}},[t._v("#")]),t._v(" Signing with HD Private Key or mnemonic seed")]),t._v(" "),e("p",[t._v("If you set up an "),e("RouterLink",{attrs:{to:"/WalletSetup/#use-an-existing-wallet"}},[t._v("existing wallet with your BTCPay Server")]),t._v(", you can spend the funds by inputting your private key into an appropriate field. Make sure to set a proper "),e("code",[t._v("AccountKeyPath")]),t._v(" in Wallet > Settings otherwise you won't be able to spend.")],1),t._v(" "),e("h5",{attrs:{id:"signing-with-a-wallet-supporting-psbt"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#signing-with-a-wallet-supporting-psbt"}},[t._v("#")]),t._v(" Signing with a wallet supporting PSBT")]),t._v(" "),e("p",[t._v("PSBT ("),e("strong",[t._v("Partially Signed Bitcoin transactions")]),t._v(") is an interchange format for Bitcoin transactions that are not fully signed yet.\nPSBT is supported in BTCPay Server and can be signed with compatible hardware and software wallets.")]),t._v(" "),e("p",[t._v("The construction of a fully signed Bitcoin transaction goes through the following steps:")]),t._v(" "),e("ul",[e("li",[t._v("A PSBT gets constructed with certain inputs and outputs, but no signatures")]),t._v(" "),e("li",[t._v("The exported PSBT can be imported by a wallet that supports this format")]),t._v(" "),e("li",[t._v("The transaction data can be inspected and signed using the wallet")]),t._v(" "),e("li",[t._v("The signed PSBT file gets exported from the wallet and imported with BTCPay Server")]),t._v(" "),e("li",[t._v("BTCPay Server produces the final Bitcoin transaction")]),t._v(" "),e("li",[t._v("You verify the result and broadcast it to the network")])]),t._v(" "),e("p",[t._v("Check this tutorial on how to "),e("RouterLink",{attrs:{to:"/ColdCardWallet/#spending-from-btcpay-server-wallet-with-coldcard-psbt"}},[t._v("sign a PSBT transaction with ColdCard Hardware Wallet")]),t._v(", completely offline/air-gapped.")],1),t._v(" "),e("h5",{attrs:{id:"signing-with-a-hardware-wallet"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#signing-with-a-hardware-wallet"}},[t._v("#")]),t._v(" Signing with a hardware wallet")]),t._v(" "),e("p",[t._v("BTCPay Server has built-in hardware wallet support allowing you to "),e("strong",[t._v("use your hardware wallet with BTCPay")]),t._v(", without leaking information to third-party apps or servers.")]),t._v(" "),e("p",[e("RouterLink",{attrs:{to:"/HardwareWalletIntegration/"}},[t._v("Check instructions")]),t._v(" on how to set up and sign with a "),e("a",{attrs:{href:"https://github.com/bitcoin-core/HWI#device-support",target:"_blank",rel:"noopener noreferrer"}},[t._v("compatible hardware wallet"),e("OutboundLink")],1),t._v(".")],1),t._v(" "),e("h5",{attrs:{id:"signing-with-a-hot-wallet"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#signing-with-a-hot-wallet"}},[t._v("#")]),t._v(" Signing with a hot wallet")]),t._v(" "),e("p",[t._v("If you "),e("RouterLink",{attrs:{to:"/CreateWallet/"}},[t._v("created a new wallet")]),t._v(" when setting up your store and enabled it as a "),e("RouterLink",{attrs:{to:"/CreateWallet/#hot-wallet"}},[t._v("hot wallet")]),t._v(", since version 1.2.0, we've added an option that when a "),e("RouterLink",{attrs:{to:"/CreateWallet/#hot-wallet"}},[t._v("hot wallet")]),t._v(" is created, it'll automatically use the seed stored on a server to sign.")],1),t._v(" "),e("div",{staticClass:"custom-block danger"},[e("p",{staticClass:"custom-block-title"},[t._v("DANGER")]),t._v(" "),e("p",[t._v("Using the hot wallet feature comes with security implications; please be sure to read and understand them over at the "),e("RouterLink",{attrs:{to:"/CreateWallet/#security-implications"}},[t._v("Hot Wallet documentation")])],1)]),t._v(" "),e("h4",{attrs:{id:"advanced-settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#advanced-settings"}},[t._v("#")]),t._v(" Advanced Settings")]),t._v(" "),e("p",[t._v("Certain wallet features are available for advanced users. Toggle the "),e("code",[t._v("Advanced Settings")]),t._v(" within the "),e("code",[t._v("Send")]),t._v(" tab to preview them.")]),t._v(" "),e("h5",{attrs:{id:"dont-create-utxo-change"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#dont-create-utxo-change"}},[t._v("#")]),t._v(" Don't create UTXO change")]),t._v(" "),e("p",[t._v("This option is available in the "),e("code",[t._v("Advanced mode")]),t._v(" of the "),e("code",[t._v("Send")]),t._v(" page.")]),t._v(" "),e("p",[t._v("It is a privacy enhancing feature which is useful when you're sending funds to another wallet of yours or to an exchange. It makes sure that no change UTXO is created by "),e("strong",[t._v("rounding up")]),t._v(" the amount sent.")]),t._v(" "),e("p",[t._v("By default this feature is disabled, so if your wallet has a UTXO of "),e("code",[t._v("1.1 BTC")]),t._v(" and you input an amount equal to "),e("code",[t._v("1.0 BTC")]),t._v(", the resulting transaction will have two outputs "),e("code",[t._v("0.1 BTC")]),t._v(" of change, and "),e("code",[t._v("1.0 BTC")]),t._v(" to your destination.")]),t._v(" "),e("p",[t._v("Blockchain analysis will understand that those "),e("code",[t._v("0.1 BTC")]),t._v(" of change belong to the same entity which controlled "),e("code",[t._v("1.1 BTC")]),t._v(" before, and can track the future purchase you make under the same pattern.")]),t._v(" "),e("p",[t._v("By enabling this feature, BTCPay Server wallet will round up the amount sent to "),e("code",[t._v("1.1 BTC")]),t._v(" such that no change output is sent back to you.")]),t._v(" "),e("p",[t._v("Warning: Despite the fact, in this example, that you entered "),e("code",[t._v("1.0")]),t._v(" in the amount field, the amount that will really be sent to your destination will be "),e("code",[t._v("1.1 BTC")]),t._v(".")]),t._v(" "),e("h5",{attrs:{id:"rbf-replace-by-fee"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#rbf-replace-by-fee"}},[t._v("#")]),t._v(" RBF (Replace-By-Fee)")]),t._v(" "),e("p",[t._v("Replace-By-Fee (RBF) is a Bitcoin protocol feature that allows you to replace a previously broadcast transaction (while unconfirmed). This allows randomizing your wallet's transaction fingerprint, or simply for replacing it with a higher fee rate to move the transaction higher in the queue of confirmation (mining) priority. This will effectively replace the original transaction as the higher fee rate will be prioritized and once confirmed, invalidating the original one (double spend).")]),t._v(" "),e("p",[t._v("Press the "),e("code",[t._v("Advanced Settings")]),t._v(" button to view the RBF options:")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(612),alt:"RBF Options",title:"RBF Options"}})]),t._v(" "),e("ul",[e("li",[t._v("Option 1 (Enabled by Default): Allow the transaction to be replaced automatically for randomization of transaction fingerprint (increased privacy)")]),t._v(" "),e("li",[t._v("Option 2: Yes, Allow the transaction to be replaced explicitly (not replaced by default)")]),t._v(" "),e("li",[t._v("Option 3: No, Do not allow the transaction to be replaced (ignore replacement)")])]),t._v(" "),e("h5",{attrs:{id:"coin-selection"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#coin-selection"}},[t._v("#")]),t._v(" Coin Selection")]),t._v(" "),e("p",[t._v("Coin selection is an advanced "),e("strong",[t._v("privacy-enhancing feature")]),t._v(" that allows you to "),e("strong",[t._v("specifically select coins")]),t._v(" that you would like to spend when crafting a transaction. For example, paying with coins that are fresh from a coinjoin mix.")]),t._v(" "),e("p",[t._v("To make the selection easier, coin-selection works natively with the wallet labels feature. This allows you to label any incoming funds for smoother UTXO management and spending.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(613),alt:"Coin Selection",title:"Coin Selection"}})]),t._v(" "),e("h5",{attrs:{id:"other-features"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#other-features"}},[t._v("#")]),t._v(" Other features")]),t._v(" "),e("h6",{attrs:{id:"camera-qr-scan"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#camera-qr-scan"}},[t._v("#")]),t._v(" Camera QR scan")]),t._v(" "),e("p",[t._v("Scan option in wallet (camera icon in send screen) lets you "),e("strong",[t._v("use your device’s camera to scan a QR code containing an address or BIP21 payment link")]),t._v(". It auto-populates the sending information so that you don’t have to manually copy-paste an address and amount.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(614),alt:"QR Scan",title:"QR Scan"}})]),t._v(" "),e("h6",{attrs:{id:"paste-bip21-address"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#paste-bip21-address"}},[t._v("#")]),t._v(" Paste BIP21 address")]),t._v(" "),e("p",[t._v("This option "),e("strong",[t._v("decodes a BIP21 payment link")]),t._v(". It's useful when you're trying to pay a "),e("RouterLink",{attrs:{to:"/Payjoin/"}},[t._v("Payjoin")]),t._v(" invoice.")],1),t._v(" "),e("h3",{attrs:{id:"receive"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#receive"}},[t._v("#")]),t._v(" Receive")]),t._v(" "),e("p",[t._v("The Receive tab "),e("strong",[t._v("generates an unused address which can be used to receive payments")]),t._v(". The same can be achieved by generating an invoice (Invoices > Create new invoice).")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(615),alt:"Wallet Receive",title:"Wallet Receive"}})]),t._v(" "),e("h3",{attrs:{id:"pull-payments"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#pull-payments"}},[t._v("#")]),t._v(" Pull Payments")]),t._v(" "),e("p",[t._v("This feature gives you the ability to "),e("strong",[t._v("create a Pull Payment")]),t._v(", so that an outside individual may request to "),e("code",[t._v("pull")]),t._v(" funds from your wallet.")]),t._v(" "),e("p",[t._v("For more information, see "),e("RouterLink",{attrs:{to:"/PullPayments/"}},[t._v("Pull Payments")]),t._v(".")],1),t._v(" "),e("h3",{attrs:{id:"payouts"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#payouts"}},[t._v("#")]),t._v(" Payouts")]),t._v(" "),e("p",[t._v("This section lets you manage Pull Payments and gives you the ability to "),e("strong",[t._v("accept or decline payouts requested by outside individuals")]),t._v(".")]),t._v(" "),e("p",[t._v("For more information, see "),e("RouterLink",{attrs:{to:"/PullPayments/#approve-and-pay-a-payout"}},[t._v("Payouts")]),t._v(".")],1),t._v(" "),e("h3",{attrs:{id:"re-scan"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#re-scan"}},[t._v("#")]),t._v(" Re-scan")]),t._v(" "),e("p",[t._v("The Rescan relies on Bitcoin Core 0.17.0's "),e("code",[t._v("scantxoutset")]),t._v(" to "),e("strong",[t._v("scan the current state of the blockchain")]),t._v(" (called UTXO Set) for coins belonging to the configured derivation scheme.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(616),alt:"Wallet Rescan",title:"Wallet Rescan"}})]),t._v(" "),e("p",[t._v("Wallet re-scan solves two critical problems for BTCPay users:")]),t._v(" "),e("ol",[e("li",[e("RouterLink",{attrs:{to:"/FAQ/Wallet/#missing-payments-in-my-software-or-hardware-wallet"}},[t._v("Gap limit")])],1),t._v(" "),e("li",[t._v("Importing a previously used wallet")])]),t._v(" "),e("p",[e("strong",[t._v("Gap limit")]),t._v(": Most wallets typically have the address gap limit set to 20. This means that if a merchant receives 21 or more consecutive unpaid invoices, those wallets show the incorrect balance and some transactions may not be visible.")]),t._v(" "),e("p",[e("strong",[t._v("Wallet import")]),t._v(": When users add a derivation scheme of a wallet that had transactions in the past (previously used wallet), BTCPay won't be able to show the balance and transactions from the past.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(617),alt:"Wallet rescan progress",title:"Wallet rescan progress"}})]),t._v(" "),e("p",[t._v("Re-scan is a feature that solves both of these problems. Once the scan is complete, BTCPay Server will show the correct balance, along with the past transactions of the wallet.")]),t._v(" "),e("p",[t._v("Wallet re-scan requires access to the full node which means that this function is only available for server owners.")]),t._v(" "),e("p",[t._v("Users who use a third-party host should use a newly generated xpub key and also use an external wallet like Electrum which allows them to increase the gap limit.")]),t._v(" "),e("h3",{attrs:{id:"settings"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#settings"}},[t._v("#")]),t._v(" Settings")]),t._v(" "),e("p",[t._v("In the top right corner of your "),e("code",[t._v("wallet")]),t._v(" you will find the "),e("code",[t._v("wallet settings")]),t._v(".\nIn the wallet settings tab you can adjust certain settings. If you've configured your wallet by "),e("RouterLink",{attrs:{to:"/CreateWallet/"}},[t._v("creating a new wallet")]),t._v(" or using an existing wallet via the "),e("RouterLink",{attrs:{to:"/HardwareWalletIntegration/"}},[t._v("hardware wallet integration")]),t._v(" these settings will be pre-configured.")],1),t._v(" "),e("p",[t._v("If you manually added the extended public key from an external wallet, you'd need to adjust "),e("code",[t._v("AccountKeyPath")]),t._v(" that you can find in your external wallet, for example "),e("code",[t._v("m/84'/0'/0'")]),t._v(" to be able to spend from the BTCPay Wallet.")]),t._v(" "),e("p",[t._v("In "),e("code",[t._v("wallet settings")]),t._v(" you will also find the "),e("code",[t._v("speed policy")]),t._v(" for the specific store.\nThere are 2 main settings under "),e("code",[t._v("Payment")]),t._v(", "),e("RouterLink",{attrs:{to:"/FAQ/Stores/#payment-invalid-if-transactions-fails-to-confirm--minutes-after-invoice-expiration"}},[t._v("Payment invalid if transaction fails to confirm in ... after invoice creation")]),t._v(" and "),e("RouterLink",{attrs:{to:"/FAQ/Stores/#consider-the-invoice-confirmed-when-the-payment-transaction"}},[t._v("Consider the invoice confirmed when the payment transaction...")]),t._v(". The latter lets you set the number of confirmations required to be recognized as settled.")],1),t._v(" "),e("figure",[e("img",{attrs:{src:a(618),alt:"Wallet settings",title:"Wallet settings"}})])])}),[],!1,null,null,null);e.default=s.exports}}]); \ No newline at end of file diff --git a/assets/js/23.da0d52fa.js b/assets/js/23.25a968f1.js similarity index 83% rename from assets/js/23.da0d52fa.js rename to assets/js/23.25a968f1.js index ef5013f084..6d26d2e78f 100644 --- a/assets/js/23.da0d52fa.js +++ b/assets/js/23.25a968f1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{329:function(t,a,e){t.exports=e.p+"assets/img/dashboardgif.e52489e5.gif"},330:function(t,a,e){t.exports=e.p+"assets/img/wallet-view.7dad96c7.jpg"},331:function(t,a,e){t.exports=e.p+"assets/img/tx-activity-view.8254b07e.jpg"},332:function(t,a,e){t.exports=e.p+"assets/img/btcpayLNDashboard3.e08e2f1f.jpg"},333:function(t,a,e){t.exports=e.p+"assets/img/btcpayLNDashboard4.946731bb.jpg"},334:function(t,a,e){t.exports=e.p+"assets/img/recent-tx-view.34d9cd12.jpg"},335:function(t,a,e){t.exports=e.p+"assets/img/recent-invoice-view.d6235bab.jpg"},336:function(t,a,e){t.exports=e.p+"assets/img/fund-full-view.79683f5c.jpg"},697:function(t,a,e){"use strict";e.r(a);var i=e(9),r=Object(i.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"dashboard"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#dashboard"}},[t._v("#")]),t._v(" Dashboard")]),t._v(" "),a("p",[t._v("BTCPay Server version 1.5.0 introduced a new dashboard concept that features several tiles that will help with the initial setup, better understand the store's data and manage refunds and payouts with ease.")]),t._v(" "),a("figure",[a("img",{attrs:{src:e(329),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),a("p",[t._v("Balance graph and recent transactions are available only for an on-chain payment method.\nInformation about Lightning network balances and transactions is on the to-do. As of BTCPay Server Version 1.6.0, basic Lightning Network balances are available.")])]),t._v(" "),a("h2",{attrs:{id:"dashboard-tiles"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#dashboard-tiles"}},[t._v("#")]),t._v(" Dashboard tiles")]),t._v(" "),a("p",[t._v("In the main dashboard view, you'll find a couple of tiles that we think could help you quickly overview your store's performance.")]),t._v(" "),a("h3",{attrs:{id:"wallet-balance"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#wallet-balance"}},[t._v("#")]),t._v(" Wallet Balance")]),t._v(" "),a("p",[t._v("The current store's "),a("RouterLink",{attrs:{to:"/Wallet/"}},[t._v("wallet")]),t._v(" balance, showing a graph by week, month, or year.")],1),t._v(" "),a("figure",[a("img",{attrs:{src:e(330),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("h3",{attrs:{id:"transaction-activity"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#transaction-activity"}},[t._v("#")]),t._v(" Transaction activity")]),t._v(" "),a("p",[t._v("Quickly manage pending payouts, view recent transactions, and overview outstanding "),a("RouterLink",{attrs:{to:"/Refund/"}},[t._v("refunds")])],1),t._v(" "),a("figure",[a("img",{attrs:{src:e(331),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("h3",{attrs:{id:"lightning-balance"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#lightning-balance"}},[t._v("#")]),t._v(" Lightning Balance")]),t._v(" "),a("p",[t._v("This will show the available balances for your Lightning node.\nPlease note that the on-chain balance refers to the wallet of your store's Lightning node, not the store's general on-chain wallet.")]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("Node Info")]),t._v(" will show you a quick overview of your node, it's online status and the address to connect to for peers.\nFor more information on "),a("code",[t._v("Lightning Network")]),t._v(" check our "),a("RouterLink",{attrs:{to:"/LightningNetwork/"}},[t._v("Lightning Network page")]),t._v(".")],1),t._v(" "),a("figure",[a("img",{attrs:{src:e(332),alt:"BTCPay Server Dashboard LN",title:"BTCPay Server Dashboard LN"}})]),t._v(" "),a("h3",{attrs:{id:"lightning-services"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#lightning-services"}},[t._v("#")]),t._v(" Lightning Services")]),t._v(" "),a("p",[t._v("In this tile, you will find quick buttons to "),a("code",[t._v("Lightning Network")]),t._v(" services like:")]),t._v(" "),a("ul",[a("li",[t._v("Core Lightning (REST)")]),t._v(" "),a("li",[t._v("Ride The Lightning")]),t._v(" "),a("li",[t._v("ThunderHub")]),t._v(" "),a("li",[t._v("Lightning Terminal")])]),t._v(" "),a("figure",[a("img",{attrs:{src:e(333),alt:"BTCPay Server Dashboard LN",title:"BTCPay Server Dashboard LN"}})]),t._v(" "),a("h3",{attrs:{id:"recent-transactions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#recent-transactions"}},[t._v("#")]),t._v(" Recent Transactions")]),t._v(" "),a("p",[t._v("Showcasing the five most recent transactions that arrived to your on-chain wallet.")]),t._v(" "),a("figure",[a("img",{attrs:{src:e(334),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("h3",{attrs:{id:"recent-invoices"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#recent-invoices"}},[t._v("#")]),t._v(" Recent invoices")]),t._v(" "),a("p",[t._v("The five most recent invoices are shown with their corresponding status and value allowing you to quickly access and manage a particular "),a("RouterLink",{attrs:{to:"/Invoices/"}},[t._v("invoice")]),t._v(".")],1),t._v(" "),a("figure",[a("img",{attrs:{src:e(335),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("h3",{attrs:{id:"current-active-crowdfund"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#current-active-crowdfund"}},[t._v("#")]),t._v(" Current active crowdfund")]),t._v(" "),a("p",[t._v("This tile shows the current active crowdfunds, including their top-ranked items/perks. When more than one crowdfunding app is active crowdfund is, the tiles will show below the initial one. That's an easy way to manage your active crowdfund campaigns and see all the perks and how they're performing.")]),t._v(" "),a("figure",[a("img",{attrs:{src:e(336),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),a("p",[t._v("This page is subject to change as the software progresses. Features will be updated by release.")])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{328:function(t,a,e){t.exports=e.p+"assets/img/dashboardgif.e52489e5.gif"},329:function(t,a,e){t.exports=e.p+"assets/img/wallet-view.7dad96c7.jpg"},330:function(t,a,e){t.exports=e.p+"assets/img/tx-activity-view.8254b07e.jpg"},331:function(t,a,e){t.exports=e.p+"assets/img/btcpayLNDashboard3.e08e2f1f.jpg"},332:function(t,a,e){t.exports=e.p+"assets/img/btcpayLNDashboard4.946731bb.jpg"},333:function(t,a,e){t.exports=e.p+"assets/img/recent-tx-view.34d9cd12.jpg"},334:function(t,a,e){t.exports=e.p+"assets/img/recent-invoice-view.d6235bab.jpg"},335:function(t,a,e){t.exports=e.p+"assets/img/fund-full-view.79683f5c.jpg"},695:function(t,a,e){"use strict";e.r(a);var i=e(9),r=Object(i.a)({},(function(){var t=this,a=t._self._c;return a("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[a("h1",{attrs:{id:"dashboard"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#dashboard"}},[t._v("#")]),t._v(" Dashboard")]),t._v(" "),a("p",[t._v("BTCPay Server version 1.5.0 introduced a new dashboard concept that features several tiles that will help with the initial setup, better understand the store's data and manage refunds and payouts with ease.")]),t._v(" "),a("figure",[a("img",{attrs:{src:e(328),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("div",{staticClass:"custom-block tip"},[a("p",{staticClass:"custom-block-title"},[t._v("TIP")]),t._v(" "),a("p",[t._v("Balance graph and recent transactions are available only for an on-chain payment method.\nInformation about Lightning network balances and transactions is on the to-do. As of BTCPay Server Version 1.6.0, basic Lightning Network balances are available.")])]),t._v(" "),a("h2",{attrs:{id:"dashboard-tiles"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#dashboard-tiles"}},[t._v("#")]),t._v(" Dashboard tiles")]),t._v(" "),a("p",[t._v("In the main dashboard view, you'll find a couple of tiles that we think could help you quickly overview your store's performance.")]),t._v(" "),a("h3",{attrs:{id:"wallet-balance"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#wallet-balance"}},[t._v("#")]),t._v(" Wallet Balance")]),t._v(" "),a("p",[t._v("The current store's "),a("RouterLink",{attrs:{to:"/Wallet/"}},[t._v("wallet")]),t._v(" balance, showing a graph by week, month, or year.")],1),t._v(" "),a("figure",[a("img",{attrs:{src:e(329),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("h3",{attrs:{id:"transaction-activity"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#transaction-activity"}},[t._v("#")]),t._v(" Transaction activity")]),t._v(" "),a("p",[t._v("Quickly manage pending payouts, view recent transactions, and overview outstanding "),a("RouterLink",{attrs:{to:"/Refund/"}},[t._v("refunds")])],1),t._v(" "),a("figure",[a("img",{attrs:{src:e(330),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("h3",{attrs:{id:"lightning-balance"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#lightning-balance"}},[t._v("#")]),t._v(" Lightning Balance")]),t._v(" "),a("p",[t._v("This will show the available balances for your Lightning node.\nPlease note that the on-chain balance refers to the wallet of your store's Lightning node, not the store's general on-chain wallet.")]),t._v(" "),a("p",[t._v("The "),a("code",[t._v("Node Info")]),t._v(" will show you a quick overview of your node, it's online status and the address to connect to for peers.\nFor more information on "),a("code",[t._v("Lightning Network")]),t._v(" check our "),a("RouterLink",{attrs:{to:"/LightningNetwork/"}},[t._v("Lightning Network page")]),t._v(".")],1),t._v(" "),a("figure",[a("img",{attrs:{src:e(331),alt:"BTCPay Server Dashboard LN",title:"BTCPay Server Dashboard LN"}})]),t._v(" "),a("h3",{attrs:{id:"lightning-services"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#lightning-services"}},[t._v("#")]),t._v(" Lightning Services")]),t._v(" "),a("p",[t._v("In this tile, you will find quick buttons to "),a("code",[t._v("Lightning Network")]),t._v(" services like:")]),t._v(" "),a("ul",[a("li",[t._v("Core Lightning (REST)")]),t._v(" "),a("li",[t._v("Ride The Lightning")]),t._v(" "),a("li",[t._v("ThunderHub")]),t._v(" "),a("li",[t._v("Lightning Terminal")])]),t._v(" "),a("figure",[a("img",{attrs:{src:e(332),alt:"BTCPay Server Dashboard LN",title:"BTCPay Server Dashboard LN"}})]),t._v(" "),a("h3",{attrs:{id:"recent-transactions"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#recent-transactions"}},[t._v("#")]),t._v(" Recent Transactions")]),t._v(" "),a("p",[t._v("Showcasing the five most recent transactions that arrived to your on-chain wallet.")]),t._v(" "),a("figure",[a("img",{attrs:{src:e(333),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("h3",{attrs:{id:"recent-invoices"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#recent-invoices"}},[t._v("#")]),t._v(" Recent invoices")]),t._v(" "),a("p",[t._v("The five most recent invoices are shown with their corresponding status and value allowing you to quickly access and manage a particular "),a("RouterLink",{attrs:{to:"/Invoices/"}},[t._v("invoice")]),t._v(".")],1),t._v(" "),a("figure",[a("img",{attrs:{src:e(334),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("h3",{attrs:{id:"current-active-crowdfund"}},[a("a",{staticClass:"header-anchor",attrs:{href:"#current-active-crowdfund"}},[t._v("#")]),t._v(" Current active crowdfund")]),t._v(" "),a("p",[t._v("This tile shows the current active crowdfunds, including their top-ranked items/perks. When more than one crowdfunding app is active crowdfund is, the tiles will show below the initial one. That's an easy way to manage your active crowdfund campaigns and see all the perks and how they're performing.")]),t._v(" "),a("figure",[a("img",{attrs:{src:e(335),alt:"BTCPay Server Navigation",title:"BTCPay Server Navigation"}})]),t._v(" "),a("div",{staticClass:"custom-block warning"},[a("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),a("p",[t._v("This page is subject to change as the software progresses. Features will be updated by release.")])])])}),[],!1,null,null,null);a.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/24.5d7f9e68.js b/assets/js/24.622da800.js similarity index 96% rename from assets/js/24.5d7f9e68.js rename to assets/js/24.622da800.js index b63de0eef4..2194ae879b 100644 --- a/assets/js/24.5d7f9e68.js +++ b/assets/js/24.622da800.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{340:function(t,e,a){t.exports=a.p+"assets/img/ShowCost.c993e200.png"},341:function(t,e,a){t.exports=a.p+"assets/img/ShowVM.75ac27ce.png"},342:function(t,e,a){t.exports=a.p+"assets/img/ShowPrice.e457705a.png"},343:function(t,e){t.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA6UAAAC/CAMAAAAxWooUAAAA5FBMVEX///8AAAAANWCqzPDu7fDuzKtfAABfqfDuqWAAAGCq7c6GNQAAADaGzPDNhTY1hc4AX6vNzIc1AACq7fDuzIfu7avu7c6qXwA1X4eqzM7NzKtfNQDuzM6qXzY1havNzPDNzM5fhasANYfN7atfqc6qhTY1NWCGXzYANTZfhWDN7fDNhWCqqc7NqWCqhYeGX4fN7c6GNTY1X6s1ADaqhWCGqc41AGCGNWBfhc6GzKvuqav/AADNqYeGzM5fXzYAX4c1X2A1NQA1NTaGqfDuqYdfX2BfNTaGqauGhWDNqauqqWBfAGCHyHK3AAAbIElEQVR4AeyceXubOBDGV/bY4CDAVTC0zbnu7Wzv+777/T/SwuD0XVUT9ULPwzZ6/3DJ6CFijl8lMJO/oqKixi41bkVFRUVK/yeaTGk2V0olqTrvWuxkY8/RuaQ0SueFKlOllheMOu9KinOUIz+li93K9BHhH1bz7rPOOhM17SF1qmLJ/L4uXiKiy3vbmO4fdIFOOempvX4sKzPaZUSqDdjUqWzfDo+I6BgV1kn/3RrrC+bsCltfmTu/r9P2jDrDvLDpnLaqTBDf5ByFp5Sar5QuiQo29Z8NxyZqEF2trxmlL+71MdVXqbEq2fp/WueNGqPk2oBNprRc7Smlr99AhbXD01n7881bBhXmXUrtSlxvCmte2PoYViacb3KOwlO6mm9DovOTzsHFzj/t53I2HY7SqCU1qLe+qCxKrXue8rYap8TagE2ilIuahQpTKlnNbfr8S6lMKeZ1KQ3pm5uj8JTe2aRMKQemrLP2yu7ey1RykkdKBxMqx0spCnScEmsDNnktTeoDNqHC2Hs/pWDbQynmdSkN6Jubo/CUNiU1PaVJype32MmSYrFzP1I6jFBkOLw+nc1RySN/tgmJtQGbSCnfkV++oRQqzNlZuFpWxk8p5pUpDeibnKPAlOp8NU8Knpm3Iu2/y+pB9TA/vYtezdWAipR2D48eGXUWpVeLxZRme2qMkmoDNpHSTpPHNJujwnpKl/wISK4w3PV5KcW8LqXhfJNzFJjSzsGO0pJYRXtli52jRgdbS+OOF0fu3q6sTFJ0n2qEsmvDsUGWbwxRigo7RWrZUZp6l1I/pZjXpTSUb3KOwlOqyvqo4Iiyi092su4/vCEpjVqSfSeGclrsWpSuL3PkR3pvurBqw7GxRN/wHIlHkjrzUYrf5acU87qUBvNNzlF4SnVOxemcZf2033MPSmnUVbptlLrO38QA3QOln63m39bnqNdSuzZsGwTfFs9vmPaIGlRYphbT+sCcTWkJo5/SVjKlAX2TcxSeUnYxSbeGF7iyr98Wq6hB3mo4zqx6e3DUvejgfEs46vtSpzbESoZv+vEx8REqLP36VsMeKsz7bOZ0ttVcmhc2UBrQN+RoPG8IRkW9/FFFRUqjIqWR0qgoUb9SfDFQkdKoSGmktKRGDako/ZjolTnD1vdypFbv4liL7/rj20LHJd028qhcTd5eUv16+7xJsiFWan2JeF53tgA5wgMx5OgPozRK56nRSWVkm86bMfeXovj0VarJefF4c6Amu5WRR/3VJDXA6DdGTfLVXLbhgevbA8OvS7izhciRKusbSr17b+foT9rxRpV9624h2VB5o+wvtYrvg9AewEW8pAajZ/ScEtZI/7vrzEQm2kApbOhXdWcbLEfrjZujSOkf+Iogf0o2ey3ln0ZKqXIo5YvmSsbo2T2nE3bau5QCD8EmUop+VWG2oXJUst3KUXBK4Yt+TP0+ez2l+vbH7nr4G11rVOetgT2HcAa/T031gf37ouyaQV+lY9M50as9p3dx9JTCD/4EpejLtKpJok9eSh/ca2QbYsXi8CGuwmwD5ah17MGGZpmco9CUfnp9Q026a1lvbhv9jCqzfRHaHuW/hWHv2XFGe3Ri1CE1CmfYipQWWCBE22RaZ07Rjp5SrDfrTWVAqd2XuQQ3DzaFr5cUu1WfDbHi1+b4A7JnGypHOqfbRid1JucoMKXdtIxf0m8nQClGt1l4xj9BOCOpDMfFOiPqJyjFRgU3POOnFK0Ek5xAKfoybUqJN1yeBhjoIkMv2RArnu629ZcwnNkGyxEvUzyxnKPAO17VU9WH16YUoxwKaniIWI3CGTonVmqdEfXDO16FoKF3ceyUQt1W8GlnBqXoy7SqST9w6JPu8ECeY0OssAyjX1WYbaAc4Q7Vk6PglPKRj9Ly210IzsD96i9RGp8eYWuC3sWxU+r2bWAUfZk2pejh8y2l2MoKNsQKl4J+VWG2oXLUT5mkvhwFpxTXI1O63hzgwbrsQaT0157yI3Ru7+L4KYUzGEVfpk0piPIvpf611Ckz9KsKsw2Vo7LO+MiXo+CUqiVdU5PXRzKlfHk6t5+Y4Yz1plv+b34236c0vtXA7by2TX9R/GDC6l0cOaXwY/Kl2/Q2GEUXmEMpd5r6e0nVze4Nhl3ECjYrVoAW/arCbEPlaLFb7XHHrCdH4SlVhxua3ecgu5Rug89hgnDG5PGGaP/k+5TGNwRRAbCtp0SzvdH2l6L4dE6syij48faIaHbjv6NPJErx98L9vaQcjfo2YgWbFSuV/NvefTA3jxxpHC/pdCu5Nqk2vfmCLr/B2Zeds/39v4851Io/ltye1esBC9NQt8NiAcxMNwYPCZLz14MqveNV49HG5+iw9eJ4jtZa1eBx5lQtKmq1feettB+12v5890zxkR9blm5RUSodt2wqlX5tZCLGW2w5SqUVtY63olRaKrXucQJKLQExd0J20d/emp4vjZjOgPhU0Zyk6cAcrcKXQnJKpWGcnl1EhkzPl0ZMZ0B8qigTaToyRyuodPh72/fvr1Y13OxmfW6+NGY/Q5ZMRYlI0/E5KpVufIXgRz9+ErCLiVXaKkpAmg7M0SoqxYje+Xm0Xbe/DMcE6fmzdnj/qtZ2NvO2wzqx3XlP/+Zef8twrXo27tnZbtf+p3Ut5KKtnLW4+e5/7Uio693C7KOez3/clmk8Oc5Ffto6Orra/vrqLAdfer+MmPhsFSUgTYfmaAWVYkTd2LevIb9oFyIgSBvM9qK5KrQTf/XbF+3l5din56tGn371of4W4lr1bNyz64s3rZcnWhzloq2ctWjLGy//9192l+Go5/Pmm9A+/chFZ9o6OkiuffTj1nECvjRYHBsQn4eK5iVNx+doBZViRO+rtEVEkHrVaffzi6/XN95ReAh+/S3DterZuJ5MtJCLkLMWrf49FPREz56r5CI/bR0dvAOu22vz9HwpplOExOehonlJ0/E5WkGlGNEjVV2//vqRIiJIaU+D9mK2L4o+HcamDnGtetZxG/b2o4kWctFWolrctBd7KuWNu//eXS7y09bRkacpL9Mp+NJWvAiJz0NFiUjT8Tk6sUrlQ3S38a+/ff23x58Muyo93Lq7Kxa/l45zrXqOVaqFXERfpXre9fEvuw/Kgyp9+DcT167f1HxpMJch8XmoKBFpOj5Hp1dpKzeciY/aFzshQaqFBu14u7nxfQ4vxLXqWcd60UIu/SdeKtWzbxwilWrr6BJ/6TMBXxqUGhCfKspEmo7P0clVihHd38v7Ks9/9/P2GeDKUQQpqvQ3R2rxTrb7xPbqQKS2/hbjWvVsXN/naCEXIWctqFTP+w+8T9tXE5FKtXV0hF004ZPzpeShjoj4VFEm0nR8jk6uUoxoK6x9KLu6/Tniqx+2PSFBervv1ZFaQKi7bz//+faLcv0tw7Xq+Xjcp19Djlr4h5CzFlSq572pwv//YjdXkUq1dXSEXfQwNTlfiulUR0R8quhbCUjTgTlKuNreqy2lLb/u4aE9y2XRnmsReX7StJiY889ZPg9QquNaksuCPZdK85OmpdJP28OIO36AUh3XklxKpUWulUorNh2l0vIvLf9SW7n40qCO82e/f/v8wyO3z23wpeVfWv6ltnLyperY/7B4/eUH3D63wZeWf2nxpbZy8qXquG4H2i9b3D63wZeWf2nxpYetH2TkS9XR7uTbG/vwk39+vjS9f2nFMk5BtlLxpUFtlxdv9uznwe0zP1+a3b+0YiHXPVsZ+VLZ75fkXPxLE9Cd22d2vjS/f2nF8ipNyJfKfifS9scudocPbp8J+dL8/qUVp33izciXyn7/v48uL46o/P9MzZfm9y9dPurbo88y8qWyx+ce3D5z86X5/UuXj/olJiVfKvumlXtun9n50vz+pRULeWPaSsmXqqPdye3/uH2m50vz+5dWLOqN+VkyvjSo4/uvX/7D8xfcPhPwpUn9Sysqii9N4F9aUVF8aXL/0opSaUXxpRWl0lLpsl5MKKEEfwvhX3/0bi6+FDOZgC91/VquF+/uU6UCSpaDL9Wf4FqqypPzpaXSj/754ivzMAlfipmcni91/doP6PtfRFCl9/kWFzoDX6q/KClVBnM0q0r7R/oq1XaF+IWBp1nVgLyami91/SxvuG46QJUex/Wv2ol5+FL9Ca6lqjw9X1oqNfBk/qV70U7vX+r6tVTx0X9OhrUV9leZ+FL9CT6sqlyBL+17gd4ypz/8+M7DqV0HDqB8Sb/R2dNoN/c9TfUXuYfyII28VOV8893DYpPgaKDSqVbbYyaxi7Or1JpdVKlon9raiZn4Uv0JjjeqXIEv7XuB3rzebx2plAOoCftGZ0+jvfzDfU9T/UXuoVZPB16qcr5DIi6vwqOxSuch1zCTbtXJVcqF8jNUqbj9AHeVyr9Uf4J5nCpX4Es7XqCY02OVxq5PD3P2jHzY9Be5h/IgjbxU5dzuirbvSXA0g0oxk5Pzpa5fg0zOP7744jNUaQt625+YiC/Vn+BaqsoV+NKuFyj3USp1k2vyUM/AyNNUH5F7KA/SyEtV4ybGPVEUHk3wxOsOm5wvdf3aHxj5r92/oEpFm7F2YiL/Uv3Fb6WqXIkvjbxAKW1BlRotUmngHsqDNPJS1Xiv0DbLwdEE3x657tjFqVVqRp/cfwayKL+JJQ9fqr/wU6kqV+JLAy9QdDL//d2u93riDVQaeJrqL3IP5UEaeanqZP+ivf/GPD4qpvwlxvsDdnFulSoBVRpd6Dx8qf7CpFS5Al/a9wL99GL3y/Wz11e3mv3xP7SqOYDyJX2gs2fkaaq/wD2UB2nopSrnPVNx2c5zdCqVdtlFzOT0fKnrd/6b9tD75AxVqjYnJuJL9Wc0UlTlCnxp1wv0ljn9TTuw/wWl5cgBlC/pNzp7+r7kzzxN9Re5h4JaIy9VOd+q84Oz6KjwmVZWM/ClmMlZ+dLg+v30cJOgSmOVpuBL9Wc0D7yqPCVfus6aPUs/rIaMI87Fw82JMqgovnQ88qt0wJeQB2lF8aVzRqmUB2lFkWtFrlVUlEqLL33ge7jOdvEkBUE6zpfiIxPwpXxJA2fPmAzNwpe6c1ClQpWOmq3HqNIDgpCBIB3nS/GR0/OlfEkDZ8+IAk3El7pzglRU6ejxbOUn18ZVOglBWnypaQmcPYWK8vCl7hxUqVClo0ezVSodSDiJA8XhLpudL+VLGjl7CkLOw5e6c1ClQuWOmq1N8aX2IU05o8qFSvUnvzkJ0vHV9m1jdr6Ui2fk7BlQoHn4UneO5QxC5Y6arU3xpfYhTTmjyoVK9Se/cYJ0RnLNQtOZ+VIunpGzZ0CB5uFL3TlQGKFyR83WpvhS+4zLGdU+KtWf/GKCNLNK8ZGz86VcPCNnz4ACzcOXunNQpULljpqtTfGl9hmXM6p9VKo/gwUEaf4nXm8jU/OlXjUjZ89gcWcivtSd481SqNJRs7UlvtQ+46Je7OuqNCBI8397JOW5+VIunpGzZ0CBZuJLdeNTqVClo2ZrQ3ypfcbljGpf9MRrsAGCdNZfYlym2flSLp6Rs2f4XpqGL3XnRKmo0lGztSG+1D7jcka1L/z2SH7jBOlkfKmbbna+lItn5OwZUKCJ+FJ3DtkZV5WOHs3WhvhS+5CmnFHlQqX6k99sBOk4X4qPnJ0v5eIZOXsGFGgivtSd45HWuKp01Gw9ar60CNLiSxNE8aUVxZeWSkulFUWuFV9aUSrNH/VeGlGlqCOZLuzNqMVAzwN8acAzzs6XyhTdKWJ30yx8qV76FZmjR6dSJMw2VRrwpQHPODtfKtPwN8XQ3TQLX6qXfkUr+JfO4FUYq3TxTPUi9LfCqoaAZ5ycL5VprNLA3TQRX6qXfkXmaFsqLZVaQ9XlGSfnS2UaqzRwN83Dl+qlX9E6/qUrO4oajUqPedWW3rud8QQ2Vab2aWGftkG9WoSV41rjnsdX28c84+x8qUzRnSJwN83Dl+qlX9Eq/qVrO4oajUoP8m47Wga79SDYVJnap4V92gb1ahFWbmVi2PM4uRbxjCn8S2WK7uy4m/5nKr5UB12/1hX9S9dxFDVarNJ29B6vKlP7tLBP26heLaLKPaGGPS+v0phYnFClMnUhO+6m/5mGL9VLv6LPVvUvXcVR1K5IpTI7Zmy0sU8L+7SN6tUiqhwxF/W8/BNvTCzOqFKZuhgdd9M8fKle+hWt61+6hqNoX6Uy+6tUqm1Q76IqHfj2CM+YgS+Vaf9THHfTPHypXvoVreBfOoGjaPeJ1939/irVNqr3/Z949Tz+S0zMMybgS2Xae+JVdB6+VC/9itb1L13HUdRokUrbdPzL2fmP//5YpTLtq1TbqF4tgsrjb4/0PM6XRjxjAr5UppHbZ+Bumocv1Uu/olX8S1d2FDVarNI94fq9XTMakWlfpdpG9WoRVY5rjXse50tjnnF2vlSmkdtn4G6ahy/VS7eiFfxLxaSOogOrDrQt+jQFX1p8aVpH0fPd8037fXOwbUUCvrRUmtVR9PyZNZinbltR5FrxpRWl0rpQxZeOjDHAsI36l9qaly/1gPL7t88/jIlPW9w+E/Gl5iNmTvdY22n50uJLjbGCSnv+pbam5kstdbyOiU9b3D6T8KXBHAU9X7aXhBPzpUWuGWMCvtQ+W1PzpX5KufluSHzacpEz8aXmI87g+lftPknJl5ZKxx0oDls/mJcvdfH+IvFpi9tnIr7UfMQqbczArqeT86XFlwZj6E8di5OmfTcnW/PzpZcXb/4S8WmL22cSvjSYo8AiZv9qfnK+tPjSaAz9yXRp0rTvjGhrer60Lbq5+JeY+LTF7TORf2k0R3puH8Y9c52QLy2+tK9SmQ6TpgMqnZMvJdL2ePUupEBtcftM5F8azJGe2yuI++SUfGnxpX2VynSMYRt44p2eL205fnQZUyq2vLb9Zwq+tM8A34nXXXFSvrT40r5KZTqi0oFvjz6bnS91RwTEpy0f5RLxpdEc6fnywlr8k/GlxZf2VSqXAdJ0+JeYyflSDnmhV6ktbp+J+NJgjvSs+pPzpcWXRmPoT6aLk6Zd/1Jb0/OlTX3t/yLi0xa3zzx8aTBHeqbS0/OlxZdGY+hPpsuTph3/UlsJ/Eu///rlPzyPvUptcfvMxJcGc6RnKi2+tPjS4ksf6YUqvrSi+NLiS4svLZVWFF9aUSotlQ58KkQJrRR8JqeNPl8q+9n5UpmGTGdMfCbmSwNi9q/jS0ulfCZnjT5fKvvZ+VKZxkxnTHwm5ksDYjaeo1lV6sh4jPf3i8Fk1uRLZT87XyrTkP0MWLJt8KWI2QG+tFQ6nMyqfOkh+wz+pe+n0m3wpYjZdfhSBCn2E1G5JzR/eFhT0K4D8hKXieXTFoMZjeY8lKr+kKGywn5qkUel/dX2sscu5lDpcUEh8ZmbLw2I2VX4UgQp9tOauJvX+61jlSIvTZh1HtpiMKPRnIdS1R8yVFbYTy3yqLRPrsl+dr5UptFC+ID4TM6XBsTsinwp9hN1hNA8UqnXmlCl2mIwo9Gc5wlDf8hQWWE/tdikSqfmS2WKvBQB8ZmcLw2I2VX5Ulcfq4U7pVKTFKlU22itq9Gch1LVHzLUENhPLbb3xDs9XyrT4K0vID6/lZsvDYjZz9bjS2OVUtUyKjWa81Cq94k0KrWvhRbb+vYog3+pTG2IgPhMzpcGxOy6fGkrNKKT2zl3On6PJ95IpUZzHkpVf44a4nhcLUTqX2JkPzlfKlNTKwLiMzlfGhCz6/Kl7nLfHn168Wr3le7rq1vN/vgfWqLIS1xm8O1RpFKjOQ+lqj9kqKywn1rkUWmfL5X97HypTCO3z4D4TM6XBsTsGnwpgtRdjqjcE5q/aQf2fw+0vZwgL3GZroi2kUqN5jyUqv6QobLCfmohjnwmp4w+Xyr72flSmUZunwHxmZwvDYjZmC/N6kARsKR/NNoSyxSKGy2+tNyclgujJSRDK4ovLZUWGVoqHYki1yoqSqXlXyqDh7JGzsuysKHvjYlinJ4v5eKpIpyncF4qvhSjbCt0bo1p4FJpbpX2vTFRjLPzpVw8VRT80Om8THwpdtaW4Nwa0cCbdkaUwYDeEqi0zy7amp0v5eKpokilzsvEl2JnbQnOrTENXCrNrtK+NyYhz86XcvE8qihQqfMS8aVuIFuCc2tAA2/ev1QGgaPog31EkbBTRt8bE8U4PV/KxVNFB85TOC8RX9pXKefWgAbevH+pDALnlgf7iCJhZ4y+NyaKcX6+lIunig6cp3BeIr60r1LOrQENvHX/UmNEKn2wjygSNo1KUZEoxon5UjoKVGoC752XiS/tq5Rza0ADb9y/1BiRSh/uUKiCKaPvjYm8mJ4v5eKpooCQcV4ivrSvUs6tEQ28df9SY4yoVAVTRt8bU4XT86VcPFUUgIXOS8SX9lXqPg1p4I37lxrj/Z94qRQJO2X0vTG9P8zOl5obFZlG4bwsfGlHpXZ0aOCN+5caI3IUfaiPKBJ2yuh7Y6IYZ+dL3a8qwnmqzXl5+NJYpcbl3BrRwBv3L5VB5Cj6YB9RJOyU0ffGRDHOzZe6gVWE8wxVmogvxc7aMi7n1pgGLv/SiuJLZ4jyL60ovjRnlH9pRZFrpdKKilJp8aUPgNB28aTDGuVn2AK+FMXoY/qXH0zPl2I6VcTZU9iXki8N6FhzpLbHwZe6IltXacCX4hTxILPzpb6sVRFnTw3sS8mXBnSs9NS2fb40Vul4LtpPvaohoBjbCpDp+VLKUFEwffZl5EvRscIcqS0/X1oq7a4QlKYHuScJ/EspQ0XREozDvox8KTpWmCO1PSK+lEojvlTbxKRpZ7W9NK9T+JdiOlXE2VMc9qXkS1G0whyp99HwpVQarePVNitpGpBr8Yq0H3+Ywb8U06kizp7isC8lX4qiFeZIvY+HL+2qVNsUpOmASq/fnWXwL3VbqIizpzjsS8mXomiFOVLv4+FLuyrVNjdp2n/i9TI9PV/qpVNFXdfH/8zIl6JohTlS7+PhS3sq1TY3adr/9sgnngT+pYBoFXH2FHf7UvKlKFphjtT7ePjSnkq1TU2axr/EKNO7yPR8qdtCRZw9D2FfUr7UZpCeeh8JXxqrVC7aJidNA77UrWCaJ+dLMZ0q4uypNvtS8qU2jWuO1PtY+NJYpXLRNjlpGvClOEUPU3PzpZhOFXH2VJt9OfnSSKXmSL3Fl1YUX5ouii+tKL50LIovrSiVVhRfWlEqLZVWVJRKS6UVWW++h0bF8iqtqCiVlkorKipKpRUVpdKKiopSaUVFRam0oqJUWlFRUSqtqCiVVlRUlEorKipyq7SiouJP+XmaVR5qe/oAAAAASUVORK5CYII="},344:function(t,e,a){t.exports=a.p+"assets/img/ShowB1.2698f386.png"},345:function(t,e,a){t.exports=a.p+"assets/img/ShowSize.0af29467.png"},346:function(t,e){t.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAc4AAADMCAIAAAB1O9RYAAAhsUlEQVR4AeydhW8byxaH7x/yKrrMzMzMzIxlZg62sW/sYrBcx2mY+VFAlxkteMyUVvA479OO3tF2tjuNtbNOHO3RKpqdPTO/ceDz8RnIKT+YIpuYIvvwww+n6iXfdtttkfQ0lI4ssrPOPf+hZ15/c2lhthetaDsZiVNuy4lFqI14Nz2lI4vsmhvveGNJgYGn5ou29BChNkJtJB1ZZL526z2PgMvgF/1EqI1QG0lHFlkWnH1rWdGclSWL1sWWbSpfvjnBRWHx+vjcVaVm2kaojVAbSYdgG4fHJ8aHN2bbLJUxt8qqo5FNk/ffNDKOMg2ytnRmwm2ZlMnZyitDJP3/MSMXTt7Aj7PzVm/ZsHV31YGGpo6+9p5BLgp7Us2F71ZBWxz8aEufeY/ao0ePJhKJl1566VrHKHBL5cxG7cKFC0dHR/mqbjds2CC3OZCur6//8ssvJxyjwO0USr/yyit5RPmcojZc2zQ8LnB1IVteQogWImqZy/LLzy5cW1a2Y29zZ19r1wCQlaute6Cpo7diX/3SjeVv+9CWPuk5j1Hb2dl511133XnnnQUFBTWOUeCWSh7NSNRC1fHx8a+++ioej/OOco5j1PT29v7SsVdffTUkaXqmf0QBHMN43DEK3FKZA2l+THytrq6OO0ZBKg3SEWpDCy9TPhE9D/IVtX7rDWavKNkcrzzS2i2ElUvC22TVocUb4oY1CfmKWmBKGAtbtRiWWyp5hINd1BJVwfGpRS2IgaqqTGHUsbGxMVVDAfaFIQ3X+C6hDtm9T6nkEQ5VVVUhSfPSTvjNp5JHAaQDwzENXOTzsweaikqaQ1qqpE5a6Y2o2yQUk0bpE6BH/IcFtWatkYyqxEepuMJV8ReuDVOvglbhqVuX93s1KrqmoKnTLqXgqH/f1FCpcUtKz/J6ZWwhJhAuvvxqP1CuKEju3psGqYarvqVrU1nFOyuK/Tqh//xD7W9/+1vFWT8HRVvcLKKWWJLfJ2u0DRDfqfJVV1015hgFVcMjhmddGtjxBkYMa3bDATecbUkLZ0/6/qFAj3POUSsohAICCoEmJTewhlOKPs5TYQes0VrhA1BEgrLylMpU2j/ZSv+KX2YtN9YEteLj4ZrqR/zx8TbEWX8qGtBZFOX7JvU88KpncNBeXbioNSyhJRubbu6Ep+YrUXnQHNjmH2pVosCQk+URDrhZRC2xm9A2x6iFsOvXr3/ssccoMFq/0JJHOJC+jMVixOC2pOlWOGs23NQYLEobOKvR1oJ0kI/8wh2pl+jP8One2+rE/oIh3QRAWpMstKReBiz13Hm4xq30n0mLKB0Kar3q0ommLq/LH6AyqjBRe9oZZ0JDvwmx2M59kqI1XLWHGteU7DCsRkAlz1AL7Jj+MvvgQNLWImrNtA0VtbxzqGwsQyU36ufGIxxwJtTF2Yo0/UCxrFIcFqV5IVq6oKenR+VneTvR/OVVTxPUSo0Bi8IRL4DE3GEmhrtpGMI4Py3DyCloRr0vaulfOpGyPBV1E2qF17qPNhgDasNceCCJ2vKKAwbCynXwSBs5BANqUQmM2heKWt/76e4Xjqt7LjH4Xn/yuRBQS3LgJz/5idkHB9zsotZM25BQS3yKoqi76+GOtvZARiWTRQGl1eSbTMqhKPkKyWNQySMZIU2sSKv3VLcQ33Y1MyaJBXNMnQdRLT5aKzekxN80JSX+epxo1vKOXByMc1DiRi/eTAV1ejZAhj1Z1MqQchjV3vvYC358ZCFXsvLgZFB7uKGD2TMDalEJjNqtg7/9x8Q//vCe0Pa5xE+dmp/uto3ajz/+GIby1YqbjlrLtLWAWoI1b1xJAKviTYwCsPNGl1A4oDQqmPbToWdNSNXrrQJL87q8/BXu4yAxrxhNqJ8GqBVoZp2r1efHZOKIflw80pCaTa7WMHLxMaFW3GQ6i6dKV+RUK/9crRG1UpBKA2olI4yEniKXpye3p19baEBkbNe+yaC29nDTWmMCAZVAqBW2Cm3dZWyGoVZoe+zYseXLl4eKWgktJZyUyTGBDgVucXOHmTShJqA0r9EdOVImj+GNaqnU3Fj0Glya0NXs4EUtTZCeHqjVUgEaDbXkgLTSJt8zGckGSJ0Xi8I8B2cSbJq1PCOXR2KGEBI3I8TEyWcFggG1etNMZjx81L4yf50BkcXJmoa2npOidteeOraQGfpBJRhqddr+/M9mzuY/arFbb72Vhv/5z38uueSS8FArMB1zzC/OBTHwTp5iNAkubZ4QM0+OBZc25IihOQ7ae4mE2KGjNjIho2G7mCFzMv3MfLLMqqJtlfuPmDnLRobiRPWclaXmM2isTYu91Zz5B9/zf/+86x3uZixqr7jiim+++YaG999/P7c5QK17/SxU9X6Kd6MW5xmMWvqX6cG8QG1kksqYtuYHR0nXst6rrsm03osNY8s2l+NsvqKo9sNsOfvzn//85ptvzs20mNoPBj2lxpxAgLY0sZZAyNJoQkPrCQRzGlei++DSkdnDq5hwNi+jWq5F62Ms+YK2bd36xtzmjr69qWaytLNXluBpJ6qNcrUGzuZ+WizmGNlJQOxthVmcFmMO0LAjC8bhEPa0mGgJhQNOi0UWmTlX+/by4rmrtyxYWzbP+bp1x94D9a3p5q761m726bJD7FBDO/HsysKkclu4LoYne8bMudpoBYIVztqPagU6CmcyOdbrGA7uSSoV50pUGzygpjfVM1Nt0NZvO5lbOviKK3qQxV4GC7DYK7LIDCsQgGwRUeqyzYmSZM32msOcNbN4feyd5cUL1mzdWFZRuq12y449ReXVKwuS7HGAreRzd9SkKvalS7fXUqYt9YYVCJbX1f60rei5mYJaOKucs+KsrcX8pF9B2GS2MOBGnBvGFgYoBlIZCRvSQCpGgVtZSGt9CwOdn/ANAKNgaQtDZJHp62qZ3eK8xP3p1sa2npbO/taufrIEB9KtBfEqaAuF+eoUioEsCGZLLqEubmwqw5/lCjWHGpcXJLXwFpW82S3GsQYABYby9ROjiRtNgqN21qxZrLvB86abbsr9GQhkP0EYOJONuYaYjgL+FMLYmEuYqYAuxi3xbC435gpqbWzMjSwyfbcYGYCCeGVdc2dLV787LcstPK052EDStihRXVheRWy7vSZFDgG2unO4bd2DHLd4oL5tzfEJXFTyBrWclHhtlkYTK1HtNddcI5zNIWp1nsq0D9QbdUzIK6yxftwMkbLQVtQxbWy4hXHcDPno8I6biSwyOQNBzvEiJvVbaUDQCnAPN3ZA2FRTh2G9LfDdUVu3dOO7eXkGAiHqx8fbiy++OGfOHFWmwK3mYCWqNeNg1N/gka2/fNka617DjxFXGs4rsCItyPM76YZHArswpPlOaqwXvvMoa+l8sMhee+2177///r333iPKUTXsGOLXnr/oX//61319fXfffbfWpKKi4vPPP3/44Yf5Q6Dt7373O2ZW+KuZ/MleJFg3lu1ubO+FlcEv5s3Wle7Mv5O9DHFuwjEK6XQ6x//whg+zcX/jw7X1QxQxgCtHg1OAtkSUsuRLzLo0KmipY8YwCiKdm6PBmZeLOUYh348GN1tk+/bt+/bbb5mIXrRoEbcLFiz47rvv6urqbrjhhtmzZ3/xxRdDQ0NnnHGGF7Xr1q2DyDTnabbn1ZKlLUnWQklbF3kGUrr5dF6tmbaPOia5ghn/D28IZt3/8IZbcJMDaVRgK7/HE45R4PZ/7J2BZ4VQFMb/tsFgCAiAMVmDQYBloMgaXApBFiAhiQCChIQgoUCl/Rn7uHaxvVFkrud88tSVcx68n+99rnuuvvX/iwQnCz/r+35VVUmSYAUuqmka4XBd1wV54Xx/oxZoxt9ZbM5RFOXokbWY0ijO8Trlcv2P55c3VKYxjjTGkVqTpJNpmvCtIKnneW3bIivIsizPc/GCpmmgKj4vBghYx48a6UEYhvu9LSaAIVrFnq0TUcswCOf1XcbZYoRaak2oJQGsn99alsVxnDRNf7javu8xuTWO42ma4HCRGwjU8ncQcCGxZYzt73tze8ePOzjrCqIYNWk4OaGWWksnkqqqCIiCIOCPZVkiDTAMYxxHntUiPYPnxeLFrFagFjdd10VRdKj7/cPjiahFNdQk1BJqqTVJOvEcVtd1/sgY47Gsbdu42bZtnueiKP7agWBZ1jAMsMPrutZ1DXAf/QJPX+zbgUddUQDH8feXtGp7ql6twTYCgrXhlcTMeiAExaMIGY+xjIdEPBoWwCQyQIACISUJFF0gSXpRKnXPfu7z7urerXa797Z67/uRnO4955yEr9y6Q9lIOqt9bj4ocf8/XFLL0Q/naODDx8zvtxKCf2itdrjlDFJLdDgaePnq9Zev+Tt0Vqu09vYDSC3R4Wig5M3bd/8eXM3U/NJCUktqOToYoKW1VQ8EPuU+F759/zH3s/RsQZ811hVd113NCbotqSU6HB03gNTGj96RWiDxIn5tZc/LWssMAFSBxL11Vq52tsVhACBCpNbf2VQqZQAgDqTW7SypBUBqY/yVNuVobm42ABAtUuvpbFNTkwGAmJDaUmcjSy0AkFq3s57UNjY2GgCIFqktdTb21AIAqXU729DQYADgwdvc3MxkMsVi0X9LF3VLE0gtAITS19eXTCa7uro8tdWXuqhbmkBqQwEAJTWdTntq63ZWtzT+b6ltE1JbiQBq6+8sqY0YAGrr6SypjR4Aahuos6QWAAJwnxuIBqQ2LgDobNrh1pbURg8AnS06AtU2kYzTs7Knjvr6+rq6utra2ieOmpoa89gAoLM3/AcYqQWAEK8wXO+sp7aaQGqjtL+/Pzo62tvbu7a2ZoCqwYu5iunfXszVLU2ootQuLy9PTk5eXFwYn0KhsLW1ZYJbWFgYGxs7PT3V+Pz8fGJiwrIsjY+OjgYGBlZWVkx4/t0AVJZKS217e/vi4mKY1K6urs7Pz5uyk5OTvb094zg4OMjn87qisW3bu7u7Z2dn5q5mZma2t7c18O8G4EEjtVNTUyMjI5Zl3Tm12mR2dtb4XU9teP5vCcDjQGpVyY2NjVwud3x8TGoBxIXU2rY959Dgj13T9fX19cHBwfeO4eFh1VkXDw8Ps9lsZ2dnR0eH/vA1Pj6uR7RapbVaNT093d3drQcUPT09/f39Ozs7V/e8vLxcWloaGvrFvhlwJhdGcfyD7SPsAwTG2MC8xgCzYVOpUkkppRRVFIhURUjQN4gKolKSQAjQ+/M+HNe9U8l7B84fee69zzn3DH47zznn/sEhtqlUisIu9xeLBdynas5N+ml01bhJS43Lu7u7+/t7Fp1OxxYhlQTif3h44KnH46EAvdvtrLhn5/v7O4/YQCGC8rQYcmnuv76+bjabk0qlckOKWhaktAAOgP6I2tFoFI1GJTllwSW2P2a1glpnVis+IV25XG42mwDXPILRsJuduBJKrlarRCIBDW3mTm+saceJt/l8/vn5aTBNDPw/gPsmDPbU63UDa9Rut/v9Pq82MRyPx5NKpXJJilpEufbt7U06WgIyUldwScffarjdbr1eL4C+DbWTySSTyZjU8owgYC6Xo/11HrXMIVSrVYNL0XA45Kagdr1ey6PlchmJREwSnU6nZ7PZSaVS/Y4UtYhRBA7yENAKMg7v+XzeZsieZDIJs25DbaVScY7ZSmFhOp0WCgWO85Qd+KoEk/OoJTynNwAdj8fhqTUGZ1QE7/P5JI9WqVSuS1ELQDmwDwYDAZlzj5N0N6BWFjaRJvv9/lartd/vyVJtO2V9jTd59XnUmuowMxhwWYGrUrkuRa183MVxm/FVa1ZLEvp/s1oW4/H45FC326VyKpfkpIFA4CJqSYHxdltWi6S8+/LyInO7KpXKRSlqkZn9CgaDBmQkmGSatlotpc9YLEbD6jbUUkgF31JdFeEHb9a3PD4+XkQtJk5v5Oa0vFhcg1rp/skf4q5UKpWi1sx+McIlXOv1elY2HQ6HcDgs5VEWpVIJq+tRS6Hg4+OD0rCx4pd2HJkysJMPhXkL+7+/vyUMsldmzpyohfgkv9YJBDpdX19fNPQuopb+nrHiF17/0pe+KpVKUYvAEAMG1rlaIPj8/MzwqZmrtR602RwKhRiehb/MS12DWsRYVTabxSFiHrZWq0FY1Gg0PP/EkADFU6sJk7lPT08EAPqd3orFohmP5ZdP4CA19y+iFlfGihioEf9l7yxgI1mOMGwxhcQUEkM4EYaZGcVhUZiZmR8zMzMzMzMemEEy6/asg82vK+nXqMbe6/XcrlfP36fWqremunrnonzXrp13tqwBANUCAKBaVAsAgGoBAFAtqgUAVItqAQBQLQAAqkW1AACoFgAA1QIAoFpUCwCAagEAUC2qBQBAtQAAqBYAANWiWkj/Grr/13/3u9/tfxZSE/2rlbOzs11VU75WuUhD5uYX/nvo0XpNcfPgw499+0e/VE6rtbPdS0449cwrrrm+d/eSuGt4x0t///TQz5/UOO/RxXYjcuWPnDi8sHNPwzp/uG5GozBZt/DKvz83urDLkS+dMaagIm87cpteN4VqUS2qFdarbOvfQ7EhlOtJej3i2JO2bh9u9wZ5XIbtz70ki1XFdNBtszJjH1RrAx5w1X7z/AltqnxUi2pRbdu21W8b8j9k3mdQbbl9Bl+1viOVveaZZe+LalEtqm1LslKthGvnqifw+c9/PtoLjp988smK6NdhjI2NxVX9XoloICioVy3URHGhY3J6610K9RSTG2+5Xe0CDUlQnlUk3saP9tJivHU/QfEzzrnwN3/6py7JyPLyBZdcEQkTk9OKax4ydTVHtEW8/cmv/qi1CiqyamZsrc/WoWC5aiUgaWgtD0ZLQXoKZ0l2P7p8Sm8V1Fxr3XOwVZXgYFKt86Ngqu8mho/YetU8IjqoFqpWuyhTBbWvaqJaVLs6qDYlRJMhItKrPCuxukVr1cqnId8gvV2HaiUySzBk6lNtyC6uhmFjrolWhd2UJmlayhHX+Mu/Do4KgWumU60m9ruKOFheMKu2+LRoN2k4J+aayIbyV0gwglJY1ZVRTfPX/m+L0qxaO92b2oDJyJGpucoqzc4tUa0Nm24N1aLaNqqVE+VKq1aWjKNovcPgtVanVWsjZ0EXk1RrT3lui2ki2SmSVsmD1mKcan3a1Uhi9TFWQ/NVVauammhVqhlXq5n1gk1OtXHktJJsqJBXMpot6UnVbg5qoc6nHrrqHB94PbTdk9MrIdxk59J+RXWOalEtqpVS5UqpMzVt5V83EEpU6+LWdHo7UKr1SdmubKjaVLBctT5+9kG1yZXOqRvfZbtVbRJ6nME3u2pRLaqVBP28l5WaMstVG6zaSXB+E9UWNBBKVesl0amwassbCEm1qWChau07d2P1qmarXtdqIHRW7Sv+9pyD9QaCm7B11VbXBtFA0NXCBkL6VOmTb2rVolqeq43Ga2oUOMGn3RLVSqmuWX97wFUbEkxfi5WrNoSotXrV8vBmBNPXYs7USCKuzlPBctVaSekYGKarfm1VolplyrBRJ11NR04fZl0/5jHc8FWdwq/F0l7pzP4CUS2qBYBsugygWgBAtagWAFAtqkW1AACoFgAA1aJaAIChXhTdu4/du3fv2rVrZWVFz+IsLS3poZypqanR0dEtW7Y89dRTjz766P3339/eVAAAqkW1AACoFgAA1aJaAABUCwCAagEAUC2qBQBAtT/506EHcDAYDAaq7ScAAKgWAADVoloAAFQLAIBqAQBQLaoFAEC1AACoFgAA1aJaAABUCwAwwKDa4bnbr3zq+0fd9Za/XP/i310zpFfNFVG8aWkAAFQ7ufjw6Q98XHpda+iqctZZHQAA1T40frJkWjKU2QYAQLU98Cy2BQBU26xvYIeWDzoJAIBqu6Bzf9bjf7e+OvVtS4p/6YyxoZ8/GeOlv3/6ruEdvlS4XKPdAC3/w3Uz+00bXdj1yr8/d96ji440Z2Hnnrcdua1esw9b5NuBweCCCy54/z5++ctftlqteoJs8NWvfvXee+/V/KCDDlKmSUuU40vKdH0tVxGnRaaDGwaq1XMFJZ792w0vm1h88MmpCzVxUGu7Mp0m+v+/LNDuG/4ADdBfD6/93xZ97MFXLQw44dDQqLS4loudZpTvoEspmKrp9Tvf+U41U3b+y1/+Ik1vsGpRrZ7iKlHtk9MXKXli8aGqarW2K9PJVnKWzIVqUS3OtSiNVKCgzJis+vzzzysoadYrpLlUq0wnx1pdEhusWlSrZ2b369kbn/+9Mlu75o+8843VuNauT7V2RDQWlGOpqckQwdCH1upqNdlX1yoSqyKoqx85cTipVmsV19rqW302OysiWqgKP758Sq/ewreQSsXcmdqxgwfjpjSUGcd8RaoL061FTvojiuRIO+i2WeW4RZO29nZpi7iUtugP4FOqLemgLxkJNCIlqj399NOlWhnWNa+++uqNP9Wi2vjvFDzOfOjTEms1cuK9745MXUoK1tpC1XquYREkH3kSUr57uGVNZE/lItksSX9Jtcn4aXevink61XZQraQcOQqGuTqo1vXDgIpUF8amEmi6TQVf8bfnYnelnXDffFz1KlWLz+Ot03Z6tY79B5X/nKE3uBUbLYJkSU+sWi9JokwLdYBVgt6GaoUvxTF5fHx841WLatMXXxG88LGvONLaNafIndsPikgaXX0tVpeXhaU0O2VVsaaFnYt4o+T6etBFvDAJtFy1xjmdT7WaJL2m4vX8+r2kLeq34+UpPy2MQz0H236eakW9RVBXreapq1v/WswJmgjb2W9R7cCdaiXZqm3VnNV86+xNcbXJqdZO8bGxOqpnMXcDkibqmqsXeXJ6xTkdVKsE9Qe0nS7F1YaqTT/aa1KoWn+SVDz9LZX+FmmuWuVEzyE/H9IXIOnPDxvU7XnsscdKxCXdXqvWnYRo0aLawezV+ssuGfbGaNFWvwpr0qvVXCP5JZEyrYlUaq0iST31k7LjWnvNM8t6VZ3mqq3nNFStb7Z3p1rfe99Ar5amVJj6BqmNm4zcrWq10ec+97lIQLWD+wTCg2MnOcFfhXk0eQIhHvZMBvRVtTurckkT66+zRpXfuVfrLeQaa65Qtd7UtxOZ6fuxJqfatDDmke/K7tWuW7XpjxR6jZuq1Ydk96taNxa6Va2PwwOtWp6rtW3dtK2OdT9XW5VF+gHW/q32E6wJ/2zuETXrRbypf+72B0hETS/poFoXDGH5w2jrg26bjcz04Zufat0e0V5KqPZ2/8/eHWggFEMBGO79H+DCGAzDMGZsq4crguICpZL7fW8w+DHOOc/vfSe1+z+KK3zdybTYvrMvTIsBSK0dCMBPU3v5gPPdWmvOOcbovbfWaq2llJxzSinGGELYtu0Im70A7KvVWUBqXWEApNZtMQCpBZDaAwCQWgCpBZBaqQWQWgCpBZBaqQWQWgCplVoAqQWQWoB/IrWPK8c39s7gJpYYBqCtQgGIE83AGXqgADoYUQIcaeFbsvRk+f01w8z+Fas/OaBsNuPYjvMmziLl9vY2lLn80NyzRGmXLFHZX7iy6f7+foOx3N00FG7o21UY66yFu6p2Koy0p6cnX5Qdjo1YooXQ4mpYJr1etxXXDobAlUPXIc4bG765Cy9hWpuXtIKravfrg40RpfjkusuBWqCT9WVZLnmrXSx7IumSqL08/mDc70MtZTtqARN0sAkVUgQbMbD+/QfaYtCsv76+/uvLw9Ez2/EhXL67uxNq5fOj/M+oZZHsLwdqD9S2ycIE6kMMUP8pB89ehptrc2hAz920z8/PB2qncqDWCRFB1uo118uW+KtkcOpQP359fdE5RveIrfL29kZ8t5yXpyLcIwmNr77VJKP/8/Oz5rn1An1yXlyULbGosptTPBSGKaj0+PgYf9HHxqZFLddGTlu0ITMN+fj4SMXSFVhNi81BQk3Yq8KxQ6wyLWF6YQsrSDZGB9Q2V9S5ZucbLT53ikamEmWi3NzcPDw8+AVQowKMxhSnZzCKR6B8eImvcKlfJHiPqfcRihcjU8MbhUeGtXYF5TirZdr6+hf4CCaC3hkW4Rggo6V1cItHdIXQrw9SWHvfamIi8JEK+KjHcH4teRHGX1pQqY1oYy2QitctwpNE4N6OrV9ZAghjIMu0Q6bjfq18O2dAbTyIu+rj9VkE8nLybhqZaWw2OnhM0ja/jOuIipccLbmNRbFWPPUMiv/trvkQg4r7/NJyoNZv1MY46p5RhwU7RF7LLF1E8XEDatHBGRl9VmqChFQjvo2vQAYlMZ3AtdVNVDzbEIlKM2qtdjTOY/11w2jkQRNLqHUrTN0OcSLsAwTUtpKnXvNOI3AFylgI8KpyMB8DK5I49GDvzED0qcJPyWmvgTWoJdJMUtyYmrtDKjxE+BUw9UCtF4yXnOlGH4eFCc4SrR9/ilqijZgzaldqcgp8M5uMPyCyLAu2bEAtu0h02IBadoU6ytiOWpRZf+Lv3aIRTDE97QoOhaEkZUhcmrFYhI1Vt4F9qbbxx0lCCjkLatGzHSCgiR68qnL8LOYDUCpsdWsezYNti0qHeTk5D/KIp1Cb+1Pi1ahdqYkpw6qI0VG1/dhNgmkfhjQo8C1qbSynMfnUNtRaLOZsRq0luMy7Wuo1nSfwjFq7gswjPMxEvLy8tP50no+JyFFaABthcJ/G1gcmRn3/AQIFaU7jtNaupxyoJfMiPWw/BDXQkJ2RgvFg7eAfvupAjREe0aidMdowMWtC9L+/v/OTBbkqKbN/KPPPYj57MWp9IH7KWNTYhlqL9T9N/xS1dshwVov+a06Z5mN3+lQwEZ819oCdzyJmQiGEkDZqgaNxzF7bllI89V5udPOCYsPOI5jWIrzJ2V7+tHcHmm4EURyH+/J9gyAIghBEJGlB3iPv00aXv3Haie3qvZMm3weqmxHgZ+/EnJFa6gsybyUt4xNILc125CtjwLkppJb8FZbNtbfifTZ7Vkit1AJILcB4UgsgtQBSK7UAUgswkCGKOapYDqv82+HKi08odE8r5STPItOZ+h/AZ5La9nTA7XYrMwqGprZO+E9/pRb+M1Lbm1k1PrWdCf95JLXw3KQ26uClOtK/HW9RxtGXgdDZhbi3bEptb2077n56+vWun9pMD6mP/vKGgjbWgNSOmQ7ejkoq4UslE9BMw8qVNu19Lb0hdZlGWOYW3pfn2/sT/muF59xQkE+OBEhtpH0ltWVsXbrZNvSPQ5Qfr83lBTM3EPLhPJozYLAN8XiA1CZVv4/uTrx6qc1eaulvWVsqPDO1+feC1D7F4BJAaq/Xa3vza5va/E/eeXupzU5Cu4HweG2m6GcD4SPeasuSIRdHA1JbJ+SXS0lzE8F0/0cvtVMNy89ij9fmW+rPYv0J/wtSWy4jmJtaQGoBpFZqAaQWQGoBpFZqAaQWQGqlFkBqAaQWQGqlFkBqAaT2DQB8+f4Bvv1yuVzO5/PpdDoej4fDYb/f73a77Xa72WzW6/VqtXqVIdYA3moBpBZAaqUWQGoBpFZqAaQWQGoBpFZqAaQWQGpfAYDUAkgtgNRKLYDUAkit1AL8BM4AKpaBP/VfAAAAAElFTkSuQmCC"},347:function(t,e,a){t.exports=a.p+"assets/img/StopVM.408afa56.png"},699:function(t,e,a){"use strict";a.r(e);var o=a(9),r=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"how-to-penny-pinch-your-azure-deployment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-penny-pinch-your-azure-deployment"}},[t._v("#")]),t._v(" How to penny-pinch your Azure deployment")]),t._v(" "),e("p",[t._v("This guide is for "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-azure",target:"_blank",rel:"noopener noreferrer"}},[t._v("Azure-deployed"),e("OutboundLink")],1),t._v(" users who wishes to do some saving on their install.")]),t._v(" "),e("p",[t._v("Please do this "),e("strong",[t._v("only after your nodes are fully synched")]),t._v(".\nDuring synchronization you need a powerful setup.")]),t._v(" "),e("p",[e("strong",[t._v("Penny-pinching")]),t._v(" is an opportunity for you to better understand the resources you are consuming and tailor the configuration to your workload.")]),t._v(" "),e("p",[t._v("Downside:")]),t._v(" "),e("ul",[e("li",[t._v("Running "),e("code",[t._v("btcpay-update.sh")]),t._v(" or rebooting will take longer")]),t._v(" "),e("li",[t._v("You might see "),e("code",[t._v("502 Bad Gateway")]),t._v(" and your node taking lots of time to start")]),t._v(" "),e("li",[t._v("Your server might become very slow")])]),t._v(" "),e("p",[t._v("Upside:")]),t._v(" "),e("ul",[e("li",[t._v("50% savings")])]),t._v(" "),e("p",[t._v("If you find that your server is too slow:")]),t._v(" "),e("ul",[e("li",[t._v("Drop support for coins by editing the setting "),e("code",[t._v("BTCPAY_DOCKER_COMPOSE")]),t._v(" in "),e("code",[t._v("/etc/profile.d/btcpay-env.sh")]),t._v(", or")]),t._v(" "),e("li",[t._v("Increase the size of your Virtual Machine")])]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("After some testing, it seems that following this guide for a setup on mainnet involving BTC+LTC+CLightning is a bit too much and makes the server very laggy.")]),t._v(" "),e("p",[t._v("Note that the server becomes less laggy as time passes after restart, so it might still be ok for your case.\nIf it is not acceptable, you should switch from "),e("code",[t._v("B1MS")]),t._v(" (20 USD/Month) type to a "),e("code",[t._v("B2S")]),t._v(" (40 USD/Month) type.")])]),t._v(" "),e("h2",{attrs:{id:"how-much-am-i-spending-now"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-much-am-i-spending-now"}},[t._v("#")]),t._v(" How much am I spending now?")]),t._v(" "),e("p",[t._v("Find out how much your installation costs:")]),t._v(" "),e("ul",[e("li",[t._v("Go on the Azure portal")]),t._v(" "),e("li",[t._v("Go to Subscription (If you don't find the "),e("code",[t._v("Subscription")]),t._v(" menu search "),e("code",[t._v("Subscription")]),t._v(" in the search bar next to the notifications bell.)")]),t._v(" "),e("li",[t._v("Go to Cost Analysis")]),t._v(" "),e("li",[t._v("Select your Resource group (mine is called \"dwoiqdwqb')")]),t._v(" "),e("li",[t._v("Timespan 30 days")]),t._v(" "),e("li",[t._v("Click on apply")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(340),alt:"Show Cost Microsoft Azure",title:"Show Cost Microsoft Azure"}})]),t._v(" "),e("p",[t._v("As you can see, my install costs "),e("code",[t._v("47.00 EUR/Month")]),t._v(".\nMost of the cost is spent on the virtual machine.")]),t._v(" "),e("h2",{attrs:{id:"what-is-my-current-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#what-is-my-current-configuration"}},[t._v("#")]),t._v(" What is my current configuration")]),t._v(" "),e("p",[t._v("First see what Virtual machine you currently have:")]),t._v(" "),e("ul",[e("li",[t._v("Go on the Azure portal")]),t._v(" "),e("li",[t._v("Go to Resource Groups")]),t._v(" "),e("li",[t._v("Select your resource group")]),t._v(" "),e("li",[t._v("Select BTCPayServerVM")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(341),alt:"Show Microsoft Azure VM",title:"Show Microsoft Azure VM"}})]),t._v(" "),e("p",[t._v("As you can see the CPU is mainly unused, disk as well. We can probably cut some fat here.\nAlso my VM type is "),e("code",[t._v("Standard_D1_v2")]),t._v(". As you can see on "),e("a",{attrs:{href:"https://azureprice.net/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Azure Price Website"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(342),alt:"Show Azure Price",title:"Show Azure Price"}})]),t._v(" "),e("p",[t._v("This costs me "),e("code",[t._v("0.0573444 EUR/H")]),t._v(" or "),e("code",[t._v("42.66 EUR/Month")]),t._v(".")]),t._v(" "),e("p",[t._v("Now we know that downgrading this VM will bring us the largest cost benefit.\nLet's see how far we can go.")]),t._v(" "),e("p",[t._v("Connect by SSH to your VM, then:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("docker")]),t._v(" stats\n")])])]),e("figure",[e("img",{attrs:{src:a(343),alt:"Show Azure Resources",title:"Show Azure Resources"}})]),t._v(" "),e("p",[t._v("As you can see, I have 3.352 GB of RAM, and around 55%.")]),t._v(" "),e("p",[t._v("The free command also seems to tell me I have approximately 1GB of RAM in fat:")]),t._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("root@BTCPayServerVM:~# free --human\n\n total used free shared buffers cached\nMem: 3.4G 3.2G 138M 30M 8.8M 991M\n-/+ buffers/cache: 2.2G 1.1G\nSwap: 0B 0B 0B\n")])])]),e("h2",{attrs:{id:"selecting-a-new-virtual-machine"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#selecting-a-new-virtual-machine"}},[t._v("#")]),t._v(" Selecting a new Virtual Machine")]),t._v(" "),e("p",[t._v("Now we know that 2 GB of RAM, and a less powerful CPU will probably do the trick.")]),t._v(" "),e("p",[t._v("But first, you don't want your machine to crash if it runs out of RAM, so you need to add some swap:\nNote that "),e("code",[t._v("/mnt")]),t._v(" is used in Azure for temporary data, and is optimized for low latency, this is why we set the swapfile here.")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\nfallocate -l 2G /mnt/swapfile\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("chmod")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("600")]),t._v(" /mnt/swapfile\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("mkswap")]),t._v(" /mnt/swapfile\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("swapon")]),t._v(" /mnt/swapfile\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("echo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/mnt/swapfile none swap sw 0 0"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">>")]),t._v(" /etc/fstab\n")])])]),e("p",[t._v("As you can see, the swap got added:")]),t._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("root@BTCPayServerVM:~# free -h\n total used free shared buffers cached\nMem: 3.4G 3.2G 141M 30M 9.8M 983M\n-/+ buffers/cache: 2.2G 1.1G\nSwap: **2.0G** 0B 2.0G\n")])])]),e("p",[t._v("Now, go back to "),e("a",{attrs:{href:"https://azureprice.net/",target:"_blank",rel:"noopener noreferrer"}},[t._v("azureprice.net"),e("OutboundLink")],1),t._v(" and find something cheaper than "),e("code",[t._v("0.0573444 EUR/H")]),t._v(".")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(344),alt:"Azure VM comparison",title:"Azure VM comparison"}})]),t._v(" "),e("p",[t._v("Wow! "),e("code",[t._v("Standard_B1ms")]),t._v(" cost only "),e("code",[t._v("0.02049219 EUR/H")]),t._v(" – let's switch to it!")]),t._v(" "),e("p",[t._v("A quick look at "),e("a",{attrs:{href:"https://www.singhkays.com/blog/understanding-azure-b-series/",target:"_blank",rel:"noopener noreferrer"}},[t._v("this article"),e("OutboundLink")],1),t._v(" shows us that this type of virtual machine is adapted for low CPU consumption with occasional burst. This is what BTCPay Server is about after the nodes are synched.")]),t._v(" "),e("ul",[e("li",[t._v("Go on the Azure portal")]),t._v(" "),e("li",[t._v("Go to Resource Groups")]),t._v(" "),e("li",[t._v("Select your resource group")]),t._v(" "),e("li",[t._v("Select BTCPayServerVM")]),t._v(" "),e("li",[t._v("Select "),e("code",[t._v("Size")])]),t._v(" "),e("li",[t._v("Select "),e("code",[t._v("B1MS")]),t._v(" (if you don't see, take a look at the "),e("a",{attrs:{href:"#b1ms"}},[t._v("FAQ")]),t._v(")")]),t._v(" "),e("li",[t._v("Click "),e("code",[t._v("Select")])])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(345),alt:"Show Azure VM Size",title:"Show Azure VM Size"}})]),t._v(" "),e("p",[t._v("Wait between 5 and 15 minutes.")]),t._v(" "),e("p",[t._v("When Azure is happy:")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(346),alt:"Happy Microsoft Azure",title:"Happy Microsoft Azure"}})]),t._v(" "),e("p",[t._v("Congratulations! You just cut down the cost by 50% per month! 😃")]),t._v(" "),e("h3",{attrs:{id:"faq-b1ms-does-not-appear-in-the-list-"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#faq-b1ms-does-not-appear-in-the-list-"}},[t._v("#")]),t._v(" FAQ: B1MS does not appear in the list "),e("a",{attrs:{name:"b1ms"}})]),t._v(" "),e("p",[t._v("In some situation, you might not see the Virtual Machine B1MS in the list.\nIt means your Azure hardware cluster does not support this type.")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("Stopping your Virtual Machine will change the public IP Address of your server. If you configured a A (as opposed to CNAME) record in your domain registar, you'll need to update it.")])]),t._v(" "),e("p",[t._v("You need to go in:")]),t._v(" "),e("ul",[e("li",[t._v("Your Virtual Machine resource")]),t._v(" "),e("li",[e("code",[t._v("Overview")]),t._v(" menu")]),t._v(" "),e("li",[t._v("Click on "),e("code",[t._v("Stop")])])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(347),alt:"Stop Azure VM",title:"Stop Azure VM"}})]),t._v(" "),e("p",[t._v("Wait until the Virtual Machine has stopped, then change the size.")]),t._v(" "),e("p",[t._v("Once the size is changed, go back to "),e("code",[t._v("Overview")]),t._v(" and click on "),e("code",[t._v("Start")]),t._v(".")])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[24],{339:function(t,e,a){t.exports=a.p+"assets/img/ShowCost.c993e200.png"},340:function(t,e,a){t.exports=a.p+"assets/img/ShowVM.75ac27ce.png"},341:function(t,e,a){t.exports=a.p+"assets/img/ShowPrice.e457705a.png"},342:function(t,e){t.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA6UAAAC/CAMAAAAxWooUAAAA5FBMVEX///8AAAAANWCqzPDu7fDuzKtfAABfqfDuqWAAAGCq7c6GNQAAADaGzPDNhTY1hc4AX6vNzIc1AACq7fDuzIfu7avu7c6qXwA1X4eqzM7NzKtfNQDuzM6qXzY1havNzPDNzM5fhasANYfN7atfqc6qhTY1NWCGXzYANTZfhWDN7fDNhWCqqc7NqWCqhYeGX4fN7c6GNTY1X6s1ADaqhWCGqc41AGCGNWBfhc6GzKvuqav/AADNqYeGzM5fXzYAX4c1X2A1NQA1NTaGqfDuqYdfX2BfNTaGqauGhWDNqauqqWBfAGCHyHK3AAAbIElEQVR4AeyceXubOBDGV/bY4CDAVTC0zbnu7Wzv+777/T/SwuD0XVUT9ULPwzZ6/3DJ6CFijl8lMJO/oqKixi41bkVFRUVK/yeaTGk2V0olqTrvWuxkY8/RuaQ0SueFKlOllheMOu9KinOUIz+li93K9BHhH1bz7rPOOhM17SF1qmLJ/L4uXiKiy3vbmO4fdIFOOempvX4sKzPaZUSqDdjUqWzfDo+I6BgV1kn/3RrrC+bsCltfmTu/r9P2jDrDvLDpnLaqTBDf5ByFp5Sar5QuiQo29Z8NxyZqEF2trxmlL+71MdVXqbEq2fp/WueNGqPk2oBNprRc7Smlr99AhbXD01n7881bBhXmXUrtSlxvCmte2PoYViacb3KOwlO6mm9DovOTzsHFzj/t53I2HY7SqCU1qLe+qCxKrXue8rYap8TagE2ilIuahQpTKlnNbfr8S6lMKeZ1KQ3pm5uj8JTe2aRMKQemrLP2yu7ey1RykkdKBxMqx0spCnScEmsDNnktTeoDNqHC2Hs/pWDbQynmdSkN6Jubo/CUNiU1PaVJype32MmSYrFzP1I6jFBkOLw+nc1RySN/tgmJtQGbSCnfkV++oRQqzNlZuFpWxk8p5pUpDeibnKPAlOp8NU8Knpm3Iu2/y+pB9TA/vYtezdWAipR2D48eGXUWpVeLxZRme2qMkmoDNpHSTpPHNJujwnpKl/wISK4w3PV5KcW8LqXhfJNzFJjSzsGO0pJYRXtli52jRgdbS+OOF0fu3q6sTFJ0n2qEsmvDsUGWbwxRigo7RWrZUZp6l1I/pZjXpTSUb3KOwlOqyvqo4Iiyi092su4/vCEpjVqSfSeGclrsWpSuL3PkR3pvurBqw7GxRN/wHIlHkjrzUYrf5acU87qUBvNNzlF4SnVOxemcZf2033MPSmnUVbptlLrO38QA3QOln63m39bnqNdSuzZsGwTfFs9vmPaIGlRYphbT+sCcTWkJo5/SVjKlAX2TcxSeUnYxSbeGF7iyr98Wq6hB3mo4zqx6e3DUvejgfEs46vtSpzbESoZv+vEx8REqLP36VsMeKsz7bOZ0ttVcmhc2UBrQN+RoPG8IRkW9/FFFRUqjIqWR0qgoUb9SfDFQkdKoSGmktKRGDako/ZjolTnD1vdypFbv4liL7/rj20LHJd028qhcTd5eUv16+7xJsiFWan2JeF53tgA5wgMx5OgPozRK56nRSWVkm86bMfeXovj0VarJefF4c6Amu5WRR/3VJDXA6DdGTfLVXLbhgevbA8OvS7izhciRKusbSr17b+foT9rxRpV9624h2VB5o+wvtYrvg9AewEW8pAajZ/ScEtZI/7vrzEQm2kApbOhXdWcbLEfrjZujSOkf+Iogf0o2ey3ln0ZKqXIo5YvmSsbo2T2nE3bau5QCD8EmUop+VWG2oXJUst3KUXBK4Yt+TP0+ez2l+vbH7nr4G11rVOetgT2HcAa/T031gf37ouyaQV+lY9M50as9p3dx9JTCD/4EpejLtKpJok9eSh/ca2QbYsXi8CGuwmwD5ah17MGGZpmco9CUfnp9Q026a1lvbhv9jCqzfRHaHuW/hWHv2XFGe3Ri1CE1CmfYipQWWCBE22RaZ07Rjp5SrDfrTWVAqd2XuQQ3DzaFr5cUu1WfDbHi1+b4A7JnGypHOqfbRid1JucoMKXdtIxf0m8nQClGt1l4xj9BOCOpDMfFOiPqJyjFRgU3POOnFK0Ek5xAKfoybUqJN1yeBhjoIkMv2RArnu629ZcwnNkGyxEvUzyxnKPAO17VU9WH16YUoxwKaniIWI3CGTonVmqdEfXDO16FoKF3ceyUQt1W8GlnBqXoy7SqST9w6JPu8ECeY0OssAyjX1WYbaAc4Q7Vk6PglPKRj9Ly210IzsD96i9RGp8eYWuC3sWxU+r2bWAUfZk2pejh8y2l2MoKNsQKl4J+VWG2oXLUT5mkvhwFpxTXI1O63hzgwbrsQaT0157yI3Ru7+L4KYUzGEVfpk0piPIvpf611Ckz9KsKsw2Vo7LO+MiXo+CUqiVdU5PXRzKlfHk6t5+Y4Yz1plv+b34236c0vtXA7by2TX9R/GDC6l0cOaXwY/Kl2/Q2GEUXmEMpd5r6e0nVze4Nhl3ECjYrVoAW/arCbEPlaLFb7XHHrCdH4SlVhxua3ecgu5Rug89hgnDG5PGGaP/k+5TGNwRRAbCtp0SzvdH2l6L4dE6syij48faIaHbjv6NPJErx98L9vaQcjfo2YgWbFSuV/NvefTA3jxxpHC/pdCu5Nqk2vfmCLr/B2Zeds/39v4851Io/ltye1esBC9NQt8NiAcxMNwYPCZLz14MqveNV49HG5+iw9eJ4jtZa1eBx5lQtKmq1feettB+12v5890zxkR9blm5RUSodt2wqlX5tZCLGW2w5SqUVtY63olRaKrXucQJKLQExd0J20d/emp4vjZjOgPhU0Zyk6cAcrcKXQnJKpWGcnl1EhkzPl0ZMZ0B8qigTaToyRyuodPh72/fvr1Y13OxmfW6+NGY/Q5ZMRYlI0/E5KpVufIXgRz9+ErCLiVXaKkpAmg7M0SoqxYje+Xm0Xbe/DMcE6fmzdnj/qtZ2NvO2wzqx3XlP/+Zef8twrXo27tnZbtf+p3Ut5KKtnLW4+e5/7Uio693C7KOez3/clmk8Oc5Ffto6Orra/vrqLAdfer+MmPhsFSUgTYfmaAWVYkTd2LevIb9oFyIgSBvM9qK5KrQTf/XbF+3l5din56tGn371of4W4lr1bNyz64s3rZcnWhzloq2ctWjLGy//9192l+Go5/Pmm9A+/chFZ9o6OkiuffTj1nECvjRYHBsQn4eK5iVNx+doBZViRO+rtEVEkHrVaffzi6/XN95ReAh+/S3DterZuJ5MtJCLkLMWrf49FPREz56r5CI/bR0dvAOu22vz9HwpplOExOehonlJ0/E5WkGlGNEjVV2//vqRIiJIaU+D9mK2L4o+HcamDnGtetZxG/b2o4kWctFWolrctBd7KuWNu//eXS7y09bRkacpL9Mp+NJWvAiJz0NFiUjT8Tk6sUrlQ3S38a+/ff23x58Muyo93Lq7Kxa/l45zrXqOVaqFXERfpXre9fEvuw/Kgyp9+DcT167f1HxpMJch8XmoKBFpOj5Hp1dpKzeciY/aFzshQaqFBu14u7nxfQ4vxLXqWcd60UIu/SdeKtWzbxwilWrr6BJ/6TMBXxqUGhCfKspEmo7P0clVihHd38v7Ks9/9/P2GeDKUQQpqvQ3R2rxTrb7xPbqQKS2/hbjWvVsXN/naCEXIWctqFTP+w+8T9tXE5FKtXV0hF004ZPzpeShjoj4VFEm0nR8jk6uUoxoK6x9KLu6/Tniqx+2PSFBervv1ZFaQKi7bz//+faLcv0tw7Xq+Xjcp19Djlr4h5CzFlSq572pwv//YjdXkUq1dXSEXfQwNTlfiulUR0R8quhbCUjTgTlKuNreqy2lLb/u4aE9y2XRnmsReX7StJiY889ZPg9QquNaksuCPZdK85OmpdJP28OIO36AUh3XklxKpUWulUorNh2l0vIvLf9SW7n40qCO82e/f/v8wyO3z23wpeVfWv6ltnLyperY/7B4/eUH3D63wZeWf2nxpbZy8qXquG4H2i9b3D63wZeWf2nxpYetH2TkS9XR7uTbG/vwk39+vjS9f2nFMk5BtlLxpUFtlxdv9uznwe0zP1+a3b+0YiHXPVsZ+VLZ75fkXPxLE9Cd22d2vjS/f2nF8ipNyJfKfifS9scudocPbp8J+dL8/qUVp33izciXyn7/v48uL46o/P9MzZfm9y9dPurbo88y8qWyx+ce3D5z86X5/UuXj/olJiVfKvumlXtun9n50vz+pRULeWPaSsmXqqPdye3/uH2m50vz+5dWLOqN+VkyvjSo4/uvX/7D8xfcPhPwpUn9Sysqii9N4F9aUVF8aXL/0opSaUXxpRWl0lLpsl5MKKEEfwvhX3/0bi6+FDOZgC91/VquF+/uU6UCSpaDL9Wf4FqqypPzpaXSj/754ivzMAlfipmcni91/doP6PtfRFCl9/kWFzoDX6q/KClVBnM0q0r7R/oq1XaF+IWBp1nVgLyami91/SxvuG46QJUex/Wv2ol5+FL9Ca6lqjw9X1oqNfBk/qV70U7vX+r6tVTx0X9OhrUV9leZ+FL9CT6sqlyBL+17gd4ypz/8+M7DqV0HDqB8Sb/R2dNoN/c9TfUXuYfyII28VOV8893DYpPgaKDSqVbbYyaxi7Or1JpdVKlon9raiZn4Uv0JjjeqXIEv7XuB3rzebx2plAOoCftGZ0+jvfzDfU9T/UXuoVZPB16qcr5DIi6vwqOxSuch1zCTbtXJVcqF8jNUqbj9AHeVyr9Uf4J5nCpX4Es7XqCY02OVxq5PD3P2jHzY9Be5h/IgjbxU5dzuirbvSXA0g0oxk5Pzpa5fg0zOP7744jNUaQt625+YiC/Vn+BaqsoV+NKuFyj3USp1k2vyUM/AyNNUH5F7KA/SyEtV4ybGPVEUHk3wxOsOm5wvdf3aHxj5r92/oEpFm7F2YiL/Uv3Fb6WqXIkvjbxAKW1BlRotUmngHsqDNPJS1Xiv0DbLwdEE3x657tjFqVVqRp/cfwayKL+JJQ9fqr/wU6kqV+JLAy9QdDL//d2u93riDVQaeJrqL3IP5UEaeanqZP+ivf/GPD4qpvwlxvsDdnFulSoBVRpd6Dx8qf7CpFS5Al/a9wL99GL3y/Wz11e3mv3xP7SqOYDyJX2gs2fkaaq/wD2UB2nopSrnPVNx2c5zdCqVdtlFzOT0fKnrd/6b9tD75AxVqjYnJuJL9Wc0UlTlCnxp1wv0ljn9TTuw/wWl5cgBlC/pNzp7+r7kzzxN9Re5h4JaIy9VOd+q84Oz6KjwmVZWM/ClmMlZ+dLg+v30cJOgSmOVpuBL9Wc0D7yqPCVfus6aPUs/rIaMI87Fw82JMqgovnQ88qt0wJeQB2lF8aVzRqmUB2lFkWtFrlVUlEqLL33ge7jOdvEkBUE6zpfiIxPwpXxJA2fPmAzNwpe6c1ClQpWOmq3HqNIDgpCBIB3nS/GR0/OlfEkDZ8+IAk3El7pzglRU6ejxbOUn18ZVOglBWnypaQmcPYWK8vCl7hxUqVClo0ezVSodSDiJA8XhLpudL+VLGjl7CkLOw5e6c1ClQuWOmq1N8aX2IU05o8qFSvUnvzkJ0vHV9m1jdr6Ui2fk7BlQoHn4UneO5QxC5Y6arU3xpfYhTTmjyoVK9Se/cYJ0RnLNQtOZ+VIunpGzZ0CB5uFL3TlQGKFyR83WpvhS+4zLGdU+KtWf/GKCNLNK8ZGz86VcPCNnz4ACzcOXunNQpULljpqtTfGl9hmXM6p9VKo/gwUEaf4nXm8jU/OlXjUjZ89gcWcivtSd481SqNJRs7UlvtQ+46Je7OuqNCBI8397JOW5+VIunpGzZ0CBZuJLdeNTqVClo2ZrQ3ypfcbljGpf9MRrsAGCdNZfYlym2flSLp6Rs2f4XpqGL3XnRKmo0lGztSG+1D7jcka1L/z2SH7jBOlkfKmbbna+lItn5OwZUKCJ+FJ3DtkZV5WOHs3WhvhS+5CmnFHlQqX6k99sBOk4X4qPnJ0v5eIZOXsGFGgivtSd45HWuKp01Gw9ar60CNLiSxNE8aUVxZeWSkulFUWuFV9aUSrNH/VeGlGlqCOZLuzNqMVAzwN8acAzzs6XyhTdKWJ30yx8qV76FZmjR6dSJMw2VRrwpQHPODtfKtPwN8XQ3TQLX6qXfkUr+JfO4FUYq3TxTPUi9LfCqoaAZ5ycL5VprNLA3TQRX6qXfkXmaFsqLZVaQ9XlGSfnS2UaqzRwN83Dl+qlX9E6/qUrO4oajUqPedWW3rud8QQ2Vab2aWGftkG9WoSV41rjnsdX28c84+x8qUzRnSJwN83Dl+qlX9Eq/qVrO4oajUoP8m47Wga79SDYVJnap4V92gb1ahFWbmVi2PM4uRbxjCn8S2WK7uy4m/5nKr5UB12/1hX9S9dxFDVarNJ29B6vKlP7tLBP26heLaLKPaGGPS+v0phYnFClMnUhO+6m/5mGL9VLv6LPVvUvXcVR1K5IpTI7Zmy0sU8L+7SN6tUiqhwxF/W8/BNvTCzOqFKZuhgdd9M8fKle+hWt61+6hqNoX6Uy+6tUqm1Q76IqHfj2CM+YgS+Vaf9THHfTPHypXvoVreBfOoGjaPeJ1939/irVNqr3/Z949Tz+S0zMMybgS2Xae+JVdB6+VC/9itb1L13HUdRokUrbdPzL2fmP//5YpTLtq1TbqF4tgsrjb4/0PM6XRjxjAr5UppHbZ+Bumocv1Uu/olX8S1d2FDVarNI94fq9XTMakWlfpdpG9WoRVY5rjXse50tjnnF2vlSmkdtn4G6ahy/VS7eiFfxLxaSOogOrDrQt+jQFX1p8aVpH0fPd8037fXOwbUUCvrRUmtVR9PyZNZinbltR5FrxpRWl0rpQxZeOjDHAsI36l9qaly/1gPL7t88/jIlPW9w+E/Gl5iNmTvdY22n50uJLjbGCSnv+pbam5kstdbyOiU9b3D6T8KXBHAU9X7aXhBPzpUWuGWMCvtQ+W1PzpX5KufluSHzacpEz8aXmI87g+lftPknJl5ZKxx0oDls/mJcvdfH+IvFpi9tnIr7UfMQqbczArqeT86XFlwZj6E8di5OmfTcnW/PzpZcXb/4S8WmL22cSvjSYo8AiZv9qfnK+tPjSaAz9yXRp0rTvjGhrer60Lbq5+JeY+LTF7TORf2k0R3puH8Y9c52QLy2+tK9SmQ6TpgMqnZMvJdL2ePUupEBtcftM5F8azJGe2yuI++SUfGnxpX2VynSMYRt44p2eL205fnQZUyq2vLb9Zwq+tM8A34nXXXFSvrT40r5KZTqi0oFvjz6bnS91RwTEpy0f5RLxpdEc6fnywlr8k/GlxZf2VSqXAdJ0+JeYyflSDnmhV6ktbp+J+NJgjvSs+pPzpcWXRmPoT6aLk6Zd/1Jb0/OlTX3t/yLi0xa3zzx8aTBHeqbS0/OlxZdGY+hPpsuTph3/UlsJ/Eu///rlPzyPvUptcfvMxJcGc6RnKi2+tPjS4ksf6YUqvrSi+NLiS4svLZVWFF9aUSotlQ58KkQJrRR8JqeNPl8q+9n5UpmGTGdMfCbmSwNi9q/jS0ulfCZnjT5fKvvZ+VKZxkxnTHwm5ksDYjaeo1lV6sh4jPf3i8Fk1uRLZT87XyrTkP0MWLJt8KWI2QG+tFQ6nMyqfOkh+wz+pe+n0m3wpYjZdfhSBCn2E1G5JzR/eFhT0K4D8hKXieXTFoMZjeY8lKr+kKGywn5qkUel/dX2sscu5lDpcUEh8ZmbLw2I2VX4UgQp9tOauJvX+61jlSIvTZh1HtpiMKPRnIdS1R8yVFbYTy3yqLRPrsl+dr5UptFC+ID4TM6XBsTsinwp9hN1hNA8UqnXmlCl2mIwo9Gc5wlDf8hQWWE/tdikSqfmS2WKvBQB8ZmcLw2I2VX5Ulcfq4U7pVKTFKlU22itq9Gch1LVHzLUENhPLbb3xDs9XyrT4K0vID6/lZsvDYjZz9bjS2OVUtUyKjWa81Cq94k0KrWvhRbb+vYog3+pTG2IgPhMzpcGxOy6fGkrNKKT2zl3On6PJ95IpUZzHkpVf44a4nhcLUTqX2JkPzlfKlNTKwLiMzlfGhCz6/Kl7nLfHn168Wr3le7rq1vN/vgfWqLIS1xm8O1RpFKjOQ+lqj9kqKywn1rkUWmfL5X97HypTCO3z4D4TM6XBsTsGnwpgtRdjqjcE5q/aQf2fw+0vZwgL3GZroi2kUqN5jyUqv6QobLCfmohjnwmp4w+Xyr72flSmUZunwHxmZwvDYjZmC/N6kARsKR/NNoSyxSKGy2+tNyclgujJSRDK4ovLZUWGVoqHYki1yoqSqXlXyqDh7JGzsuysKHvjYlinJ4v5eKpIpyncF4qvhSjbCt0bo1p4FJpbpX2vTFRjLPzpVw8VRT80Om8THwpdtaW4Nwa0cCbdkaUwYDeEqi0zy7amp0v5eKpokilzsvEl2JnbQnOrTENXCrNrtK+NyYhz86XcvE8qihQqfMS8aVuIFuCc2tAA2/ev1QGgaPog31EkbBTRt8bE8U4PV/KxVNFB85TOC8RX9pXKefWgAbevH+pDALnlgf7iCJhZ4y+NyaKcX6+lIunig6cp3BeIr60r1LOrQENvHX/UmNEKn2wjygSNo1KUZEoxon5UjoKVGoC752XiS/tq5Rza0ADb9y/1BiRSh/uUKiCKaPvjYm8mJ4v5eKpooCQcV4ivrSvUs6tEQ28df9SY4yoVAVTRt8bU4XT86VcPFUUgIXOS8SX9lXqPg1p4I37lxrj/Z94qRQJO2X0vTG9P8zOl5obFZlG4bwsfGlHpXZ0aOCN+5caI3IUfaiPKBJ2yuh7Y6IYZ+dL3a8qwnmqzXl5+NJYpcbl3BrRwBv3L5VB5Cj6YB9RJOyU0ffGRDHOzZe6gVWE8wxVmogvxc7aMi7n1pgGLv/SiuJLZ4jyL60ovjRnlH9pRZFrpdKKilJp8aUPgNB28aTDGuVn2AK+FMXoY/qXH0zPl2I6VcTZU9iXki8N6FhzpLbHwZe6IltXacCX4hTxILPzpb6sVRFnTw3sS8mXBnSs9NS2fb40Vul4LtpPvaohoBjbCpDp+VLKUFEwffZl5EvRscIcqS0/X1oq7a4QlKYHuScJ/EspQ0XREozDvox8KTpWmCO1PSK+lEojvlTbxKRpZ7W9NK9T+JdiOlXE2VMc9qXkS1G0whyp99HwpVQarePVNitpGpBr8Yq0H3+Ywb8U06kizp7isC8lX4qiFeZIvY+HL+2qVNsUpOmASq/fnWXwL3VbqIizpzjsS8mXomiFOVLv4+FLuyrVNjdp2n/i9TI9PV/qpVNFXdfH/8zIl6JohTlS7+PhS3sq1TY3adr/9sgnngT+pYBoFXH2FHf7UvKlKFphjtT7ePjSnkq1TU2axr/EKNO7yPR8qdtCRZw9D2FfUr7UZpCeeh8JXxqrVC7aJidNA77UrWCaJ+dLMZ0q4uypNvtS8qU2jWuO1PtY+NJYpXLRNjlpGvClOEUPU3PzpZhOFXH2VJt9OfnSSKXmSL3Fl1YUX5ouii+tKL50LIovrSiVVhRfWlEqLZVWVJRKS6UVWW++h0bF8iqtqCiVlkorKipKpRUVpdKKiopSaUVFRam0oqJUWlFRUSqtqCiVVlRUlEorKipyq7SiouJP+XmaVR5qe/oAAAAASUVORK5CYII="},343:function(t,e,a){t.exports=a.p+"assets/img/ShowB1.2698f386.png"},344:function(t,e,a){t.exports=a.p+"assets/img/ShowSize.0af29467.png"},345:function(t,e){t.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAc4AAADMCAIAAAB1O9RYAAAhsUlEQVR4AeydhW8byxaH7x/yKrrMzMzMzIxlZg62sW/sYrBcx2mY+VFAlxkteMyUVvA479OO3tF2tjuNtbNOHO3RKpqdPTO/ceDz8RnIKT+YIpuYIvvwww+n6iXfdtttkfQ0lI4ssrPOPf+hZ15/c2lhthetaDsZiVNuy4lFqI14Nz2lI4vsmhvveGNJgYGn5ou29BChNkJtJB1ZZL526z2PgMvgF/1EqI1QG0lHFlkWnH1rWdGclSWL1sWWbSpfvjnBRWHx+vjcVaVm2kaojVAbSYdgG4fHJ8aHN2bbLJUxt8qqo5FNk/ffNDKOMg2ytnRmwm2ZlMnZyitDJP3/MSMXTt7Aj7PzVm/ZsHV31YGGpo6+9p5BLgp7Us2F71ZBWxz8aEufeY/ao0ePJhKJl1566VrHKHBL5cxG7cKFC0dHR/mqbjds2CC3OZCur6//8ssvJxyjwO0USr/yyit5RPmcojZc2zQ8LnB1IVteQogWImqZy/LLzy5cW1a2Y29zZ19r1wCQlaute6Cpo7diX/3SjeVv+9CWPuk5j1Hb2dl511133XnnnQUFBTWOUeCWSh7NSNRC1fHx8a+++ioej/OOco5j1PT29v7SsVdffTUkaXqmf0QBHMN43DEK3FKZA2l+THytrq6OO0ZBKg3SEWpDCy9TPhE9D/IVtX7rDWavKNkcrzzS2i2ElUvC22TVocUb4oY1CfmKWmBKGAtbtRiWWyp5hINd1BJVwfGpRS2IgaqqTGHUsbGxMVVDAfaFIQ3X+C6hDtm9T6nkEQ5VVVUhSfPSTvjNp5JHAaQDwzENXOTzsweaikqaQ1qqpE5a6Y2o2yQUk0bpE6BH/IcFtWatkYyqxEepuMJV8ReuDVOvglbhqVuX93s1KrqmoKnTLqXgqH/f1FCpcUtKz/J6ZWwhJhAuvvxqP1CuKEju3psGqYarvqVrU1nFOyuK/Tqh//xD7W9/+1vFWT8HRVvcLKKWWJLfJ2u0DRDfqfJVV1015hgFVcMjhmddGtjxBkYMa3bDATecbUkLZ0/6/qFAj3POUSsohAICCoEmJTewhlOKPs5TYQes0VrhA1BEgrLylMpU2j/ZSv+KX2YtN9YEteLj4ZrqR/zx8TbEWX8qGtBZFOX7JvU88KpncNBeXbioNSyhJRubbu6Ep+YrUXnQHNjmH2pVosCQk+URDrhZRC2xm9A2x6iFsOvXr3/ssccoMFq/0JJHOJC+jMVixOC2pOlWOGs23NQYLEobOKvR1oJ0kI/8wh2pl+jP8One2+rE/oIh3QRAWpMstKReBiz13Hm4xq30n0mLKB0Kar3q0ommLq/LH6AyqjBRe9oZZ0JDvwmx2M59kqI1XLWHGteU7DCsRkAlz1AL7Jj+MvvgQNLWImrNtA0VtbxzqGwsQyU36ufGIxxwJtTF2Yo0/UCxrFIcFqV5IVq6oKenR+VneTvR/OVVTxPUSo0Bi8IRL4DE3GEmhrtpGMI4Py3DyCloRr0vaulfOpGyPBV1E2qF17qPNhgDasNceCCJ2vKKAwbCynXwSBs5BANqUQmM2heKWt/76e4Xjqt7LjH4Xn/yuRBQS3LgJz/5idkHB9zsotZM25BQS3yKoqi76+GOtvZARiWTRQGl1eSbTMqhKPkKyWNQySMZIU2sSKv3VLcQ33Y1MyaJBXNMnQdRLT5aKzekxN80JSX+epxo1vKOXByMc1DiRi/eTAV1ejZAhj1Z1MqQchjV3vvYC358ZCFXsvLgZFB7uKGD2TMDalEJjNqtg7/9x8Q//vCe0Pa5xE+dmp/uto3ajz/+GIby1YqbjlrLtLWAWoI1b1xJAKviTYwCsPNGl1A4oDQqmPbToWdNSNXrrQJL87q8/BXu4yAxrxhNqJ8GqBVoZp2r1efHZOKIflw80pCaTa7WMHLxMaFW3GQ6i6dKV+RUK/9crRG1UpBKA2olI4yEniKXpye3p19baEBkbNe+yaC29nDTWmMCAZVAqBW2Cm3dZWyGoVZoe+zYseXLl4eKWgktJZyUyTGBDgVucXOHmTShJqA0r9EdOVImj+GNaqnU3Fj0Glya0NXs4EUtTZCeHqjVUgEaDbXkgLTSJt8zGckGSJ0Xi8I8B2cSbJq1PCOXR2KGEBI3I8TEyWcFggG1etNMZjx81L4yf50BkcXJmoa2npOidteeOraQGfpBJRhqddr+/M9mzuY/arFbb72Vhv/5z38uueSS8FArMB1zzC/OBTHwTp5iNAkubZ4QM0+OBZc25IihOQ7ae4mE2KGjNjIho2G7mCFzMv3MfLLMqqJtlfuPmDnLRobiRPWclaXmM2isTYu91Zz5B9/zf/+86x3uZixqr7jiim+++YaG999/P7c5QK17/SxU9X6Kd6MW5xmMWvqX6cG8QG1kksqYtuYHR0nXst6rrsm03osNY8s2l+NsvqKo9sNsOfvzn//85ptvzs20mNoPBj2lxpxAgLY0sZZAyNJoQkPrCQRzGlei++DSkdnDq5hwNi+jWq5F62Ms+YK2bd36xtzmjr69qWaytLNXluBpJ6qNcrUGzuZ+WizmGNlJQOxthVmcFmMO0LAjC8bhEPa0mGgJhQNOi0UWmTlX+/by4rmrtyxYWzbP+bp1x94D9a3p5q761m726bJD7FBDO/HsysKkclu4LoYne8bMudpoBYIVztqPagU6CmcyOdbrGA7uSSoV50pUGzygpjfVM1Nt0NZvO5lbOviKK3qQxV4GC7DYK7LIDCsQgGwRUeqyzYmSZM32msOcNbN4feyd5cUL1mzdWFZRuq12y449ReXVKwuS7HGAreRzd9SkKvalS7fXUqYt9YYVCJbX1f60rei5mYJaOKucs+KsrcX8pF9B2GS2MOBGnBvGFgYoBlIZCRvSQCpGgVtZSGt9CwOdn/ANAKNgaQtDZJHp62qZ3eK8xP3p1sa2npbO/taufrIEB9KtBfEqaAuF+eoUioEsCGZLLqEubmwqw5/lCjWHGpcXJLXwFpW82S3GsQYABYby9ROjiRtNgqN21qxZrLvB86abbsr9GQhkP0EYOJONuYaYjgL+FMLYmEuYqYAuxi3xbC435gpqbWzMjSwyfbcYGYCCeGVdc2dLV787LcstPK052EDStihRXVheRWy7vSZFDgG2unO4bd2DHLd4oL5tzfEJXFTyBrWclHhtlkYTK1HtNddcI5zNIWp1nsq0D9QbdUzIK6yxftwMkbLQVtQxbWy4hXHcDPno8I6biSwyOQNBzvEiJvVbaUDQCnAPN3ZA2FRTh2G9LfDdUVu3dOO7eXkGAiHqx8fbiy++OGfOHFWmwK3mYCWqNeNg1N/gka2/fNka617DjxFXGs4rsCItyPM76YZHArswpPlOaqwXvvMoa+l8sMhee+2177///r333iPKUTXsGOLXnr/oX//61319fXfffbfWpKKi4vPPP3/44Yf5Q6Dt7373O2ZW+KuZ/MleJFg3lu1ubO+FlcEv5s3Wle7Mv5O9DHFuwjEK6XQ6x//whg+zcX/jw7X1QxQxgCtHg1OAtkSUsuRLzLo0KmipY8YwCiKdm6PBmZeLOUYh348GN1tk+/bt+/bbb5mIXrRoEbcLFiz47rvv6urqbrjhhtmzZ3/xxRdDQ0NnnHGGF7Xr1q2DyDTnabbn1ZKlLUnWQklbF3kGUrr5dF6tmbaPOia5ghn/D28IZt3/8IZbcJMDaVRgK7/HE45R4PZ/7J2BZ4VQFMb/tsFgCAiAMVmDQYBloMgaXApBFiAhiQCChIQgoUCl/Rn7uHaxvVFkrud88tSVcx68n+99rnuuvvX/iwQnCz/r+35VVUmSYAUuqmka4XBd1wV54Xx/oxZoxt9ZbM5RFOXokbWY0ijO8Trlcv2P55c3VKYxjjTGkVqTpJNpmvCtIKnneW3bIivIsizPc/GCpmmgKj4vBghYx48a6UEYhvu9LSaAIVrFnq0TUcswCOf1XcbZYoRaak2oJQGsn99alsVxnDRNf7javu8xuTWO42ma4HCRGwjU8ncQcCGxZYzt73tze8ePOzjrCqIYNWk4OaGWWksnkqqqCIiCIOCPZVkiDTAMYxxHntUiPYPnxeLFrFagFjdd10VRdKj7/cPjiahFNdQk1BJqqTVJOvEcVtd1/sgY47Gsbdu42bZtnueiKP7agWBZ1jAMsMPrutZ1DXAf/QJPX+zbgUddUQDH8feXtGp7ql6twTYCgrXhlcTMeiAExaMIGY+xjIdEPBoWwCQyQIACISUJFF0gSXpRKnXPfu7z7urerXa797Z67/uRnO4955yEr9y6Q9lIOqt9bj4ocf8/XFLL0Q/naODDx8zvtxKCf2itdrjlDFJLdDgaePnq9Zev+Tt0Vqu09vYDSC3R4Wig5M3bd/8eXM3U/NJCUktqOToYoKW1VQ8EPuU+F759/zH3s/RsQZ811hVd113NCbotqSU6HB03gNTGj96RWiDxIn5tZc/LWssMAFSBxL11Vq52tsVhACBCpNbf2VQqZQAgDqTW7SypBUBqY/yVNuVobm42ABAtUuvpbFNTkwGAmJDaUmcjSy0AkFq3s57UNjY2GgCIFqktdTb21AIAqXU729DQYADgwdvc3MxkMsVi0X9LF3VLE0gtAITS19eXTCa7uro8tdWXuqhbmkBqQwEAJTWdTntq63ZWtzT+b6ltE1JbiQBq6+8sqY0YAGrr6SypjR4Aahuos6QWAAJwnxuIBqQ2LgDobNrh1pbURg8AnS06AtU2kYzTs7Knjvr6+rq6utra2ieOmpoa89gAoLM3/AcYqQWAEK8wXO+sp7aaQGqjtL+/Pzo62tvbu7a2ZoCqwYu5iunfXszVLU2ootQuLy9PTk5eXFwYn0KhsLW1ZYJbWFgYGxs7PT3V+Pz8fGJiwrIsjY+OjgYGBlZWVkx4/t0AVJZKS217e/vi4mKY1K6urs7Pz5uyk5OTvb094zg4OMjn87qisW3bu7u7Z2dn5q5mZma2t7c18O8G4EEjtVNTUyMjI5Zl3Tm12mR2dtb4XU9teP5vCcDjQGpVyY2NjVwud3x8TGoBxIXU2rY959Dgj13T9fX19cHBwfeO4eFh1VkXDw8Ps9lsZ2dnR0eH/vA1Pj6uR7RapbVaNT093d3drQcUPT09/f39Ozs7V/e8vLxcWloaGvrFvhlwJhdGcfyD7SPsAwTG2MC8xgCzYVOpUkkppRRVFIhURUjQN4gKolKSQAjQ+/M+HNe9U8l7B84fee69zzn3DH47zznn/sEhtqlUisIu9xeLBdynas5N+ml01bhJS43Lu7u7+/t7Fp1OxxYhlQTif3h44KnH46EAvdvtrLhn5/v7O4/YQCGC8rQYcmnuv76+bjabk0qlckOKWhaktAAOgP6I2tFoFI1GJTllwSW2P2a1glpnVis+IV25XG42mwDXPILRsJuduBJKrlarRCIBDW3mTm+saceJt/l8/vn5aTBNDPw/gPsmDPbU63UDa9Rut/v9Pq82MRyPx5NKpXJJilpEufbt7U06WgIyUldwScffarjdbr1eL4C+DbWTySSTyZjU8owgYC6Xo/11HrXMIVSrVYNL0XA45Kagdr1ey6PlchmJREwSnU6nZ7PZSaVS/Y4UtYhRBA7yENAKMg7v+XzeZsieZDIJs25DbaVScY7ZSmFhOp0WCgWO85Qd+KoEk/OoJTynNwAdj8fhqTUGZ1QE7/P5JI9WqVSuS1ELQDmwDwYDAZlzj5N0N6BWFjaRJvv9/lartd/vyVJtO2V9jTd59XnUmuowMxhwWYGrUrkuRa183MVxm/FVa1ZLEvp/s1oW4/H45FC326VyKpfkpIFA4CJqSYHxdltWi6S8+/LyInO7KpXKRSlqkZn9CgaDBmQkmGSatlotpc9YLEbD6jbUUkgF31JdFeEHb9a3PD4+XkQtJk5v5Oa0vFhcg1rp/skf4q5UKpWi1sx+McIlXOv1elY2HQ6HcDgs5VEWpVIJq+tRS6Hg4+OD0rCx4pd2HJkysJMPhXkL+7+/vyUMsldmzpyohfgkv9YJBDpdX19fNPQuopb+nrHiF17/0pe+KpVKUYvAEAMG1rlaIPj8/MzwqZmrtR602RwKhRiehb/MS12DWsRYVTabxSFiHrZWq0FY1Gg0PP/EkADFU6sJk7lPT08EAPqd3orFohmP5ZdP4CA19y+iFlfGihioEf9l7yxgI1mOMGwxhcQUEkM4EYaZGcVhUZiZmR8zMzMzMzMemEEy6/asg82vK+nXqMbe6/XcrlfP36fWqremunrnonzXrp13tqwBANUCAKBaVAsAgGoBAFAtqgUAVItqAQBQLQAAqkW1AACoFgAA1QIAoFpUCwCAagEAUC2qBQBAtQAAqBYAANWiWkj/Grr/13/3u9/tfxZSE/2rlbOzs11VU75WuUhD5uYX/nvo0XpNcfPgw499+0e/VE6rtbPdS0449cwrrrm+d/eSuGt4x0t///TQz5/UOO/RxXYjcuWPnDi8sHNPwzp/uG5GozBZt/DKvz83urDLkS+dMaagIm87cpteN4VqUS2qFdarbOvfQ7EhlOtJej3i2JO2bh9u9wZ5XIbtz70ki1XFdNBtszJjH1RrAx5w1X7z/AltqnxUi2pRbdu21W8b8j9k3mdQbbl9Bl+1viOVveaZZe+LalEtqm1LslKthGvnqifw+c9/PtoLjp988smK6NdhjI2NxVX9XoloICioVy3URHGhY3J6610K9RSTG2+5Xe0CDUlQnlUk3saP9tJivHU/QfEzzrnwN3/6py7JyPLyBZdcEQkTk9OKax4ydTVHtEW8/cmv/qi1CiqyamZsrc/WoWC5aiUgaWgtD0ZLQXoKZ0l2P7p8Sm8V1Fxr3XOwVZXgYFKt86Ngqu8mho/YetU8IjqoFqpWuyhTBbWvaqJaVLs6qDYlRJMhItKrPCuxukVr1cqnId8gvV2HaiUySzBk6lNtyC6uhmFjrolWhd2UJmlayhHX+Mu/Do4KgWumU60m9ruKOFheMKu2+LRoN2k4J+aayIbyV0gwglJY1ZVRTfPX/m+L0qxaO92b2oDJyJGpucoqzc4tUa0Nm24N1aLaNqqVE+VKq1aWjKNovcPgtVanVWsjZ0EXk1RrT3lui2ki2SmSVsmD1mKcan3a1Uhi9TFWQ/NVVauammhVqhlXq5n1gk1OtXHktJJsqJBXMpot6UnVbg5qoc6nHrrqHB94PbTdk9MrIdxk59J+RXWOalEtqpVS5UqpMzVt5V83EEpU6+LWdHo7UKr1SdmubKjaVLBctT5+9kG1yZXOqRvfZbtVbRJ6nME3u2pRLaqVBP28l5WaMstVG6zaSXB+E9UWNBBKVesl0amwassbCEm1qWChau07d2P1qmarXtdqIHRW7Sv+9pyD9QaCm7B11VbXBtFA0NXCBkL6VOmTb2rVolqeq43Ga2oUOMGn3RLVSqmuWX97wFUbEkxfi5WrNoSotXrV8vBmBNPXYs7USCKuzlPBctVaSekYGKarfm1VolplyrBRJ11NR04fZl0/5jHc8FWdwq/F0l7pzP4CUS2qBYBsugygWgBAtagWAFAtqkW1AACoFgAA1aJaAIChXhTdu4/du3fv2rVrZWVFz+IsLS3poZypqanR0dEtW7Y89dRTjz766P3339/eVAAAqkW1AACoFgAA1aJaAABUCwCAagEAUC2qBQBAtT/506EHcDAYDAaq7ScAAKgWAADVoloAAFQLAIBqAQBQLaoFAEC1AACoFgAA1aJaAABUCwAwwKDa4bnbr3zq+0fd9Za/XP/i310zpFfNFVG8aWkAAFQ7ufjw6Q98XHpda+iqctZZHQAA1T40frJkWjKU2QYAQLU98Cy2BQBU26xvYIeWDzoJAIBqu6Bzf9bjf7e+OvVtS4p/6YyxoZ8/GeOlv3/6ruEdvlS4XKPdAC3/w3Uz+00bXdj1yr8/d96ji440Z2Hnnrcdua1esw9b5NuBweCCCy54/z5++ctftlqteoJs8NWvfvXee+/V/KCDDlKmSUuU40vKdH0tVxGnRaaDGwaq1XMFJZ792w0vm1h88MmpCzVxUGu7Mp0m+v+/LNDuG/4ADdBfD6/93xZ97MFXLQw44dDQqLS4loudZpTvoEspmKrp9Tvf+U41U3b+y1/+Ik1vsGpRrZ7iKlHtk9MXKXli8aGqarW2K9PJVnKWzIVqUS3OtSiNVKCgzJis+vzzzysoadYrpLlUq0wnx1pdEhusWlSrZ2b369kbn/+9Mlu75o+8843VuNauT7V2RDQWlGOpqckQwdCH1upqNdlX1yoSqyKoqx85cTipVmsV19rqW302OysiWqgKP758Sq/ewreQSsXcmdqxgwfjpjSUGcd8RaoL061FTvojiuRIO+i2WeW4RZO29nZpi7iUtugP4FOqLemgLxkJNCIlqj399NOlWhnWNa+++uqNP9Wi2vjvFDzOfOjTEms1cuK9745MXUoK1tpC1XquYREkH3kSUr57uGVNZE/lItksSX9Jtcn4aXevink61XZQraQcOQqGuTqo1vXDgIpUF8amEmi6TQVf8bfnYnelnXDffFz1KlWLz+Ot03Z6tY79B5X/nKE3uBUbLYJkSU+sWi9JokwLdYBVgt6GaoUvxTF5fHx841WLatMXXxG88LGvONLaNafIndsPikgaXX0tVpeXhaU0O2VVsaaFnYt4o+T6etBFvDAJtFy1xjmdT7WaJL2m4vX8+r2kLeq34+UpPy2MQz0H236eakW9RVBXreapq1v/WswJmgjb2W9R7cCdaiXZqm3VnNV86+xNcbXJqdZO8bGxOqpnMXcDkibqmqsXeXJ6xTkdVKsE9Qe0nS7F1YaqTT/aa1KoWn+SVDz9LZX+FmmuWuVEzyE/H9IXIOnPDxvU7XnsscdKxCXdXqvWnYRo0aLawezV+ssuGfbGaNFWvwpr0qvVXCP5JZEyrYlUaq0iST31k7LjWnvNM8t6VZ3mqq3nNFStb7Z3p1rfe99Ar5amVJj6BqmNm4zcrWq10ec+97lIQLWD+wTCg2MnOcFfhXk0eQIhHvZMBvRVtTurckkT66+zRpXfuVfrLeQaa65Qtd7UtxOZ6fuxJqfatDDmke/K7tWuW7XpjxR6jZuq1Ydk96taNxa6Va2PwwOtWp6rtW3dtK2OdT9XW5VF+gHW/q32E6wJ/2zuETXrRbypf+72B0hETS/poFoXDGH5w2jrg26bjcz04Zufat0e0V5KqPZ2/8/eHWggFEMBGO79H+DCGAzDMGZsq4crguICpZL7fW8w+DHOOc/vfSe1+z+KK3zdybTYvrMvTIsBSK0dCMBPU3v5gPPdWmvOOcbovbfWaq2llJxzSinGGELYtu0Im70A7KvVWUBqXWEApNZtMQCpBZDaAwCQWgCpBZBaqQWQWgCpBZBaqQWQWgCplVoAqQWQWoB/IrWPK8c39s7gJpYYBqCtQgGIE83AGXqgADoYUQIcaeFbsvRk+f01w8z+Fas/OaBsNuPYjvMmziLl9vY2lLn80NyzRGmXLFHZX7iy6f7+foOx3N00FG7o21UY66yFu6p2Koy0p6cnX5Qdjo1YooXQ4mpYJr1etxXXDobAlUPXIc4bG765Cy9hWpuXtIKravfrg40RpfjkusuBWqCT9WVZLnmrXSx7IumSqL08/mDc70MtZTtqARN0sAkVUgQbMbD+/QfaYtCsv76+/uvLw9Ez2/EhXL67uxNq5fOj/M+oZZHsLwdqD9S2ycIE6kMMUP8pB89ehptrc2hAz920z8/PB2qncqDWCRFB1uo118uW+KtkcOpQP359fdE5RveIrfL29kZ8t5yXpyLcIwmNr77VJKP/8/Oz5rn1An1yXlyULbGosptTPBSGKaj0+PgYf9HHxqZFLddGTlu0ITMN+fj4SMXSFVhNi81BQk3Yq8KxQ6wyLWF6YQsrSDZGB9Q2V9S5ZucbLT53ikamEmWi3NzcPDw8+AVQowKMxhSnZzCKR6B8eImvcKlfJHiPqfcRihcjU8MbhUeGtXYF5TirZdr6+hf4CCaC3hkW4Rggo6V1cItHdIXQrw9SWHvfamIi8JEK+KjHcH4teRHGX1pQqY1oYy2QitctwpNE4N6OrV9ZAghjIMu0Q6bjfq18O2dAbTyIu+rj9VkE8nLybhqZaWw2OnhM0ja/jOuIipccLbmNRbFWPPUMiv/trvkQg4r7/NJyoNZv1MY46p5RhwU7RF7LLF1E8XEDatHBGRl9VmqChFQjvo2vQAYlMZ3AtdVNVDzbEIlKM2qtdjTOY/11w2jkQRNLqHUrTN0OcSLsAwTUtpKnXvNOI3AFylgI8KpyMB8DK5I49GDvzED0qcJPyWmvgTWoJdJMUtyYmrtDKjxE+BUw9UCtF4yXnOlGH4eFCc4SrR9/ilqijZgzaldqcgp8M5uMPyCyLAu2bEAtu0h02IBadoU6ytiOWpRZf+Lv3aIRTDE97QoOhaEkZUhcmrFYhI1Vt4F9qbbxx0lCCjkLatGzHSCgiR68qnL8LOYDUCpsdWsezYNti0qHeTk5D/KIp1Cb+1Pi1ahdqYkpw6qI0VG1/dhNgmkfhjQo8C1qbSynMfnUNtRaLOZsRq0luMy7Wuo1nSfwjFq7gswjPMxEvLy8tP50no+JyFFaABthcJ/G1gcmRn3/AQIFaU7jtNaupxyoJfMiPWw/BDXQkJ2RgvFg7eAfvupAjREe0aidMdowMWtC9L+/v/OTBbkqKbN/KPPPYj57MWp9IH7KWNTYhlqL9T9N/xS1dshwVov+a06Z5mN3+lQwEZ819oCdzyJmQiGEkDZqgaNxzF7bllI89V5udPOCYsPOI5jWIrzJ2V7+tHcHmm4EURyH+/J9gyAIghBEJGlB3iPv00aXv3Haie3qvZMm3weqmxHgZ+/EnJFa6gsybyUt4xNILc125CtjwLkppJb8FZbNtbfifTZ7Vkit1AJILcB4UgsgtQBSK7UAUgswkCGKOapYDqv82+HKi08odE8r5STPItOZ+h/AZ5La9nTA7XYrMwqGprZO+E9/pRb+M1Lbm1k1PrWdCf95JLXw3KQ26uClOtK/HW9RxtGXgdDZhbi3bEptb2077n56+vWun9pMD6mP/vKGgjbWgNSOmQ7ejkoq4UslE9BMw8qVNu19Lb0hdZlGWOYW3pfn2/sT/muF59xQkE+OBEhtpH0ltWVsXbrZNvSPQ5Qfr83lBTM3EPLhPJozYLAN8XiA1CZVv4/uTrx6qc1eaulvWVsqPDO1+feC1D7F4BJAaq/Xa3vza5va/E/eeXupzU5Cu4HweG2m6GcD4SPeasuSIRdHA1JbJ+SXS0lzE8F0/0cvtVMNy89ij9fmW+rPYv0J/wtSWy4jmJtaQGoBpFZqAaQWQGoBpFZqAaQWQGqlFkBqAaQWQGqlFkBqAaT2DQB8+f4Bvv1yuVzO5/PpdDoej4fDYb/f73a77Xa72WzW6/VqtXqVIdYA3moBpBZAaqUWQGoBpFZqAaQWQGoBpFZqAaQWQGpfAYDUAkgtgNRKLYDUAkit1AL8BM4AKpaBP/VfAAAAAElFTkSuQmCC"},346:function(t,e,a){t.exports=a.p+"assets/img/StopVM.408afa56.png"},697:function(t,e,a){"use strict";a.r(e);var o=a(9),r=Object(o.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"how-to-penny-pinch-your-azure-deployment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-penny-pinch-your-azure-deployment"}},[t._v("#")]),t._v(" How to penny-pinch your Azure deployment")]),t._v(" "),e("p",[t._v("This guide is for "),e("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver-azure",target:"_blank",rel:"noopener noreferrer"}},[t._v("Azure-deployed"),e("OutboundLink")],1),t._v(" users who wishes to do some saving on their install.")]),t._v(" "),e("p",[t._v("Please do this "),e("strong",[t._v("only after your nodes are fully synched")]),t._v(".\nDuring synchronization you need a powerful setup.")]),t._v(" "),e("p",[e("strong",[t._v("Penny-pinching")]),t._v(" is an opportunity for you to better understand the resources you are consuming and tailor the configuration to your workload.")]),t._v(" "),e("p",[t._v("Downside:")]),t._v(" "),e("ul",[e("li",[t._v("Running "),e("code",[t._v("btcpay-update.sh")]),t._v(" or rebooting will take longer")]),t._v(" "),e("li",[t._v("You might see "),e("code",[t._v("502 Bad Gateway")]),t._v(" and your node taking lots of time to start")]),t._v(" "),e("li",[t._v("Your server might become very slow")])]),t._v(" "),e("p",[t._v("Upside:")]),t._v(" "),e("ul",[e("li",[t._v("50% savings")])]),t._v(" "),e("p",[t._v("If you find that your server is too slow:")]),t._v(" "),e("ul",[e("li",[t._v("Drop support for coins by editing the setting "),e("code",[t._v("BTCPAY_DOCKER_COMPOSE")]),t._v(" in "),e("code",[t._v("/etc/profile.d/btcpay-env.sh")]),t._v(", or")]),t._v(" "),e("li",[t._v("Increase the size of your Virtual Machine")])]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("After some testing, it seems that following this guide for a setup on mainnet involving BTC+LTC+CLightning is a bit too much and makes the server very laggy.")]),t._v(" "),e("p",[t._v("Note that the server becomes less laggy as time passes after restart, so it might still be ok for your case.\nIf it is not acceptable, you should switch from "),e("code",[t._v("B1MS")]),t._v(" (20 USD/Month) type to a "),e("code",[t._v("B2S")]),t._v(" (40 USD/Month) type.")])]),t._v(" "),e("h2",{attrs:{id:"how-much-am-i-spending-now"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-much-am-i-spending-now"}},[t._v("#")]),t._v(" How much am I spending now?")]),t._v(" "),e("p",[t._v("Find out how much your installation costs:")]),t._v(" "),e("ul",[e("li",[t._v("Go on the Azure portal")]),t._v(" "),e("li",[t._v("Go to Subscription (If you don't find the "),e("code",[t._v("Subscription")]),t._v(" menu search "),e("code",[t._v("Subscription")]),t._v(" in the search bar next to the notifications bell.)")]),t._v(" "),e("li",[t._v("Go to Cost Analysis")]),t._v(" "),e("li",[t._v("Select your Resource group (mine is called \"dwoiqdwqb')")]),t._v(" "),e("li",[t._v("Timespan 30 days")]),t._v(" "),e("li",[t._v("Click on apply")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(339),alt:"Show Cost Microsoft Azure",title:"Show Cost Microsoft Azure"}})]),t._v(" "),e("p",[t._v("As you can see, my install costs "),e("code",[t._v("47.00 EUR/Month")]),t._v(".\nMost of the cost is spent on the virtual machine.")]),t._v(" "),e("h2",{attrs:{id:"what-is-my-current-configuration"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#what-is-my-current-configuration"}},[t._v("#")]),t._v(" What is my current configuration")]),t._v(" "),e("p",[t._v("First see what Virtual machine you currently have:")]),t._v(" "),e("ul",[e("li",[t._v("Go on the Azure portal")]),t._v(" "),e("li",[t._v("Go to Resource Groups")]),t._v(" "),e("li",[t._v("Select your resource group")]),t._v(" "),e("li",[t._v("Select BTCPayServerVM")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(340),alt:"Show Microsoft Azure VM",title:"Show Microsoft Azure VM"}})]),t._v(" "),e("p",[t._v("As you can see the CPU is mainly unused, disk as well. We can probably cut some fat here.\nAlso my VM type is "),e("code",[t._v("Standard_D1_v2")]),t._v(". As you can see on "),e("a",{attrs:{href:"https://azureprice.net/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Azure Price Website"),e("OutboundLink")],1),t._v(".")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(341),alt:"Show Azure Price",title:"Show Azure Price"}})]),t._v(" "),e("p",[t._v("This costs me "),e("code",[t._v("0.0573444 EUR/H")]),t._v(" or "),e("code",[t._v("42.66 EUR/Month")]),t._v(".")]),t._v(" "),e("p",[t._v("Now we know that downgrading this VM will bring us the largest cost benefit.\nLet's see how far we can go.")]),t._v(" "),e("p",[t._v("Connect by SSH to your VM, then:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("docker")]),t._v(" stats\n")])])]),e("figure",[e("img",{attrs:{src:a(342),alt:"Show Azure Resources",title:"Show Azure Resources"}})]),t._v(" "),e("p",[t._v("As you can see, I have 3.352 GB of RAM, and around 55%.")]),t._v(" "),e("p",[t._v("The free command also seems to tell me I have approximately 1GB of RAM in fat:")]),t._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("root@BTCPayServerVM:~# free --human\n\n total used free shared buffers cached\nMem: 3.4G 3.2G 138M 30M 8.8M 991M\n-/+ buffers/cache: 2.2G 1.1G\nSwap: 0B 0B 0B\n")])])]),e("h2",{attrs:{id:"selecting-a-new-virtual-machine"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#selecting-a-new-virtual-machine"}},[t._v("#")]),t._v(" Selecting a new Virtual Machine")]),t._v(" "),e("p",[t._v("Now we know that 2 GB of RAM, and a less powerful CPU will probably do the trick.")]),t._v(" "),e("p",[t._v("But first, you don't want your machine to crash if it runs out of RAM, so you need to add some swap:\nNote that "),e("code",[t._v("/mnt")]),t._v(" is used in Azure for temporary data, and is optimized for low latency, this is why we set the swapfile here.")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\nfallocate -l 2G /mnt/swapfile\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("chmod")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token number"}},[t._v("600")]),t._v(" /mnt/swapfile\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("mkswap")]),t._v(" /mnt/swapfile\n"),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("swapon")]),t._v(" /mnt/swapfile\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("echo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"/mnt/swapfile none swap sw 0 0"')]),t._v(" "),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v(">>")]),t._v(" /etc/fstab\n")])])]),e("p",[t._v("As you can see, the swap got added:")]),t._v(" "),e("div",{staticClass:"language- extra-class"},[e("pre",{pre:!0,attrs:{class:"language-text"}},[e("code",[t._v("root@BTCPayServerVM:~# free -h\n total used free shared buffers cached\nMem: 3.4G 3.2G 141M 30M 9.8M 983M\n-/+ buffers/cache: 2.2G 1.1G\nSwap: **2.0G** 0B 2.0G\n")])])]),e("p",[t._v("Now, go back to "),e("a",{attrs:{href:"https://azureprice.net/",target:"_blank",rel:"noopener noreferrer"}},[t._v("azureprice.net"),e("OutboundLink")],1),t._v(" and find something cheaper than "),e("code",[t._v("0.0573444 EUR/H")]),t._v(".")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(343),alt:"Azure VM comparison",title:"Azure VM comparison"}})]),t._v(" "),e("p",[t._v("Wow! "),e("code",[t._v("Standard_B1ms")]),t._v(" cost only "),e("code",[t._v("0.02049219 EUR/H")]),t._v(" – let's switch to it!")]),t._v(" "),e("p",[t._v("A quick look at "),e("a",{attrs:{href:"https://www.singhkays.com/blog/understanding-azure-b-series/",target:"_blank",rel:"noopener noreferrer"}},[t._v("this article"),e("OutboundLink")],1),t._v(" shows us that this type of virtual machine is adapted for low CPU consumption with occasional burst. This is what BTCPay Server is about after the nodes are synched.")]),t._v(" "),e("ul",[e("li",[t._v("Go on the Azure portal")]),t._v(" "),e("li",[t._v("Go to Resource Groups")]),t._v(" "),e("li",[t._v("Select your resource group")]),t._v(" "),e("li",[t._v("Select BTCPayServerVM")]),t._v(" "),e("li",[t._v("Select "),e("code",[t._v("Size")])]),t._v(" "),e("li",[t._v("Select "),e("code",[t._v("B1MS")]),t._v(" (if you don't see, take a look at the "),e("a",{attrs:{href:"#b1ms"}},[t._v("FAQ")]),t._v(")")]),t._v(" "),e("li",[t._v("Click "),e("code",[t._v("Select")])])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(344),alt:"Show Azure VM Size",title:"Show Azure VM Size"}})]),t._v(" "),e("p",[t._v("Wait between 5 and 15 minutes.")]),t._v(" "),e("p",[t._v("When Azure is happy:")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(345),alt:"Happy Microsoft Azure",title:"Happy Microsoft Azure"}})]),t._v(" "),e("p",[t._v("Congratulations! You just cut down the cost by 50% per month! 😃")]),t._v(" "),e("h3",{attrs:{id:"faq-b1ms-does-not-appear-in-the-list-"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#faq-b1ms-does-not-appear-in-the-list-"}},[t._v("#")]),t._v(" FAQ: B1MS does not appear in the list "),e("a",{attrs:{name:"b1ms"}})]),t._v(" "),e("p",[t._v("In some situation, you might not see the Virtual Machine B1MS in the list.\nIt means your Azure hardware cluster does not support this type.")]),t._v(" "),e("div",{staticClass:"custom-block warning"},[e("p",{staticClass:"custom-block-title"},[t._v("WARNING")]),t._v(" "),e("p",[t._v("Stopping your Virtual Machine will change the public IP Address of your server. If you configured a A (as opposed to CNAME) record in your domain registar, you'll need to update it.")])]),t._v(" "),e("p",[t._v("You need to go in:")]),t._v(" "),e("ul",[e("li",[t._v("Your Virtual Machine resource")]),t._v(" "),e("li",[e("code",[t._v("Overview")]),t._v(" menu")]),t._v(" "),e("li",[t._v("Click on "),e("code",[t._v("Stop")])])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(346),alt:"Stop Azure VM",title:"Stop Azure VM"}})]),t._v(" "),e("p",[t._v("Wait until the Virtual Machine has stopped, then change the size.")]),t._v(" "),e("p",[t._v("Once the size is changed, go back to "),e("code",[t._v("Overview")]),t._v(" and click on "),e("code",[t._v("Start")]),t._v(".")])])}),[],!1,null,null,null);e.default=r.exports}}]); \ No newline at end of file diff --git a/assets/js/25.2396ab27.js b/assets/js/25.d71dc568.js similarity index 90% rename from assets/js/25.2396ab27.js rename to assets/js/25.d71dc568.js index 388b62aa29..a2beffa2ad 100644 --- a/assets/js/25.2396ab27.js +++ b/assets/js/25.d71dc568.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{639:function(e,t,a){e.exports=a.p+"assets/img/1.61c3b232.jpg"},640:function(e,t,a){e.exports=a.p+"assets/img/2.4ec63b47.jpg"},641:function(e,t,a){e.exports=a.p+"assets/img/3.0a39c840.jpg"},642:function(e,t,a){e.exports=a.p+"assets/img/4.e37e0402.png"},643:function(e,t,a){e.exports=a.p+"assets/img/5.29be95a6.png"},644:function(e,t,a){e.exports=a.p+"assets/img/6.861ee564.jpg"},645:function(e,t,a){e.exports=a.p+"assets/img/7.56e93cc1.jpg"},646:function(e,t,a){e.exports=a.p+"assets/img/8.e6a2f12e.jpg"},803:function(e,t,a){"use strict";a.r(t);var r=a(9),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"pull-payments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pull-payments"}},[e._v("#")]),e._v(" Pull payments")]),e._v(" "),t("h2",{attrs:{id:"introduction"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),t("p",[e._v("Traditionally, to make a Bitcoin payment, a receiver shares their bitcoin address and the sender later sends money to this address.\nSuch system is called "),t("code",[e._v("Push payment")]),e._v(" as the sender initiates the payment while the receiver may be unavailable, in effect "),t("code",[e._v("pushing")]),e._v(" the payment to the receiver.")]),e._v(" "),t("p",[e._v("However, what about reversing the role?")]),e._v(" "),t("p",[e._v("What if, instead of a sender "),t("code",[e._v("pushing")]),e._v(" the payment, the sender allows the receiver to "),t("code",[e._v("pull")]),e._v(" the payment at a time the receiver seems fit?\nThis is the concept of "),t("code",[e._v("Pull payment")]),e._v(". This allows several new applications such as:")]),e._v(" "),t("ul",[t("li",[e._v("A subscription service (where the subscriber allows the service to pull money every x amount of time)")]),e._v(" "),t("li",[e._v("Refunds (where the merchant allows the customer to pull the refund money to his wallet when it seems fit)")]),e._v(" "),t("li",[e._v("Time-based billing for freelancers (where the person hiring allows the freelancer to pull money to his wallet as time gets reported)")]),e._v(" "),t("li",[e._v("Patronage (where the patron allows the recipient to pull money every month to continue supporting their work)")]),e._v(" "),t("li",[e._v("Automatic selling (where a customer of an exchange would allow an exchange to pull money from their wallet to automatically sell every month)")]),e._v(" "),t("li",[e._v("Balance withdraw system (where a high-volume service allows users to request withdrawals from their balance, the service can then easily batch all the payouts to many users, at fixed intervals)")])]),e._v(" "),t("p",[e._v("You can also follow this video:")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/-e8lPd9NtPs/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=-e8lPd9NtPs",title:"What is a pull payment","data-id":"-e8lPd9NtPs"}},[t("iframe",{attrs:{title:"What is a pull payment","data-src":"https://www.youtube-nocookie.com/embed/-e8lPd9NtPs?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("h2",{attrs:{id:"concept"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#concept"}},[e._v("#")]),e._v(" Concept")]),e._v(" "),t("p",[e._v("When a sender configures a "),t("code",[e._v("Pull payment")]),e._v(", they can configure a number of properties:")]),e._v(" "),t("ul",[t("li",[e._v("Start date")]),e._v(" "),t("li",[e._v("End date (optional)")]),e._v(" "),t("li",[e._v("A period (optional)")]),e._v(" "),t("li",[e._v("A limit amount")]),e._v(" "),t("li",[e._v("A unit (such as USD, BTC, Hours)")]),e._v(" "),t("li",[e._v("Available payment methods")])]),e._v(" "),t("p",[e._v("After this, the sender can "),t("strong",[e._v("share the pull payment")]),e._v(" using a link with the receiver, allowing the receiver to "),t("code",[e._v("create a payout")]),e._v(".\nThe receiver will choose for their payout:")]),e._v(" "),t("ul",[t("li",[e._v("Which payment method to use")]),e._v(" "),t("li",[e._v("Where to send the money")])]),e._v(" "),t("p",[e._v("Once a payout is created, it will count toward the "),t("code",[e._v("pull payment's limit")]),e._v(" for the current "),t("code",[e._v("period")]),e._v(".\nThe sender will then approve the payout by setting the "),t("code",[e._v("rate")]),e._v(" in which the payout will be sent, and proceed with payment.")]),e._v(" "),t("p",[e._v("For the sender, we provide an easy to use way to batch the payment of several payouts from the "),t("RouterLink",{attrs:{to:"/Wallet/"}},[e._v("BTCPay Internal Wallet")]),e._v(".")],1),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("\n +----------+ +-------------------+ +------------+\n | | | | | |\n | Sender | | BTCPay Server | | Receiver |\n | | | | | |\n +----------+ +-------------------+ +------------+\n | | |\n | | |\n | Create | |\n +---------------------------\x3e+ |\n | Pull payment | |\n | | |\n | | |\n | Share | |\n +--------------------------------------------------------\x3e+\n | Pull payment | |\n | | |\n | | Create |\n | +<---------------------------+\n | | Payout |\n | | |\n | Approve | |\n +---------------------------\x3e+ v\n | Payout |\n | |\n | Pay |\n +---------------------------\x3e+\n | Payout |\n | |\n | |\n v v\n")])])]),t("p",[e._v("Note that BTCPay Server does not approve and pay a payout automatically. In future releases, we will look into payouts which are approved to be paid out automatically under the correct conditions.\nInstead, a notification will appear for the sender, giving the sender the choice to approve and pay the payouts.")]),e._v(" "),t("h2",{attrs:{id:"greenfield-api"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#greenfield-api"}},[e._v("#")]),e._v(" Greenfield API")]),e._v(" "),t("p",[e._v("We provide a full API to both the sender and receiver that is documented in the "),t("code",[e._v("/docs")]),e._v(" page of your instance. (or on our "),t("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/",target:"_blank",rel:"noopener noreferrer"}},[e._v("public link"),t("OutboundLink")],1),e._v(" page)")]),e._v(" "),t("p",[e._v("Since our API exposes the full capability of pull payments, a sender can automate payments for his own need.")]),e._v(" "),t("h2",{attrs:{id:"user-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#user-interface"}},[e._v("#")]),e._v(" User interface")]),e._v(" "),t("p",[e._v("The user interface only allows a subset of what is possible.")]),e._v(" "),t("h3",{attrs:{id:"create-a-pull-payment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-a-pull-payment"}},[e._v("#")]),e._v(" Create a pull payment")]),e._v(" "),t("ol",[t("li",[e._v("Go to your wallet page / pull payments\n"),t("img",{attrs:{src:a(639),alt:"BTCPay Server Pull Payment",title:"BTCPay Server Pull Payment"}})]),e._v(" "),t("li",[e._v("Click on "),t("code",[e._v("Create a new pull payment")]),e._v(" "),t("img",{attrs:{src:a(640),alt:"BTCPay Server Pull Payment",title:"BTCPay Server Pull Payment"}})]),e._v(" "),t("li",[e._v("Fill out the pull payment information, click "),t("code",[e._v("Create")]),e._v(" "),t("img",{attrs:{src:a(641),alt:"BTCPay Server Pull Payment",title:"BTCPay Server Pull Payment"}})]),e._v(" "),t("li",[e._v("Go to the pull payment page by clicking on "),t("code",[e._v("View")])]),e._v(" "),t("li",[e._v("Share this page with the payment receiver\n"),t("img",{attrs:{src:a(642),alt:"BTCPay Server Pull Payment",title:"BTCPay Server Pull Payment"}})]),e._v(" "),t("li",[e._v("As the receiver, fill out how much "),t("code",[e._v("USD")]),e._v(" you claim, and to which address the money should be sent.\n"),t("img",{attrs:{src:a(643),alt:"BTCPay Server Pull Payment",title:"BTCPay Server Pull Payment"}})])]),e._v(" "),t("h3",{attrs:{id:"approve-and-pay-a-payout"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#approve-and-pay-a-payout"}},[e._v("#")]),e._v(" Approve and pay a payout")]),e._v(" "),t("ol",[t("li",[e._v("The sender gets notified when the receiver is pulling money\n"),t("img",{attrs:{src:a(644),alt:"6",title:"6"}})]),e._v(" "),t("li",[e._v("Clicking on the notification brings the sender to a page listing all outstanding payouts\n"),t("img",{attrs:{src:a(645),alt:"7",title:"7"}})]),e._v(" "),t("li",[e._v("Check the payout to approve, pay and confirm\n"),t("img",{attrs:{src:a(646),alt:"8",title:"8"}})]),e._v(" "),t("li",[e._v("You are then brought to the normal wallet user interface of BTCPay Server")])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Clicking on Confirm selected payouts will use the current exchange rate of your wallet's store settings. The rate is then fixed, even if you don't complete the payment. Payments made at a later time will use this previously confirmed rate.")])]),e._v(" "),t("h2",{attrs:{id:"additional-use-cases-for-the-pull-payments-feature"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-use-cases-for-the-pull-payments-feature"}},[e._v("#")]),e._v(" Additional use cases for the Pull Payments feature")]),e._v(" "),t("p",[e._v("The "),t("strong",[e._v("Pull Payment feature")]),e._v(" can be used in multiple applications, the first one being "),t("RouterLink",{attrs:{to:"/Refund/"}},[e._v("Refunds")]),e._v(".")],1)])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[25],{519:function(e,t,a){e.exports=a.p+"assets/img/1.61c3b232.jpg"},520:function(e,t,a){e.exports=a.p+"assets/img/2.4ec63b47.jpg"},521:function(e,t,a){e.exports=a.p+"assets/img/3.0a39c840.jpg"},522:function(e,t,a){e.exports=a.p+"assets/img/4.e37e0402.png"},523:function(e,t,a){e.exports=a.p+"assets/img/5.29be95a6.png"},524:function(e,t,a){e.exports=a.p+"assets/img/6.861ee564.jpg"},525:function(e,t,a){e.exports=a.p+"assets/img/7.56e93cc1.jpg"},526:function(e,t,a){e.exports=a.p+"assets/img/8.e6a2f12e.jpg"},781:function(e,t,a){"use strict";a.r(t);var r=a(9),n=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"pull-payments"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#pull-payments"}},[e._v("#")]),e._v(" Pull payments")]),e._v(" "),t("h2",{attrs:{id:"introduction"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#introduction"}},[e._v("#")]),e._v(" Introduction")]),e._v(" "),t("p",[e._v("Traditionally, to make a Bitcoin payment, a receiver shares their bitcoin address and the sender later sends money to this address.\nSuch system is called "),t("code",[e._v("Push payment")]),e._v(" as the sender initiates the payment while the receiver may be unavailable, in effect "),t("code",[e._v("pushing")]),e._v(" the payment to the receiver.")]),e._v(" "),t("p",[e._v("However, what about reversing the role?")]),e._v(" "),t("p",[e._v("What if, instead of a sender "),t("code",[e._v("pushing")]),e._v(" the payment, the sender allows the receiver to "),t("code",[e._v("pull")]),e._v(" the payment at a time the receiver seems fit?\nThis is the concept of "),t("code",[e._v("Pull payment")]),e._v(". This allows several new applications such as:")]),e._v(" "),t("ul",[t("li",[e._v("A subscription service (where the subscriber allows the service to pull money every x amount of time)")]),e._v(" "),t("li",[e._v("Refunds (where the merchant allows the customer to pull the refund money to his wallet when it seems fit)")]),e._v(" "),t("li",[e._v("Time-based billing for freelancers (where the person hiring allows the freelancer to pull money to his wallet as time gets reported)")]),e._v(" "),t("li",[e._v("Patronage (where the patron allows the recipient to pull money every month to continue supporting their work)")]),e._v(" "),t("li",[e._v("Automatic selling (where a customer of an exchange would allow an exchange to pull money from their wallet to automatically sell every month)")]),e._v(" "),t("li",[e._v("Balance withdraw system (where a high-volume service allows users to request withdrawals from their balance, the service can then easily batch all the payouts to many users, at fixed intervals)")])]),e._v(" "),t("p",[e._v("You can also follow this video:")]),e._v(" "),t("a",{staticClass:"ytEmbed",staticStyle:{"background-image":"url(https://img.youtube.com/vi/-e8lPd9NtPs/hqdefault.jpg)"},attrs:{href:"https://www.youtube.com/watch?v=-e8lPd9NtPs",title:"What is a pull payment","data-id":"-e8lPd9NtPs"}},[t("iframe",{attrs:{title:"What is a pull payment","data-src":"https://www.youtube-nocookie.com/embed/-e8lPd9NtPs?&autoplay=1&autohide=1&modestbranding=1&color=white&rel=0",frameborder:"0",allow:"autoplay;encrypted-media;picture-in-picture",allowfullscreen:""}})]),e._v(" "),t("h2",{attrs:{id:"concept"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#concept"}},[e._v("#")]),e._v(" Concept")]),e._v(" "),t("p",[e._v("When a sender configures a "),t("code",[e._v("Pull payment")]),e._v(", they can configure a number of properties:")]),e._v(" "),t("ul",[t("li",[e._v("Start date")]),e._v(" "),t("li",[e._v("End date (optional)")]),e._v(" "),t("li",[e._v("A period (optional)")]),e._v(" "),t("li",[e._v("A limit amount")]),e._v(" "),t("li",[e._v("A unit (such as USD, BTC, Hours)")]),e._v(" "),t("li",[e._v("Available payment methods")])]),e._v(" "),t("p",[e._v("After this, the sender can "),t("strong",[e._v("share the pull payment")]),e._v(" using a link with the receiver, allowing the receiver to "),t("code",[e._v("create a payout")]),e._v(".\nThe receiver will choose for their payout:")]),e._v(" "),t("ul",[t("li",[e._v("Which payment method to use")]),e._v(" "),t("li",[e._v("Where to send the money")])]),e._v(" "),t("p",[e._v("Once a payout is created, it will count toward the "),t("code",[e._v("pull payment's limit")]),e._v(" for the current "),t("code",[e._v("period")]),e._v(".\nThe sender will then approve the payout by setting the "),t("code",[e._v("rate")]),e._v(" in which the payout will be sent, and proceed with payment.")]),e._v(" "),t("p",[e._v("For the sender, we provide an easy to use way to batch the payment of several payouts from the "),t("RouterLink",{attrs:{to:"/Wallet/"}},[e._v("BTCPay Internal Wallet")]),e._v(".")],1),e._v(" "),t("div",{staticClass:"language- extra-class"},[t("pre",{pre:!0,attrs:{class:"language-text"}},[t("code",[e._v("\n +----------+ +-------------------+ +------------+\n | | | | | |\n | Sender | | BTCPay Server | | Receiver |\n | | | | | |\n +----------+ +-------------------+ +------------+\n | | |\n | | |\n | Create | |\n +---------------------------\x3e+ |\n | Pull payment | |\n | | |\n | | |\n | Share | |\n +--------------------------------------------------------\x3e+\n | Pull payment | |\n | | |\n | | Create |\n | +<---------------------------+\n | | Payout |\n | | |\n | Approve | |\n +---------------------------\x3e+ v\n | Payout |\n | |\n | Pay |\n +---------------------------\x3e+\n | Payout |\n | |\n | |\n v v\n")])])]),t("p",[e._v("Note that BTCPay Server does not approve and pay a payout automatically. In future releases, we will look into payouts which are approved to be paid out automatically under the correct conditions.\nInstead, a notification will appear for the sender, giving the sender the choice to approve and pay the payouts.")]),e._v(" "),t("h2",{attrs:{id:"greenfield-api"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#greenfield-api"}},[e._v("#")]),e._v(" Greenfield API")]),e._v(" "),t("p",[e._v("We provide a full API to both the sender and receiver that is documented in the "),t("code",[e._v("/docs")]),e._v(" page of your instance. (or on our "),t("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/",target:"_blank",rel:"noopener noreferrer"}},[e._v("public link"),t("OutboundLink")],1),e._v(" page)")]),e._v(" "),t("p",[e._v("Since our API exposes the full capability of pull payments, a sender can automate payments for his own need.")]),e._v(" "),t("h2",{attrs:{id:"user-interface"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#user-interface"}},[e._v("#")]),e._v(" User interface")]),e._v(" "),t("p",[e._v("The user interface only allows a subset of what is possible.")]),e._v(" "),t("h3",{attrs:{id:"create-a-pull-payment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-a-pull-payment"}},[e._v("#")]),e._v(" Create a pull payment")]),e._v(" "),t("ol",[t("li",[e._v("Go to your wallet page / pull payments\n"),t("img",{attrs:{src:a(519),alt:"BTCPay Server Pull Payment",title:"BTCPay Server Pull Payment"}})]),e._v(" "),t("li",[e._v("Click on "),t("code",[e._v("Create a new pull payment")]),e._v(" "),t("img",{attrs:{src:a(520),alt:"BTCPay Server Pull Payment",title:"BTCPay Server Pull Payment"}})]),e._v(" "),t("li",[e._v("Fill out the pull payment information, click "),t("code",[e._v("Create")]),e._v(" "),t("img",{attrs:{src:a(521),alt:"BTCPay Server Pull Payment",title:"BTCPay Server Pull Payment"}})]),e._v(" "),t("li",[e._v("Go to the pull payment page by clicking on "),t("code",[e._v("View")])]),e._v(" "),t("li",[e._v("Share this page with the payment receiver\n"),t("img",{attrs:{src:a(522),alt:"BTCPay Server Pull Payment",title:"BTCPay Server Pull Payment"}})]),e._v(" "),t("li",[e._v("As the receiver, fill out how much "),t("code",[e._v("USD")]),e._v(" you claim, and to which address the money should be sent.\n"),t("img",{attrs:{src:a(523),alt:"BTCPay Server Pull Payment",title:"BTCPay Server Pull Payment"}})])]),e._v(" "),t("h3",{attrs:{id:"approve-and-pay-a-payout"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#approve-and-pay-a-payout"}},[e._v("#")]),e._v(" Approve and pay a payout")]),e._v(" "),t("ol",[t("li",[e._v("The sender gets notified when the receiver is pulling money\n"),t("img",{attrs:{src:a(524),alt:"6",title:"6"}})]),e._v(" "),t("li",[e._v("Clicking on the notification brings the sender to a page listing all outstanding payouts\n"),t("img",{attrs:{src:a(525),alt:"7",title:"7"}})]),e._v(" "),t("li",[e._v("Check the payout to approve, pay and confirm\n"),t("img",{attrs:{src:a(526),alt:"8",title:"8"}})]),e._v(" "),t("li",[e._v("You are then brought to the normal wallet user interface of BTCPay Server")])]),e._v(" "),t("div",{staticClass:"custom-block warning"},[t("p",{staticClass:"custom-block-title"},[e._v("WARNING")]),e._v(" "),t("p",[e._v("Clicking on Confirm selected payouts will use the current exchange rate of your wallet's store settings. The rate is then fixed, even if you don't complete the payment. Payments made at a later time will use this previously confirmed rate.")])]),e._v(" "),t("h2",{attrs:{id:"additional-use-cases-for-the-pull-payments-feature"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#additional-use-cases-for-the-pull-payments-feature"}},[e._v("#")]),e._v(" Additional use cases for the Pull Payments feature")]),e._v(" "),t("p",[e._v("The "),t("strong",[e._v("Pull Payment feature")]),e._v(" can be used in multiple applications, the first one being "),t("RouterLink",{attrs:{to:"/Refund/"}},[e._v("Refunds")]),e._v(".")],1)])}),[],!1,null,null,null);t.default=n.exports}}]); \ No newline at end of file diff --git a/assets/js/26.05934715.js b/assets/js/26.96d028f1.js similarity index 99% rename from assets/js/26.05934715.js rename to assets/js/26.96d028f1.js index 76e0e1cc26..c04bbf4444 100644 --- a/assets/js/26.05934715.js +++ b/assets/js/26.96d028f1.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{300:function(e,t,o){e.exports=o.p+"assets/img/docker-compose-up-dev.82514a01.png"},301:function(e,t,o){e.exports=o.p+"assets/img/vs-solution-explorer.71213904.png"},302:function(e,t,o){e.exports=o.p+"assets/img/vs-debug-console.9b8e7386.png"},303:function(e,t,o){e.exports=o.p+"assets/img/dashboard-change.d3ce411b.jpg"},304:function(e,t){e.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA3UAAABGCAIAAADkairpAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAB0VSURBVHhe7Z0/bCQ3lofLc4vFXWocnEgCxjg7EjZy0DtYCCtnDrSZEmEGkziUMFEDAhRdNICAjgwpdDJYQ0lnVuDMAwwWswo2VLJewANISuyFk0suufW99/i/mmSR1dWt7tHvgzBTxWI9Pj6yyVckq9h8uv24AYq909evvzna1mfN9tE3/ilIAbuBpTNELWMZp3v6xCMVDoS1+r0/oNboobXDi84v+rW5+YD8yx+u3+mzBw9VofP9DX3S3E0Pn55d6xOQAXYDS8NUtqvJ7vGlDusHS9q6mJWSCgeatfi9D1dP1oa1KJcBWXR+H5o9hwfjlwAAAAAAYEAe6f8BAAAAAAAYAviXAAAAAABgSEL/8oX8lbPVNP9t/r7QYavI9tE3rzWt9bqrtGB31fRZY1yBL/U1DU4W74UAAAAA841fftk03xr/8jsdNhj89pZmPqdr7/R8/3ayq7j3BbqUrTXwIRet5YLlX589pbI+nN7p8354jyUMPEcAAACgjNC//Er+CtmSf/8m/w4N9+zjzemh8gl3XzbP+zsj2483m6s3kRcIxQlZoRfCVk0fQFyZB5PD6eYYo8sAAABACca//MIMQz7TAZoXTfOZuUR/yqfMQ7fY+AHl8797z/c3ribO1bo+OzbH/piSHVBS85J2wLM7DSelPSjly2fkupKvIgRjb3SBDu09fsJWG5uGijYeNRv75+qCFepSzeljr3FgOr9yS7cN+hHVh/DDmXY+inF2s1lg2V5+wtNI/A762ef67OX0buPJ593pWlPYCxziDEJ3ultsZE1vuwEAAACrg/EvvxN38K/6LOBPTfO1ufpHCVHO6JdyrPxI+lOQc/l3E0Lxq1ZzWpIjjtQZnz95q0c1eUDJ69pH44MbuXI4bfafcy+tu27+gNVoLJ237b5T86feVDpfvJsedn45jZxFrRMnfKIUoqR33oiY3d3J1UjpqRKdXLFYdcl+ly2hT11+F09Snx52i0Ku17jRI4aT2/1zVVzX37/1PLvtz59s3L39Xp434vEXhKdGJt3RmD+dGLkQYyi7AQAAACtFwfrLb5vmRg5+bpoP5UA5o+R0EsqVpD9iSyLYhZh0QKduyLN4/vfjLftJ0wD2LK4ujIDrs4srbzzJjndev7ttNh9TsHLapOO2s5z57tt3bMWb2PpYjrPYr65ywhpK2qZ0+eZKH9VSmV9DsZ1rSerTy24R9nZGd9NX2nCXr6Z3o50ZB9NXIhU/z/z2yaXrvubMBR8UzAxD2Q0AAABYLeZ7v6fFR03ziz7U0CkFDgX5nXc3P+oT4sebgXtkdtWMqyDDZH5qKW7fGU/l8ti6LXrsVBiPJKiehee3kqQ+vew2C7tbbu2ADDxr/0x8WUlK3EvtkqXjL5bB0h3IbgAAAMCKMah/+ZMZ4LTQKQXWwgM/sZGotn/V9neGQc+l88Rl30Gu7aOT/cZOgk/6jl8uJ7/l5PWZ327sbrm1A4KVRHVCqgSlaZdO5OIvAPEAeWJ+2HQHqG8AAADAajGof3kjA5b2Q5jP5FTNrTMypuetIEwjDqa32HD76FQWMH7/9m50YEL3Tscjsw5vIPZ2RnYm3Z9L98aZKBPd45HkBNlhTVZTDjTspLlZ7iw981tu50qS+qTsVguV+0ZqLalyMPd2Nu3EdD5+mn724aWSZmK+KF22j46fqj9D2Q0AAABYLT74dPvxD9fv+EUcf+jxH03zZzmg8L+YjxB91jR/8D5gtCWv+KiVlz42hJzL4GtH1LWe87Be2SiNxNbrMO0SR+617XyzC+W4Wxemg6YoBzculfCi4MsWzKK59gW7mM5duJoc3hycNC9FfkS2wql5N528fXKg4wteIlp+Up8++VXSCuz8z81P9BEAAAAA3mv+85Z8u+Vh/EtAsGP25K3zy9i3a6yn994B/xIAAAB4ICzZvxx0fnzd4WltD36NA29cAAAAAADUgfHLgHCi2puWfx/B+CUAAADwQMD8OFgSvn+55GoHAAAAgEVzjx095scBAAAAAMCQwL8EAAAAAABDEvqXLyp3DN/y9oe0n71cQbbdbjredw8ldBHfiezJqukDlsveaUXpU2VBVQEALA/uoU5rPzc8APeV7hqxov3BfOOXX8ru5Mq/tNuODwV1t4b5LMdfxr41n7G+9xd2qryIe0I8XcdcP+0Vym8yW+GFNfDbpErbneDbze/yTO79RgWlxZDVp5oVq2+DlUv9zaoYWtZ3JeaktcqLKEgpJihHbfyE/lGGrHBVdnaZamfLU8lTJx4/Z/8as/UyQ1V+V5B1138grs8ubvfP56r5iyD0L79qfRE9y5b8qz69PjT8Sxlv2i34XjbP+1ch/syQ3VLQ5/rs6Qr4m47V0sduLDO5Go3na7JXCZutw+nm2G+ZzIXDabOCv9OAvVP+bazCZ1kvj9lkkyv+1AIfOZ2SdgbLgN2Sk+Zte2daqjmNKhiu5ie6VKThsfB2tmbzsRQk3jTPRb+X2vgp/TPcS3ul6r8w8bp36r74Q8oSzvXfVv94/LT94+WVA7+7h8rlMRf5kip+Kca//MIMQz7TAZoXsm2PukR/yqfMQ7fY+AHyeFVU4/ee729cebsxX58d+2M1BmtLDjzd4zZJ6E7DSWmXhy+fketKvoogbZ9JgS7Qob3HT9hqY9NQ0cajZmP/XF2wQl2qOX3sNQ5M51du6bZBKZevpnfN5mMtLqoP4YfrCyoomt9WfMLe0m3PIGuRdMu4Pns5je3UyZtg6sMknKhLy6sPGX0S+nvhZp+mDraPDsy+kwXU6UOx6czeE2raj5SdfZQ9rUZ+sr7+vvqRfKmg+6tvcqnUZL6cefIVhaoIuSVPz2a+C0L+jX4E4GoeLZW9ndGdtwVrFInzUlVBKV+3a2yU2vhJ/YUOO5e0VxQ6W+71dvbhPY11qtufPzE7yXJ+L65ihvbiBwT2z5ZX3g7t352rzyZX+fzOxje0zKZJxLeRGf9C4veVoZ1uXn9fIZMC35HqNyP6c3QvTnBqlWE680Wx6czeo6/k5NfIMXBV6/hlLZ1Ptx/rI4K8zFn/0rqV9qp1Rv0/BcW3CzHpIFjNKWZpmSQKR/SLzBKUgHeiDO6dyN0qNCQQa2NauFB1iCe+FZEi+RcIderdQYc2Pss08Qnv7jZhMoQnsS3ephq/K5mGxz83P7F/OkgTinQJu6PWSXhDQDS/CTvLScyeXvzgOJNuhHZsm4B/oURkGMfLYermlP7+sS8nQySJdpATVKsPx4/ZP09b8XaqnYJ0suoeL3Zwo3/Cx7F8EVErenmckRnLb84+iXS1MD/tdmyrmpdSeJKRH81XB77qbeLXMgo42hZxZRenNr4lrWNoi1BrPiuwMxGJxWm6k3JYiFGhpbZ/yRINTAYTs7bguIGu7Zv53GbRXmBB3l3R/CbiS4pWDU+jlHy+wV7w8G4NjhMk0yXobFb/QAlHIIdPPD2tRO9WP4qcmEj+sY+vmn/M8Qkly0mdkW9OKuU4KHI7KNfRL5yC9ZffNs2NHPxs9ij/ThzKr+XY9y/JDaUIdiEmHdCpG/Isnv9t7aNjCZ4L2w+Gdrzz+t2tejDU0w6H9DhrZw3yk4r+VLo8MG59LMdZ7FfYOWENJW1T4gfVflTm11Bs5zJ4MPnu7fckLqtPM9qJ/ODiZO0csWf4TP9qeuenVZFujtGYf7mvX/Na3Xwt6SCiT0r/ILwMLoO6TaUq9BFi9XkguKkM8NpC+okqs7t6tWb1Lfq7M9WKGesB6sHylbNnnr3Tcazq0W+9KaqQVAVVX8fzwNzCdlAbP0dH+1baXlXU85yd9bVzz3Dc4ttS3D46cTt2EJH4jqT9Y+VV0c7X9keZ+PZ36o/A5uRH6nOyPSxpH/x0U0gCesC8RaSdServR5HKpNsQoSJfQqS++YPSfmXt3z7/eNM1V7RcfqP/H4SPmuYXfaihUwpU7un8kN8ZdK1sTO4pSn5hRXCJ7VNRXlLRcnnfvS3oyN1apcvjXVP/qDH1NgKi5lUfVLHw/ObgjnEsR/SLfCr5SutDv8/D5ptzdYdrCVJk7TxrT3YPNkbnr/clVLiTB4jadHPYu+Wx8LH+DVcS1yelf0Pht2/qk+laHeeo00dJjdbnYagU+D7UNz8SdZ8H/P9g+epZQFTD2Vs5bNdwXnlx9/ZVSeXa2D8/Jwm7ImL7SAVmqI1fT1V7xVTU81wEe42do1NVZJfHh49NKd5NJ9O7sRtlicXXpOyfKq8KavujgeJXtj896/MMnEBdw5rKLzmb44PPt8nynz9ppi+NdkO1q+zA7u9wlVTupQqeo33mlu6JPl4F5nt/vMVPZoDTQqcUWAs/QUSeDmz7YGi3H8OgRxx4HKuXj0HwM2ujlrMTvGC7F8vJbwL61WhsC5jVh35yElvWlcfmDtqU25l/NNw5ebg7qtO1KE+DBzoCigeu40T0yepv4ValjI6H95De+gyGs3NufMIhvQM3ou9ZfbMMlq8ye4ZIT0qN06wNZNW7He7LQPpz+2AkSPnm2qXa+L2oba9qKLJzMKxmSpFrTrMVDnxpZobh4vZPl1cX7ndX2x8NGb+m/elTn1N0N5K2ncnpT6XEA4JkyybsKmrylYHki6tDddNWkjnaZ5en1WBQ/5Kc/l+89ZfP5NQ9+dAvpbDGiIPp3rqjO0/5mHt+t35Vpgxm3YN52NsZuWbKe7LkAtcOL2XCTHOlocpiS5nVlAMNN3qFI9g981tu50qK9OFI+lCI5Tdl5xT8I99/nu9r2+l2wZ/4iXanBd1fSX3w9Uno79tT1JHQPHxP2/sVdWy5qFGQbLmU2HMofDvTA3dIrNmUblaaWt8+LGjF65v87kpczsHyVWTPAC6NuLMi1SYxN8tdvZcvHnVxFW7GLZo7fgfD2rlNXzuz/SJdO2Vu3MQW3LTjx+2fLq8uO/i/u9r+KBffwhcK5Bv8+pz6fZW1Dy5dJqY/p9X5A3btTFb/y1f85v7JE/c5uJCSfOWge6gr2dvZ9Mq+f/tMORn+0W0OzP7jL8Khx380zZ/lgML/Yj5C9FnT/MH7gNGWfP9Srbz0sSHkXAZfO6LfQ8WTmMTWPS458+Ym/r3q8nehHHfrwnQcFOXgxqUSXhR82QL1PnK9fcGEexeuJoc3ByfNS5Efka1wat5NJ2+fHOj4gpeIlp/Up09+lbQCO/urfcNtSZPZyujj9PdKS/Cudtk5nXB4R9Ru7XRniMpgKuUQ7g6/PmTkJNK2wRT5Yus8KMcEfMusjWrLJa5PXHYaL1VByYnLzpC5YZ3qm9LVqd+WTtdtAQ+TrxTtctE3zAQHhuCPBMektrMlZJQZIH5Cf83MDSw8UW09SZ49MzdkVW3hxQyLy6UaFGIyvroyY/8ZM+TtEIiPRWVK+qNU/HQCJfHTpgh1nSUfOaZ/eI9JOS2n0z5B2YRyCvLFofn61u6ve8ghKBuRLiTd0S+e4P3xBw6VXjDuR6VV8Vi9dth3yvz6twwemJ0Hh+y1iOHp+4MrxAIrwLLqG6eDirx4YGcF7FBJv3am3133QErRe+voB54fX3d4mNyD1zKs1GDz+wLsPB+Xx5NV3KthZVlCfZOuPjkCCIYCdlbADstCrc2MrRtZMXhBxJyfPlkAGL/0kZ+t5f0aJJrhHh9rHpSdFwJZ8P0xG1eHhbrLqG8APHjq2hnTaKzL2GWyWbvHjt6svwQPD7+2LXtZBgAAAAAWzD129PAvHy7Lf5oBAAAAwL2wZP8S6y8BAAAAAMCQhP7li9aO4V1seftD2s9eriDe8itvkYKErtBarFXTBwAAAACgD49+bT7Qhz34UnYnV/6l3XZ8KPgrIpr5nC71YlXmi61L5b37uAwAAAAAQMgnv/svfVSLGrxcDK2hPL1/Tz9Y1gq9ArYO/iWbzCgpRTGH/WryGxSVPF90JxyTP3yRk8SVLzUAAABgVXj062//nf//wgxDPpNgywvZtkddoj+3TX8ausXGDxBPpaiXlq2bvF2Cr8+OzbEI0VgXQvkT4pAw3Wk4KW03xJfPyHUlX0UIPBq6QIf2Hj9hq41NQ0Ubj5qN/XN1wQp1qeb0sdc4MJ1fuaXbBoXI/lduM9eoPkQkXAVF81vC5aupn3CVPQWr0vz2oQrZ2n4WAAAAAGmC8UvyMmf9S+tW2qvWGfX/FBTfLsSkg2A1Z3G/zhGjnghfsAK8E5Hsn8jdKjRkxgEJ02EnRod44lsRQ/+SpapT7w46tPFZpolPeHe3CZMhPIlt8TbV+F3JNIrw0/XV98P9k1Q4k8nvDHyry0qYQI09+U5b2KFQQq4W60TMSAAAAABAjkfNv/6lD1N82zQ3cvCz2aP8O3Eov5Zj378kN5Qi2IWYdECnbsjz+uxp2frH1n4blu3Pn5gd+4nrs4srb2d7O955/e5WDXtJeru7h9M73r9Tkf+8Pe/sobe8V3vkb30sx1ns9qOcsIaStildvrnSR7VU5tdQbOcsZlBw3EyMsJQ+WT17w4PYd3rQsIc97e6yc9tHsqdrBQAAAAC6GfT7RB81zS/6UEOnFDgU5HcG+7r9eFPmARbDrshoR41UsVdRtIvc7TvjqVweW7dFj6AJeuP8ehae3xzkNpM/PrmyBknrM6ieo7Exm3NsB7JnP3hufB32BwMAAABWhkdzvD0+w09mgNNCpxRYC49QOa/G0fZb2n7NMGgHh9857zsIqPYsZf+MIR+tH8vJbxZeBDka68nhlD6D6mmHmr2x5oHs2Yu9nZEZRQUAAABAEY+a5ld9OD83MmBp118+k1M1t86Ur3sTB3Psour3x3nKenRgQvdOx0P3/ORLOPfG82+8cU3KRPf4GTlYdliT1ZQDDTtjhbPHPfNbbucCeLa70Uqk9MnqWZHfJAPZU1Njn+2jg5Gb+gcAAABACWZ+XL3H8/um+UQOWm/5lPOVCFErMj+U015cHu8eThv7WvBJ80q6+Ouzp5NbEzreNAsfq9Gzref7G3q0Ug/QXb6abprpWcG81aGG8TjkfOuCF3TmuTyeXJl53oObSRD/+uyly5mWn9JnqPzOBed9Y/85a5TSJ6dnLL+11NpzMLD0EgAAAOjDp9uP9RFgN88f1+I3lYf2WMAaUfPuOwAAAAAM2H/cg6dhPfht8mWvdwSrhPfCFgAAAACK+eDT7cc/XL/TZw+e7aNveJJaY788BAAAAAAAisH8OAAAAAAAGBDMjwMAAAAAgCGBfwkAAAAAAIYk9C9ftHYM72LLfIqI/uxnL1cQ/f0fxnsfWEJX6P3gVdNnjXEFvp7v//fSf/76wxLu3WCpl/bxMv/9AvsDAKqYb/zyS9mdXPmXdtvxoeCvA2nma9f2TnkvHv3R9Ht/YWcdmmnn3jBW3TBY8LIyRHm1UugtR7YYl53n15MV1D9Vbweuz6kP2kfCVWVp+cOuFjqtZuttgcYxQTlq4yf0j+OEt8Wnko3fUSInngFsNAAAqKX/+z1q8HIxSNPrmjm9f08/WNYKjWJRQx5rv1cK32RSFKH9ZrMwVHkNW1YrVvLVLF3/XIKpejtsfSYNotLa4ewOfXN0RP8G+lKwPuesxPXiW7usqsTL3Sxo8Pgp/QsI1KcTfRzkN33i8OV0x6fAiAwAAEhjxi+/MMOQrZ17XjTNZ+YS/ZFP2YnaCkj9BXDDFWvpZtl7vr9x5e3+fX12bI5FiMY2sxx4usctptCdhpPSbt59+YxcV/JVBGmZTQp0gQ7tPX7CVhubhoo2HjUbZrsZK9SlmtPHXuPAdH7llm4bFMKbP+rDJJnyIubWJxQg2VamyNshisjSOFtTKN1sr/mCXDl6oZn4MTiiS4wkmhsq5SSxErxkFO4K0b4Yp62OOp+tt6lwdaVX/aSK1MS2QG2Fbx8dNJPdp2cz31W7PDa7unK1je4byvvJT1/lt2SSOC9VFeb9obzdT6PUxk/qL2TsQ/DeuZuP9cVEfv39VNWVrY/VicOX0xk/VS4AAJDE+JffiTv4V30W8Kem+dpc/aOEKGf0SzlWfiT9Kci5/LsJofhVqzkt/GHz6K581PKeP3l7KBPdu4fTTW+L8mY0PriRK7yxpOxmqPo/b9dFQneAqflHbyqdL95ND90m5Amoc9U6ccInSiFKeueNiNnd5a0NRU+V6OSKxapLdovzhD51+V0MBVskJstrIMg61rY8TxcUy2g8pr5a20GbP0XOntFyJBdJS6eCu90/9xy0aPweDCInVZ+3j07c0hB/R/00o/H51gVHZnXMrqB0OltvM/WZqCkXTWoOdiacUu7MSuAzWVJJBJC7aG/lKkMNSMRBc9TGL9I/QTIDfn7VdraqcnOT1sw61IGcjvhFRgMAgJCC9ZffNs2NHPwsW4oTyhklp5NQriT9EVsSwS7EpAM6dUOe0h+VrH9s7aNjEVfHtnPXZxdX3giFHT+7fnerHsxV/ye97pXpY/PNuu8oJR77Z6HeVaXMCWv8DoQHCvpRmV9DsZ2zGJecHe6OzjBVXppKfeyzgD/epnYZPzk9PaHOT48UKaholXot+0TI2jNWjsFYl3TCO87BjJV7H4aSk8LXuQBnz3a9qiNdLqn6kHqSKXjCmWHvdBwbpuRxuK7BS+Hu5kfyFKkKsu8/67fPUBs/R9w+ejQ46izO5JdF8PMQ3cBevi8sKicTv5/9AQBgvvd7WnzUNL/oQw2dUuBQkB8T7Nf4402ZB1gMd6mmO+ZWtWh3SDdI4m0nqDobxXgkQfUsPL85rEt+eHPQf+K2Bzbh8GlAPMzRqOVdVpG352w58uOGm/uVgXDP4YqWew+GkhOD/AYeplX6e4Ovq0jK9yv2CS3042Nva6ai8DjcXdk0rxtVLiuR2vj1UOVQXGydt4pyNr/sROrh40lDxe/Fj8rJxO9hfwAAIB792nygD+fnJzPAaaFTCqyFR/xioy5t/6rtLwyDHj/jcbu+fQVPSzZ20nDSd/xyOfntonsgN1Veg6KmenmQJeUnsTvonLUItfbkxw039yssyntYHDIaRoifmTLdQuksF4HHiqNLLxPhKcjZ4rG5yM6u5Ch5w9cZqJ7wY46R0PmkWRt/PoIFmNH8ih9t1pBcHh/G14M6Odn4tfYHAADFo+bRv+nD+bmRAUv7Icxncqrm1hkZ0ysaCROHxVscp99HZk/HtXwyJTRsy0dtaXT0zBvXlLECCcxAjovtUVlNOdCwk5OdxXX0zG+5nYso6C4T5aUZQh+1MPb48vKYl7NG3SRxH7LTeNX2pHxtDLG2tbb+LALOvD7sRaredtbnmXKJ1YfUEr/apX9q9WDEuRRJ8Rd71IyxV6d4Rr+xFWXGLZ07fgf53wvnw7nr0fxydfPKxG+NHJ6cTPxa+wMAgOHR//32P/h/9dL375vmEzlovUVezlciRK3I/FBOe3F5LK8FmKnJk+aVNHHXZ0/1KiFivBntR0qQFlxNeKrRSt34X76yk4kK0ymoBfAccr510b28SnlBIuH1wc0kiK9WEuo8aPkpfYbKbx+M/rKirCvdRHn1wiZsO1nqoMfk+JvxFbGt7a5tdJ7f048Eg9mTB3P8GmFTraSy/qT0T5GKr8MVXI7ukamaWL1lUuGxckmSWuKXClcum6w88TOsnuW8JQ1WIR79Lhu8FLjcTaZK9K+Nn9A/hV+OMg2v5afy66tDqVBFVzek5KTiJ+0PAADdfPzZ7/QR4ObXHzfgXiDf8IN7hQsMBbR61JYL/dCi43WpcLAcYH8AQH8e/eZ//0cfAp4Y8uB1Y/ew3hGAB0bqxaZUOFgOsD8AoD+Dvj++7oTTREUTwwAAAAAAoMWn27k3gwEAAAAAAKjiUdP8qg8BAAAAAACYG8yPAwAAAACAIQn9yxeVO4ZvmU8R0Z/97OUK4n2Xw3sfUkJX6P3IVdNnjcm++DqcnYvrlYs4wOvu91BPVu1F4oQ+bJl6Ay/QnrV2S9WT2vqz7i9+36v+A9SH+9K/tp4MBepbP7LpLrBdWhJN8/+USjVEyA6ZVgAAAABJRU5ErkJggg=="},305:function(e,t,o){e.exports=o.p+"assets/img/DB-Connect.f1650039.png"},306:function(e,t,o){e.exports=o.p+"assets/img/DB-Edit.54e91f2d.png"},685:function(e,t,o){"use strict";o.r(t);var r=o(9),a=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"setup-developer-environment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setup-developer-environment"}},[e._v("#")]),e._v(" Setup Developer Environment")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#developer-resources"}},[e._v("Developer Resources")])]),t("li",[t("a",{attrs:{href:"#windows-setup-software"}},[e._v("Windows Setup Software")])]),t("li",[t("a",{attrs:{href:"#git-setup"}},[e._v("Git Setup")]),t("ul",[t("li",[t("a",{attrs:{href:"#fork-btcpay-server-repository"}},[e._v("Fork BTCPay Server Repository")])]),t("li",[t("a",{attrs:{href:"#clone-btcpay-server-repository"}},[e._v("Clone BTCPay Server Repository")])]),t("li",[t("a",{attrs:{href:"#create-a-development-feature-branch"}},[e._v("Create a Development Feature Branch")])])])]),t("li",[t("a",{attrs:{href:"#local-btcpay-setup"}},[e._v("Local BTCPay Setup")]),t("ul",[t("li",[t("a",{attrs:{href:"#bitcoin-regtest-network-setup"}},[e._v("Bitcoin Regtest Network Setup")])]),t("li",[t("a",{attrs:{href:"#build-local-btcpay-server-in-browser-mode"}},[e._v("Build Local BTCPay Server in Browser Mode")])]),t("li",[t("a",{attrs:{href:"#visual-studio-setup"}},[e._v("Visual Studio Setup")])]),t("li",[t("a",{attrs:{href:"#build-local-btcpay-server-in-debug-mode"}},[e._v("Build Local BTCPay Server in Debug Mode")])]),t("li",[t("a",{attrs:{href:"#visual-studio-code-changes-in-your-local-btcpay-server"}},[e._v("Visual Studio Code Changes In Your Local BTCPay Server")])])])]),t("li",[t("a",{attrs:{href:"#git-maintenance"}},[e._v("Git Maintenance")]),t("ul",[t("li",[t("a",{attrs:{href:"#sync-forked-btcpay-server-repository"}},[e._v("Sync Forked BTCPay Server Repository")])]),t("li",[t("a",{attrs:{href:"#commit-code-to-make-pull-request"}},[e._v("Commit Code To Make Pull Request")])]),t("li",[t("a",{attrs:{href:"#create-a-branch-of-a-pull-request"}},[e._v("Create a Branch of a Pull Request")])]),t("li",[t("a",{attrs:{href:"#delete-local-branch"}},[e._v("Delete Local Branch")])])])]),t("li",[t("a",{attrs:{href:"#working-with-docker-containers"}},[e._v("Working with Docker Containers")])]),t("li",[t("a",{attrs:{href:"#greenfield-api-development"}},[e._v("Greenfield API Development")])]),t("li",[t("a",{attrs:{href:"#working-with-the-database"}},[e._v("Working with the Database")])]),t("li",[t("a",{attrs:{href:"#questions"}},[e._v("Questions")])])])]),t("p"),e._v(" "),t("p",[e._v("This guide will help you set up your developer environment to prepare you for later contributions to the BTCPay Server repositories. A variety of beginner tools are used in the guide below to help you get started with development. Once you understand the general setup process, feel free to use any tools that you like.")]),e._v(" "),t("p",[e._v("If you are looking for how to make a simple code change such as fixing a typo or copy change, check out the simplified "),t("RouterLink",{attrs:{to:"/Contribute/WriteSoftware/"}},[e._v("Write Software")]),e._v(" tutorial instead. If you are an advanced developer with a local environment already set up for development, you can skip ahead to the "),t("RouterLink",{attrs:{to:"/Development/LocalDevelopment/"}},[e._v("LocalDevelopment")]),e._v(" documentation.")],1),e._v(" "),t("h2",{attrs:{id:"developer-resources"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#developer-resources"}},[e._v("#")]),e._v(" Developer Resources")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://docs.github.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github Docs"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/Development/LocalDevelopment/"}},[e._v("BTCPay Commands and Concepts")])],1),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/Development/LocalDevelopment/#videos"}},[e._v("Environment Setup Videos (Linux, Mac, Windows)")])],1)]),e._v(" "),t("h2",{attrs:{id:"windows-setup-software"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#windows-setup-software"}},[e._v("#")]),e._v(" Windows Setup Software")]),e._v(" "),t("p",[e._v("Software to install to follow this guide:")]),e._v(" "),t("ol",[t("li",[t("a",{attrs:{href:"https://visualstudio.microsoft.com/downloads/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Visual Studio Community Edition"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://dotnet.microsoft.com/en-us/download/dotnet/6.0",target:"_blank",rel:"noopener noreferrer"}},[e._v(".NET Core SDK 6.0+"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.docker.com/products/docker-desktop",target:"_blank",rel:"noopener noreferrer"}},[e._v("Docker Desktop"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("PowerShell (included in Windows OS)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://gitforwindows.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitBash"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://desktop.github.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub Desktop"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("www.Github.com account"),t("OutboundLink")],1),e._v(" (sign up)")])]),e._v(" "),t("p",[e._v("Note: "),t("em",[e._v("This guide assumes installations in default locations. Take note if you have a different file directory structure.")])]),e._v(" "),t("h2",{attrs:{id:"git-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#git-setup"}},[e._v("#")]),e._v(" Git Setup")]),e._v(" "),t("h3",{attrs:{id:"fork-btcpay-server-repository"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#fork-btcpay-server-repository"}},[e._v("#")]),e._v(" Fork BTCPay Server Repository")]),e._v(" "),t("ul",[t("li",[e._v("Open a web browser and login to your www.Github.com account.")]),e._v(" "),t("li",[e._v("Navigate to the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay Server Repository"),t("OutboundLink")],1),e._v(" and press the "),t("code",[e._v("Fork")]),e._v(" button to create your own copy of the BTCPay Server repository on Github.")]),e._v(" "),t("li",[e._v("Next open Github Desktop and login so that Github Desktop knows about your www.Github.com account and connects to it.")])]),e._v(" "),t("h3",{attrs:{id:"clone-btcpay-server-repository"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#clone-btcpay-server-repository"}},[e._v("#")]),e._v(" Clone BTCPay Server Repository")]),e._v(" "),t("ul",[t("li",[e._v("In GitHub Desktop, use the "),t("code",[e._v("Add")]),e._v(" button and see the option clone repository.")]),e._v(" "),t("li",[e._v("If you are using your www.Github.com credentials in GitHub Desktop, you will see your BTCPay Server repository that you just forked on www.Github.com. Select it and take note of the local path shown below. (by default it will be something like "),t("code",[e._v("C:\\Users\\SatoshisComputer\\Documents\\GitHub\\btcpayserver")]),e._v(" for clarity, lets call it our: "),t("em",[e._v("clone local path")]),e._v(") then press clone.")]),e._v(" "),t("li",[e._v("Now you will see the BTCPay Server repository has been cloned in your GitHub Desktop and you will be on the "),t("em",[e._v("master branch")]),e._v(".")])]),e._v(" "),t("h3",{attrs:{id:"create-a-development-feature-branch"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-a-development-feature-branch"}},[e._v("#")]),e._v(" Create a Development Feature Branch")]),e._v(" "),t("ul",[t("li",[e._v("Next we will practice working with our BTCPay Server repository that we just cloned to our computer using Github Desktop.")]),e._v(" "),t("li",[e._v("When developing, you may want to work on different features at once. To do that, we typically want to create multiple feature branches instead of making all changes to the master branch.")]),e._v(" "),t("li",[e._v("We're using GitBash and some Git commands, so open GitBash. (If you prefer to only use GitHub desktop instead of GitBash, you can create branches there instead.)")]),e._v(" "),t("li",[e._v("Once you have a GitBash terminal open, we need to change directory to our clone of BTCPay Server repository.")]),e._v(" "),t("li",[e._v("To do this, navigate to our "),t("em",[e._v("clone local path")]),e._v(" with the change directory command: "),t("code",[e._v("$ cd Documents/Github/btcpayserver")])]),e._v(" "),t("li",[e._v("You can see your clone of BTCPay Server is on the branch called "),t("code",[e._v("master")])]),e._v(" "),t("li",[e._v("Make a copy of your master branch to do some development on it, with the command: "),t("code",[e._v("$ git branch OurNewDevelopmentBranch")])]),e._v(" "),t("li",[e._v("Let's view all the branches we have now, with the command: "),t("code",[e._v("$ git branch")]),e._v(" you can see we have master and OurNewDevelopmentBranch")]),e._v(" "),t("li",[e._v("In Git, we now have a copy of our forked BTCPay Server repository (our clone). When we want to switch between branches (copies of our clone), we need to tell Git which branch our development code changes should be assigned to. We do this by checking out our branch, with the command: "),t("code",[e._v("$ git checkout OurNewDevelopmentBranch")])]),e._v(" "),t("li",[e._v("Now you are on OurNewDevelopmentBranch in GitBash.")]),e._v(" "),t("li",[e._v("Open your GitHub Desktop and you can see you are no longer on master and you are now on "),t("code",[e._v("OurNewDevelopmentBranch")])]),e._v(" "),t("li",[e._v("In the top menu in Github Desktop click: "),t("code",[e._v("Repository > Show In Explorer")]),e._v(" to see the location of the files.")])]),e._v(" "),t("h2",{attrs:{id:"local-btcpay-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#local-btcpay-setup"}},[e._v("#")]),e._v(" Local BTCPay Setup")]),e._v(" "),t("h3",{attrs:{id:"bitcoin-regtest-network-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bitcoin-regtest-network-setup"}},[e._v("#")]),e._v(" Bitcoin Regtest Network Setup")]),e._v(" "),t("ul",[t("li",[e._v("For the next step make sure that you have Docker-Compose installed (included with Docker Desktop). Open a PowerShell terminal and navigate to your "),t("em",[e._v("clone local path")]),e._v(" and into the BTCPayServer.Tests directory with the command: "),t("code",[e._v("$ cd Documents/Github/btcpayserver/BTCPayServer.Tests")])]),e._v(" "),t("li",[e._v("The BTCPay Server.Tests project contains the docker files needed to run our docker commands that will start all the project dependencies and create a local Regtest network.")]),e._v(" "),t("li",[e._v("In Powershell, start the docker services with the command: "),t("code",[e._v("docker-compose up dev")]),e._v("(you must be in the BTCPay Server.Tests to run this command).")]),e._v(" "),t("li",[e._v("In your PowerShell terminal you will first see the necessary docker images being pulled, then containers being built. If the build is successful the containers will all show as done.")])]),e._v(" "),t("figure",[t("img",{attrs:{src:o(300),alt:"BTCPayServer.Tests powershell terminal",title:"BTCPayServer.Tests powershell terminal"}})]),e._v(" "),t("h3",{attrs:{id:"build-local-btcpay-server-in-browser-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-local-btcpay-server-in-browser-mode"}},[e._v("#")]),e._v(" Build Local BTCPay Server in Browser Mode")]),e._v(" "),t("p",[e._v("If you don't want to do any coding and you simply want to create a local BTCPay Server for testing features in the interface, you can start a local BTCPay from the command line.")]),e._v(" "),t("p",[e._v("After building your "),t("a",{attrs:{href:"#bitcoin-regtest-network-setup"}},[e._v("regtest network")]),e._v(", navigate to your "),t("code",[e._v("btcpayserver\\BTCPayServer")]),e._v(" directory and run the following command:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet run --launch-profile Bitcoin\n")])])]),t("p",[e._v("Open a new browser and visit: "),t("a",{attrs:{href:"http://127.0.0.1:14142",target:"_blank",rel:"noopener noreferrer"}},[e._v("http://127.0.0.1:14142"),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"visual-studio-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#visual-studio-setup"}},[e._v("#")]),e._v(" Visual Studio Setup")]),e._v(" "),t("ul",[t("li",[e._v("Open a file explorer to the BTCPay Server repository folder. Without opening any of the folders shown, look for the "),t("code",[e._v("btcpayserver.sln")]),e._v(" item and right click it to "),t("code",[e._v("Open with > Visual Studio")]),e._v(". You may need to choose Open with > Choose another app ... and look for Visual Studio if you have never opened this kind of file before.")]),e._v(" "),t("li",[e._v("To get your Visual Studio set up choose "),t("code",[e._v("View > Solution Explorer")]),e._v(" from the top menu. In this solution explorer you will see all the BTCPay Server files and folders.")]),e._v(" "),t("li",[e._v("The top project is BTCPay Server, make sure it's in bold. If it isn't, right click it and choose Set as StartUp Project.")]),e._v(" "),t("li",[e._v("Your Visual Studio is now set up and ready.")])]),e._v(" "),t("figure",[t("img",{attrs:{src:o(301),alt:"VS Solution Explorer",title:"VS Solution Explorer"}})]),e._v(" "),t("h3",{attrs:{id:"build-local-btcpay-server-in-debug-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-local-btcpay-server-in-debug-mode"}},[e._v("#")]),e._v(" Build Local BTCPay Server in Debug Mode")]),e._v(" "),t("ul",[t("li",[e._v("Back in Visual Studio, click: "),t("code",[e._v("Build > Build Solution")])]),e._v(" "),t("li",[e._v("In the output window, a successful build will look something like this: "),t("code",[e._v("========== Build: 6 succeeded, 0 failed, 0 up-to-date, 0 skipped ==========")])]),e._v(" "),t("li",[e._v("Next press "),t("code",[e._v("Debug > Start Debugging")])]),e._v(" "),t("li",[e._v("First a Visual Studio debug console will open which shows information about the status of your local BTCPay Server.")]),e._v(" "),t("li",[e._v("Next a local BTCPay Server will be created in a web browser, showing on the home page that it's in "),t("code",[e._v("REGTEST")]),e._v(" mode.")]),e._v(" "),t("li",[e._v("You now will have three windows to view: BTCPay Server browser session, our Visual Studio debug console and our BTCPay Server.Tests powershell terminal.")]),e._v(" "),t("li",[e._v("Register a new user in your BTCPay Server and see the registration event is shown in your Visual Studio debug console.")])]),e._v(" "),t("figure",[t("img",{attrs:{src:o(302),alt:"VS Debug Console",title:"VS Debug Console"}})]),e._v(" "),t("figure",[t("img",{attrs:{src:o(303),alt:"Local Regtest BTCPay",title:"Local Regtest BTCPay"}})]),e._v(" "),t("h3",{attrs:{id:"visual-studio-code-changes-in-your-local-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#visual-studio-code-changes-in-your-local-btcpay-server"}},[e._v("#")]),e._v(" Visual Studio Code Changes In Your Local BTCPay Server")]),e._v(" "),t("ul",[t("li",[e._v("Make changes to code in Visual Studio (Ex: modify the "),t("code",[e._v("This store is ready to accept transactions, good job!")]),e._v(" text in the "),t("code",[e._v("~\\BTCPayServer\\Views\\UIStores\\Dashboard.cshtml")]),e._v(" file)")]),e._v(" "),t("li",[e._v("Refresh the page to see your text changes on the home page.")]),e._v(" "),t("li",[e._v("Some code changes require re-start of Debugging for changes to take effect.")]),e._v(" "),t("li",[e._v("Add breakpoints in Visual Studio and see those breakpoints get hit when you try to use a feature in your local BTCPay Server instance.")])]),e._v(" "),t("h2",{attrs:{id:"git-maintenance"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#git-maintenance"}},[e._v("#")]),e._v(" Git Maintenance")]),e._v(" "),t("h3",{attrs:{id:"sync-forked-btcpay-server-repository"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sync-forked-btcpay-server-repository"}},[e._v("#")]),e._v(" Sync Forked BTCPay Server Repository")]),e._v(" "),t("ul",[t("li",[e._v("With many contributors adding code changes to the Master BTCPay Server Repository, sometimes your forked copy can fall behind, unless you merge new changes into your fork.")]),e._v(" "),t("li",[e._v("If you go to your Fork of BTCPay Server on www.Github.com you will see a message saying that your branch is behind by some commits. Example: "),t("code",[e._v("This branch is 32 commits behind btcpayserver:master")]),e._v(".")]),e._v(" "),t("li",[e._v("To update, you can use GitBash or simply use Github Desktop by clicking through the synchronization prompts.")]),e._v(" "),t("li",[e._v("Open a GitBash terminal and update your BTCPay Server repository with the following commands.")]),e._v(" "),t("li",[e._v("First always navigate to your "),t("em",[e._v("clone local path")]),e._v(" with the command: "),t("code",[e._v("$ cd Documents/Github/btcpayserver")]),e._v(" and make sure you are on "),t("code",[e._v("master")]),e._v(" branch.")])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" fetch upstream\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" merge upstream/master\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" commit -m "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("SomeCommitMessage"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n\nMessage prompt: "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v(".your branch is ahead of origin master by "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"X"')]),e._v(" commits"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v(". use "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" push to publish"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v(".\n\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("add")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v("\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" push origin master\n")])])]),t("p",[e._v("If you see an error "),t("code",[e._v("fatal: 'upstream' does not appear to be a git repository")]),e._v(" when running "),t("code",[e._v("$ git fetch upstream")]),e._v(", you must first configure a remote that points to the upstream repository in Git. That is needed only once. Just run the following command while you are in your "),t("em",[e._v("clone local path")]),e._v(" .")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" remote "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("add")]),e._v(" upstream https://github.com/btcpayserver/btcpayserver.git\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# check if the upstream repo is added succesfully")]),e._v("\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" remote -v\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# you should see something like this:")]),e._v("\norigin\tYOUR_FORKED_GITHUB_REPO "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("fetch"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\norigin\tYOUR_FORKED_GITHUB_REPO "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("push"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\nupstream\thttps://github.com/btcpayserver/btcpayserver.git "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("fetch"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\nupstream\thttps://github.com/btcpayserver/btcpayserver.git "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("push"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("h3",{attrs:{id:"commit-code-to-make-pull-request"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#commit-code-to-make-pull-request"}},[e._v("#")]),e._v(" Commit Code To Make Pull Request")]),e._v(" "),t("ul",[t("li",[e._v("After you have made some code changes on a feature branch (Example: A feature branch called "),t("code",[e._v("Fix/BugBranch")]),e._v(") and you want to make a Pull Request to the BTCPay Server Repository. Open a GitBash terminal and navigate to your "),t("em",[e._v("clone local path")]),e._v(" with the command: "),t("code",[e._v("$ cd Documents/Github/btcpayserver")]),e._v(" and make sure you are on the "),t("strong",[e._v("correct branch")]),e._v(" that you want to commit and use git status to check the files changed are the ones you want to commit.")])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" status\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("add")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v("\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" commit\n\nText Editor appears to "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("add")]),e._v(" your commit message"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v(".\nExample Commit Message: Fix bug "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("for")]),e._v(" update button\n\nAccept Changes: Ctrl + x\nSave Changes: Shift + y\nClose Editor with: Enter\n\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" push origin Fix/BugBranch\n")])])]),t("p",[e._v("See your new branch has been created on you www.Github.com BTCPay Server Fork, review changes and create Pull Request.")]),e._v(" "),t("h3",{attrs:{id:"create-a-branch-of-a-pull-request"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-a-branch-of-a-pull-request"}},[e._v("#")]),e._v(" Create a Branch of a Pull Request")]),e._v(" "),t("p",[e._v("A great way to contribute without having to be an advanced developer is by testing other contributor's pull requests. Manual testing is a great way to help other's and ensure that BTCPay Server code changes are working properly. Here is an example of how to make a branch of someone else's pull request, using this previous PoS Pull Request https://github.com/btcpayserver/btcpayserver/pull/454. Open a GitBash terminal and navigate to your "),t("em",[e._v("clone local path")]),e._v(" with the command: "),t("code",[e._v("$ cd Documents/Github/btcpayserver")]),e._v(" and use "),t("code",[e._v("git status")]),e._v(" to check you don't have any other staged commits (git status is clear).")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" status\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" fetch upstream pull/454/head:pos-new-design\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" branch "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("to your new testing branch called pos-new-design"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("p",[e._v("Note: Be sure to change the /454/ pull request number to the number of the one you would like to test. You can typically leave /head: as is, and add the name of the pull request branch after it.")]),e._v(" "),t("h3",{attrs:{id:"delete-local-branch"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#delete-local-branch"}},[e._v("#")]),e._v(" Delete Local Branch")]),e._v(" "),t("p",[e._v("If you delete a branch on your forked BTCPay repository on Github.com, your local copy on your machine will still remain, unless you delete it:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" checkout master\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" branch -D "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("branch name"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n")])])]),t("p",[e._v("Note: You can't delete a branch if you have it checked out, so checkout another branch like "),t("code",[e._v("master")]),e._v(" first, as shown in the example above.")]),e._v(" "),t("h2",{attrs:{id:"working-with-docker-containers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-docker-containers"}},[e._v("#")]),e._v(" Working with Docker Containers")]),e._v(" "),t("p",[e._v("If you want to use Docker Commands when developing locally, you can run the following commands in the "),t("code",[e._v("BTCPayServer.Tests")]),e._v(" directory.")]),e._v(" "),t("ul",[t("li",[e._v("Show running containers "),t("code",[e._v("docker ps")])]),e._v(" "),t("li",[e._v("Show logs for a container "),t("code",[e._v("docker ps logs ")])]),e._v(" "),t("li",[e._v("Start Docker containers "),t("code",[e._v("docker-compose up dev")])]),e._v(" "),t("li",[e._v("Stop Docker containers "),t("code",[e._v("docker-compose down")])]),e._v(" "),t("li",[e._v("Destroy Docker containers "),t("code",[e._v("docker-compoose down --v")])])]),e._v(" "),t("h2",{attrs:{id:"greenfield-api-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#greenfield-api-development"}},[e._v("#")]),e._v(" Greenfield API Development")]),e._v(" "),t("p",[e._v("The BTCPay Greenfield API is "),t("RouterLink",{attrs:{to:"/FAQ/General/#how-can-i-use-the-btcpay-server-api"}},[e._v("currently being developed")]),e._v(". You can find a "),t("RouterLink",{attrs:{to:"/Development/GreenFieldExample/"}},[e._v("usage example here")]),e._v(". The official Greenfield "),t("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/",target:"_blank",rel:"noopener noreferrer"}},[e._v("API reference documentation"),t("OutboundLink")],1),e._v(" is available for developers who want to develop with the BTCPay REST API.")],1),e._v(" "),t("p",[e._v("Developers who would like to contribute to the Greenfield API should follow the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/docs/greenfield-development.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("developer guidelines"),t("OutboundLink")],1),e._v(" used by the BTCPay project for additions or modifications. If you feel these guidelines are not clear, consider discussing your ideas in the community chat (development channel) or "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues/new/choose",target:"_blank",rel:"noopener noreferrer"}},[e._v("open a github issue"),t("OutboundLink")],1),e._v(" to discuss endpoint implementation ideas.")]),e._v(" "),t("h2",{attrs:{id:"working-with-the-database"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-the-database"}},[e._v("#")]),e._v(" Working with the Database")]),e._v(" "),t("p",[e._v("BTCPay uses a PostgreSQL database by default. During development you can easily connect to it. This is helpful if you want to view how data is saved, modify records or use it to find issues during development. You can use the free tool "),t("a",{attrs:{href:"https://www.pgadmin.org/download/",target:"_blank",rel:"noopener noreferrer"}},[e._v("PgAdmin4"),t("OutboundLink")],1),e._v(" to do this.")]),e._v(" "),t("p",[e._v("Start your BTCPay in your local environment and view your debug console to find your database connection details:")]),e._v(" "),t("figure",[t("img",{attrs:{src:o(304),alt:"PostgreSQL Configuration",title:"PostgreSQL Configuration"}})]),e._v(" "),t("p",[e._v("Next, open your PgAdmin and select: "),t("code",[e._v("Servers > Create > Server...")]),e._v(" to connect to your server. Provide a name for your server and provide your host connection details from your Visual Studio debug console:")]),e._v(" "),t("figure",[t("img",{attrs:{src:o(305),alt:"PgAdmin Connection",title:"PgAdmin Connection"}})]),e._v(" "),t("p",[e._v("Save to connect to your development btcpayserver database. In the btcpayserver database look for:\n"),t("code",[e._v("Schemas > public > Tables")]),e._v(" to see the tables which contain the BTCPay Server data.")]),e._v(" "),t("p",[e._v("As an example, you can see all the users registered to your development BTCPay by viewing the rows of the "),t("code",[e._v("AspNetUsers")]),e._v(" table. Try changing the username of a registered user in the database, then "),t("code",[e._v("Save Changes")]),e._v(" and "),t("code",[e._v("Refresh (F5)")]),e._v(". Now log into your BTCPay using the new username and original password.")]),e._v(" "),t("figure",[t("img",{attrs:{src:o(306),alt:"PgAdmin Edit",title:"PgAdmin Edit"}})]),e._v(" "),t("h2",{attrs:{id:"questions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#questions"}},[e._v("#")]),e._v(" Questions")]),e._v(" "),t("p",[e._v("If you have questions about the BTCPay Server local development setup, you can join the "),t("a",{attrs:{href:"https://chat.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("community chat"),t("OutboundLink")],1),e._v(". If you have questions about any of the other tools or commands, etc. it's likely you can find answers to your questions by doing a search on the internet or on "),t("a",{attrs:{href:"https://stackoverflow.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("StackOverflow"),t("OutboundLink")],1),e._v(".")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file +(window.webpackJsonp=window.webpackJsonp||[]).push([[26],{300:function(e,t,o){e.exports=o.p+"assets/img/docker-compose-up-dev.82514a01.png"},301:function(e,t,o){e.exports=o.p+"assets/img/vs-solution-explorer.71213904.png"},302:function(e,t,o){e.exports=o.p+"assets/img/vs-debug-console.9b8e7386.png"},303:function(e,t,o){e.exports=o.p+"assets/img/dashboard-change.d3ce411b.jpg"},304:function(e,t){e.exports="data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAA3UAAABGCAIAAADkairpAAAAAXNSR0IArs4c6QAAAARnQU1BAACxjwv8YQUAAAAJcEhZcwAADsMAAA7DAcdvqGQAAB0VSURBVHhe7Z0/bCQ3lofLc4vFXWocnEgCxjg7EjZy0DtYCCtnDrSZEmEGkziUMFEDAhRdNICAjgwpdDJYQ0lnVuDMAwwWswo2VLJewANISuyFk0suufW99/i/mmSR1dWt7tHvgzBTxWI9Pj6yyVckq9h8uv24AYq909evvzna1mfN9tE3/ilIAbuBpTNELWMZp3v6xCMVDoS1+r0/oNboobXDi84v+rW5+YD8yx+u3+mzBw9VofP9DX3S3E0Pn55d6xOQAXYDS8NUtqvJ7vGlDusHS9q6mJWSCgeatfi9D1dP1oa1KJcBWXR+H5o9hwfjlwAAAAAAYEAe6f8BAAAAAAAYAviXAAAAAABgSEL/8oX8lbPVNP9t/r7QYavI9tE3rzWt9bqrtGB31fRZY1yBL/U1DU4W74UAAAAA841fftk03xr/8jsdNhj89pZmPqdr7/R8/3ayq7j3BbqUrTXwIRet5YLlX589pbI+nN7p8354jyUMPEcAAACgjNC//Er+CtmSf/8m/w4N9+zjzemh8gl3XzbP+zsj2483m6s3kRcIxQlZoRfCVk0fQFyZB5PD6eYYo8sAAABACca//MIMQz7TAZoXTfOZuUR/yqfMQ7fY+AHl8797z/c3ribO1bo+OzbH/piSHVBS85J2wLM7DSelPSjly2fkupKvIgRjb3SBDu09fsJWG5uGijYeNRv75+qCFepSzeljr3FgOr9yS7cN+hHVh/DDmXY+inF2s1lg2V5+wtNI/A762ef67OX0buPJ593pWlPYCxziDEJ3ultsZE1vuwEAAACrg/EvvxN38K/6LOBPTfO1ufpHCVHO6JdyrPxI+lOQc/l3E0Lxq1ZzWpIjjtQZnz95q0c1eUDJ69pH44MbuXI4bfafcy+tu27+gNVoLJ237b5T86feVDpfvJsedn45jZxFrRMnfKIUoqR33oiY3d3J1UjpqRKdXLFYdcl+ly2hT11+F09Snx52i0Ku17jRI4aT2/1zVVzX37/1PLvtz59s3L39Xp434vEXhKdGJt3RmD+dGLkQYyi7AQAAACtFwfrLb5vmRg5+bpoP5UA5o+R0EsqVpD9iSyLYhZh0QKduyLN4/vfjLftJ0wD2LK4ujIDrs4srbzzJjndev7ttNh9TsHLapOO2s5z57tt3bMWb2PpYjrPYr65ywhpK2qZ0+eZKH9VSmV9DsZ1rSerTy24R9nZGd9NX2nCXr6Z3o50ZB9NXIhU/z/z2yaXrvubMBR8UzAxD2Q0AAABYLeZ7v6fFR03ziz7U0CkFDgX5nXc3P+oT4sebgXtkdtWMqyDDZH5qKW7fGU/l8ti6LXrsVBiPJKiehee3kqQ+vew2C7tbbu2ADDxr/0x8WUlK3EvtkqXjL5bB0h3IbgAAAMCKMah/+ZMZ4LTQKQXWwgM/sZGotn/V9neGQc+l88Rl30Gu7aOT/cZOgk/6jl8uJ7/l5PWZ327sbrm1A4KVRHVCqgSlaZdO5OIvAPEAeWJ+2HQHqG8AAADAajGof3kjA5b2Q5jP5FTNrTMypuetIEwjDqa32HD76FQWMH7/9m50YEL3Tscjsw5vIPZ2RnYm3Z9L98aZKBPd45HkBNlhTVZTDjTspLlZ7iw981tu50qS+qTsVguV+0ZqLalyMPd2Nu3EdD5+mn724aWSZmK+KF22j46fqj9D2Q0AAABYLT74dPvxD9fv+EUcf+jxH03zZzmg8L+YjxB91jR/8D5gtCWv+KiVlz42hJzL4GtH1LWe87Be2SiNxNbrMO0SR+617XyzC+W4Wxemg6YoBzculfCi4MsWzKK59gW7mM5duJoc3hycNC9FfkS2wql5N528fXKg4wteIlp+Up8++VXSCuz8z81P9BEAAAAA3mv+85Z8u+Vh/EtAsGP25K3zy9i3a6yn994B/xIAAAB4ICzZvxx0fnzd4WltD36NA29cAAAAAADUgfHLgHCi2puWfx/B+CUAAADwQMD8OFgSvn+55GoHAAAAgEVzjx095scBAAAAAMCQwL8EAAAAAABDEvqXLyp3DN/y9oe0n71cQbbdbjredw8ldBHfiezJqukDlsveaUXpU2VBVQEALA/uoU5rPzc8APeV7hqxov3BfOOXX8ru5Mq/tNuODwV1t4b5LMdfxr41n7G+9xd2qryIe0I8XcdcP+0Vym8yW+GFNfDbpErbneDbze/yTO79RgWlxZDVp5oVq2+DlUv9zaoYWtZ3JeaktcqLKEgpJihHbfyE/lGGrHBVdnaZamfLU8lTJx4/Z/8as/UyQ1V+V5B1138grs8ubvfP56r5iyD0L79qfRE9y5b8qz69PjT8Sxlv2i34XjbP+1ch/syQ3VLQ5/rs6Qr4m47V0sduLDO5Go3na7JXCZutw+nm2G+ZzIXDabOCv9OAvVP+bazCZ1kvj9lkkyv+1AIfOZ2SdgbLgN2Sk+Zte2daqjmNKhiu5ie6VKThsfB2tmbzsRQk3jTPRb+X2vgp/TPcS3ul6r8w8bp36r74Q8oSzvXfVv94/LT94+WVA7+7h8rlMRf5kip+Kca//MIMQz7TAZoXsm2PukR/yqfMQ7fY+AHyeFVU4/ee729cebsxX58d+2M1BmtLDjzd4zZJ6E7DSWmXhy+fketKvoogbZ9JgS7Qob3HT9hqY9NQ0cajZmP/XF2wQl2qOX3sNQ5M51du6bZBKZevpnfN5mMtLqoP4YfrCyoomt9WfMLe0m3PIGuRdMu4Pns5je3UyZtg6sMknKhLy6sPGX0S+nvhZp+mDraPDsy+kwXU6UOx6czeE2raj5SdfZQ9rUZ+sr7+vvqRfKmg+6tvcqnUZL6cefIVhaoIuSVPz2a+C0L+jX4E4GoeLZW9ndGdtwVrFInzUlVBKV+3a2yU2vhJ/YUOO5e0VxQ6W+71dvbhPY11qtufPzE7yXJ+L65ihvbiBwT2z5ZX3g7t352rzyZX+fzOxje0zKZJxLeRGf9C4veVoZ1uXn9fIZMC35HqNyP6c3QvTnBqlWE680Wx6czeo6/k5NfIMXBV6/hlLZ1Ptx/rI4K8zFn/0rqV9qp1Rv0/BcW3CzHpIFjNKWZpmSQKR/SLzBKUgHeiDO6dyN0qNCQQa2NauFB1iCe+FZEi+RcIderdQYc2Pss08Qnv7jZhMoQnsS3ephq/K5mGxz83P7F/OkgTinQJu6PWSXhDQDS/CTvLScyeXvzgOJNuhHZsm4B/oURkGMfLYermlP7+sS8nQySJdpATVKsPx4/ZP09b8XaqnYJ0suoeL3Zwo3/Cx7F8EVErenmckRnLb84+iXS1MD/tdmyrmpdSeJKRH81XB77qbeLXMgo42hZxZRenNr4lrWNoi1BrPiuwMxGJxWm6k3JYiFGhpbZ/yRINTAYTs7bguIGu7Zv53GbRXmBB3l3R/CbiS4pWDU+jlHy+wV7w8G4NjhMk0yXobFb/QAlHIIdPPD2tRO9WP4qcmEj+sY+vmn/M8Qkly0mdkW9OKuU4KHI7KNfRL5yC9ZffNs2NHPxs9ij/ThzKr+XY9y/JDaUIdiEmHdCpG/Isnv9t7aNjCZ4L2w+Gdrzz+t2tejDU0w6H9DhrZw3yk4r+VLo8MG59LMdZ7FfYOWENJW1T4gfVflTm11Bs5zJ4MPnu7fckLqtPM9qJ/ODiZO0csWf4TP9qeuenVZFujtGYf7mvX/Na3Xwt6SCiT0r/ILwMLoO6TaUq9BFi9XkguKkM8NpC+okqs7t6tWb1Lfq7M9WKGesB6sHylbNnnr3Tcazq0W+9KaqQVAVVX8fzwNzCdlAbP0dH+1baXlXU85yd9bVzz3Dc4ttS3D46cTt2EJH4jqT9Y+VV0c7X9keZ+PZ36o/A5uRH6nOyPSxpH/x0U0gCesC8RaSdServR5HKpNsQoSJfQqS++YPSfmXt3z7/eNM1V7RcfqP/H4SPmuYXfaihUwpU7un8kN8ZdK1sTO4pSn5hRXCJ7VNRXlLRcnnfvS3oyN1apcvjXVP/qDH1NgKi5lUfVLHw/ObgjnEsR/SLfCr5SutDv8/D5ptzdYdrCVJk7TxrT3YPNkbnr/clVLiTB4jadHPYu+Wx8LH+DVcS1yelf0Pht2/qk+laHeeo00dJjdbnYagU+D7UNz8SdZ8H/P9g+epZQFTD2Vs5bNdwXnlx9/ZVSeXa2D8/Jwm7ImL7SAVmqI1fT1V7xVTU81wEe42do1NVZJfHh49NKd5NJ9O7sRtlicXXpOyfKq8KavujgeJXtj896/MMnEBdw5rKLzmb44PPt8nynz9ppi+NdkO1q+zA7u9wlVTupQqeo33mlu6JPl4F5nt/vMVPZoDTQqcUWAs/QUSeDmz7YGi3H8OgRxx4HKuXj0HwM2ujlrMTvGC7F8vJbwL61WhsC5jVh35yElvWlcfmDtqU25l/NNw5ebg7qtO1KE+DBzoCigeu40T0yepv4ValjI6H95De+gyGs3NufMIhvQM3ou9ZfbMMlq8ye4ZIT0qN06wNZNW7He7LQPpz+2AkSPnm2qXa+L2oba9qKLJzMKxmSpFrTrMVDnxpZobh4vZPl1cX7ndX2x8NGb+m/elTn1N0N5K2ncnpT6XEA4JkyybsKmrylYHki6tDddNWkjnaZ5en1WBQ/5Kc/l+89ZfP5NQ9+dAvpbDGiIPp3rqjO0/5mHt+t35Vpgxm3YN52NsZuWbKe7LkAtcOL2XCTHOlocpiS5nVlAMNN3qFI9g981tu50qK9OFI+lCI5Tdl5xT8I99/nu9r2+l2wZ/4iXanBd1fSX3w9Uno79tT1JHQPHxP2/sVdWy5qFGQbLmU2HMofDvTA3dIrNmUblaaWt8+LGjF65v87kpczsHyVWTPAC6NuLMi1SYxN8tdvZcvHnVxFW7GLZo7fgfD2rlNXzuz/SJdO2Vu3MQW3LTjx+2fLq8uO/i/u9r+KBffwhcK5Bv8+pz6fZW1Dy5dJqY/p9X5A3btTFb/y1f85v7JE/c5uJCSfOWge6gr2dvZ9Mq+f/tMORn+0W0OzP7jL8Khx380zZ/lgML/Yj5C9FnT/MH7gNGWfP9Srbz0sSHkXAZfO6LfQ8WTmMTWPS458+Ym/r3q8nehHHfrwnQcFOXgxqUSXhR82QL1PnK9fcGEexeuJoc3ByfNS5Efka1wat5NJ2+fHOj4gpeIlp/Up09+lbQCO/urfcNtSZPZyujj9PdKS/Cudtk5nXB4R9Ru7XRniMpgKuUQ7g6/PmTkJNK2wRT5Yus8KMcEfMusjWrLJa5PXHYaL1VByYnLzpC5YZ3qm9LVqd+WTtdtAQ+TrxTtctE3zAQHhuCPBMektrMlZJQZIH5Cf83MDSw8UW09SZ49MzdkVW3hxQyLy6UaFGIyvroyY/8ZM+TtEIiPRWVK+qNU/HQCJfHTpgh1nSUfOaZ/eI9JOS2n0z5B2YRyCvLFofn61u6ve8ghKBuRLiTd0S+e4P3xBw6VXjDuR6VV8Vi9dth3yvz6twwemJ0Hh+y1iOHp+4MrxAIrwLLqG6eDirx4YGcF7FBJv3am3133QErRe+voB54fX3d4mNyD1zKs1GDz+wLsPB+Xx5NV3KthZVlCfZOuPjkCCIYCdlbADstCrc2MrRtZMXhBxJyfPlkAGL/0kZ+t5f0aJJrhHh9rHpSdFwJZ8P0xG1eHhbrLqG8APHjq2hnTaKzL2GWyWbvHjt6svwQPD7+2LXtZBgAAAAAWzD129PAvHy7Lf5oBAAAAwL2wZP8S6y8BAAAAAMCQhP7li9aO4V1seftD2s9eriDe8itvkYKErtBarFXTBwAAAACgD49+bT7Qhz34UnYnV/6l3XZ8KPgrIpr5nC71YlXmi61L5b37uAwAAAAAQMgnv/svfVSLGrxcDK2hPL1/Tz9Y1gq9ArYO/iWbzCgpRTGH/WryGxSVPF90JxyTP3yRk8SVLzUAAABgVXj062//nf//wgxDPpNgywvZtkddoj+3TX8ausXGDxBPpaiXlq2bvF2Cr8+OzbEI0VgXQvkT4pAw3Wk4KW03xJfPyHUlX0UIPBq6QIf2Hj9hq41NQ0Ubj5qN/XN1wQp1qeb0sdc4MJ1fuaXbBoXI/lduM9eoPkQkXAVF81vC5aupn3CVPQWr0vz2oQrZ2n4WAAAAAGmC8UvyMmf9S+tW2qvWGfX/FBTfLsSkg2A1Z3G/zhGjnghfsAK8E5Hsn8jdKjRkxgEJ02EnRod44lsRQ/+SpapT7w46tPFZpolPeHe3CZMhPIlt8TbV+F3JNIrw0/XV98P9k1Q4k8nvDHyry0qYQI09+U5b2KFQQq4W60TMSAAAAABAjkfNv/6lD1N82zQ3cvCz2aP8O3Eov5Zj378kN5Qi2IWYdECnbsjz+uxp2frH1n4blu3Pn5gd+4nrs4srb2d7O955/e5WDXtJeru7h9M73r9Tkf+8Pe/sobe8V3vkb30sx1ns9qOcsIaStildvrnSR7VU5tdQbOcsZlBw3EyMsJQ+WT17w4PYd3rQsIc97e6yc9tHsqdrBQAAAAC6GfT7RB81zS/6UEOnFDgU5HcG+7r9eFPmARbDrshoR41UsVdRtIvc7TvjqVweW7dFj6AJeuP8ehae3xzkNpM/PrmyBknrM6ieo7Exm3NsB7JnP3hufB32BwMAAABWhkdzvD0+w09mgNNCpxRYC49QOa/G0fZb2n7NMGgHh9857zsIqPYsZf+MIR+tH8vJbxZeBDka68nhlD6D6mmHmr2x5oHs2Yu9nZEZRQUAAABAEY+a5ld9OD83MmBp118+k1M1t86Ur3sTB3Psour3x3nKenRgQvdOx0P3/ORLOPfG82+8cU3KRPf4GTlYdliT1ZQDDTtjhbPHPfNbbucCeLa70Uqk9MnqWZHfJAPZU1Njn+2jg5Gb+gcAAABACWZ+XL3H8/um+UQOWm/5lPOVCFErMj+U015cHu8eThv7WvBJ80q6+Ouzp5NbEzreNAsfq9Gzref7G3q0Ug/QXb6abprpWcG81aGG8TjkfOuCF3TmuTyeXJl53oObSRD/+uyly5mWn9JnqPzOBed9Y/85a5TSJ6dnLL+11NpzMLD0EgAAAOjDp9uP9RFgN88f1+I3lYf2WMAaUfPuOwAAAAAM2H/cg6dhPfht8mWvdwSrhPfCFgAAAACK+eDT7cc/XL/TZw+e7aNveJJaY788BAAAAAAAisH8OAAAAAAAGBDMjwMAAAAAgCGBfwkAAAAAAIYk9C9ftHYM72LLfIqI/uxnL1cQ/f0fxnsfWEJX6P3gVdNnjXEFvp7v//fSf/76wxLu3WCpl/bxMv/9AvsDAKqYb/zyS9mdXPmXdtvxoeCvA2nma9f2TnkvHv3R9Ht/YWcdmmnn3jBW3TBY8LIyRHm1UugtR7YYl53n15MV1D9Vbweuz6kP2kfCVWVp+cOuFjqtZuttgcYxQTlq4yf0j+OEt8Wnko3fUSInngFsNAAAqKX/+z1q8HIxSNPrmjm9f08/WNYKjWJRQx5rv1cK32RSFKH9ZrMwVHkNW1YrVvLVLF3/XIKpejtsfSYNotLa4ewOfXN0RP8G+lKwPuesxPXiW7usqsTL3Sxo8Pgp/QsI1KcTfRzkN33i8OV0x6fAiAwAAEhjxi+/MMOQrZ17XjTNZ+YS/ZFP2YnaCkj9BXDDFWvpZtl7vr9x5e3+fX12bI5FiMY2sxx4usctptCdhpPSbt59+YxcV/JVBGmZTQp0gQ7tPX7CVhubhoo2HjUbZrsZK9SlmtPHXuPAdH7llm4bFMKbP+rDJJnyIubWJxQg2VamyNshisjSOFtTKN1sr/mCXDl6oZn4MTiiS4wkmhsq5SSxErxkFO4K0b4Yp62OOp+tt6lwdaVX/aSK1MS2QG2Fbx8dNJPdp2cz31W7PDa7unK1je4byvvJT1/lt2SSOC9VFeb9obzdT6PUxk/qL2TsQ/DeuZuP9cVEfv39VNWVrY/VicOX0xk/VS4AAJDE+JffiTv4V30W8Kem+dpc/aOEKGf0SzlWfiT9Kci5/LsJofhVqzkt/GHz6K581PKeP3l7KBPdu4fTTW+L8mY0PriRK7yxpOxmqPo/b9dFQneAqflHbyqdL95ND90m5Amoc9U6ccInSiFKeueNiNnd5a0NRU+V6OSKxapLdovzhD51+V0MBVskJstrIMg61rY8TxcUy2g8pr5a20GbP0XOntFyJBdJS6eCu90/9xy0aPweDCInVZ+3j07c0hB/R/00o/H51gVHZnXMrqB0OltvM/WZqCkXTWoOdiacUu7MSuAzWVJJBJC7aG/lKkMNSMRBc9TGL9I/QTIDfn7VdraqcnOT1sw61IGcjvhFRgMAgJCC9ZffNs2NHPwsW4oTyhklp5NQriT9EVsSwS7EpAM6dUOe0h+VrH9s7aNjEVfHtnPXZxdX3giFHT+7fnerHsxV/ye97pXpY/PNuu8oJR77Z6HeVaXMCWv8DoQHCvpRmV9DsZ2zGJecHe6OzjBVXppKfeyzgD/epnYZPzk9PaHOT48UKaholXot+0TI2jNWjsFYl3TCO87BjJV7H4aSk8LXuQBnz3a9qiNdLqn6kHqSKXjCmWHvdBwbpuRxuK7BS+Hu5kfyFKkKsu8/67fPUBs/R9w+ejQ46izO5JdF8PMQ3cBevi8sKicTv5/9AQBgvvd7WnzUNL/oQw2dUuBQkB8T7Nf4402ZB1gMd6mmO+ZWtWh3SDdI4m0nqDobxXgkQfUsPL85rEt+eHPQf+K2Bzbh8GlAPMzRqOVdVpG352w58uOGm/uVgXDP4YqWew+GkhOD/AYeplX6e4Ovq0jK9yv2CS3042Nva6ai8DjcXdk0rxtVLiuR2vj1UOVQXGydt4pyNr/sROrh40lDxe/Fj8rJxO9hfwAAIB792nygD+fnJzPAaaFTCqyFR/xioy5t/6rtLwyDHj/jcbu+fQVPSzZ20nDSd/xyOfntonsgN1Veg6KmenmQJeUnsTvonLUItfbkxw039yssyntYHDIaRoifmTLdQuksF4HHiqNLLxPhKcjZ4rG5yM6u5Ch5w9cZqJ7wY46R0PmkWRt/PoIFmNH8ih9t1pBcHh/G14M6Odn4tfYHAADFo+bRv+nD+bmRAUv7Icxncqrm1hkZ0ysaCROHxVscp99HZk/HtXwyJTRsy0dtaXT0zBvXlLECCcxAjovtUVlNOdCwk5OdxXX0zG+5nYso6C4T5aUZQh+1MPb48vKYl7NG3SRxH7LTeNX2pHxtDLG2tbb+LALOvD7sRaredtbnmXKJ1YfUEr/apX9q9WDEuRRJ8Rd71IyxV6d4Rr+xFWXGLZ07fgf53wvnw7nr0fxydfPKxG+NHJ6cTPxa+wMAgOHR//32P/h/9dL375vmEzlovUVezlciRK3I/FBOe3F5LK8FmKnJk+aVNHHXZ0/1KiFivBntR0qQFlxNeKrRSt34X76yk4kK0ymoBfAccr510b28SnlBIuH1wc0kiK9WEuo8aPkpfYbKbx+M/rKirCvdRHn1wiZsO1nqoMfk+JvxFbGt7a5tdJ7f048Eg9mTB3P8GmFTraSy/qT0T5GKr8MVXI7ukamaWL1lUuGxckmSWuKXClcum6w88TOsnuW8JQ1WIR79Lhu8FLjcTaZK9K+Nn9A/hV+OMg2v5afy66tDqVBFVzek5KTiJ+0PAADdfPzZ7/QR4ObXHzfgXiDf8IN7hQsMBbR61JYL/dCi43WpcLAcYH8AQH8e/eZ//0cfAp4Y8uB1Y/ew3hGAB0bqxaZUOFgOsD8AoD+Dvj++7oTTREUTwwAAAAAAoMWn27k3gwEAAAAAAKjiUdP8qg8BAAAAAACYG8yPAwAAAACAIQn9yxeVO4ZvmU8R0Z/97OUK4n2Xw3sfUkJX6P3IVdNnjcm++DqcnYvrlYs4wOvu91BPVu1F4oQ+bJl6Ay/QnrV2S9WT2vqz7i9+36v+A9SH+9K/tp4MBepbP7LpLrBdWhJN8/+USjVEyA6ZVgAAAABJRU5ErkJggg=="},305:function(e,t,o){e.exports=o.p+"assets/img/DB-Connect.f1650039.png"},306:function(e,t,o){e.exports=o.p+"assets/img/DB-Edit.54e91f2d.png"},684:function(e,t,o){"use strict";o.r(t);var r=o(9),a=Object(r.a)({},(function(){var e=this,t=e._self._c;return t("ContentSlotsDistributor",{attrs:{"slot-key":e.$parent.slotKey}},[t("h1",{attrs:{id:"setup-developer-environment"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#setup-developer-environment"}},[e._v("#")]),e._v(" Setup Developer Environment")]),e._v(" "),t("p"),t("div",{staticClass:"table-of-contents"},[t("ul",[t("li",[t("a",{attrs:{href:"#developer-resources"}},[e._v("Developer Resources")])]),t("li",[t("a",{attrs:{href:"#windows-setup-software"}},[e._v("Windows Setup Software")])]),t("li",[t("a",{attrs:{href:"#git-setup"}},[e._v("Git Setup")]),t("ul",[t("li",[t("a",{attrs:{href:"#fork-btcpay-server-repository"}},[e._v("Fork BTCPay Server Repository")])]),t("li",[t("a",{attrs:{href:"#clone-btcpay-server-repository"}},[e._v("Clone BTCPay Server Repository")])]),t("li",[t("a",{attrs:{href:"#create-a-development-feature-branch"}},[e._v("Create a Development Feature Branch")])])])]),t("li",[t("a",{attrs:{href:"#local-btcpay-setup"}},[e._v("Local BTCPay Setup")]),t("ul",[t("li",[t("a",{attrs:{href:"#bitcoin-regtest-network-setup"}},[e._v("Bitcoin Regtest Network Setup")])]),t("li",[t("a",{attrs:{href:"#build-local-btcpay-server-in-browser-mode"}},[e._v("Build Local BTCPay Server in Browser Mode")])]),t("li",[t("a",{attrs:{href:"#visual-studio-setup"}},[e._v("Visual Studio Setup")])]),t("li",[t("a",{attrs:{href:"#build-local-btcpay-server-in-debug-mode"}},[e._v("Build Local BTCPay Server in Debug Mode")])]),t("li",[t("a",{attrs:{href:"#visual-studio-code-changes-in-your-local-btcpay-server"}},[e._v("Visual Studio Code Changes In Your Local BTCPay Server")])])])]),t("li",[t("a",{attrs:{href:"#git-maintenance"}},[e._v("Git Maintenance")]),t("ul",[t("li",[t("a",{attrs:{href:"#sync-forked-btcpay-server-repository"}},[e._v("Sync Forked BTCPay Server Repository")])]),t("li",[t("a",{attrs:{href:"#commit-code-to-make-pull-request"}},[e._v("Commit Code To Make Pull Request")])]),t("li",[t("a",{attrs:{href:"#create-a-branch-of-a-pull-request"}},[e._v("Create a Branch of a Pull Request")])]),t("li",[t("a",{attrs:{href:"#delete-local-branch"}},[e._v("Delete Local Branch")])])])]),t("li",[t("a",{attrs:{href:"#working-with-docker-containers"}},[e._v("Working with Docker Containers")])]),t("li",[t("a",{attrs:{href:"#greenfield-api-development"}},[e._v("Greenfield API Development")])]),t("li",[t("a",{attrs:{href:"#working-with-the-database"}},[e._v("Working with the Database")])]),t("li",[t("a",{attrs:{href:"#questions"}},[e._v("Questions")])])])]),t("p"),e._v(" "),t("p",[e._v("This guide will help you set up your developer environment to prepare you for later contributions to the BTCPay Server repositories. A variety of beginner tools are used in the guide below to help you get started with development. Once you understand the general setup process, feel free to use any tools that you like.")]),e._v(" "),t("p",[e._v("If you are looking for how to make a simple code change such as fixing a typo or copy change, check out the simplified "),t("RouterLink",{attrs:{to:"/Contribute/WriteSoftware/"}},[e._v("Write Software")]),e._v(" tutorial instead. If you are an advanced developer with a local environment already set up for development, you can skip ahead to the "),t("RouterLink",{attrs:{to:"/Development/LocalDevelopment/"}},[e._v("LocalDevelopment")]),e._v(" documentation.")],1),e._v(" "),t("h2",{attrs:{id:"developer-resources"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#developer-resources"}},[e._v("#")]),e._v(" Developer Resources")]),e._v(" "),t("ul",[t("li",[t("a",{attrs:{href:"https://docs.github.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Github Docs"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/Development/LocalDevelopment/"}},[e._v("BTCPay Commands and Concepts")])],1),e._v(" "),t("li",[t("RouterLink",{attrs:{to:"/Development/LocalDevelopment/#videos"}},[e._v("Environment Setup Videos (Linux, Mac, Windows)")])],1)]),e._v(" "),t("h2",{attrs:{id:"windows-setup-software"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#windows-setup-software"}},[e._v("#")]),e._v(" Windows Setup Software")]),e._v(" "),t("p",[e._v("Software to install to follow this guide:")]),e._v(" "),t("ol",[t("li",[t("a",{attrs:{href:"https://visualstudio.microsoft.com/downloads/",target:"_blank",rel:"noopener noreferrer"}},[e._v("Visual Studio Community Edition"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://dotnet.microsoft.com/en-us/download/dotnet/6.0",target:"_blank",rel:"noopener noreferrer"}},[e._v(".NET Core SDK 6.0+"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://www.docker.com/products/docker-desktop",target:"_blank",rel:"noopener noreferrer"}},[e._v("Docker Desktop"),t("OutboundLink")],1)]),e._v(" "),t("li",[e._v("PowerShell (included in Windows OS)")]),e._v(" "),t("li",[t("a",{attrs:{href:"https://gitforwindows.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitBash"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://desktop.github.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("GitHub Desktop"),t("OutboundLink")],1)]),e._v(" "),t("li",[t("a",{attrs:{href:"https://github.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("www.Github.com account"),t("OutboundLink")],1),e._v(" (sign up)")])]),e._v(" "),t("p",[e._v("Note: "),t("em",[e._v("This guide assumes installations in default locations. Take note if you have a different file directory structure.")])]),e._v(" "),t("h2",{attrs:{id:"git-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#git-setup"}},[e._v("#")]),e._v(" Git Setup")]),e._v(" "),t("h3",{attrs:{id:"fork-btcpay-server-repository"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#fork-btcpay-server-repository"}},[e._v("#")]),e._v(" Fork BTCPay Server Repository")]),e._v(" "),t("ul",[t("li",[e._v("Open a web browser and login to your www.Github.com account.")]),e._v(" "),t("li",[e._v("Navigate to the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver",target:"_blank",rel:"noopener noreferrer"}},[e._v("BTCPay Server Repository"),t("OutboundLink")],1),e._v(" and press the "),t("code",[e._v("Fork")]),e._v(" button to create your own copy of the BTCPay Server repository on Github.")]),e._v(" "),t("li",[e._v("Next open Github Desktop and login so that Github Desktop knows about your www.Github.com account and connects to it.")])]),e._v(" "),t("h3",{attrs:{id:"clone-btcpay-server-repository"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#clone-btcpay-server-repository"}},[e._v("#")]),e._v(" Clone BTCPay Server Repository")]),e._v(" "),t("ul",[t("li",[e._v("In GitHub Desktop, use the "),t("code",[e._v("Add")]),e._v(" button and see the option clone repository.")]),e._v(" "),t("li",[e._v("If you are using your www.Github.com credentials in GitHub Desktop, you will see your BTCPay Server repository that you just forked on www.Github.com. Select it and take note of the local path shown below. (by default it will be something like "),t("code",[e._v("C:\\Users\\SatoshisComputer\\Documents\\GitHub\\btcpayserver")]),e._v(" for clarity, lets call it our: "),t("em",[e._v("clone local path")]),e._v(") then press clone.")]),e._v(" "),t("li",[e._v("Now you will see the BTCPay Server repository has been cloned in your GitHub Desktop and you will be on the "),t("em",[e._v("master branch")]),e._v(".")])]),e._v(" "),t("h3",{attrs:{id:"create-a-development-feature-branch"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-a-development-feature-branch"}},[e._v("#")]),e._v(" Create a Development Feature Branch")]),e._v(" "),t("ul",[t("li",[e._v("Next we will practice working with our BTCPay Server repository that we just cloned to our computer using Github Desktop.")]),e._v(" "),t("li",[e._v("When developing, you may want to work on different features at once. To do that, we typically want to create multiple feature branches instead of making all changes to the master branch.")]),e._v(" "),t("li",[e._v("We're using GitBash and some Git commands, so open GitBash. (If you prefer to only use GitHub desktop instead of GitBash, you can create branches there instead.)")]),e._v(" "),t("li",[e._v("Once you have a GitBash terminal open, we need to change directory to our clone of BTCPay Server repository.")]),e._v(" "),t("li",[e._v("To do this, navigate to our "),t("em",[e._v("clone local path")]),e._v(" with the change directory command: "),t("code",[e._v("$ cd Documents/Github/btcpayserver")])]),e._v(" "),t("li",[e._v("You can see your clone of BTCPay Server is on the branch called "),t("code",[e._v("master")])]),e._v(" "),t("li",[e._v("Make a copy of your master branch to do some development on it, with the command: "),t("code",[e._v("$ git branch OurNewDevelopmentBranch")])]),e._v(" "),t("li",[e._v("Let's view all the branches we have now, with the command: "),t("code",[e._v("$ git branch")]),e._v(" you can see we have master and OurNewDevelopmentBranch")]),e._v(" "),t("li",[e._v("In Git, we now have a copy of our forked BTCPay Server repository (our clone). When we want to switch between branches (copies of our clone), we need to tell Git which branch our development code changes should be assigned to. We do this by checking out our branch, with the command: "),t("code",[e._v("$ git checkout OurNewDevelopmentBranch")])]),e._v(" "),t("li",[e._v("Now you are on OurNewDevelopmentBranch in GitBash.")]),e._v(" "),t("li",[e._v("Open your GitHub Desktop and you can see you are no longer on master and you are now on "),t("code",[e._v("OurNewDevelopmentBranch")])]),e._v(" "),t("li",[e._v("In the top menu in Github Desktop click: "),t("code",[e._v("Repository > Show In Explorer")]),e._v(" to see the location of the files.")])]),e._v(" "),t("h2",{attrs:{id:"local-btcpay-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#local-btcpay-setup"}},[e._v("#")]),e._v(" Local BTCPay Setup")]),e._v(" "),t("h3",{attrs:{id:"bitcoin-regtest-network-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#bitcoin-regtest-network-setup"}},[e._v("#")]),e._v(" Bitcoin Regtest Network Setup")]),e._v(" "),t("ul",[t("li",[e._v("For the next step make sure that you have Docker-Compose installed (included with Docker Desktop). Open a PowerShell terminal and navigate to your "),t("em",[e._v("clone local path")]),e._v(" and into the BTCPayServer.Tests directory with the command: "),t("code",[e._v("$ cd Documents/Github/btcpayserver/BTCPayServer.Tests")])]),e._v(" "),t("li",[e._v("The BTCPay Server.Tests project contains the docker files needed to run our docker commands that will start all the project dependencies and create a local Regtest network.")]),e._v(" "),t("li",[e._v("In Powershell, start the docker services with the command: "),t("code",[e._v("docker-compose up dev")]),e._v("(you must be in the BTCPay Server.Tests to run this command).")]),e._v(" "),t("li",[e._v("In your PowerShell terminal you will first see the necessary docker images being pulled, then containers being built. If the build is successful the containers will all show as done.")])]),e._v(" "),t("figure",[t("img",{attrs:{src:o(300),alt:"BTCPayServer.Tests powershell terminal",title:"BTCPayServer.Tests powershell terminal"}})]),e._v(" "),t("h3",{attrs:{id:"build-local-btcpay-server-in-browser-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-local-btcpay-server-in-browser-mode"}},[e._v("#")]),e._v(" Build Local BTCPay Server in Browser Mode")]),e._v(" "),t("p",[e._v("If you don't want to do any coding and you simply want to create a local BTCPay Server for testing features in the interface, you can start a local BTCPay from the command line.")]),e._v(" "),t("p",[e._v("After building your "),t("a",{attrs:{href:"#bitcoin-regtest-network-setup"}},[e._v("regtest network")]),e._v(", navigate to your "),t("code",[e._v("btcpayserver\\BTCPayServer")]),e._v(" directory and run the following command:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("dotnet run --launch-profile Bitcoin\n")])])]),t("p",[e._v("Open a new browser and visit: "),t("a",{attrs:{href:"http://127.0.0.1:14142",target:"_blank",rel:"noopener noreferrer"}},[e._v("http://127.0.0.1:14142"),t("OutboundLink")],1)]),e._v(" "),t("h3",{attrs:{id:"visual-studio-setup"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#visual-studio-setup"}},[e._v("#")]),e._v(" Visual Studio Setup")]),e._v(" "),t("ul",[t("li",[e._v("Open a file explorer to the BTCPay Server repository folder. Without opening any of the folders shown, look for the "),t("code",[e._v("btcpayserver.sln")]),e._v(" item and right click it to "),t("code",[e._v("Open with > Visual Studio")]),e._v(". You may need to choose Open with > Choose another app ... and look for Visual Studio if you have never opened this kind of file before.")]),e._v(" "),t("li",[e._v("To get your Visual Studio set up choose "),t("code",[e._v("View > Solution Explorer")]),e._v(" from the top menu. In this solution explorer you will see all the BTCPay Server files and folders.")]),e._v(" "),t("li",[e._v("The top project is BTCPay Server, make sure it's in bold. If it isn't, right click it and choose Set as StartUp Project.")]),e._v(" "),t("li",[e._v("Your Visual Studio is now set up and ready.")])]),e._v(" "),t("figure",[t("img",{attrs:{src:o(301),alt:"VS Solution Explorer",title:"VS Solution Explorer"}})]),e._v(" "),t("h3",{attrs:{id:"build-local-btcpay-server-in-debug-mode"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#build-local-btcpay-server-in-debug-mode"}},[e._v("#")]),e._v(" Build Local BTCPay Server in Debug Mode")]),e._v(" "),t("ul",[t("li",[e._v("Back in Visual Studio, click: "),t("code",[e._v("Build > Build Solution")])]),e._v(" "),t("li",[e._v("In the output window, a successful build will look something like this: "),t("code",[e._v("========== Build: 6 succeeded, 0 failed, 0 up-to-date, 0 skipped ==========")])]),e._v(" "),t("li",[e._v("Next press "),t("code",[e._v("Debug > Start Debugging")])]),e._v(" "),t("li",[e._v("First a Visual Studio debug console will open which shows information about the status of your local BTCPay Server.")]),e._v(" "),t("li",[e._v("Next a local BTCPay Server will be created in a web browser, showing on the home page that it's in "),t("code",[e._v("REGTEST")]),e._v(" mode.")]),e._v(" "),t("li",[e._v("You now will have three windows to view: BTCPay Server browser session, our Visual Studio debug console and our BTCPay Server.Tests powershell terminal.")]),e._v(" "),t("li",[e._v("Register a new user in your BTCPay Server and see the registration event is shown in your Visual Studio debug console.")])]),e._v(" "),t("figure",[t("img",{attrs:{src:o(302),alt:"VS Debug Console",title:"VS Debug Console"}})]),e._v(" "),t("figure",[t("img",{attrs:{src:o(303),alt:"Local Regtest BTCPay",title:"Local Regtest BTCPay"}})]),e._v(" "),t("h3",{attrs:{id:"visual-studio-code-changes-in-your-local-btcpay-server"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#visual-studio-code-changes-in-your-local-btcpay-server"}},[e._v("#")]),e._v(" Visual Studio Code Changes In Your Local BTCPay Server")]),e._v(" "),t("ul",[t("li",[e._v("Make changes to code in Visual Studio (Ex: modify the "),t("code",[e._v("This store is ready to accept transactions, good job!")]),e._v(" text in the "),t("code",[e._v("~\\BTCPayServer\\Views\\UIStores\\Dashboard.cshtml")]),e._v(" file)")]),e._v(" "),t("li",[e._v("Refresh the page to see your text changes on the home page.")]),e._v(" "),t("li",[e._v("Some code changes require re-start of Debugging for changes to take effect.")]),e._v(" "),t("li",[e._v("Add breakpoints in Visual Studio and see those breakpoints get hit when you try to use a feature in your local BTCPay Server instance.")])]),e._v(" "),t("h2",{attrs:{id:"git-maintenance"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#git-maintenance"}},[e._v("#")]),e._v(" Git Maintenance")]),e._v(" "),t("h3",{attrs:{id:"sync-forked-btcpay-server-repository"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#sync-forked-btcpay-server-repository"}},[e._v("#")]),e._v(" Sync Forked BTCPay Server Repository")]),e._v(" "),t("ul",[t("li",[e._v("With many contributors adding code changes to the Master BTCPay Server Repository, sometimes your forked copy can fall behind, unless you merge new changes into your fork.")]),e._v(" "),t("li",[e._v("If you go to your Fork of BTCPay Server on www.Github.com you will see a message saying that your branch is behind by some commits. Example: "),t("code",[e._v("This branch is 32 commits behind btcpayserver:master")]),e._v(".")]),e._v(" "),t("li",[e._v("To update, you can use GitBash or simply use Github Desktop by clicking through the synchronization prompts.")]),e._v(" "),t("li",[e._v("Open a GitBash terminal and update your BTCPay Server repository with the following commands.")]),e._v(" "),t("li",[e._v("First always navigate to your "),t("em",[e._v("clone local path")]),e._v(" with the command: "),t("code",[e._v("$ cd Documents/Github/btcpayserver")]),e._v(" and make sure you are on "),t("code",[e._v("master")]),e._v(" branch.")])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" fetch upstream\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" merge upstream/master\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" commit -m "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("SomeCommitMessage"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n\nMessage prompt: "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v(".your branch is ahead of origin master by "),t("span",{pre:!0,attrs:{class:"token string"}},[e._v('"X"')]),e._v(" commits"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v(". use "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" push to publish"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v(".\n\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("add")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v("\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" push origin master\n")])])]),t("p",[e._v("If you see an error "),t("code",[e._v("fatal: 'upstream' does not appear to be a git repository")]),e._v(" when running "),t("code",[e._v("$ git fetch upstream")]),e._v(", you must first configure a remote that points to the upstream repository in Git. That is needed only once. Just run the following command while you are in your "),t("em",[e._v("clone local path")]),e._v(" .")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" remote "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("add")]),e._v(" upstream https://github.com/btcpayserver/btcpayserver.git\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# check if the upstream repo is added succesfully")]),e._v("\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" remote -v\n\n"),t("span",{pre:!0,attrs:{class:"token comment"}},[e._v("# you should see something like this:")]),e._v("\norigin\tYOUR_FORKED_GITHUB_REPO "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("fetch"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\norigin\tYOUR_FORKED_GITHUB_REPO "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("push"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\nupstream\thttps://github.com/btcpayserver/btcpayserver.git "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("fetch"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\nupstream\thttps://github.com/btcpayserver/btcpayserver.git "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("push"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("h3",{attrs:{id:"commit-code-to-make-pull-request"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#commit-code-to-make-pull-request"}},[e._v("#")]),e._v(" Commit Code To Make Pull Request")]),e._v(" "),t("ul",[t("li",[e._v("After you have made some code changes on a feature branch (Example: A feature branch called "),t("code",[e._v("Fix/BugBranch")]),e._v(") and you want to make a Pull Request to the BTCPay Server Repository. Open a GitBash terminal and navigate to your "),t("em",[e._v("clone local path")]),e._v(" with the command: "),t("code",[e._v("$ cd Documents/Github/btcpayserver")]),e._v(" and make sure you are on the "),t("strong",[e._v("correct branch")]),e._v(" that you want to commit and use git status to check the files changed are the ones you want to commit.")])]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" status\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("add")]),e._v(" "),t("span",{pre:!0,attrs:{class:"token builtin class-name"}},[e._v(".")]),e._v("\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" commit\n\nText Editor appears to "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("add")]),e._v(" your commit message"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("..")]),e._v(".\nExample Commit Message: Fix bug "),t("span",{pre:!0,attrs:{class:"token keyword"}},[e._v("for")]),e._v(" update button\n\nAccept Changes: Ctrl + x\nSave Changes: Shift + y\nClose Editor with: Enter\n\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" push origin Fix/BugBranch\n")])])]),t("p",[e._v("See your new branch has been created on you www.Github.com BTCPay Server Fork, review changes and create Pull Request.")]),e._v(" "),t("h3",{attrs:{id:"create-a-branch-of-a-pull-request"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#create-a-branch-of-a-pull-request"}},[e._v("#")]),e._v(" Create a Branch of a Pull Request")]),e._v(" "),t("p",[e._v("A great way to contribute without having to be an advanced developer is by testing other contributor's pull requests. Manual testing is a great way to help other's and ensure that BTCPay Server code changes are working properly. Here is an example of how to make a branch of someone else's pull request, using this previous PoS Pull Request https://github.com/btcpayserver/btcpayserver/pull/454. Open a GitBash terminal and navigate to your "),t("em",[e._v("clone local path")]),e._v(" with the command: "),t("code",[e._v("$ cd Documents/Github/btcpayserver")]),e._v(" and use "),t("code",[e._v("git status")]),e._v(" to check you don't have any other staged commits (git status is clear).")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" status\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" fetch upstream pull/454/head:pos-new-design\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" branch "),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v("(")]),e._v("to your new testing branch called pos-new-design"),t("span",{pre:!0,attrs:{class:"token punctuation"}},[e._v(")")]),e._v("\n")])])]),t("p",[e._v("Note: Be sure to change the /454/ pull request number to the number of the one you would like to test. You can typically leave /head: as is, and add the name of the pull request branch after it.")]),e._v(" "),t("h3",{attrs:{id:"delete-local-branch"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#delete-local-branch"}},[e._v("#")]),e._v(" Delete Local Branch")]),e._v(" "),t("p",[e._v("If you delete a branch on your forked BTCPay repository on Github.com, your local copy on your machine will still remain, unless you delete it:")]),e._v(" "),t("div",{staticClass:"language-bash extra-class"},[t("pre",{pre:!0,attrs:{class:"language-bash"}},[t("code",[e._v("$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" checkout master\n$ "),t("span",{pre:!0,attrs:{class:"token function"}},[e._v("git")]),e._v(" branch -D "),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v("<")]),e._v("branch name"),t("span",{pre:!0,attrs:{class:"token operator"}},[e._v(">")]),e._v("\n")])])]),t("p",[e._v("Note: You can't delete a branch if you have it checked out, so checkout another branch like "),t("code",[e._v("master")]),e._v(" first, as shown in the example above.")]),e._v(" "),t("h2",{attrs:{id:"working-with-docker-containers"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-docker-containers"}},[e._v("#")]),e._v(" Working with Docker Containers")]),e._v(" "),t("p",[e._v("If you want to use Docker Commands when developing locally, you can run the following commands in the "),t("code",[e._v("BTCPayServer.Tests")]),e._v(" directory.")]),e._v(" "),t("ul",[t("li",[e._v("Show running containers "),t("code",[e._v("docker ps")])]),e._v(" "),t("li",[e._v("Show logs for a container "),t("code",[e._v("docker ps logs ")])]),e._v(" "),t("li",[e._v("Start Docker containers "),t("code",[e._v("docker-compose up dev")])]),e._v(" "),t("li",[e._v("Stop Docker containers "),t("code",[e._v("docker-compose down")])]),e._v(" "),t("li",[e._v("Destroy Docker containers "),t("code",[e._v("docker-compoose down --v")])])]),e._v(" "),t("h2",{attrs:{id:"greenfield-api-development"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#greenfield-api-development"}},[e._v("#")]),e._v(" Greenfield API Development")]),e._v(" "),t("p",[e._v("The BTCPay Greenfield API is "),t("RouterLink",{attrs:{to:"/FAQ/General/#how-can-i-use-the-btcpay-server-api"}},[e._v("currently being developed")]),e._v(". You can find a "),t("RouterLink",{attrs:{to:"/Development/GreenFieldExample/"}},[e._v("usage example here")]),e._v(". The official Greenfield "),t("a",{attrs:{href:"https://docs.btcpayserver.org/API/Greenfield/v1/",target:"_blank",rel:"noopener noreferrer"}},[e._v("API reference documentation"),t("OutboundLink")],1),e._v(" is available for developers who want to develop with the BTCPay REST API.")],1),e._v(" "),t("p",[e._v("Developers who would like to contribute to the Greenfield API should follow the "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/blob/master/docs/greenfield-development.md",target:"_blank",rel:"noopener noreferrer"}},[e._v("developer guidelines"),t("OutboundLink")],1),e._v(" used by the BTCPay project for additions or modifications. If you feel these guidelines are not clear, consider discussing your ideas in the community chat (development channel) or "),t("a",{attrs:{href:"https://github.com/btcpayserver/btcpayserver/issues/new/choose",target:"_blank",rel:"noopener noreferrer"}},[e._v("open a github issue"),t("OutboundLink")],1),e._v(" to discuss endpoint implementation ideas.")]),e._v(" "),t("h2",{attrs:{id:"working-with-the-database"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#working-with-the-database"}},[e._v("#")]),e._v(" Working with the Database")]),e._v(" "),t("p",[e._v("BTCPay uses a PostgreSQL database by default. During development you can easily connect to it. This is helpful if you want to view how data is saved, modify records or use it to find issues during development. You can use the free tool "),t("a",{attrs:{href:"https://www.pgadmin.org/download/",target:"_blank",rel:"noopener noreferrer"}},[e._v("PgAdmin4"),t("OutboundLink")],1),e._v(" to do this.")]),e._v(" "),t("p",[e._v("Start your BTCPay in your local environment and view your debug console to find your database connection details:")]),e._v(" "),t("figure",[t("img",{attrs:{src:o(304),alt:"PostgreSQL Configuration",title:"PostgreSQL Configuration"}})]),e._v(" "),t("p",[e._v("Next, open your PgAdmin and select: "),t("code",[e._v("Servers > Create > Server...")]),e._v(" to connect to your server. Provide a name for your server and provide your host connection details from your Visual Studio debug console:")]),e._v(" "),t("figure",[t("img",{attrs:{src:o(305),alt:"PgAdmin Connection",title:"PgAdmin Connection"}})]),e._v(" "),t("p",[e._v("Save to connect to your development btcpayserver database. In the btcpayserver database look for:\n"),t("code",[e._v("Schemas > public > Tables")]),e._v(" to see the tables which contain the BTCPay Server data.")]),e._v(" "),t("p",[e._v("As an example, you can see all the users registered to your development BTCPay by viewing the rows of the "),t("code",[e._v("AspNetUsers")]),e._v(" table. Try changing the username of a registered user in the database, then "),t("code",[e._v("Save Changes")]),e._v(" and "),t("code",[e._v("Refresh (F5)")]),e._v(". Now log into your BTCPay using the new username and original password.")]),e._v(" "),t("figure",[t("img",{attrs:{src:o(306),alt:"PgAdmin Edit",title:"PgAdmin Edit"}})]),e._v(" "),t("h2",{attrs:{id:"questions"}},[t("a",{staticClass:"header-anchor",attrs:{href:"#questions"}},[e._v("#")]),e._v(" Questions")]),e._v(" "),t("p",[e._v("If you have questions about the BTCPay Server local development setup, you can join the "),t("a",{attrs:{href:"https://chat.btcpayserver.org/",target:"_blank",rel:"noopener noreferrer"}},[e._v("community chat"),t("OutboundLink")],1),e._v(". If you have questions about any of the other tools or commands, etc. it's likely you can find answers to your questions by doing a search on the internet or on "),t("a",{attrs:{href:"https://stackoverflow.com/",target:"_blank",rel:"noopener noreferrer"}},[e._v("StackOverflow"),t("OutboundLink")],1),e._v(".")])])}),[],!1,null,null,null);t.default=a.exports}}]); \ No newline at end of file diff --git a/assets/js/27.b8a632de.js b/assets/js/27.ea0bc7e7.js similarity index 97% rename from assets/js/27.b8a632de.js rename to assets/js/27.ea0bc7e7.js index 1c48cbd8b4..1234f3fda6 100644 --- a/assets/js/27.b8a632de.js +++ b/assets/js/27.ea0bc7e7.js @@ -1 +1 @@ -(window.webpackJsonp=window.webpackJsonp||[]).push([[27],{415:function(t,e,a){t.exports=a.p+"assets/img/BTCPayPayButtonDynamic2.ade3500b.png"},416:function(t,e,a){t.exports=a.p+"assets/img/BTCPayPayButtonDynamic.5ea88bef.png"},417:function(t,e,a){t.exports=a.p+"assets/img/domainmapping1.6d8e57ba.png"},418:function(t,e,a){t.exports=a.p+"assets/img/domainmapping2.96812b62.png"},419:function(t,e,a){t.exports=a.p+"assets/img/AppRedirect.21368bcf.png"},420:function(t,e,a){t.exports=a.p+"assets/img/CrowdfundingWoo.372a5115.gif"},421:function(t,e,a){t.exports=a.p+"assets/img/CrowdfundCodeEmbed.11ca2ead.png"},745:function(t,e,a){"use strict";a.r(e);var s=a(9),n=Object(s.a)({},(function(){var t=this,e=t._self._c;return e("ContentSlotsDistributor",{attrs:{"slot-key":t.$parent.slotKey}},[e("h1",{attrs:{id:"apps-faq"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#apps-faq"}},[t._v("#")]),t._v(" Apps FAQ")]),t._v(" "),e("p",[t._v("This document covers frequently asked questions about the BTCPay Server Apps.")]),t._v(" "),e("p"),e("div",{staticClass:"table-of-contents"},[e("ul",[e("li",[e("a",{attrs:{href:"#what-are-the-apps-in-btcpay"}},[t._v("What are the Apps in BTCPay?")])]),e("li",[e("a",{attrs:{href:"#is-there-a-limit-on-the-number-of-apps-i-can-create"}},[t._v("Is there a limit on the number of Apps I can create?")])]),e("li",[e("a",{attrs:{href:"#is-there-a-point-of-sale-feature-in-btcpay"}},[t._v("Is there a Point of Sale feature in BTCPay?")])]),e("li",[e("a",{attrs:{href:"#how-can-i-use-btcpay-in-a-physical-store"}},[t._v("How can I use BTCPay in a physical store?")])]),e("li",[e("a",{attrs:{href:"#how-to-customize-the-appearance-of-point-of-sale-app-in-btcpay"}},[t._v("How to customize the appearance of Point of Sale App in BTCPay")])]),e("li",[e("a",{attrs:{href:"#what-is-a-payment-button"}},[t._v("What is a Payment Button?")])]),e("li",[e("a",{attrs:{href:"#how-to-create-a-pay-button-with-a-custom-amount"}},[t._v("How to create a Pay Button with a custom amount?")])]),e("li",[e("a",{attrs:{href:"#how-to-map-a-domain-name-to-an-app"}},[t._v("How to map a domain name to an app?")])]),e("li",[e("a",{attrs:{href:"#how-to-redirect-to-another-site-after-payment"}},[t._v("How to redirect to another site after payment?")])]),e("li",[e("a",{attrs:{href:"#how-to-integrate-woocommerce-store-into-a-btcpay-crowdfund-app"}},[t._v("How to integrate WooCommerce Store into a BTCPay Crowdfund app?")]),e("ul",[e("li",[e("a",{attrs:{href:"#requirements"}},[t._v("Requirements")])]),e("li",[e("a",{attrs:{href:"#instructions"}},[t._v("Instructions")])])])])])]),e("p"),t._v(" "),e("h2",{attrs:{id:"what-are-the-apps-in-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#what-are-the-apps-in-btcpay"}},[t._v("#")]),t._v(" What are the Apps in BTCPay?")]),t._v(" "),e("p",[t._v("Apps are features you can use to expand the use case of your BTCPay. See the "),e("RouterLink",{attrs:{to:"/Apps/"}},[t._v("apps doc")]),t._v(" for more information.")],1),t._v(" "),e("h2",{attrs:{id:"is-there-a-limit-on-the-number-of-apps-i-can-create"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#is-there-a-limit-on-the-number-of-apps-i-can-create"}},[t._v("#")]),t._v(" Is there a limit on the number of Apps I can create?")]),t._v(" "),e("p",[t._v("Apps are added on the store level. To create one, you need to have a store already setup. There is no limit to the number of apps that can be assigned to a store.")]),t._v(" "),e("h2",{attrs:{id:"is-there-a-point-of-sale-feature-in-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#is-there-a-point-of-sale-feature-in-btcpay"}},[t._v("#")]),t._v(" Is there a Point of Sale feature in BTCPay?")]),t._v(" "),e("p",[t._v("Yes. Please read our "),e("RouterLink",{attrs:{to:"/WhatsNext/#creating-the-pay-button"}},[t._v("guide on creating the POS app")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"how-can-i-use-btcpay-in-a-physical-store"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-can-i-use-btcpay-in-a-physical-store"}},[t._v("#")]),t._v(" How can I use BTCPay in a physical store?")]),t._v(" "),e("p",[t._v("You can use our Point of Sale (PoS) app. When you create a PoS app within BTCPay Server, it will be publicly accessible via a URL where checkout buttons for products you’ve created for your PoS will be displayed.\nTo have a physical PoS, the easiest solution (currently) is to create a PoS App in BTCPay and display it on any web device such as a phone, tablet or pc.")]),t._v(" "),e("p",[t._v("Please follow our detailed guide on how to use our "),e("a",{attrs:{href:"https://blog.btcpayserver.org/bitcoin-pos/",target:"_blank",rel:"noopener noreferrer"}},[t._v("PoS App on a mobile device"),e("OutboundLink")],1),t._v(". Also note that Section 2.3 Connecting a Wallet is covered much more in-depth here in the "),e("RouterLink",{attrs:{to:"/WalletSetup/"}},[t._v("wallet section")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"how-to-customize-the-appearance-of-point-of-sale-app-in-btcpay"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-customize-the-appearance-of-point-of-sale-app-in-btcpay"}},[t._v("#")]),t._v(" How to customize the appearance of Point of Sale App in BTCPay")]),t._v(" "),e("p",[t._v("It is very easy to customize the look of the Point of Sale app. "),e("RouterLink",{attrs:{to:"/Development/Theme/"}},[t._v("Follow this guide")]),t._v(" to learn how to change the theme.")],1),t._v(" "),e("h2",{attrs:{id:"what-is-a-payment-button"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#what-is-a-payment-button"}},[t._v("#")]),t._v(" What is a Payment Button?")]),t._v(" "),e("p",[t._v("The Payment Button is a simple and customizable HTML button you can create and embed into your website. To create a payment button, "),e("RouterLink",{attrs:{to:"/WhatsNext/#creating-the-point-of-sale-app"}},[t._v("follow this guide")]),t._v(".")],1),t._v(" "),e("h2",{attrs:{id:"how-to-create-a-pay-button-with-a-custom-amount"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-create-a-pay-button-with-a-custom-amount"}},[t._v("#")]),t._v(" How to create a Pay Button with a custom amount?")]),t._v(" "),e("p",[t._v("The BTCPay Server Pay Button which can be found in Store Settings > Pay Button, currently does not support custom amounts.\nHowever, you can use a work-around:")]),t._v(" "),e("ul",[e("li",[e("RouterLink",{attrs:{to:"/WhatsNext/#creating-the-point-of-sale-app"}},[t._v("Create Point of sale app")])],1),t._v(" "),e("li",[t._v("Enable "),e("code",[t._v("user can input a custom amount")]),t._v(" field")]),t._v(" "),e("li",[t._v("Remove all the products from the automatically generated template.")]),t._v(" "),e("li",[t._v("Save settings.")]),t._v(" "),e("li",[t._v("Click on the "),e("code",[t._v("Embed payment button linking to PoS item")]),t._v(" at the bottom of the page and copy the expanded code. Paste it into html page of your website.")]),t._v(" "),e("li",[t._v("Remove the extra fields you do not need, especially "),e("code",[t._v('')]),t._v(" so that button redirects to the point of sale.")])]),t._v(" "),e("p",[e("img",{attrs:{src:a(415),alt:"Custom Amount Pay Button",title:"Custom Amount Pay Button"}}),t._v(" "),e("img",{attrs:{src:a(416),alt:"Custom Amount Pay Button",title:"Custom Amount Pay Button"}})]),t._v(" "),e("h2",{attrs:{id:"how-to-map-a-domain-name-to-an-app"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-map-a-domain-name-to-an-app"}},[t._v("#")]),t._v(" How to map a domain name to an app?")]),t._v(" "),e("p",[t._v("BTCPay Server Apps can have a domain name that's different from the servers domain. Let's assume you have BTCPay Server at mybtcpayserver.com and want to display your PoS app on mybtcpaypos.com instead mybtcpayserver.com/apps/pos/abc123\nFirst, "),e("RouterLink",{attrs:{to:"/FAQ/Deployment/#setting-up-dns-records"}},[t._v("configure DNS settings")]),t._v(") of mypointofsale.com and make sure it's pointing to the external ip of your BTCPay Server.")],1),t._v(" "),e("p",[t._v("Next, add additional domain or subdomain name(s) by adding a new environment variable through ssh:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAY_ADDITIONAL_HOSTS")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mybtcpaypos.com"')]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" btcpay-setup.sh -i\n")])])]),e("p",[t._v("If you want to add multiple domains, you just need to update the env variables again:")]),t._v(" "),e("div",{staticClass:"language-bash extra-class"},[e("pre",{pre:!0,attrs:{class:"language-bash"}},[e("code",[e("span",{pre:!0,attrs:{class:"token function"}},[t._v("sudo")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token function"}},[t._v("su")]),t._v(" -\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v("export")]),t._v(" "),e("span",{pre:!0,attrs:{class:"token assign-left variable"}},[t._v("BTCPAY_ADDITIONAL_HOSTS")]),e("span",{pre:!0,attrs:{class:"token operator"}},[t._v("=")]),e("span",{pre:!0,attrs:{class:"token string"}},[t._v('"mybtcpaypos.com,subdomain.domain2.com,domain3.com"')]),t._v("\n"),e("span",{pre:!0,attrs:{class:"token builtin class-name"}},[t._v(".")]),t._v(" btcpay-setup.sh -i\n")])])]),e("p",[t._v("Finally, in Server Settings > Policies click on the "),e("code",[t._v("Map specific domains to specific apps")])]),t._v(" "),e("figure",[e("img",{attrs:{src:a(417),alt:"App domain mapping",title:"App domain mapping"}})]),t._v(" "),e("p",[t._v("Enter domain name, select a previously created app from the drop down menu and click "),e("code",[t._v("save")]),t._v(" to map the app to specific domain.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(418),alt:"App domain mapping",title:"App domain mapping"}})]),t._v(" "),e("p",[t._v("If any of the additionally added hosts do not have a properly configured DNS, Let's Encrypt will not be able to renew the certificate for any of the domains, including the main domain. If you're using additional hosts and facing https issues with the main domain, try removing a domain from the "),e("code",[t._v("BTCPAY_ADDITIONAL_HOSTS")]),t._v(" and re-run the setup. The https issue also occurs if "),e("RouterLink",{attrs:{to:"/Deployment/DynamicDNS/"}},[t._v("Dynamic DNS")]),t._v(" has not been renewed and is configured as an additional host.")],1),t._v(" "),e("p",[t._v("If for any reason, you want an app to be on the same domain as your BTCPay Server homepage, you can select to display it on the root. In that case, no DNS configuration is needed, since your domain is already pointing properly. Using an app on the root domain of BTCPay Server means you'll have to access the login and other pages manually. The easiest way is to append a page route such as "),e("code",[t._v("/apps")]),t._v(" or "),e("code",[t._v("/stores")]),t._v(" to your root domain. (Ex: "),e("code",[t._v("mybtcpayserver.com/apps")]),t._v("). This will make navigation to your root displayed app easier, but navigation to other pages (such as Login) more challenging for users.")]),t._v(" "),e("h2",{attrs:{id:"how-to-redirect-to-another-site-after-payment"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-redirect-to-another-site-after-payment"}},[t._v("#")]),t._v(" How to redirect to another site after payment?")]),t._v(" "),e("p",[t._v("Point of Sale apps allow redirecting customers to any URL after an invoice is paid. Modify the redirect functionality in Apps > Settings")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(419),alt:"Set Point of Sale Redirects",title:"Set Point of Sale Redirects"}})]),t._v(" "),e("p",[t._v("In PoS settings these are the following options for redirects on paid invoices:")]),t._v(" "),e("ul",[e("li",[e("strong",[t._v("No")]),t._v(" - "),e("em",[t._v("Without")]),t._v(" Redirect URL\n"),e("ul",[e("li",[t._v("Invoice displays a prompt for the user to return to the PoS App (Default setting).")])])]),t._v(" "),e("li",[e("strong",[t._v("No")]),t._v(" - "),e("em",[t._v("With")]),t._v(" Redirect URL\n"),e("ul",[e("li",[t._v("Invoice displays a prompt for the user to return to the provided App Redirect URL.")])])]),t._v(" "),e("li",[e("strong",[t._v("Yes")]),t._v(" - "),e("em",[t._v("Without")]),t._v(" Redirect URL\n"),e("ul",[e("li",[t._v("Paid invoice automatically redirects to the PoS App.")])])]),t._v(" "),e("li",[e("strong",[t._v("Yes")]),t._v(" - "),e("em",[t._v("With")]),t._v(" Redirect URL\n"),e("ul",[e("li",[t._v("Paid invoice automatically redirects to the provided App Redirect URL.")])])]),t._v(" "),e("li",[e("strong",[t._v("Use Store Settings")]),t._v(" "),e("ul",[e("li",[t._v("Enable/disable automatic redirect to the PoS App on the "),e("RouterLink",{attrs:{to:"/FAQ/Stores/#how-to-redirect-store-invoices-after-payment"}},[t._v("store level")]),t._v(".")],1)])])]),t._v(" "),e("p",[t._v("Notes:")]),t._v(" "),e("ol",[e("li",[t._v("Provide the Redirect URL in the App Settings (above the redirect option).")]),t._v(" "),e("li",[t._v("Expired or partially paid "),e("RouterLink",{attrs:{to:"/Invoices/#invoice-statuses"}},[t._v("invoices")]),t._v(" will not redirect, even if the setting is enabled. This feature is for paid invoices only.")],1),t._v(" "),e("li",[t._v("Alternatively, redirect URLs can be specified via the API (i.e. Embedded PoS).")])]),t._v(" "),e("h2",{attrs:{id:"how-to-integrate-woocommerce-store-into-a-btcpay-crowdfund-app"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#how-to-integrate-woocommerce-store-into-a-btcpay-crowdfund-app"}},[t._v("#")]),t._v(" How to integrate WooCommerce Store into a BTCPay Crowdfund app?")]),t._v(" "),e("p",[t._v("If you want to provide a way for your backers to receive digital files and physical products, you can embed WooCommerce store into your Crowdfunding app.")]),t._v(" "),e("figure",[e("img",{attrs:{src:a(420),alt:"Crowdfunding WooCommerce Integration Preview",title:"Crowdfunding WooCommerce Integration Preview"}})]),t._v(" "),e("p",[t._v("The following tutorial assumes you have a semi-advanced understanding of BTCPay, WordPress and WooCommerce.")]),t._v(" "),e("h3",{attrs:{id:"requirements"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#requirements"}},[t._v("#")]),t._v(" Requirements")]),t._v(" "),e("ol",[e("li",[t._v("Wordpress Website")]),t._v(" "),e("li",[e("a",{attrs:{href:"https://wordpress.org/plugins/woocommerce/",target:"_blank",rel:"noopener noreferrer"}},[t._v("WooCommerce Plugin"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://wordpress.org/plugins/btcpay-for-woocommerce/",target:"_blank",rel:"noopener noreferrer"}},[t._v("BTCPay for WooCommerce Plugin"),e("OutboundLink")],1)]),t._v(" "),e("li",[e("a",{attrs:{href:"https://wordpress.org/themes/storefront/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Storefront Theme"),e("OutboundLink")],1),t._v(" (if you're using another theme, you may need to modify the CSS code to fit your theme.")]),t._v(" "),e("li",[t._v("BTCPay Server")])]),t._v(" "),e("p",[e("strong",[t._v("Important Note")]),t._v(" Make sure that both your WooCommerce store and BTCPay Server "),e("strong",[t._v("are on a same domain")]),t._v(". Some browsers have aggressive way of blocking the cross-domain embedded content. Quite specifically, Safari on iOS will destroy the cookie when the item is added, which will lead to empty cart. There's no other way to fix this besides having BTCPay and Woo on a same domain as subdomains at least.")]),t._v(" "),e("h4",{attrs:{id:"optional-wordpress-plugins"}},[e("a",{staticClass:"header-anchor",attrs:{href:"#optional-wordpress-plugins"}},[t._v("#")]),t._v(" Optional WordPress Plugins")]),t._v(" "),e("p",[t._v("The following plugins are recommended, but not required. You don't have to use them if you're an advanced WordPress user.")]),t._v(" "),e("ul",[e("li",[e("a",{attrs:{href:"https://wordpress.org/plugins/flexible-checkout-fields/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Flexible Checkout Fields"),e("OutboundLink")],1),t._v(" (to edit checkout and remove redundant checkout fields in Woo)")]),t._v(" "),e("li",[e("a",{attrs:{href:"https://wordpress.org/plugins/woocommerce-direct-checkout/",target:"_blank",rel:"noopener noreferrer"}},[t._v("WooCommerce Direct Checkout"),e("OutboundLink")],1),t._v(" (remove redundant steps in the checkout process and make pledging quicker)")]),t._v(" "),e("li",[e("a",{attrs:{href:"https://wordpress.org/plugins/header-and-footer-scripts/",target:"_blank",rel:"noopener noreferrer"}},[t._v("Header and Footer Scripts"),e("OutboundLink")],1),t._v(" (place "),e("code",[t._v(" + diff --git a/sitemap.xml b/sitemap.xml index acb792cbd6..373f7e232e 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -1 +1 @@ -https://docs.btcpayserver.org/AdvancedForms/dailyhttps://docs.btcpayserver.org/Apps/dailyhttps://docs.btcpayserver.org/BTCPayServer/LocalDevSetup/dailyhttps://docs.btcpayserver.org/BTCPayServer/Security/dailyhttps://docs.btcpayserver.org/BTCPayServer/db-migration/dailyhttps://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/dailyhttps://docs.btcpayserver.org/BTCPayServer/greenfield-development/dailyhttps://docs.btcpayserver.org/BTCPayVsOthers/dailyhttps://docs.btcpayserver.org/ColdCardWallet/dailyhttps://docs.btcpayserver.org/Community/dailyhttps://docs.btcpayserver.org/Configurator/dailyhttps://docs.btcpayserver.org/ConnectWallet/dailyhttps://docs.btcpayserver.org/Contribute/Design/dailyhttps://docs.btcpayserver.org/Contribute/Dev/dailyhttps://docs.btcpayserver.org/Contribute/DevCode/dailyhttps://docs.btcpayserver.org/Contribute/DevTest/dailyhttps://docs.btcpayserver.org/Contribute/Misc/dailyhttps://docs.btcpayserver.org/Contribute/dailyhttps://docs.btcpayserver.org/Contribute/Translate/dailyhttps://docs.btcpayserver.org/Contribute/Write/dailyhttps://docs.btcpayserver.org/Contribute/WriteBlog/dailyhttps://docs.btcpayserver.org/Contribute/WriteDocs/dailyhttps://docs.btcpayserver.org/Contribute/WriteSoftware/dailyhttps://docs.btcpayserver.org/CreateStore/dailyhttps://docs.btcpayserver.org/CreateWallet/dailyhttps://docs.btcpayserver.org/CustomIntegration/dailyhttps://docs.btcpayserver.org/Dashboard/dailyhttps://docs.btcpayserver.org/Deployment/Azure/dailyhttps://docs.btcpayserver.org/Deployment/AzurePennyPinching/dailyhttps://docs.btcpayserver.org/Deployment/Clovyr/dailyhttps://docs.btcpayserver.org/Deployment/DreamlabNetwork/dailyhttps://docs.btcpayserver.org/Deployment/DynamicDNS/dailyhttps://docs.btcpayserver.org/Deployment/GoogleCloud/dailyhttps://docs.btcpayserver.org/Deployment/Hack0/dailyhttps://docs.btcpayserver.org/Deployment/Hardware/dailyhttps://docs.btcpayserver.org/Deployment/HardwareAsAService/dailyhttps://docs.btcpayserver.org/Deployment/LightningInABox/dailyhttps://docs.btcpayserver.org/Deployment/LunaNode/dailyhttps://docs.btcpayserver.org/Deployment/ManualDeployment/dailyhttps://docs.btcpayserver.org/Deployment/ManualDeploymentExtended/dailyhttps://docs.btcpayserver.org/Deployment/dailyhttps://docs.btcpayserver.org/Deployment/RaspberryPi4/dailyhttps://docs.btcpayserver.org/Deployment/ReverseProxyToTor/dailyhttps://docs.btcpayserver.org/Deployment/ReverseSSHtunnel/dailyhttps://docs.btcpayserver.org/Deployment/ThirdPartyHosting/dailyhttps://docs.btcpayserver.org/Deployment/voltagecloud/dailyhttps://docs.btcpayserver.org/Deployment/webdeployment/dailyhttps://docs.btcpayserver.org/Development/Altcoins/dailyhttps://docs.btcpayserver.org/Development/GreenFieldExample-NodeJS/dailyhttps://docs.btcpayserver.org/Development/GreenFieldExample/dailyhttps://docs.btcpayserver.org/Development/GreenfieldExample-PHP/dailyhttps://docs.btcpayserver.org/Development/InvoiceMetadata/dailyhttps://docs.btcpayserver.org/Development/LocalDev/dailyhttps://docs.btcpayserver.org/Development/LocalDevelopment/dailyhttps://docs.btcpayserver.org/Development/Plugins/dailyhttps://docs.btcpayserver.org/Development/dailyhttps://docs.btcpayserver.org/Development/TestnetDemo/dailyhttps://docs.btcpayserver.org/Development/Theme/dailyhttps://docs.btcpayserver.org/Docker/dailyhttps://docs.btcpayserver.org/Docker/backup-restore/dailyhttps://docs.btcpayserver.org/Docker/chatwoot/dailyhttps://docs.btcpayserver.org/Docker/cloudflare-tunnel/dailyhttps://docs.btcpayserver.org/Docker/fastsync/dailyhttps://docs.btcpayserver.org/Docker/fireflyiii/dailyhttps://docs.btcpayserver.org/Docker/joinmarket/dailyhttps://docs.btcpayserver.org/Docker/lightning-terminal/dailyhttps://docs.btcpayserver.org/Docker/ndlc/dailyhttps://docs.btcpayserver.org/Docker/pihole/dailyhttps://docs.btcpayserver.org/Docker/tallycoin-connect/dailyhttps://docs.btcpayserver.org/Drupal/dailyhttps://docs.btcpayserver.org/ElectrumPersonalServer/dailyhttps://docs.btcpayserver.org/ElectrumWallet/dailyhttps://docs.btcpayserver.org/ElectrumX/dailyhttps://docs.btcpayserver.org/FAQ/Altcoin/dailyhttps://docs.btcpayserver.org/FAQ/Apps/dailyhttps://docs.btcpayserver.org/FAQ/Deployment/dailyhttps://docs.btcpayserver.org/FAQ/General/dailyhttps://docs.btcpayserver.org/FAQ/Integrations/dailyhttps://docs.btcpayserver.org/FAQ/LightningNetwork/dailyhttps://docs.btcpayserver.org/FAQ/dailyhttps://docs.btcpayserver.org/FAQ/ServerSettings/dailyhttps://docs.btcpayserver.org/FAQ/Stores/dailyhttps://docs.btcpayserver.org/FAQ/Synchronization/dailyhttps://docs.btcpayserver.org/FAQ/Wallet/dailyhttps://docs.btcpayserver.org/Forms/dailyhttps://docs.btcpayserver.org/Guide/dailyhttps://docs.btcpayserver.org/HardwareWalletIntegration/dailyhttps://docs.btcpayserver.org/Invoices/dailyhttps://docs.btcpayserver.org/LNDhubAPI/dailyhttps://docs.btcpayserver.org/LNbank/LNDhub/dailyhttps://docs.btcpayserver.org/LNbank/dailyhttps://docs.btcpayserver.org/LNbank/Troubleshooting/dailyhttps://docs.btcpayserver.org/LedgerWallet/dailyhttps://docs.btcpayserver.org/LightningNetwork/dailyhttps://docs.btcpayserver.org/LightningNetwork_PaymentChannels/dailyhttps://docs.btcpayserver.org/Magento/dailyhttps://docs.btcpayserver.org/NBXplorer/API/dailyhttps://docs.btcpayserver.org/NBXplorer/Postgres-Migration/dailyhttps://docs.btcpayserver.org/NBXplorer/Postgres-Schema/dailyhttps://docs.btcpayserver.org/NBXplorer/dailyhttps://docs.btcpayserver.org/Nostr/dailyhttps://docs.btcpayserver.org/Notifications/dailyhttps://docs.btcpayserver.org/OpenCart/dailyhttps://docs.btcpayserver.org/Payjoin/dailyhttps://docs.btcpayserver.org/PaymentRequests/dailyhttps://docs.btcpayserver.org/Payouts/dailyhttps://docs.btcpayserver.org/PodServer/dailyhttps://docs.btcpayserver.org/PrestaShop/dailyhttps://docs.btcpayserver.org/RegisterAccount/dailyhttps://docs.btcpayserver.org/Reporting/dailyhttps://docs.btcpayserver.org/Shopify/dailyhttps://docs.btcpayserver.org/Shopware/dailyhttps://docs.btcpayserver.org/Support/dailyhttps://docs.btcpayserver.org/TicketTailor/dailyhttps://docs.btcpayserver.org/Transmuter/DCA/dailyhttps://docs.btcpayserver.org/Transmuter/EmailReceiptsPreset/dailyhttps://docs.btcpayserver.org/Transmuter/dailyhttps://docs.btcpayserver.org/Trocador/dailyhttps://docs.btcpayserver.org/Troubleshooting/dailyhttps://docs.btcpayserver.org/TryItOut/dailyhttps://docs.btcpayserver.org/UseCase/dailyhttps://docs.btcpayserver.org/Vault/HowToVerify/dailyhttps://docs.btcpayserver.org/Vault/dailyhttps://docs.btcpayserver.org/VirtueMart/dailyhttps://docs.btcpayserver.org/Wabisabi/dailyhttps://docs.btcpayserver.org/Walkthrough/dailyhttps://docs.btcpayserver.org/Wallet/dailyhttps://docs.btcpayserver.org/WalletSetup/dailyhttps://docs.btcpayserver.org/WasabiWallet/dailyhttps://docs.btcpayserver.org/WhatsNext/dailyhttps://docs.btcpayserver.org/WooCommerce/dailyhttps://docs.btcpayserver.org/Zapier/dailyhttps://docs.btcpayserver.org/PullPayments/dailyhttps://docs.btcpayserver.org/Refund/dailyhttps://docs.btcpayserver.org/daily \ No newline at end of file +https://docs.btcpayserver.org/Apps/dailyhttps://docs.btcpayserver.org/AdvancedForms/dailyhttps://docs.btcpayserver.org/BTCPayServer/db-migration/dailyhttps://docs.btcpayserver.org/BTCPayServer/LocalDevSetup/dailyhttps://docs.btcpayserver.org/BTCPayServer/greenfield-development/dailyhttps://docs.btcpayserver.org/BTCPayServer/Security/dailyhttps://docs.btcpayserver.org/BTCPayVsOthers/dailyhttps://docs.btcpayserver.org/ColdCardWallet/dailyhttps://docs.btcpayserver.org/Configurator/dailyhttps://docs.btcpayserver.org/Community/dailyhttps://docs.btcpayserver.org/ConnectWallet/dailyhttps://docs.btcpayserver.org/Contribute/Design/dailyhttps://docs.btcpayserver.org/Contribute/Dev/dailyhttps://docs.btcpayserver.org/Contribute/DevCode/dailyhttps://docs.btcpayserver.org/Contribute/DevTest/dailyhttps://docs.btcpayserver.org/Contribute/dailyhttps://docs.btcpayserver.org/Contribute/Misc/dailyhttps://docs.btcpayserver.org/Contribute/Translate/dailyhttps://docs.btcpayserver.org/Contribute/Write/dailyhttps://docs.btcpayserver.org/Contribute/WriteBlog/dailyhttps://docs.btcpayserver.org/Contribute/WriteSoftware/dailyhttps://docs.btcpayserver.org/CreateStore/dailyhttps://docs.btcpayserver.org/CreateWallet/dailyhttps://docs.btcpayserver.org/CustomIntegration/dailyhttps://docs.btcpayserver.org/Dashboard/dailyhttps://docs.btcpayserver.org/Deployment/Azure/dailyhttps://docs.btcpayserver.org/Deployment/AzurePennyPinching/dailyhttps://docs.btcpayserver.org/BTCPayServer/greenfield-authorization/dailyhttps://docs.btcpayserver.org/Deployment/Clovyr/dailyhttps://docs.btcpayserver.org/Deployment/DynamicDNS/dailyhttps://docs.btcpayserver.org/Deployment/DreamlabNetwork/dailyhttps://docs.btcpayserver.org/Deployment/GoogleCloud/dailyhttps://docs.btcpayserver.org/Deployment/HardwareAsAService/dailyhttps://docs.btcpayserver.org/Deployment/Hardware/dailyhttps://docs.btcpayserver.org/Deployment/Hack0/dailyhttps://docs.btcpayserver.org/Deployment/LightningInABox/dailyhttps://docs.btcpayserver.org/Deployment/LunaNode/dailyhttps://docs.btcpayserver.org/Deployment/ManualDeployment/dailyhttps://docs.btcpayserver.org/Deployment/ManualDeploymentExtended/dailyhttps://docs.btcpayserver.org/Deployment/dailyhttps://docs.btcpayserver.org/Deployment/ReverseSSHtunnel/dailyhttps://docs.btcpayserver.org/Deployment/ReverseProxyToTor/dailyhttps://docs.btcpayserver.org/Deployment/RaspberryPi4/dailyhttps://docs.btcpayserver.org/Deployment/ThirdPartyHosting/dailyhttps://docs.btcpayserver.org/Deployment/voltagecloud/dailyhttps://docs.btcpayserver.org/Deployment/webdeployment/dailyhttps://docs.btcpayserver.org/Development/Altcoins/dailyhttps://docs.btcpayserver.org/Development/GreenFieldExample-NodeJS/dailyhttps://docs.btcpayserver.org/Development/GreenFieldExample/dailyhttps://docs.btcpayserver.org/Development/GreenfieldExample-PHP/dailyhttps://docs.btcpayserver.org/Development/InvoiceMetadata/dailyhttps://docs.btcpayserver.org/Development/LocalDev/dailyhttps://docs.btcpayserver.org/Development/LocalDevelopment/dailyhttps://docs.btcpayserver.org/Development/Plugins/dailyhttps://docs.btcpayserver.org/Development/dailyhttps://docs.btcpayserver.org/Development/TestnetDemo/dailyhttps://docs.btcpayserver.org/Development/Theme/dailyhttps://docs.btcpayserver.org/Docker/dailyhttps://docs.btcpayserver.org/Docker/backup-restore/dailyhttps://docs.btcpayserver.org/Docker/chatwoot/dailyhttps://docs.btcpayserver.org/Docker/fastsync/dailyhttps://docs.btcpayserver.org/Docker/cloudflare-tunnel/dailyhttps://docs.btcpayserver.org/Docker/joinmarket/dailyhttps://docs.btcpayserver.org/Docker/lightning-terminal/dailyhttps://docs.btcpayserver.org/Docker/fireflyiii/dailyhttps://docs.btcpayserver.org/Docker/ndlc/dailyhttps://docs.btcpayserver.org/Docker/pihole/dailyhttps://docs.btcpayserver.org/Docker/tallycoin-connect/dailyhttps://docs.btcpayserver.org/Drupal/dailyhttps://docs.btcpayserver.org/ElectrumWallet/dailyhttps://docs.btcpayserver.org/FAQ/Altcoin/dailyhttps://docs.btcpayserver.org/ElectrumPersonalServer/dailyhttps://docs.btcpayserver.org/ElectrumX/dailyhttps://docs.btcpayserver.org/FAQ/Apps/dailyhttps://docs.btcpayserver.org/FAQ/Deployment/dailyhttps://docs.btcpayserver.org/FAQ/General/dailyhttps://docs.btcpayserver.org/FAQ/Integrations/dailyhttps://docs.btcpayserver.org/FAQ/LightningNetwork/dailyhttps://docs.btcpayserver.org/FAQ/dailyhttps://docs.btcpayserver.org/FAQ/ServerSettings/dailyhttps://docs.btcpayserver.org/FAQ/Stores/dailyhttps://docs.btcpayserver.org/FAQ/Synchronization/dailyhttps://docs.btcpayserver.org/FAQ/Wallet/dailyhttps://docs.btcpayserver.org/Forms/dailyhttps://docs.btcpayserver.org/Guide/dailyhttps://docs.btcpayserver.org/Invoices/dailyhttps://docs.btcpayserver.org/HardwareWalletIntegration/dailyhttps://docs.btcpayserver.org/LNDhubAPI/dailyhttps://docs.btcpayserver.org/LNbank/dailyhttps://docs.btcpayserver.org/LNbank/LNDhub/dailyhttps://docs.btcpayserver.org/LedgerWallet/dailyhttps://docs.btcpayserver.org/LNbank/Troubleshooting/dailyhttps://docs.btcpayserver.org/LightningNetwork/dailyhttps://docs.btcpayserver.org/LightningNetwork_PaymentChannels/dailyhttps://docs.btcpayserver.org/NBXplorer/API/dailyhttps://docs.btcpayserver.org/Magento/dailyhttps://docs.btcpayserver.org/NBXplorer/Postgres-Migration/dailyhttps://docs.btcpayserver.org/NBXplorer/Postgres-Schema/dailyhttps://docs.btcpayserver.org/NBXplorer/dailyhttps://docs.btcpayserver.org/Notifications/dailyhttps://docs.btcpayserver.org/OpenCart/dailyhttps://docs.btcpayserver.org/Nostr/dailyhttps://docs.btcpayserver.org/Payjoin/dailyhttps://docs.btcpayserver.org/Payouts/dailyhttps://docs.btcpayserver.org/PaymentRequests/dailyhttps://docs.btcpayserver.org/PrestaShop/dailyhttps://docs.btcpayserver.org/PodServer/dailyhttps://docs.btcpayserver.org/Refund/dailyhttps://docs.btcpayserver.org/dailyhttps://docs.btcpayserver.org/Contribute/WriteDocs/dailyhttps://docs.btcpayserver.org/PullPayments/dailyhttps://docs.btcpayserver.org/RegisterAccount/dailyhttps://docs.btcpayserver.org/Shopify/dailyhttps://docs.btcpayserver.org/Reporting/dailyhttps://docs.btcpayserver.org/Shopware/dailyhttps://docs.btcpayserver.org/TicketTailor/dailyhttps://docs.btcpayserver.org/Support/dailyhttps://docs.btcpayserver.org/Transmuter/DCA/dailyhttps://docs.btcpayserver.org/Transmuter/dailyhttps://docs.btcpayserver.org/Transmuter/EmailReceiptsPreset/dailyhttps://docs.btcpayserver.org/Troubleshooting/dailyhttps://docs.btcpayserver.org/TryItOut/dailyhttps://docs.btcpayserver.org/Trocador/dailyhttps://docs.btcpayserver.org/Vault/HowToVerify/dailyhttps://docs.btcpayserver.org/UseCase/dailyhttps://docs.btcpayserver.org/VirtueMart/dailyhttps://docs.btcpayserver.org/Vault/dailyhttps://docs.btcpayserver.org/Wabisabi/dailyhttps://docs.btcpayserver.org/Walkthrough/dailyhttps://docs.btcpayserver.org/WalletSetup/dailyhttps://docs.btcpayserver.org/Wallet/dailyhttps://docs.btcpayserver.org/WasabiWallet/dailyhttps://docs.btcpayserver.org/Zapier/dailyhttps://docs.btcpayserver.org/WooCommerce/dailyhttps://docs.btcpayserver.org/WhatsNext/daily \ No newline at end of file