Documentation

Bringing Twitter to Lukso with ChainLink Oracle Services
View Demo »

About The Project

Twitter Name Space (TNS) is using ChainLink Oracle Request to verify your Twitter ID.

Getting Started

The website is divided into two parts:

The ChainLink Faucet where any user can claim LINK from the faucet at every 12 hour intervals. This is a mitigation used to prevent spam atacks and prevent bad actors from draining the pool.

The Twitter Name Space where any user can connect their Twitter ID to their wallet address, update / resolve their existing wallet address to a different twitter ID, and search a user's twitter ID to see their connected wallet.

Guide (Step-by-step)

The website can be daunting at first for inexperienced tech users. As a result, we have currated this guide to ease the process of registering you TNS! If you're using a UP, start at step 3; otherwise, start at step 1.

1. First and foremost, you must have L16 LYXE test-net tokens. These will be used for gas. You can acquire these here.

2. Head over to the LINK page where you will request for 20 LINK. If the faucet is empty, you will need to patiently wait for it to top-up. Please be mindful, you can only request every 12 hours.

3. Retrieve your Twitter ID by entering your twitter username (e.g. @rickastley = 148137271).

4. Go to the TNS page, connect your wallet, and insert your retrieved Twitter ID in the text-field, and hit the Register button.

   NOTE: Notice that, in the TNS page, the Twitter LINK Balance in the modal above the text-fields shows the amount of LINK in the twitter contract. If the LINK balance is larger than 0 LINK, you should be okay to proceed. Otherwise, the modal will display an address you will need to send LINK to (from Step 2) with a wallet before being able to register your twitter account.

5. Once you have registered and you have confirmed the transctions through MetaMask, you should be able to insert your Twitter ID into the text-field and see the wallet address linked to it but hitting the Enter button.

6. OPTIONAL: If you ever need to change the address your Twitter ID points to, you can do so by using the Resolve button on screen.

Contributing

Any contributions you make are welcome!

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

1. Clone the Project
2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
3. Commit your Changes (git commit -m 'Add some AmazingFeature')
4. Push to the Branch (git push origin feature/AmazingFeature)
5. Open a Pull Request

Acknowledgments

smart contracts: Marcus Wentz
devops: @0x_rxx
frontend & docs: @0xfinesto
logo: @gabibibah
advisor: @johannafransn