diff --git a/README.md b/README.md index 1789c59c9..2728b2631 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,12 @@ ARC is a transaction processor for Bitcoin that keeps track of the life cycle of Settings for ARC are defined in a configuration file. The default configuration file is `config.yaml` in the root directory. Each setting is documented in the file itself. If you want to load `config.yaml` from a different location, you can specify it on the command line using the `-config=` flag. +Each setting in the file `config.yaml` can be overridden with an environment variable. The environment variable needs to have this prefix `ARC_`. A sub setting will be separated using an underscore character. For example the following config setting could be overridden by the environment variable `ARC_METAMORPH_LISTENADDR` +```yaml +metamorph: + listenAddr: +``` + ## Microservices To run all the microservices in one process (during development), use the `main.go` file in the root directory. diff --git a/api/arc.go b/api/arc.go index ae3bfd2e4..2037f24a9 100644 --- a/api/arc.go +++ b/api/arc.go @@ -376,7 +376,7 @@ type POSTTransactionParams struct { // XSkipTxValidation Whether we should skip overall tx validation or not. XSkipTxValidation *SkipTxValidation `json:"X-SkipTxValidation,omitempty"` - // XCallbackToken Access token for notification callback endpoint. + // XCallbackToken Access token for notification callback endpoint. It will be used as a Authorization header for the http callback XCallbackToken *CallbackToken `json:"X-CallbackToken,omitempty"` // XMerkleProof Whether to include merkle proofs in the callbacks (true | false). @@ -406,7 +406,7 @@ type POSTTransactionsParams struct { // XSkipTxValidation Whether we should skip overall tx validation or not. XSkipTxValidation *SkipTxValidation `json:"X-SkipTxValidation,omitempty"` - // XCallbackToken Access token for notification callback endpoint. + // XCallbackToken Access token for notification callback endpoint. It will be used as a Authorization header for the http callback XCallbackToken *CallbackToken `json:"X-CallbackToken,omitempty"` // XMerkleProof Whether to include merkle proofs in the callbacks (true | false). @@ -1847,64 +1847,64 @@ func RegisterHandlersWithBaseURL(router EchoRouter, si ServerInterface, baseURL // Base64 encoded, gzipped, json marshaled Swagger object var swaggerSpec = []string{ - "H4sIAAAAAAAC/+xbW3PbOJb+KyjuPiRVssWbSMlV/eA48o63O3bWVrp3N+PqAsFDCxMS4ACgI3fW/30L", - "4F2ibFm2M93T4ydLuJyDD+eOo28W4VnOGTAlraNvVo4FzkCBMJ8ITtMIky8L/gWY/iIGSQTNFeXMOrKO", - "CQEpkdKjKOECMa5oQgnW46hejIDFOadMHVoji+p1S8AxCGtkMZyBdWT998FJj9DIkmQJGdYU1V2up0gl", - "KLux7u9HDVOfRLrJ0ntIcJEqFPMiSgHJHFiMMItRBuJLCigXnCfP51PTfpjLkt5HTW6Ty1+WoJYgkOKI", - "MpIWMfT4k4gypJbQsCbRGyUKQP+HEpxKePsAhx86dB/mUH6h+SnAzzilMS4Z28bnV0ByyYs0RnoRSgDQ", - "bbMMlRf/AE9XG5QGOIs4TwGzhrUrw8ce3JVTnszgBr0deFys9uCP34LAaYrU6sk89ug9wt9XTNUpF1cK", - "q0IOMUfJEkkzquVQTzc6nAieGeGTIG5BoAgSLgAJUIVglN2gNy76AV3OT+ZnP8/fj5CHfkBXi4tL/b+P", - "fkDH5+cXn85P5u9/XVz8ej5f/HJx+eMITcya//o0v1rM3//67n/akUCvn58vetNDvdHJyfzj+uypmT0/", - "//XivP7y7XbMfulhMAAYZQpuQFj3GjEBMudMgkHrnKvjQi25oL9BvAnfFZBCUHWHBPy9oAIybUBRgmkK", - "cSkehpTZ6mSJKTtjCd/cxgwhqsdGVi54DkLRkoEo5eTLX7Bcbq56p4fQUo+NLFjhLE/1Yez1v+nED/1Z", - "5BHHncQTlwQz3wvCcOL7ZIoDPJ1OXD+ceZMIT2MnjK3RupUYVVwAvVmqrXyUox1OwqnrOdORlXCRYWUd", - "WQVlKvDb/VvYm6949DcgSpM84VnG2WV1GQOYmXFU3xaqVq7jp2gGUuEs1x8aTmKs4EAPbR7WSIC5zNg6", - "+txZfz3A5FwILgY8IkN/WSw+oo+CRylk6D0oTFNZ8ThCWKIYEsog1ib+bL44RZenJyic2iF6s1Qql0fj", - "seI8lYcUVHLIxc14qbJ0LBKiJxnLzxlcJNbR52/WvwtIrCPr38atEx9Xgjc2HH5i+ooouymtm7TuRzus", - "OmN5sevcDzjV4Gqp32X6qeC/AfvIU0runrLiRF81k4W07q9r+N/h+BL+XoA0oonTdFdUTimkcXm+vszE", - "5rr0f61WLZZglBykQhIgM9YyApTVBzfhBcGMcaW/zwXXUZEBxKJMKswI9LesLxoLcqgwTg8Jz8agOZNj", - "x/X8ySTQi2Vjupulvm1rlaEqXdvyHY5rLq1GqbbRjKginDJ52yXs2/aQPm4V/hPOkpSS18VeYCYxMQ6S", - "ytJdjlBUKO2gBOjvMCIVI9o3qVUdOhnDhRRkeYoVPOMuvG1XEQTDV3HS5yfhBYv3vpPZk+7kFOC1VSEB", - "kAgLQIpzlPKvz0DW3YrsZBjZU+iR3QtQ92mAlvAcbUenb/9/4uwGBOp8iXiCDPGeq66QrIVV9eW8OmNl", - "aKoMwXgMXMr14ZCrhpUSeDjMuDD/4BSZOSbe0P5Qk8MRL9Wp5LIN/zLKymCqSFMcaa51CjJAt3v7fbJv", - "arpv0U+UfdHnwUQVmg9Di7MqyNyFjNwSyJp7QoTH0EXYt91O/EGZGgg+OjK2nkRWn24BKViVcXF9iRuM", - "qRUdCBC7puvsPVJLKqtTU4kEJCCEMRB8l7PXkr5G4i6HRrxG6CtVS5RWOGc6Zu/c8+Phjh6tEWnQHtWS", - "vl1D1tzzK5ofE5agkiB6E6WYfEmpVCjDDGutIzUTqBmD+O1rGKjQHTZQXQ73tVDhEy1UN6D6B4KfGw5e", - "H3nnFZF3noR8FSV/v/CHMhMAoQgILiQYK00NE8YhM84OYKWhZwpxYWpf6lXc81bpL/mjdfqw1y0ET5P/", - "Nv/4fhfxmqH/dtS9YdQbALpRxN7ge08CfyO9/Ge/A+d73MHOZugU4DjjBStzsDimZbT1sYOlqRdvlJbu", - "FAxEUudFFoHQEUU5YZcCzsiSWHG5pAP7lbzpsPWqnrNjTagbmMh2bcnWEBId//cQDM01fLMyvCp5lfQ3", - "yKvlE1M2G+lBtZL0hueS6DPIeoLvzvxZELqzSTOpXe1UZbeRlVFG2U2VjVVoO2akRcvRB+3fyyBP66h+", - "wCuaFVld5tZT0WdD43rHG9t6um2kWCMYkt4wrAoBSPNtIkv5NKqPH6ybDO1zui72D5mgVnvWRW7oHrbD", - "tnm0LhPbpbVb4dzNaK5VRrXdfILWt7g/RKMuza1BUi3ePM31/ahrmquC5+5n6qy9KqKMqqpYrw/XUddO", - "Ndyy1srSdi/31cPV4xtWy6os3mY0R65Ww05x2HJt1zuwvQN7tnDcI9s78qeH3tSdOfbE8f+3yYmOrIsf", - "9YdV/aJirb1DWHUqaBE7DhICoeOD77qTwPET27ZJgCc4jjHGjuc7mETRjExDx5k4jh+TZOonXhjN/Ak2", - "xb/+3T2Q288fSOm73mi03Zdq12lCt11y0S62DyW99YMmVkvtApaw2inTXW17sOru3WSnwIpMi+en8x/P", - "L345t0ZW/TBljazyVcoaWUNPUmbq5nuUXtZ/jDLfrF/0h7Nzs/PJxfnp2eUH8//l/D/nJ4v5e60kLdT1", - "K9belYMGu3bPIIojkuDInrhB7NkwjYOpG86ScBYnSeAkkW+7ASYwjcLIc8PpDCe2E3heABM/cRN7sBiw", - "GW9sZyuutHythKCPM2TvOks7BfuOdgv8dbGyjqy/Frbtka4DWMIKlUyaMdhUjWrtOoqX+Gtn8aPlj3KX", - "R5l/AYv94PTmpfCxmQMm94nuYCeT8oczCM/UsUdqZCtjIhuWun7nUc942X1d/g7S8wRR6Cic+UwVZOaf", - "3V4at8jio+lfCVGFGhYC3w0aoj6MrTT8vjB8EQ/9B3O+bf5bucMX83DhzA1dz4sdO8YkngR2QAAmUWJH", - "7jQIpglxZg6Enm27M0zAJ2FCfBtimMywO3UnsKsqV2d5VHl7oenD6JiZLUh9Kdn2iHG1galrO/s/YCyq", - "Kn4nDIljiM3DAGQ55+mjALUW1ey1iZBO/asmmCutPOUB3wEWII6LIQEtxxAu1BKYqtvv+i0Rl6cnKAgn", - "dt2sY7qazLqW46VSedmxQyt9SymByi9XvT8XOTD07upn9JMeIhqMQqSd+ktVe8FSckINJ4cM1JjnwA4i", - "eXtQbTnuoGzp/Y4vT6yRdQtClodyDu1DW0/SK3FOrSPLM1+NLK19BpTxrTNus68bGGilWZj3oaoBsWq2", - "ksZCVIV1CUpRdiNNA0ide5/pbOM/5ouPdd7Za2Fybds0cXKmoKoR5Xla4T7+myx71tqeqMfTwtaMavTX", - "RLgw3aAaCt92tu3XMDjuN1gZcSqyDIs7fSRQQ2fXIoBvpBbPY0Gsa71IY6tWZX4rHwWWSlTIUhGk6QxF", - "An/tVRwUR7h8+zSvfubxVZo8qXyqZbBSdXPBEqv2qRQRAViBPERosQRUNqOhtp8WEcxQBA19fgtC0Lgs", - "49+kPMJpc1BN7I4XAh0LgmIslxHHIjYMqSXIntsYkIiPF1eLRc+xdNt6tzjMdsq422G7zWF2pm82ku64", - "aKPlcsd1vTbIHdb025h3WNBt3t1her/VUqdOVSvOOx7fvZgKDmRRWgG6G3KiQB1IJQBn/Y0bTxJRpnVs", - "MAOElRrnKaZrTLVeZIf8bHPj+4cyyV6K1vofHaDc72XOKmbLemrl6/RpGttynArA8Z1WsdYX3uK0+DPW", - "mcp6afl4tglRObQFHXvz79n8rAEeeoHrTv9BqDcx7YthfT/aR9N39Lgv5+rXeysHKK91G+7j70eW77ov", - "y/MQp59Y9SCoEx+kw051hw7KXpl++23ZR9TWffxg8rLsncLgLa41tflB8LJkmz7NAdq9VsWOVa56Fnsx", - "WZkCIdydeLg9Iht/04pzv2PA24nLbqrYjxRCAKszKcQThFEu4JbyQqZ3VZ6l+k+ug8HxZvFgIx5aZ63f", - "kXf2Hr3xXPMoapru3/a9lvntgY71218eVNll35899Guc61cM3TfP//LRu17lD7woczUoSya+3ygpPCBN", - "ct8APytSRfMU1uN8+RKB/u8szpf/CvT/MIF+U2J9asQ/UDD9fWUAf2X7ZQnPD/dxHK9HsrVZa2LYz3+6", - "EP/6fmRB/WulFpm6WY8XynTrdRGq2692aUCs1g92IFbzrT6oWJCqE9oPvCO09rErNuXeyEZ110yHCavb", - "3cWKNG2vxQ+8FunNc1bIYjsOZtiNExyHjh2GNsTu1CUEPCcgk3DmJoFjOziY2n6A3cDDTogdDLYbhIHt", - "dEvMu7XVXT8p1/r8SLLlxNPEjyLXj+OZF/swcwjM3ICQEM9CJwLbmRI3msZ+EPuTJNnIrAJnGvzTZFbX", - "z0qtBuOhTpWg/0uikRZs3Lu0nfOvzot3q2J7/7ysqwA7/aSsoyHlXaqNn449QaZtU/V+sZTykWTM9p5X", - "Ua6ylyYcXA+s1uLOzuOG0cXus8bnax0pHOf04Ee4az5WhKufgn++1sFB+eOWMhLrvz4onNP2nrAgWoj/", - "PwAA//+Wgp4zjEEAAA==", + "H4sIAAAAAAAC/+xcW3PbOJb+KyjuPiRVssWbSMlV/eA48o63O3bWVrp3N+PqAsFDCxMS4ACgLXfW/30L", + "4F2iLNmxM93TkydLuB18OPdzlK8W4VnOGTAlraOvVo4FzkCBMJ8ITtMIky8L/gWY/iIGSQTNFeXMOrKO", + "CQEpkdKjKOECMa5oQgnW46hejIDFOadMHaIzhe5omqIIUCEhRlgijI4LteSC/lauWgKOQZjd1BLQUqm8", + "2ckaWVSfW86xRhbDGVhH1n8fnPQIHVmSLCHDmmJ1n+spUgnKbqyHh1FzqU8i3bzSe0hwkSoU8yJKAckc", + "WIwwi1EG4ksKKBecJ7vuuZtOffbjVJbnfdTHbVL5yxLUEgRSHFFG0iKGHn0SUWbQq0mT6I0SBaD/QwlO", + "Jbx9hMIPnXMfp1B+ofkpwM84pTEuCdtG5x0gueRFGiO9CCUA6LZZhkrGeYSmq42TBiiLOE8Bs4a0K0PH", + "M6grpzyZwI3z9qBxsXoGffwWBE5TpFZPprF33g767jBVp1xcKawKOUQcJUskzajmQz3dSG0ieGaYT4K4", + "BYEiSLgAJEAVglF2g9646Ad0OT+Zn/08fz9CHvoBXS0uLvXfPvoBHZ+fX3w6P5m//3Vx8ev5fPHLxeWP", + "IzQxa/7r0/xqMX//67v/aUcCvX5+vuhND/VGJyfzj+uzp2b2/PzXi/P6y7fbMfulh8EAYJQpuAFhPWjE", + "BMicMwkGrXOuasUG8SZ8V0AKQdU9EvD3ggrItAJGCaYpxCV7mKPMVidLTNkZS/jmNmYIUT02snLBcxCK", + "lgREKSdf/oLlcnPVOz2ElnpsZMEKZ3mqL2Ov/5tO/NCfRR5x3Ek8cUkw870gDCe+T6Y4wNPpxPXDmTeJ", + "8DR2wtgarWuJUUUF0Jul2kpHOdqhJJy6njMdWQkXGVbWkVVQpgK/3b+FvfmKR38DovSRJzzLOLusHmMA", + "MzOO6tdC1cp1/BTNQCqc5fpDQ0mMFRzooc3LGg4wjxlbR587668HiJwLwcWARWXoL4vFR/RR8CiFDL0H", + "hWkqKxpH2mDGkFAGsVbxZ/PFKbo8PUHh1A7RG20r5dF4rDhP5SEFlRxycTNeqiwdi4ToSUbzcwYXiXX0", + "+av17wIS68j6t3HrBIwrxhsbCj8x/USU3ZTaTVoPoz1WnbG82HfuB5xqcDXX7zP9VPDfgH3kKSX3T1lx", + "op+ayUJaD9c1/O9wfAl/L0Aa1sRpui8qpxTSuLxfn2di81z6r1aqFkswQg5SIQmQGW0ZAcrqixv3gmDG", + "uNLf54Jrr8oAYlEmFWYE+lvWD40FOVQYp4eEZ2PQlMmx43r+ZBLoxbJR3c1S37a1yFCVrm35Dsc1lVYj", + "VNvOjKginDJ52z3Yt+0hedzK/CecJSklr4u9wExiYgwklaW5HKGoUNpACdDfYUQqQrRtUqvadTKKCynI", + "8hQr+Ia38LY9RRAMP8VJn56EFyx+9pvMnvQmpwCvLQoJgERYAFKco5TffQOy7lZkJ8PInkLv2GcB6j4N", + "0BKeo+3o9PX/T5zdgECdLxFPkDm8Z6orJGtmVX0+r+5YKZoqQjAWA5d8fThkqmGlBB52My7MHzhFZo7x", + "N7Q91MfhiJfiVFLZun8ZZaUzVaQpjjTVOgQZOLf7+v1j39TnvkU/UfZF3wcTVWg6zFmcVU7mPsfILY6s", + "eSdEeAxdhH3b7fgflKkB56PDY+tBZPXpFpCCVekX14+4QZha0QEHsau6zt4jtaSyujWVSEACQhgFwfe5", + "e83pa0fc59Cw1wjdUbVEaYVzpn32zjvvdnf0aI1Ig/ao5vTtErJmnl9R/Ri3BJUHojdRismXlEqFMsyw", + "ljpSE4GaMYjfvoaCCt1hBdWl8LkaKnyihuo6VP9A8HNDwesj77wi8s6TkK+85O/n/lBmHCAUAcGFBKOl", + "qSHCGGTG2QGsNPRMIS5M7ku9inneyv0lfbQOH571CsHT+L+NP77fQ7ym678ddW8Y9QaArhfxbPC9J4G/", + "EV7+s7+B8z3eYG81dApwnPGClTFYHNPS2/rYwdLkizdSS/cKBjyp8yKLQGiPopywTwJnZEmsuFzSgf1K", + "2rTbelXP2TMn1HVMZLu2JGsIiY79ewyG5hm+WhlelbRK+hvk1fKJSZuN9KBaSXrDc0n0HWQ9wXdn/iwI", + "3dmkmdSudqq028jKKKPsporGKrQdM9Ki5eiL9t9lkKZ1VD/gFc2KrE5z66nosznjes8X23q7bUexhjEk", + "vWFYFQKQptt4lvJpp+6+WDcYes7tutg/poJa6VlnuaF32A7b5tW6RGzn1m6Gcz+luZYZ1XrzCVLf4v7Y", + "GXVqbg2SavHmba4fRl3VXCU8979TZ+1VEWVUVcl6fbmOuHay4Za1lpa2e7GvHq6Kb1gtq7R4G9EcuVoM", + "O8lhy7Vd78D2DuzZwnGPbO/Inx56U3fm2BPH/98mJjqyLn7UH1Z1RcVaq0NYdShoETsOEgKh44PvupPA", + "8RPbtkmAJziOMcaO5zuYRNGMTEPHmTiOH5Nk6ideGM38CTbJv/7bPRLbzx8J6bvWaLTdlmrTaVy3fWLR", + "LraPBb11QROrpTYBS1jtFemuthWsuns30SmwItPs+en8x/OLX86tkVUXpqyRVValrJE1VJIyUzfrUXpZ", + "vxhlvll/6A9n52bnk4vz07PLD+bvy/l/zk8W8/daSFqo6yrWszMHDXbtnkEURyTBkT1xg9izYRoHUzec", + "JeEsTpLASSLfdgNMYBqFkeeG0xlObCfwvAAmfuIm9mAyYNPf2E5WXEn5WgpBX2dI33WWdhL2HekW+G6x", + "so6svxa27ZGuAVjCCpVEmjHYFI1q7TqKl/ius3hn+qPcZSfxL6CxH53eVAp3zRxQuU80B3uplD+cQvhG", + "GduRI1sZFdmQ1LU7Oy3jZbe6/B245wms0BE485kqyMwf+1Uat/DizvCvhKhCDQuB7wcVUR/Glht+Xxi+", + "iIX+gxnfNv6tzOGLWbhw5oau58WOHWMSTwI7IACTKLEjdxoE04Q4MwdCz7bdGSbgkzAhvg0xTGbYnboT", + "2FeUq7vsFN6ea/o4OmZmC1KfS7YVMa42MHVt5/kFjEWVxe+4IXEMsSkMQJZznu4EqNWoZq9NhHToXzXB", + "XGnhKS/4DrAAcVwMMWg5hnChlsBU3X7Xb4m4PD1BQTix62Yd09Vk1rUUL5XKy44dWslbSglUdrnq/bnI", + "gaF3Vz+jn/QQ0WAUIu3kX6rcC5aSE2ooOWSgxjwHdhDJ24Nqy3EHZUvvd3x5Yo2sWxCyvJRzaB/aepJe", + "iXNqHVme+WpkaekzoIxvnXEbfd3AQCvNwtSHqgbEqtlKGg1RJdYlKEXZjTQNIHXsfaajjf+YLz7WcWev", + "hcm1bdMEypmCKkeU52mF+/hvsuxZa3uidoeFrRrV6K+xcGG6STUUvu1s268hcNxvsDLsVGQZFvf6SqCG", + "7q5ZAN9IzZ7HgljXepHGVq3K+FbuBJbKsnFVcSRNZygS+K6XcVAc4bL2aap+pvgqTZxUlmoZrFTdXLDE", + "qi2VIiIAK5CHCC2WUPfBtv24iGDWNM4qbtoABY3LNP5NyiOcNhfVh93zQqBjQVCM5TLiWMR1U63smY0B", + "jvh4cbVY9AxLty14i8Fsp4y7HbbbDGZn+mYj6Z6LNlou91zXa4PcY02/DXqPBd3m3T2m91stdehUteK8", + "4/H9i4ngQBSlBaC7IScK1IFUAnDW37ixJBFlWsYGI0BYqXGeYrpGVGtF9ojPNjd+eCyS7IVorf3RDsrD", + "s9RZRWyZT61snb5No1uOUwE4vtci1trCW5wWf8Y8U5kvLYtnmxCVQ1vQsTf/fTM9a4CHXuC6038Q6o1P", + "+2JYP4yeI+l7WtyXM/XrvZUDJ691Gz7H3o8s33VfluYhSj+xqiCoAx+k3U51jw7KXpl++23ZR9Tmffxg", + "8rLkncLgK641tflB8LLHNn2aA2f3WhU7WrnqWez5ZGUIhHB34uF2j2z8VQvOw54Ob8cvu6l8P1IIAayO", + "pBBPEEa5gFvKC5neV3GW6pdcB53jzeTBhj+0Tlq/I+/sPXrjuaYoapru3/atlvntgfb1218eVNFl3549", + "9muc61d03Tfv//Leu17lD1SUuRrkJePfb6QUHuEm+VwHPytSRfMU1v18+RKO/u/Mz5f/cvT/MI5+k2J9", + "qsc/kDD9fUUAf2XPixK+3d3HcbzuydZqrfFhP//pXPzrh5EF9a+VWmTqZj1eKNOt10Wobr/apwGxWj/Y", + "gVjNt/qgYkGqTmg/8I7Q2scu25R7IxvVXTMdIqxudxcr0rR9Fj/wWqQ371khi+04mGE3TnAcOnYY2hC7", + "U5cQ8JyATMKZmwSO7eBgavsBdgMPOyF2MNhuEAa2000x79dWd/2kWOvzjmDLiaeJH0WuH8czL/Zh5hCY", + "uQEhIZ6FTgS2MyVuNI39IPYnSbIRWQXONPiniayuvym0GvSHOlmC/i+JRpqxce/R9o6/OhXvVsSe/fOy", + "rgDs9ZOyjoSUb6k2fjr2BJ62Tdb7xULKHcGY7X1bRrmKXhp3cN2xWvM7O8UNI4vdssbna+0pHOf04Ee4", + "bz52/xME8+W13kLc1p5Yv/qgcE7bd8KCaCb+/wAAAP//X1HMtcxBAAA=", } // GetSwagger returns the content of the embedded swagger specification file diff --git a/api/arc.json b/api/arc.json index 0b36a5d43..b554291c4 100644 --- a/api/arc.json +++ b/api/arc.json @@ -1035,7 +1035,7 @@ "callbackToken": { "name": "X-CallbackToken", "in": "header", - "description": "Access token for notification callback endpoint.", + "description": "Access token for notification callback endpoint. It will be used as a Authorization header for the http callback", "schema": { "type": "string" } diff --git a/api/arc.yml b/api/arc.yml index 70cd5811b..547c6d303 100644 --- a/api/arc.yml +++ b/api/arc.yml @@ -6,7 +6,7 @@ info: name: Open BSV Licence url: https://bitcoinassociation.net/open-bsv-license/ servers: -- url: https://tapi.taal.com/arc + - url: https://tapi.taal.com/arc paths: # Get Policy @@ -206,7 +206,7 @@ paths: added: summary: Success value: - [ + [ { "blockHash": "", "blockHeight": 0, @@ -223,7 +223,7 @@ paths: error: summary: "Invalid outputs" value: - [ + [ { "detail": "Transaction is invalid because the outputs are non-existent or invalid", "extraInfo": "arc error 463: arc error 463: transaction output 0 satoshis is invalid", @@ -731,7 +731,7 @@ components: callbackToken: name: X-CallbackToken in: header - description: Access token for notification callback endpoint. + description: Access token for notification callback endpoint. It will be used as a Authorization header for the http callback schema: type: string merkleProof: @@ -748,6 +748,6 @@ components: type: integer security: - - BearerAuth: [] - - Api-Key: [] - - Authorization: [] + - BearerAuth: [ ] + - Api-Key: [ ] + - Authorization: [ ] diff --git a/doc/api.md b/doc/api.md index 65a2c8629..fab86d736 100644 --- a/doc/api.md +++ b/doc/api.md @@ -537,7 +537,7 @@ This endpoint is used to send a raw transaction to a miner for inclusion in the |X-SkipFeeValidation|header|boolean|false|Whether we should skip fee validation or not.| |X-SkipScriptValidation|header|boolean|false|Whether we should skip script validation or not.| |X-SkipTxValidation|header|boolean|false|Whether we should skip overall tx validation or not.| -|X-CallbackToken|header|string|false|Access token for notification callback endpoint.| +|X-CallbackToken|header|string|false|Access token for notification callback endpoint. It will be used as a Authorization header for the http callback| |X-MerkleProof|header|string|false|Whether to include merkle proofs in the callbacks (true | false).| |X-WaitForStatus|header|integer|false|Which status to wait for from the server before returning (2 = RECEIVED, 3 = STORED, 4 = ANNOUNCED_TO_NETWORK, 5 = REQUESTED_BY_NETWORK, 6 = SENT_TO_NETWORK, 7 = ACCEPTED_BY_NETWORK, 8 = SEEN_ON_NETWORK)| |body|body|string|true|Transaction hex string| @@ -800,7 +800,7 @@ This endpoint is used to send multiple raw transactions to a miner for inclusion |X-SkipFeeValidation|header|boolean|false|Whether we should skip fee validation or not.| |X-SkipScriptValidation|header|boolean|false|Whether we should skip script validation or not.| |X-SkipTxValidation|header|boolean|false|Whether we should skip overall tx validation or not.| -|X-CallbackToken|header|string|false|Access token for notification callback endpoint.| +|X-CallbackToken|header|string|false|Access token for notification callback endpoint. It will be used as a Authorization header for the http callback| |X-MerkleProof|header|string|false|Whether to include merkle proofs in the callbacks (true | false).| |X-WaitForStatus|header|integer|false|Which status to wait for from the server before returning (2 = RECEIVED, 3 = STORED, 4 = ANNOUNCED_TO_NETWORK, 5 = REQUESTED_BY_NETWORK, 6 = SENT_TO_NETWORK, 7 = ACCEPTED_BY_NETWORK, 8 = SEEN_ON_NETWORK)| |body|body|string|false|none| @@ -1673,4 +1673,3 @@ and |instance|string¦null|false|none|(Optional) Link to actual error on server| |txid|string¦null|false|none|Transaction ID this error is referring to| |extraInfo|string¦null|false|none|Optional extra information about the error from the miner| - diff --git a/doc/arc.json b/doc/arc.json index 0b36a5d43..b554291c4 100644 --- a/doc/arc.json +++ b/doc/arc.json @@ -1035,7 +1035,7 @@ "callbackToken": { "name": "X-CallbackToken", "in": "header", - "description": "Access token for notification callback endpoint.", + "description": "Access token for notification callback endpoint. It will be used as a Authorization header for the http callback", "schema": { "type": "string" }