Skip to content

Commit

Permalink
arc26k
Browse files Browse the repository at this point in the history
  • Loading branch information
Tasos Bitsios committed Oct 7, 2024
1 parent 1dd146c commit 5d2ac31
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions ARCs/arc-0026-k.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,13 +12,13 @@ created: 2024-10-02

## Abstract

This URI specification represents an extension to the base Algorand URI encoding standard (ARC-26) that specifies encoding of consensus participation key registration transactions through deeplinks, QR codes, etc.
This URI specification represents an extension to the base Algorand URI encoding standard ([ARC-26](./arc-0026.md)) that specifies encoding of key registration transactions through deeplinks, QR codes, etc.

## Specification

### General format

As in ARC-26, URIs follow the general format for URIs as set forth in <a href="https://www.rfc-editor.org/rfc/rfc3986">RFC 3986</a>. The path component consists of an Algorand address, and the query component provides additional transaction parameters.
As in [ARC-26](./arc-0026.md), URIs follow the general format for URIs as set forth in <a href="https://www.rfc-editor.org/rfc/rfc3986">RFC 3986</a>. The path component consists of an Algorand address, and the query component provides additional transaction parameters.

Elements of the query component may contain characters outside the valid range. These must first be encoded according to UTF-8, and then each octet of the corresponding UTF-8 sequence must be percent-encoded as described in RFC 3986.

Expand All @@ -43,40 +43,40 @@ fee = "fee=" *qdigit
otherparam = qchar *qchar [ "=" *qchar ]
```

- "qbase64url" corresponds to valid characters of "base64url" encoding, as defined in [RFC 4648 section 5](https://www.rfc-editor.org/rfc/rfc4648.html#section-5)
- "qbase64url" corresponds to valid characters of "base64url" encoding, as defined in <a href="https://www.rfc-editor.org/rfc/rfc4648.html#section-5">RFC 4648 section 5</a>
- "qchar" corresponds to valid characters of an RFC 3986 URI query component, excluding the "=" and "&" characters, which this specification takes as separators.

As in the base ARC-26 standard, the scheme component ("algorand:") is case-insensitive, and implementations must accept any combination of uppercase and lowercase letters. The rest of the URI is case-sensitive, including the query parameter keys.
As in the base [ARC-26](./arc-0026.md) standard, the scheme component ("algorand:") is case-insensitive, and implementations must accept any combination of uppercase and lowercase letters. The rest of the URI is case-sensitive, including the query parameter keys.

### Query Keys

- address: Algorand address of transaction sender

- type: fixed to "keyreg". Used to disambiguate the transaction type from the base ARC-26 standard and other possible extensions
- type: fixed to "keyreg". Used to disambiguate the transaction type from the base [ARC-26](./arc-0026.md) standard and other possible extensions

- votekeyparam: The vote key parameter to use in the transaction. Encoded with [base64url](https://www.rfc-editor.org/rfc/rfc4648.html#section-5) encoding.
- votekeyparam: The vote key parameter to use in the transaction. Encoded with <a href="https://www.rfc-editor.org/rfc/rfc4648.html#section-5">base64url</a> encoding.

- selkeyparam: The selection key parameter to use in the transaction. Encoded with [base64url](https://www.rfc-editor.org/rfc/rfc4648.html#section-5) encoding.
- selkeyparam: The selection key parameter to use in the transaction. Encoded with <a href="https://www.rfc-editor.org/rfc/rfc4648.html#section-5">base64url</a> encoding.

- sprfkeyparam: The state proof key parameter to use in the transaction. Encoded with [base64url](https://www.rfc-editor.org/rfc/rfc4648.html#section-5) encoding.
- sprfkeyparam: The state proof key parameter to use in the transaction. Encoded with <a href="https://www.rfc-editor.org/rfc/rfc4648.html#section-5">base64url</a> encoding.

- votefstparam: The first round valid parameter to use in the transaction.

- votelstparam: The last round valid parameter to use in the transaction.

- votekdparam: The key dilution key parameter to use in the transaction.

- xnote: As in ARC-26. A URL-encoded notes field value that must not be modifiable by the user when displayed to users.
- xnote: As in [ARC-26](./arc-0026.md). A URL-encoded notes field value that must not be modifiable by the user when displayed to users.

- note: As in ARC-26. A URL-encoded default notes field value that the the user interface may optionally make editable by the user.
- note: As in [ARC-26](./arc-0026.md). A URL-encoded default notes field value that the the user interface may optionally make editable by the user.

- fee: Optional. A static fee to set for the transaction in microAlgos. Useful to signal intent to receive participation incentives (e.g. with a 2,000,000 microAlgo transaction fee.)

- (others): optional, for future extensions

### Appendix

This section contains encoding examples. The raw transaction object is presented along with the resulting arc26k URI encoding.
This section contains encoding examples. The raw transaction object is presented along with the resulting ARC-26-K URI encoding.

#### Encoding with minimum fee

Expand Down

0 comments on commit 5d2ac31

Please sign in to comment.