Repository files navigation

This repository contains two main projects:Selfie Records SDK andSelfie Records Website. Each project extends the use of DNS TXT records, from SDK-based interactions to visual presentation and documentation on the website.

Initially, BIP353 focused solely on payments through DNS TXT records. However, the infrastructure of DNS is versatile and secure, especially when combined with DNSSEC. This project, Selfie Records, aims to expand the utility of BIP353 to support a variety of use cases through TXT records, including:

• Identities: Verifying and associating public keys (e.g., Nostr, Bitcoin) with email addresses or domain names.
• Payments: Continuing to support Bitcoin payments using DNS-based resolutions.
• Other data types: DNS TXT records can store anything from authentication keys to metadata, making it a flexible and decentralized alternative to more traditional data storage methods.

By leveraging the existing DNS infrastructure, we offer a decentralized, secure, and simple solution for handling multiple types of data.

TheSelfie Records SDK is designed to interact with DNS TXT records, offering a robust solution for storing and retrieving data, extending the concept of Bitcoin Improvement Proposal (BIP) 353 to support a broad range of data types using standard DNS infrastructure.

• Support for various data types via DNS TXT records.
• A robust SDK that simplifies developers' interaction with DNS TXT records.
• Enhanced security withDNSSEC to ensure data integrity and authenticity.

npm i @synonymdev/selfie-records

import{getRecords}from"@synonymdev/selfie-records";asyncfunctionfetchRecords(){constrecords=awaitgetRecords({name:"hello@miguelmedeiros.dev",filters:["bitcoin-payment","nostr"],// optionaldnsServer:"1.1.1.1",// optional});console.log(records);}fetchRecords();

For more details, check theSDK README.

TheSelfie Records Website is the official website. It showcases the interface for interacting with DNS TXT records, highlighting the use of payments, identities, and other data through this technology.

To run the development server:

npm run start:dev

For more information, see theWebsite README.

/├── 0_docs/              # Docs assets and images├── 1_package/           # Selfie Records SDK├── 2_app/               # Selfie Records Website├── docker-compose.yml   # Selfie Records Docker Compose file└── README.md            # This file

Each project has its own detailed README with instructions for installation, usage, and development.

You can also run the project using Docker. Thedocker-compose.yml file is located at the root of the repository.

To build and run the services, execute the following command from the root directory:

docker-compose up -d --build

This will build and start the containers for both the SDK and the website in detached mode.

To view the logs of the running services:

docker-compose logs -f

To stop the services:

docker-compose down

This repository is open-source under theMIT License.

Contributions are welcome! Please submit pull requests or open issues to suggest improvements or report problems.