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.

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

Create a standardised URI schema #15

Open
owenvoke opened this issue Sep 6, 2019 · 0 comments
Open

Create a standardised URI schema #15

owenvoke opened this issue Sep 6, 2019 · 0 comments

Comments

@owenvoke
Copy link
Member

owenvoke commented Sep 6, 2019

Description

We currently have a format for QR metadata content, it would be good to standardise a URI schema that can be used in future. Both for links, QR codes, and NFC tags.

Wallet QRs currently use the format:

{address}|{publicKey}|{privateKey}

Transaction QRs currently use the format:

arosend|{address}|{value}|{message}

Possible implementation

URI Scheme

All Arionum URLs should start with the arionum prefix. For example, arionum://send.

URI Endpoints

Send

The send endpoint is used for sending transactions to a specific address, alias, or public key.

# Sending to an address, alias, or public key
GET arionum://send?address=[address]
GET arionum://send?alias=[alias]
GET arionum://send?public-key=[publicKey]

# Sending a specific value
GET arionum://send?value=[value]

# Sending with a specific message
GET arionum://send?message=[message]

# Sending to an address with a pre-filled value and message
GET arionum://send?address=[address]&value=[value]&message=[message]

Account

The account endpoint is used for registering account details. The values can be combined to register a full keypair, or used individually.

# Register one or more values for an account
GET arionum://account?address=[address]
GET arionum://account?public-key=[publicKey]
GET arionum://account?private-key=[privateKey]

# Register a full keypair
GET arionum://account?public-key=[publicKey]&private-key=[privateKey]

Verify

The verify endpoint is used for verifying a signature matches the specified input data.

GET arionum://verify?data=[data]&signature=[signature]&public-key=[publicKey]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant