base58 recipe

content/_recipes/convert-btc-to-stx-address.mdx

@@ -0,0 +1,44 @@
+# Convert a bitcoin address to its corresponding Stacks address
+
+Every base58-encoded bitcoin address can be easily converted to its corresponding Stacks address. This conversion can be done on-chain by implementing the base58 encoding scheme in Clarity.
+
+## Use cases
+
+- Abstracting away Stacks address usage for native bitcoin users
+- Onboard bitcoin users onto Stacks with familiar UX
+- Verify Stacks asset ownership of a bitcoin address
+
+## Example usage
+
+```typescript
+let stxAddress = b58ToC32("1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa") // SP1HEJ1XHBJZJFNA2AECYQXQGZD8EQE4F30D6H5CR
+```
+
+```clarity
+;; verify bitcoin address owns sBTC
+
+(define-public (verify-sbtc-ownership (btc-address (string-ascii 60)))
+  (let
+    (
+      (stx-address (try! (btc-to-stx btc-address)))
+      (sbtc-balance (try! (contract-call? 'SM3VDXK3WZZSA84XXFKAFAF15NNZX32CTSG82JFQ4.sbtc-token get-balance stx-address)))
+    )
+    (if (> sbtc-balance u0)
+      (ok true)
+      (err false)
+    )
+  )
+)
+```
+
+## Resources
+
+**Clarity functions**
+
+- [`principal-construct?`](/stacks/clarity/functions/principal-construct)
+- [`element-at?`](/stacks/clarity/functions/element-at) [`index-of?`](/stacks/clarity/functions/index-of)
+- [`fold`](/stacks/clarity/functions/fold)
+
+**Related snippet**
+
+- [Convert a Stacks address to its corresponding Bitcoin address](https://play.hiro.so/?epoch=3.1&snippet=KGRlZmluZS1jb25zdGFudCBBTExfSEVYIDB4MDAwMTAyMDMwNDA1MDYwNzA4MDkwQTBCMEMwRDBFMEYxMDExMTIxMzE0MTUxNjE3MTgxOTFBMUIxQzFEMUUxRjIwMjEyMjIzMjQyNTI2MjcyODI5MkEyQjJDMkQyRTJGMzAzMTMyMzMzNDM1MzYzNzM4MzkzQTNCM0MzRDNFM0Y0MDQxNDI0MzQ0NDU0NjQ3NDg0OTRBNEI0QzRENEU0RjUwNTE1MjUzNTQ1NTU2NTc1ODU5NUE1QjVDNUQ1RTVGNjA2MTYyNjM2NDY1NjY2NzY4Njk2QTZCNkM2RDZFNkY3MDcxNzI3Mzc0NzU3Njc3Nzg3OTdBN0I3QzdEN0U3RjgwODE4MjgzODQ4NTg2ODc4ODg5OEE4QjhDOEQ4RThGOTA5MTkyOTM5NDk1OTY5Nzk4OTk5QTlCOUM5RDlFOUZBMEExQTJBM0E0QTVBNkE3QThBOUFBQUJBQ0FEQUVBRkIwQjFCMkIzQjRCNUI2QjdCOEI5QkFCQkJDQkRCRUJGQzBDMUMyQzNDNEM1QzZDN0M4QzlDQUNCQ0NDRENFQ0ZEMEQxRDJEM0Q0RDVENkQ3RDhEOURBREJEQ0REREVERkUwRTFFMkUzRTRFNUU2RTdFOEU5RUFFQkVDRURFRUVGRjBGMUYyRjNGNEY1RjZGN0Y4RjlGQUZCRkNGREZFRkYpCihkZWZpbmUtY29uc3RhbnQgQkFTRTU4X0NIQVJTICIxMjM0NTY3ODlBQkNERUZHSEpLTE1OUFFSU1RVVldYWVphYmNkZWZnaGlqa21ub3BxcnN0dXZ3eHl6IikKKGRlZmluZS1jb25zdGFudCBTVFhfVkVSIDB4MTYxNDFhMTUpCihkZWZpbmUtY29uc3RhbnQgQlRDX1ZFUiAweDAwMDU2ZmM0KQooZGVmaW5lLWNvbnN0YW50IExTVCAobGlzdCkpCgooZGVmaW5lLWNvbnN0YW50IEVSUl9JTlZBTElEX0FERFIgKGVyciB1MSkpCgooZGVmaW5lLXJlYWQtb25seSAoY29udmVydCAoYWRkciBwcmluY2lwYWwpKQogICAgKG1hdGNoIChwcmluY2lwYWwtZGVzdHJ1Y3Q_IGFkZHIpIAogICAgICAgIDs7IGlmIHZlcnNpb24gYnl0ZSBtYXRjaCB0aGUgbmV0d29yayAoaWUuIG1haW5uZXQgcHJpbmNpcGFsIG9uIG1haW5uZXQsIG9yIHRlc3RuZXQgcHJpbmNpcGFsIG9uIHRlc3RuZXQpCiAgICAgICAgbmV0d29yay1tYXRjaC1kYXRhIChjb252ZXJ0LWlubmVyIG5ldHdvcmstbWF0Y2gtZGF0YSkKICAgICAgICA7OyBpZiB2ZXJzaW4gYnl0ZSBkb2VzIG5vdCBtYXRjaCB0aGUgbmV0d29yawogICAgICAgIG5ldHdvcmstbm90LW1hdGNoLWRhdGEgKGNvbnZlcnQtaW5uZXIgbmV0d29yay1ub3QtbWF0Y2gtZGF0YSkKICAgICkKKQoKKGRlZmluZS1wcml2YXRlIChjb252ZXJ0LWlubmVyIChkYXRhIHtoYXNoLWJ5dGVzOiAoYnVmZiAyMCksIG5hbWU6IChvcHRpb25hbCAoc3RyaW5nLWFzY2lpIDQwKSksIHZlcnNpb246KGJ1ZmYgMSl9KSkKICAgIChsZXQgKAogICAgICAgIDs7IGV4aXQgZWFybHkgaWYgY29udHJhY3QgcHJpbmNpcGFsCiAgICAgICAgKHQxIChhc3NlcnRzISAoaXMtbm9uZSAoZ2V0IG5hbWUgZGF0YSkpIEVSUl9JTlZBTElEX0FERFIpKQogICAgICAgIDs7IGNvbnZlcnQgU1RYIHZlcnNpb24gYnl0ZSB0byBCVEMgdmVyc2lvbgogICAgICAgICh2ZXJzaW9uICh1bndyYXAtcGFuaWMgKGVsZW1lbnQtYXQ_IEJUQ19WRVIgKHVud3JhcC1wYW5pYyAoaW5kZXgtb2Y_IFNUWF9WRVIgKGdldCB2ZXJzaW9uIGRhdGEpKSkpKSkKICAgICAgICA7OyBjb25jYXQgQlRDIHZlcnNpb24gJiBoYXNoMTYwIAogICAgICAgICh2ZXJzaW9uZWQtaGFzaC1ieXRlcyAoY29uY2F0IHZlcnNpb24gKGdldCBoYXNoLWJ5dGVzIGRhdGEpKSkKICAgICAgICA7OyBjb25jYXQgaGFzaC1ieXRlcyAmIDQgYnl0ZXMgY2hlY2tzdW0sIGFuZCBjb252ZXJ0IGhleHQgdG8gdWludAogICAgICAgICh0by1lbmNvZGUgKG1hcCBoZXgtdG8tdWludCAoY29uY2F0IAogICAgICAgICAgICB2ZXJzaW9uZWQtaGFzaC1ieXRlcyAKICAgICAgICAgICAgOzsgY2hlY2tzdW0gPSBlbmNvZGUgdmVyc2lvbmRlZC1oYXNoLWJ5dGVzIDJ4IHdpdGggc2hhMjU2LCBhbmQgdGhlbiBleHRyYWN0IGZpcnN0IDQgYnl0ZXMKICAgICAgICAgICAgOzsgd2UgY2FuIHVzZSB1bndyYXAtcGFuaWMgdHdpY2UsIGJlY2F1c2Ugc2hhMjU2IG9mIGVtcHR5IGJ1ZmYgd2lsbCBhbHdhc3kgcmV0dXJuIHZhbHVlCiAgICAgICAgICAgICh1bndyYXAtcGFuaWMgKGFzLW1heC1sZW4_ICh1bndyYXAtcGFuaWMgKHNsaWNlPyAoc2hhMjU2IChzaGEyNTYgdmVyc2lvbmVkLWhhc2gtYnl0ZXMpKSB1MCB1NCkpIHU0KSkKICAgICAgICApKSkKICAgICAgICA7OyAiY3V0IiBsZWFkaW5nIHplcm9zIGxldmVyYWdpbmcgaW5kZXgtb2Y_IHByb3BlcnR5CiAgICAgICAgOzsgZmlyc3QgY29udmVydCBsaXN0IG9mIHVpbnQncyB0byBsaXN0IG9mIGJvb2xlYW5zIHRoYXQgdGVsbHMgaWYgdmFsdWUgd2FzIDAgb3Igbm90CiAgICAgICAgOzsgKGxpc3QgdTAgdTAgdTIgdTIzIHUwIHUzIHU1MyB1MjIpIC0-IChsaXN0IHRydWUgdHJ1ZSBmYWxzZSBmYWxzZSB0cnVlIGZhbHNlIGZhbHNlIGZhbHNlKQogICAgICAgIDs7IHNpbmNlIGluZGV4LW9mPyBhbHdheXMgcmV0dXJucyBmaXJzdCBpbmRleCB3ZSB1c2UgaXQgdG8gZmluZCB0aGUgcG9zaXRpb24gb2YgZmlyc3Qgbm9uLXplcm8gdmFsdWUKICAgICAgICA7OyBhbmQgd2UgZGVmYXVsdCBpdCB0byB1MCAtIGluIGNhc2UgaXQgd29uJ3QgZmluZCBhbnl0aGluZwogICAgICAgIDs7IGluIG91ciBleGFtcGxlLCBpdCB3aWxsIHJldHVybiAoc29tZSB1MikKICAgICAgICA7OyB0aGUgcmVhc29uIHdoeSB3ZSBkZWZhdWx0IHRvIHUwIGlzIHRoYXQgKHNsaWNlPyAobGlzdCB1MCB1MCB1MiB1MjMgdTAgdTMgdTUzIHUyMikgdTAgdTApIHdpbGwgcmV0dXJuIChzb21lIChsaXN0KSkKICAgICAgICA7OyBpdCBndWFyYW50ZWVzIHRoYXQgb3VyIHNsaWNlPyB3aWxsIG5ldmVyIHJldHVybiAobm9uZSkgc28gd2UgY2FuIHNhZmVseSB1c2UgdW53cmFwLXBhbmljIGhlcmUKICAgICAgICAobGVhZGluZy16ZXJvcyAodW53cmFwLXBhbmljIChzbGljZT8gdG8tZW5jb2RlIHUwIChkZWZhdWx0LXRvIHUwIChpbmRleC1vZj8gKG1hcCBpcy16ZXJvIHRvLWVuY29kZSkgZmFsc2UpKSkpKQogICAgKQogICAgICAgIChvayAKICAgICAgICAgICAgKGZvbGQgCiAgICAgICAgICAgICAgICBjb252ZXJ0LXRvLWJhc2U1OC1zdHJpbmcgCiAgICAgICAgICAgICAgICA7OyBydW4gdGhyb3VnaCAib3V0ZXItbG9vcCIgZXZlcnl0aGluZyBleGNlcHQgbGVhZGluZyB6ZXJvcwogICAgICAgICAgICAgICAgOzsgYW5kIGNvbmNhdGVuYXRlIHJlc3VsdHMgd2l0aCBsZWFkaW5nIHplcm9zIGlmIGFueQogICAgICAgICAgICAgICAgOzsgd2UgdXNlIHUyNSwgYmVjYXVzZSBoYXNoLWJ5dGVzIChha2EuIGhhc2gxNjApID0gMjAgYnl0ZXMsIHZlcnNpb24gPSAxIGJ5dGUsIGFuZCBjaGVja3N1bSA9IDQgYnl0ZXMKICAgICAgICAgICAgICAgIChjb25jYXQgKGZvbGQgb3V0ZXItbG9vcCAodW53cmFwLXBhbmljIChzbGljZT8gdG8tZW5jb2RlIChsZW4gbGVhZGluZy16ZXJvcykgdTI1KSkgTFNUKSBsZWFkaW5nLXplcm9zKSAKICAgICAgICAgICAgICAgICIiCiAgICAgICAgICAgICkKICAgICAgICApCiAgICApCikKCgooZGVmaW5lLXJlYWQtb25seSAob3V0ZXItbG9vcCAoeCB1aW50KSAob3V0IChsaXN0IDQ0IHVpbnQpKSkKICAgIChsZXQgKAogICAgICAgIChuZXctb3V0IChmb2xkIHVwZGF0ZS1vdXQgb3V0IChsaXN0IHgpKSkKICAgICAgICAocHVzaCAoZm9sZCBjYXJyeS1wdXNoIDB4MDAwMCAobGlzdCAodW53cmFwLXBhbmljIChlbGVtZW50LWF0PyBuZXctb3V0IHUwKSkpKSkKICAgICkKICAgICAgICAoY29uY2F0IAogICAgICAgICAgICAoZGVmYXVsdC10byBMU1QgKHNsaWNlPyBuZXctb3V0IHUxIChsZW4gbmV3LW91dCkpKQogICAgICAgICAgICAoZGVmYXVsdC10byBMU1QgKHNsaWNlPyBwdXNoIHUxIChsZW4gcHVzaCkpKQogICAgICAgICkKICAgICkKKQoKKGRlZmluZS1yZWFkLW9ubHkgKHVwZGF0ZS1vdXQgKHggdWludCkgKG91dCAobGlzdCAzNSB1aW50KSkpCiAgICAobGV0ICgKICAgICAgICA7OyBmaXJzdCBieXRlIG9mIG91dCBpcyBhbHdheXMgYSBjYXJyeSBmcm9tIHByZXZpb3VzIGl0ZXJhdGlvbgogICAgICAgIChjYXJyeSAoKyAodW53cmFwLXBhbmljIChlbGVtZW50LWF0PyBvdXQgdTApKSAoKiB4IHUyNTYpKSkKICAgICkKICAgICAgICAodW53cmFwLXBhbmljIChhcy1tYXgtbGVuPyAoY29uY2F0ICAKICAgICAgICAgICAgKGxpc3QgKC8gY2FycnkgdTU4KSkgOzsgbmV3IGNhcnJ5CiAgICAgICAgICAgIChjb25jYXQgCiAgICAgICAgICAgICAgICAoZGVmYXVsdC10byBMU1QgKHNsaWNlPyBvdXQgdTEgKGxlbiBvdXQpKSkgOzsgZXhpc3RpbmcgbGlzdAogICAgICAgICAgICAgICAgKGxpc3QgKG1vZCBjYXJyeSB1NTgpKSA7OyBuZXcgdmFsdWUgd2Ugd2FudCB0byBhcHBlbmQKICAgICAgICAgICAgKQogICAgICAgICkgdTM1KSkKICAgICkKKQoKKGRlZmluZS1yZWFkLW9ubHkgKGNhcnJ5LXB1c2ggKHggKGJ1ZmYgMSkpIChvdXQgKGxpc3QgOSB1aW50KSkpCiAgICAobGV0ICgKICAgICAgICA7OyBmaXJzdCBieXRlIG9mIG91dCBpcyBhbHdheXMgYSBjYXJyeSBmcm9tIHByZXZpb3VzIGl0ZXJhdGlvbgogICAgICAgIChjYXJyeSAodW53cmFwLXBhbmljIChlbGVtZW50LWF0PyBvdXQgdTApKSkKICAgICkKICAgICAgICAoaWYgKD4gY2FycnkgdTApCiAgICAgICAgICAgIDs7IHdlIG9ubHkgY2hhbmdlIG91dCBpZiBjYXJ5IGlzID4gdTAKICAgICAgICAgICAgKHVud3JhcC1wYW5pYyAoYXMtbWF4LWxlbj8gKGNvbmNhdCAKICAgICAgICAgICAgICAgIChsaXN0ICgvIGNhcnJ5IHU1OCkpIDs7IG5ldyBjYXJyeQogICAgICAgICAgICAgICAgKGNvbmNhdAogICAgICAgICAgICAgICAgICAgIChkZWZhdWx0LXRvIExTVCAoc2xpY2U_IG91dCB1MSAobGVuIG91dCkpKSA7OyBleGlzdGluZyBsaXN0CiAgICAgICAgICAgICAgICAgICAgKGxpc3QgKG1vZCBjYXJyeSB1NTgpKSA7OyBuZXcgdmFsdWUgd2Ugd2FudCB0byBhcHBlbmQKICAgICAgICAgICAgICAgICkKICAgICAgICAgICAgKSB1OSkpCiAgICAgICAgICAgIDs7IGRvIG5vdGhpbmcKICAgICAgICAgICAgb3V0CiAgICAgICAgKQogICAgKQopCgo7OyBjb252ZXJ0cyB1aW50IHRvIGJhc2U1OCBjYXJhY3RlciBhbmQgY29uY2F0ZW5hdGUgaW4gcmV2ZXJzZSBvcmRlcgooZGVmaW5lLXJlYWQtb25seSAoY29udmVydC10by1iYXNlNTgtc3RyaW5nICh4IHVpbnQpIChvdXQgKHN0cmluZy1hc2NpaSA0NCkpKQogICAgKHVud3JhcC1wYW5pYyAoYXMtbWF4LWxlbj8gKGNvbmNhdCAodW53cmFwLXBhbmljIChlbGVtZW50LWF0PyBCQVNFNThfQ0hBUlMgeCkpIG91dCkgdTQ0KSkKKQoKKGRlZmluZS1yZWFkLW9ubHkgKGhleC10by11aW50ICh4IChidWZmIDEpKSkgKHVud3JhcC1wYW5pYyAoaW5kZXgtb2Y_IEFMTF9IRVggeCkpKQooZGVmaW5lLXJlYWQtb25seSAoaXMtemVybyAoaSB1aW50KSkgKDw9IGkgdTApKQ)