Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(docs): update docs #758

Merged
merged 2 commits into from
Oct 23, 2024
Merged

chore(docs): update docs #758

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ef0caa3
Update README.md
stavares843 Oct 23, 2024
7e30676
Merge branch 'dev' into sara/update-docs
stavares843 Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 7 additions & 7 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ The goal should be to build a hyper-customizable application that can run anywhe

## Quickstart for Developing

To get running fast, ensure you have this project cloned, with latest dependencies and submodules installed.
To get running fast, ensure this project is cloned, with the latest dependencies and submodules installed.

**Standard Steps:**

Expand All @@ -40,26 +40,26 @@ npm run dev

2. In Xverse, go to Settings -> General -> Network and select 'Testnet'

3. Get some free Testnet BTC from a faucet. For example: https://bitcoinfaucet.uo1.net/send.php
3. Get some free Testnet BTC from a faucet. For example https://bitcoinfaucet.uo1.net/send.php

## Get (Sepolia) Testnet Ethereum and LINK (ERC20 Token)

1. Install MetaMask Chrome extension
1. Install the MetaMask Chrome extension

2. In Metamask, Open the dropdown in the top left corner, and select Sepolia (This is the Ethereum testnet currently)
2. In Metamask, Open the dropdown in the top left corner, and select Sepolia (This is the Ethereum test net currently)

3. Go to https://faucets.chain.link and select Sepolia ETH and LINK. Press continue and paste your address.

## Request a Payment

1. While in a chat with another user in UplinkWeb, click the `Create Payment Request` button on the bottom chat bar (coin exchange icon, next to chat input).
1. While chatting with another user in UplinkWeb, click the `Create Payment Request` button on the bottom chat bar (coin exchange icon, next to chat input).

<img width="1034" alt="Captura de ecrã 2024-08-28, às 11 00 58" src="https://github.com/user-attachments/assets/5c18e3f6-80f5-4ee7-9194-13ae248dc52b">


2. Select the asset type. If selecting ETH.ERC20, you will need to put in the asset ID as well. The asset ID of LINK on Sepolia testnet is `0x779877A7B0D9E8603169DdbD7836e478b4624789` (You can see this ID in MetaMask if you own some LINK: click on it, then near the top click the '3 dots' icon, and select 'Token details'. The ID is listed under `Token contract address`).
2. Select the asset type. If selecting ETH.ERC20, you will need to put in the asset ID as well. The asset ID of LINK on Sepolia test net is `0x779877A7B0D9E8603169DdbD7836e478b4624789` (You can see this ID in MetaMask if you own some LINK: click on it, then near the top click the '3 dots' icon, and select 'Token details'. The ID is listed under `Token contract address`).

3. In UplinkWeb, once you selected the asset (and ID if applicable), enter an amount. Then click the `Request` button. A clickable message will appear in the chat. Anyone clicking this message will get a prompt via the Chrome extension to make the transfer. (Expect at least 10 seconds for a transfer to go through on the Ethereum network).
3. In UplinkWeb, once you select the asset (and ID if applicable), enter an amount. Then click the `Request` button. A clickable message will appear in the chat. Anyone clicking this message will get a prompt via the Chrome extension to make the transfer. (Expect at least 10 seconds for a transfer to go through on the Ethereum network).

## Mobile Builds

Expand Down