Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/mahamodulhasanmoon/headless-radix-connect

Last synced: 7 days ago
JSON representation

Host: GitHub
URL: https://github.com/mahamodulhasanmoon/headless-radix-connect
Owner: mahamodulhasanmoon
License: other
Created: 2023-11-06T17:27:03.000Z (about 1 year ago)
Default Branch: main
Last Pushed: 2023-11-06T17:27:07.000Z (about 1 year ago)
Last Synced: 2024-04-21T18:04:06.866Z (7 months ago)
Language: TypeScript
Size: 346 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# Headless Radix Connect

> ⚠️ **Warning**:
> This code is experimental and not meant to be used in a production environment. Use on your own risk.

## Why use this?

Headless Radix Connect enables use cases where a user does not have access to a browser/connector extension, e.g. telegram bot or in-game transactions.

## What is this?

A nodejs express server that establishes a p2p connection through webRTC to send dApp requests to the Radix Wallet.

## Getting started

```bash
# install dependencies
npm install

# dev server runs on http://localhost:3000
npm run dev
```

## Radix Wallet preparations

Make sure that the wallet has `Developer mode` enabled

![Alt text](docs/developer-mode.png)

Gateway is set to Stokenet

![Alt text](docs/gateway.png)

## Running the code

The first time you run the dev server you will see a QR code containing the connection password (32 byte random string).

![QR code](docs/qr.png)

Add link by Clicking `Link new Connector` and scanning the QR code.

![Link connector](docs/link.png)

## Connection password

For convenience the connection password is stored in the file system at the project root level. If you want to display the QR code again run `npm run reset` or manually delete `connection-password.txt`.

## License

All code in this repository is licensed under the modified MIT license described in [LICENSE](/LICENSE).