[{"_1":2,"_162":-5,"_163":-5},"loaderData",{"_3":4,"_17":18,"_25":26,"_141":142},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7,"_13":14,"_15":16},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","theme","system","contrast","normal","routes/_layout",{"_19":-5,"_20":21,"_22":21,"_23":11,"_24":21},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_27":28,"_29":-5,"_30":11,"_31":11,"_32":33,"_34":35,"_36":-5,"_37":11,"_38":39,"_88":-5,"_89":90,"_129":-5,"_130":11,"_131":21,"_132":11,"_133":11,"_134":-5,"_135":11,"_136":-5,"_137":138,"_139":91,"_140":-7},"canonicalUrl","https://hub.docker.com/r/anthonybudd/spot/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","anthonybudd","reponame","spot","cloudBuildSource","isAutobuildsAvailable","repo",{"_40":41,"_42":43,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":55,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":74,"_79":11,"_80":81,"_85":33,"_86":87},"categories",[],"content_types",[44],"image","date_registered","2021-03-02T00:16:59.423762Z","description","Bitcoin HD Wallet Billing Microservice ","is_private","last_updated","2021-03-02T05:27:13.864034Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[56],"application/vnd.docker.container.image.v1+json","name","pull_count",1011,"repository_type","star_count",0,"status",1,"status_description","active","source","collaborator_count","full_description","\n# Spot - Bitcoin HD Wallet Billing Microservice\n\nSpot is a Bitcoin billing microservice that provides your infrastructure with an endpoint for generating an infinite amount of addresses to handle transactions between your application and users without the need for 3rd parties.\n\n- 🔑 **Secure By Design** - Spot only requires your public key.\n- ☁️ **Production Ready** - Stateless microservice designed for production.\n- 🌳 **HD Wallets** - Billing system that implements [BIP 32 HD Wallets.](https://github.com/bitcoin/bips/blob/master/bip-0032.mediawiki)\n- 🐳 **DockerHub** - Available on [Docker Hub.](https://hub.docker.com/r/anthonybudd/spot)\n\n

\n $\"Scanning$ \n

\n\n## Quick Start\nTo start a local instance of Spot you will first need to create a `ROOT_PUBLIC_KEY`. This is the public key for the root HD wallet, all accounts will be derived from this key. Once you have created a public key, pass it to the container as an ENV and run it using Docker.\n\n```sh\nexport ROOT_PUBLIC_KEY=`node -e \"console.log(require('hdkey').fromMasterSeed(Buffer.from(require('bip39').mnemonicToSeedSync(require('bip39').generateMnemonic()).toString('hex'), 'hex')).publicExtendedKey);\"`\n\ndocker run -p 8888:8888 --env ROOT_PUBLIC_KEY=$ROOT_PUBLIC_KEY anthonybudd/spot\n\nopen http://localhost:8888/api/v1/generate/0/0/0.svg?amount=0.005\n```\n_{^{⚠️ Do not use the above code to create production keys!}}\n\n\n\n## REST API\n\n### `GET - /api/v1/generate/:account/:wallet/:address`\n\nEndpoint for generating the receiving address. The `account`, `wallet` and `address` URL parameters represent the derivation path for the BIP 32 tree node. \n\n### Response\nBy default the response will be a plain JSON object containing the address.\n\n```json\n{\n\t\"addresss\": \"13sDzEE3L8LeB3Af9SWiNxxY71ZjgqceHB\",\n}\n```\n\n### Response - QR Codes\nTo create a QR code of the address add the file extension `.png` or `.svg` to the endpoint, for example `/api/v1/generate/0/0/0.png`.\n\nIf you would like to prompt the user to pay a specific amount when they scan the QR code use the query parameter `amount`, this value will be in BTC. Example `/api/v1/generate/0/0/0.png?amount=0.0005`.\n\n\n

\n $\"QR$ \n

\n_{^{⚠️ Do not send Bitcoin here.}}\n\n## Implementation\nSpot is a stateless microservice designed to be deployed along with the rest of your containers in your infrastructure. Your application will make an HTTP request to Spot to generate an address.\n\nTo maximise security Spot does not use your private key. This means if your servers get hacked no sensitive information can be compromised. Even with these security measures you should never allow Spot to be publicly open to the internet.\n\nEach user on your application will need their own corresponding `account` in spot. If your user ID column is unsigned int you could use this. Alternatively if you use UUID, you may need to add a new int column to the users table called `account_id` for storing the spot account.\n\nIn production you should only use one `address` for each transaction. So on the first transaction the derivation path will be `.../0/0/0`, the second will be `.../0/0/1`, the third `.../0/0/2` and so on. \n\n\n```\nROOT_PUBLIC_KEY\n│ \n└─── Account 0\n│ └─── Chain 0\n│ │ Address 0: 1PYvjSG6sHzHbiw19DXsbRqe6tvEU8X294\n│ │ Address 1: 13uZtpZN8gQr7yypD5G5u4Y6sghiBBmAjC\n│ │ Address 2: 1M1cb4EWwRSeGwNCrTtVXiDKzkdPBznzdd\n│ │ ...\n│ \n└─── Account 1\n│ └─── Chain 0\n│ │ Address 0: 17mcx19MzsPAWx18f6RLsB8c66TDHR66aS\n│ │ Address 1: 19f3ExY2LuuYH8nxuP1pPSTaTFLjHYDXn5\n│ │ ...\n│... \n```\n\n\n### Example\nBelow is a basic example of how Spot works in practice.\n1. A user incurs a charge on your website, such as a one-off payment or a monthly fee.\n2. The backend of your application will send a request to the Spot microservice `/api/v1/generate/:account/:wallet/:address`. \n3. In your application you will need to prompt the user to send bitcoin to the address. You can use the QR code feature and the `amount` param to return an image. For example `/api/v1/generate/0/0/15266.png?amount=0.0005`\n4. You will need to externally verify the payment and confirm that correct amount was sent using a Bitcoin full node or an API.\n\n### Why \"Spot\"?\nIt's the furthest thing from Stripe.\n","has_starred","hub_user","immutable_tags_settings",{"_75":11,"_76":77},"enabled","rules",[78],".*","is_automated","permissions",{"_82":21,"_83":11,"_84":11},"read","write","admin","user","storage_size",429131416,"orgData","recentTags",[91],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":100,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},"content_type","creator",1925283,"full_size",396735381,"id",139586756,"images",[101],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},"architecture","amd64","digest","sha256:66ef6e4b7a13ef9015a8fcf227df82485e60c5634b1633d841566190c5c60733","features","","last_pulled","2026-10-12T02:49:29.450323086Z","last_pushed","2021-03-02T05:27:14Z","os","linux","os_features","os_version","size","variant","2021-03-02T05:27:13.486391Z","last_updater","last_updater_username","media_type","latest","repository",11631290,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxRunInCloud","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"selectedTag","attestationsUrl","routes/_layout.r.$namespace.$reponame.tags",{"_38":143,"_150":151,"_137":160,"_161":11},{"_40":144,"_42":145,"_45":46,"_47":48,"_49":11,"_50":51,"_52":53,"_54":146,"_57":35,"_32":33,"_58":59,"_60":44,"_61":62,"_63":64,"_65":66,"_67":-5,"_68":62,"_69":70,"_71":11,"_72":33,"_73":147,"_79":11,"_80":149,"_85":33,"_86":87},[],[44],[56],{"_75":11,"_76":148},[78],{"_82":21,"_83":11,"_84":11},"tags",{"_152":64,"_153":-5,"_154":-5,"_155":156},"count","next","previous","results",[157],{"_92":44,"_93":94,"_95":96,"_97":98,"_99":158,"_50":118,"_119":94,"_120":33,"_121":56,"_57":122,"_123":124,"_125":109,"_126":118,"_127":66,"_128":21},[159],{"_102":103,"_104":105,"_106":107,"_108":109,"_110":111,"_112":113,"_114":107,"_115":-5,"_116":96,"_63":66,"_117":-5},[],"canDeleteTags","actionData","errors"]

anthonybudd/spot

Tags for anthonybudd/spot