commit cdc8213e934e2761c9266a0a65a3872f4f192a57 Author: Nathan Woodburn Date: Thu Jan 30 16:28:32 2025 +1100 Initial docs diff --git a/Home.md b/Home.md new file mode 100644 index 0000000..d3a92be --- /dev/null +++ b/Home.md @@ -0,0 +1,33 @@ +# FireSales + +Welcome to FireSales, a self custodial domain listing service + +## List domain +First send the domain to a valid sale address + +Send an API request to submit a domain +Request +``` +POST https://sales.firewallet.au/api/v1/list +{ +"domain": "domainname", +"price": 100.2, +"description": "Listing description", +"tx": "partially-signed-buy-tx" +} +``` + +## Cancel Listing +If you want to delete your listing (please do so if you transfer your domain back to your wallet), send this request +Sign this message and include the signature +``` +FS: {domain} +``` + +``` +POST https://sales.firewallet.au/api/v1/delete +{ +"domain":"domainname", +"signature":"signature to prove domain ownership" +} +```` \ No newline at end of file