Algorand xGov Beta

This document describes the architecture of the xGov process (Beta).

Specifically, the architecture aims to solve the following main requirement:

The xGov process is a trustless voting system to manage grant proposals funding and polls for the Algorand ecosystem.

The design takes a step towards this end goal, which is a fully decentralized application relying uniquely on a front-end and the Algorand Virtual Machine (AVM).

The current design minimizes the trust model and the off-chain footprint to a few operations, carried out by a back-end controlled by the Algorand Foundation, which could be pushed on the AVM in future iterations.

It is worth noting that the residual trusted off-chain operations are fully accountable on the Algorand public Ledger.

Motivation

The old xGov process (Alpha) has shown some weaknesses concerning the incentive alignment, the gamification risks of the voting system, and low-quality proposals.

Moreover, the old grant proposal submission and funding mechanism were based on a per-quarter schedule, making the whole process slow and inflexible.

Therefore, a more robust process with a continuous stream of grant proposals, votes, and funding is desirable.

Finally, given the shift of the Algorand protocol towards consensus incentivization, the xGov (Beta) voting power will be based on active consensus participation instead of ALGO locking periods (Alpha).

Architecture Overview

The xGov Architecture consists of the following components:

The on-chain components are used for:

1. Onboarding xGov;
2. Whitelisting Proposers (KYC required);
3. Creating and submitting Proposals;
4. Binding xGov Committees to Proposals;
5. Voting on Proposals;
6. Managing the xGov Treasury and funding approved Proposals.

The off-chain components are used for:

1. Selecting xGov Committees periodically and verifiably, according to ARC-86;
2. Intermediate Proposers’ KYC;
3. Intermediate onboarding of xGovs that cannot execute a self-onboarding.

Reading Guidelines

The keywords “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document, are to be interpreted as described in RFC 2119.

The data types (like uint64, byte[], etc.) in this document are to be interpreted as specified in ARC-4.

📝 NOTE

Notes like this are non-normative

📎 EXAMPLE

Sections like this are examples aiming to clarify the specifications.

Sections like this are either pseudo-code or data structures.

Math Symbols

For a correct rendering of mathematical symbols and formulas, it is recommended to right-click on the symbol below, and select Math Settings -> Math Renderer -> Common HTML from the drop-down menu.

$$ \mathcal{C} $$

Once MathJax rendering is correctly set, you should see a calligraphic “C”.

xGov Registry

The xGov Registry is the orchestrator of the xGov process. It is used to:

• Manage the role-based access control of the process;

• Onboard xGovs;

• Onboard and enable Proposers (KYC required);

• Create Proposals;

• Bind the xGov Committees to Proposals;

• Vote on Proposals;

• Manage the xGov Treasury and funding approved Proposals.

The xGov Registry is implemented as an Application, deployed by the original xGov Manager.

Roles

xGov Manager

The xGov Manager is an Algorand Address controlled by the Algorand Foundation.

It represents the root of trust for the xGov process.

RBAC

The xGov Manager MAY rotate itself.

The xGov Manager MUST provide and MAY update the xGov Committee Manager Address.

The xGov Manager MUST provide and MAY update the xGov Daemon Address.

The xGov Manager MUST provide and MAY update the xGov Council Address.

The xGov Manager MUST provide and MAY update the xGov Payor.

The xGov Manager MUST provide and MAY update the xGov Subscriber Address.

The xGov Manager MUST provide and MAY update the KYC Provider Address.

Configuration and Updates

The xGov Manager MAY pause the xGov Registry.

The xGov Manager MAY pause the creation of new Proposals.

The xGov Manager MAY update the xGov Registry anytime.

The xGov Manager MAY reconfigure the parameters of the xGov Registry.

The xGov Manager MUST NOT reconfigure the xGov Registry in case of pending Proposals.

Treasury Management

The xGov Manager MAY execute withdrawals of outstanding funds from the xGov Treasury.

xGov Committee Manager

The xGov Committee Manager is an Algorand Address controlled by the Algorand Foundation.

The xGov Committee Manager SHALL declare the xGov Committee currently in charge on the xGov Registry.

xGov Daemon

The xGov Daemon is an Algorand Address controlled by the Algorand Foundation (back-end).

The xGov Daemon SHALL assign the xGov Committee currently in charge (and their voting power) to open Proposals.

The xGov Daemon SHALL delete the xGov Committee assigned to a Proposal once the voting is over (see Proposal Finalization section).

xGov Council

The xGov Council is an Algorand Address representing a group of elected Councilors.

The xGov Council MUST have an odd number of Councilors.

The xGov Council MUST review approved Proposals (see Proposal review section).

The xGov Council MAY apply a veto against approved Proposals according to the terms and conditions of the xGov process.

The xGov Council majority vote is REQUIRED to apply a veto against approved proposals.

xGov Payor

The xGov Payor is an Algorand Address controlled by the Algorand Foundation.

The xGov Payor MAY disburse the requested funds for approved and reviewed Proposals if there are enough funds in the xGov Treasury.

xGov Subscriber

The xGov Subscriber is an Algorand Address controlled by the Algorand Foundation.

The xGov Subscriber MAY onboard xGovs who cannot execute a self-subscription (e.g., due to contract immutability or other restrictions).

Treasury

The xGov Treasury is an Algorand Address controlled by the xGov Registry.

Treasury Inflows

• Governance funds from the Algorand Foundation;

• xGov Fee deposits from xGovs on subscription/request;

• Proposer Fees from Proposers on subscription;

• Open Proposal Fees from Proposers on proposal submission;

• Proposal Commitment from Proposal Escrows if a veto is applied to the Proposal.

Treasury Outflows

• Partial Open Proposal Fees to Proposal Escrow on Proposal submission;

• Proposal Funds to the Proposer on proposal payment;

• Algorand Foundation withdrawals of outstanding funds.

Treasury MBRs

• Treasury Application Account;

• xGov Boxes;

• Proposer Boxes;

• Created Proposal Applications.

📝 NOTE

Partial Open Proposal Fees are equal to the Open Proposal Fee discounted by the Proposal Application MBR.

xGovs

An xGov MUST have an Algorand Address.

An xGov MUST provide a Voting Address.

It is RECOMMENDED to provide a Voting Address different from the xGov Address, to facilitate voting operation on behalf of the xGov Address (supposed to be secure and less accessible).

The xGov Address and the current Voting Address MAY update the Voting Address.

📝 NOTE

xGov Address can be associated with any Account type. This ensures the compatibility and inclusivity of xGov participation (direct or delegated).

Subscription

The xGov Registry provides two xGov subscription procedures:

• Self-Subscription: the xGov Address MUST call the xGov Registry.

• Managed-Subscription: the ownership of the xGov App Address is verified off-chain, by the Algorand Foundation, according to a pre-defined trust model. The Managed-Onboarding is executed in two steps:

  1. Users issue a Subscription Request, declaring the xGov App Address, the Application Owner Address, and a Relation Type (enumerative that identifies a pre-defined trust model).

  2. The Algorand Foundation verifies the declared and accountable xGov/Owner Addresses relationship off-chain (based on the Relation Type) and eventually approves it.

📝 NOTE

For further details about existing and new Relation Types, refer to the Relation Types section.

An xGov Fee MUST be paid to the xGov Treasury for the subscription or subscription request.

📝 NOTE

The xGov Manager MAY update the xGov Fee.

The xGov Fee has the following scope:

1. Minimal deterrent for Sybil attacks;

2. Covering the xGov Box MBR (see below).

xGov Box

An xGov is associated with a Box on the xGov Registry, called xGov Box.

xGov Box ID is equal to: [X||<xgov address>], where X is a domain separation prefix and || denotes concatenation.

An xGov Box has the following ABI schema:

{
    "voting_addr": "address",
    "voted_proposals": "uint64",
    "last_vote_timestamp": "uint64",
    "subscription_round": "uint64"
}

The xGov Fee MUST NOT be lower than the xGov Box MBR.

xGov Self-Subscription

The xGov Fee MUST be paid to the xGov Treasury upon xGov Box creation.

The xGov Fee MAY NOT be paid by the xGov Address.

The Voting Address declared on subscription MUST BE assigned to the xGov Box.

xGov Managed-Subscription

An xGov Subscription Request is associated with a Box on the xGov Registry, called xGov Subscription Request Box.

The xGov Fee MUST be paid to the xGov Treasury upon xGov Subscription Request Box creation.

The xGov Fee MAY NOT be paid by the xGov Address.

xGov Subscription Request Box ID is equal to: [R||<counter>], where R is a domain separation prefix, <counter> is a global counter for pending requests, and || denotes concatenation.

An xGov Subscription Request Box has the following ABI schema:

{
    "xgov_addr": "address",
    "owner_addr": "address",
    "relation_type": "uint64"
}

The xGov Subscription Request MUST be performed by the Owner Address.

The xGov Fee MUST NOT be lower than the xGov Subscribe Request Box MBR.

If the Algorand Foundation approves the subscription request:

1. The xGov Subscription Request Box MUST be destroyed;

2. An xGov Box MUST be created using the xGov Address declared on the subscription request.

3. The Owner Address declared on the subscription request MUST be assigned to the Voting Address in the created xGov Box.

Relation Types

A Relation Type identifies the trust model and the off-chain verification process of the xGov App Address ownership for a Managed-Subscription.

New Relation Type Request

A request for a new Relation Type SHALL be submitted by the Application Creator opening a new Relation Type Request issue.

A Relation Type MUST be approved by the Algorand Foundation.

Available Relation Type

The following enumerative relation_type (uint64) are currently available:

Relation Type 1: Réti Pooling

Réti Validators are created by an immutable factory contract.

A Validator is uniquely owned by an immutable Owner Address.

Each Validator may control several Staking Pools, which participate in Algorand consensus.

To request a Managed Subscription for a Réti Staking Pool:

• The relation_type MUST be set to 1;
• The owner_addr MUST be set to the Validator Owner Address;
• The xgov_addr MUST be set to the Staking Pool Address.

Relation Type 2: Compx LST

TBD

xGov Committee

xGov Committees are responsible for voting on Proposals.

Selection

The xGov Committee selection and the assignment of their voting power is performed by the Algorand Foundation, based on the selection criteria defined in ARC-0086.

An xGov Committee is identified by the Committee ID, as defined in ARC-0086.

Declaration

The xGov Committee Manager SHALL declare on the xGov Registry:

• The current Committee ID;

• The current xGov Committee Total Members;

• The current xGov Committee Total Votes.

Assignment to Proposal

The xGov Daemon SHALL assign the current xGov Committee to Proposals upon creation (see Proposal Creation section).

Proposers

A Proposer MUST have an Algorand Address.

KYC

A Proposer MUST have a valid or invalid KYC status, defined by a KYC process.

The Proposer KYC status MUST have an expiration date.

The KYC Provider SHALL update the Proposer KYC status after the KYC process.

The KYC Provider MAY update the Proposer KYC during its validity.

The Proposer KYC status MUST be valid and not expired to receive Proposal funding.

Subscription

A Proposer Fee MUST be paid to the xGov Treasury for the subscription.

📝 NOTE

The xGov Manager MAY modify the Proposer Fee.

The Proposer Fee has the following scope:

1. Covering the KYC process costs;

2. Covering the Proposer Box MBR (see below).

Proposer Box

A Proposer is associated with a Box on the xGov Registry, called Proposer Box.

The Proposer Fee MUST be paid to the xGov Treasury upon creating the Proposer Box.

The Proposer SHOULD pay the Proposer Fee.

Proposer Box ID is equal to [P||<proposer address>], where P is a domain separation prefix and || denotes concatenation.

A Proposer Box has the following ABI schema:

{
    "active_proposal": "bool",
    "kyc_status": "bool",
    "kyc_expiring": "uint64"
}

The Proposer Fee MUST NOT be lower than the Proposer Box MBR.

Proposal

A Proposal is a funding request from the xGov Treasury, which is approved or rejected by the xGov Committee vote and reviewed by the xGov Council.

A Proposal consists of:

• Proposal Application, with REQUIRED data;

• Proposal metadata.

The Proposal Application is created and funded by the xGov Registry App (see Creation section) through the Open Proposal Fee.

Lifecycle

The Proposal life cycle has four phases:

1. Creation;

2. Discussion & Submission;

3. Vote & Review;

4. Finalization.

Funding Types

The Proposals have two different funding types:

1. Retroactive

   • Claim: “I have done X, which has benefited the Algorand ecosystem because of Y metrics, I would like to receive Z as compensation for the work”.

   • Positive outcome: funding is immediately disbursed if the Proposal is approved by the xGov Committee vote, and the xGov Council does not apply a veto according to the terms and conditions.

2. Proactive (NOT AVAILABLE YET)

   • Claim: “I want to do X, it has the potential Y for the Algorand ecosystem, I would like to receive Z staggered behind these milestones”.

   • Positive outcome: funding will be disbursed if the Proposal is approved by the xGov Committee vote, after milestone reviews from the xGov Council, and if the xGov Council does not apply a veto according to terms and conditions.

Funding Sizes

Proposals have different funding sizes based on the requested funding amount.

The funding size defines the timing of the Proposal lifecycle and the voting quorums.

The Proposal’s requested amount (\( A \)) MUST be bounded as follows:

📝 NOTE

Refer to the Proposal implementation configuration for the parameters’ value.

Metadata

The Proposal Metadata byte length MUST NOT exceed 30 kB.

The Proposal Metadata is stored in a Box on the Proposal Application, called Metadata Box.

The Proposal Metadata Box ID is equal to metadata.

The Proposal Metadata Box body has no ABI schema (raw bytes).

Finite-State Machine

A Proposal SHALL be in one of the following enumerated statuses:

📝 NOTE

The FINALIZED boolean flag is not an enumerated state, since it can be superposed to several states (i.e., EMPTY, DRAFT, REJECTED, BLOCKED, and FUNDED). Example: a Proposal can be FUNDED and FINALIZED.

Escrow

The Proposal Escrow is an Address controlled by the Proposal Application.

Escrow Inflows

• Partial Open Proposal Fees from xGov Treasury

• Proposal Commitment Lock from the Proposer

Escrow Outflows

• Operation Funds to xGov Daemon on Proposal submission

• Proposal Commitment Lock to xGov Treasury if the Proposal is blocked with a veto

• Decommissioned MBRs to xGov Treasury

Escrow MBRs

• Proposal Application Account

• Metadata Box

• xGov Committee Voters Boxes

Creation

Proposers can create a Proposal at any time.

The Proposer MUST provide the following REQUIRED data to open a Proposal:

• Title: a short name for the Proposal;

• Focus: an enumerative focus area (e.g., Wallets, SDKs, etc.);

• Funding Type: enumerative for Retroactive or Proactive (currently just Retroactive);

• Requested Amount (in 𝜇ALGO).

A Proposer MUST NOT have more than one active proposal at any time.

The Proposer creates a Proposal Application from the xGov Registry.

Upon Proposal creation, an Open Proposal Fee MUST be paid to the xGov Treasury.

The Open Proposal Fee MUST NOT be lower than the sum of:

• Proposal Application MBR;

• Proposal Escrow Account MBR;

• Full Metadata Box MBR;

• Daemon Operations Funding.

The Proposal Application MBR is deducted from the Open Proposal Fee; the remainder MUST be entirely transferred to the Proposal Escrow.

📝 NOTE

The xGov Manager MAY update the Proposal Fee.

The remainder of the Open Proposal Fee MUST cover the MBR of all the Boxes required by the xGov Committee assigned to the Proposal upon opening.

📎 EXAMPLE

Given a Proposer Voter Box size, the Open Proposal Fee amount SHOULD be proportional to the xGov Committee size. The Voter Box MBR is roughly \( 0.02 \) ALGO. Example: an xGov Committee of \( 500 \) voters requires roughly \( 10 \) ALGO of MBR to the Proposal Application.

The Proposer SHOULD pay the Open Proposal Fee.

The Open Proposal Fee has the following scope:

1. Anti-spam measure;

2. Covering Proposal Escrow Account MBR;

3. Covering Proposal Metadata Box MBR;

4. Covering xGov Committee Boxes MBR (introduced later).

5. Covering xGov Daemon operation fees for the Proposal.

Upon opening the Proposal Draft, the Proposer MUST lock in the Proposal Escrow a percentage of the requested funding amount as a commitment.

📝 NOTE

The xGov Manager MAY update the percentage of the requested funding amount to commit.

The locked amount SHALL be either:

• Returned to the Proposer when the Proposal is:

  • Funded or Rejected;
  • Dropped by the Proposer before submission.

• Slashed if the Proposal is blocked with a veto by the xGov Council.

Upon proposal opening, the xGov Committee ID, total members, and total voting power MUST be fetched from the xGov Registry and assigned to the Proposal.

The xGov Daemon MAY finalize the Empty Proposal if it becomes stale (the Proposer does not open a Draft).

Discussion

The Proposer MAY update the Proposal Metadata during the discussion phase.

The Proposer SHALL NOT change the Proposal REQUIRED data (e.g., the requested amount) during the discussion phase.

To change the Proposal REQUIRED data, the Proposer MUST drop the Proposal Draft and open a new one.

Submission

The Proposer SHALL submit the Draft Proposal after the minimum discussion period (depending on the Proposal funding size).

The xGov Daemon MAY finalize the Draft Proposal if it becomes stale (the Proposer does not submit the Draft).

The Proposal Metadata SHOULD be submitted from the xGov Portal (front-end).

The Proposal MUST NOT be submitted without Metadata.

Upon proposal submission, a percentage of the Open Proposal Fee SHALL be transferred from the Proposal Escrow to the xGov Daemon to cover the operation fees.

📝 NOTE

The xGov Manager MAY update the percentage of the Open Proposal Fee transferred to the xGov Daemon.

xGov Committee Assignment

The xGov Daemon SHALL assign the xGov Committee of the Submitted Proposal.

The assigned xGov Committee MUST have the size (total members) and voting power (total votes) of the xGov Committee ID (see xGov Committee section).

The Proposal status MUST be set to Voting once the xGov Committee is completely assigned.

Voters

The xGov Committee Voters are represented by a set of Boxes on the Proposal Application (one box per xGov Committee Member), called the Voter Box.

The xGov Daemon SHALL create all the Voter Boxes once the Proposal is Submitted.

Voter Box MBR MUST be covered by the Partial Open Proposal Fee.

Voter Box ID is equal to [V||<xgov address>], where V is a domain separation prefix, <xgov address> is the same as used by the xGov upon subscription, and || denotes concatenation.

A Voter Box has the following ABI schema:

{
    "votes": "unit32",
    "voted": "bool"
}

Vote Opening

The Submitted Proposal MUST be promoted to Voting once the xGov Committee has been completely assigned.

The duration of the voting session depends on the Proposal funding sizes.

The Voting Proposal MUST stay open until either:

• All the xGov Committee members have voted, or

• The voting duration expires.

Votes

xGovs vote MUST BE either “Approve”, “Reject”, or “Null”.

xGovs MAY abstain from voting.

xGovs SHALL vote once per Proposal: the allocation of “Approve”, “Reject”, and “Null” votes MUST be simultaneous.

Vote usage MAY be partial. Unused votes are default “Null”.

The sum of “Approve”, “Reject”, and “Null” votes of each xGov MUST equal to the xGov voting power.

Vote SHALL NOT be modified.

📎 EXAMPLE

Pooled Vote Example: Let’s have an xGov Staking Pool with N votes. The Pool SHOULD collect poolers’ opinions before expressing the Pool vote accordingly. Once the Pool is ready to vote, the allocation of N votes among “Approve”, “Reject”, or “Null” is simultaneous and can no longer be modified.

Voting Outcome

A Submitted Proposal is Approved if and only if all the following conditions hold:

• A category-dependent democratic quorum of all xGov Committee (one xGov, one vote) is reached. “Null” votes affect this quorum.

• A category-dependent weighted quorum of all xGov Committee voting power is reached. “Null” votes affect this quorum.

• The relative majority of “Approve” over “Reject” votes is reached. “Null” votes do not affect the relative majority.

And it is Rejected otherwise.

The Commitment Lock MUST be returned to the Proposer if the Proposal is Rejected.

Review

The xGov Council MUST review Approved Proposals.

The xGov Council MAY apply a veto to an Approved Proposal.

An Approved Proposal is considered either:

• Blocked, if the veto is applied;

• Reviewed, if the veto is not applied.

In case of a Blocked Proposal:

• The requested amount MUST NOT be paid.

• The Commitment Lock MUST be transferred (slashed) from the Proposal Escrow to the xGov Treasury.

Finalization

Payment

The xGov Payor MAY pay a Reviewed Proposal and promote it to Funded.

If the Proposal is Funded:

• The requested amount MUST BE transferred from the xGov Treasury to its Proposer.

• The Commitment Lock MUST be returned to the Proposer.

Finalize

The xGov Daemon SHOULD finalize:

• Empty and Draft Proposals, after a stale period,

• Funded, Rejected, or Blocked Proposals.

If a Draft Proposal is finalized, the Commitment Lock MUST be returned to the Proposer.

The xGov Daemon SHALL delete the Voter Boxes of Funded, Rejected, or Blocked Proposals.

All Voter Box MUST be deleted before finalizing the Proposal.

Outstanding balance of the Proposal Escrow MUST be returned to the xGov Treasury.

Delete

The xGov Manager MAY delete Finalized Proposals.

The Proposal Metadata MUST be deleted before deletion (Empty Proposals are an exception).

Proposal Escrow MUST be closed to the xGov Treasury before deletion.

Numeric Precisions

Percentages

All the percentages MUST have a precision of two decimals and be expressed as basis-points (bps) scaled as Algorand Virtual Machine (AVM) uint64.

📎 EXAMPLE

The AVM works with uint64, therefore \( 100.00 \% = 10{,}000 \mathrm{bps} \). So, \( 12.5 \% \) of \( X \) is calculated on the AVM as:

$$ \frac{1{,}250 \mathrm{bps} \times X}{10{,}000 \mathrm{bps}}. $$

Testing

xGov Architecture uses the PyTest framework for unit tests and end-to-end tests.

PyTest fixtures are organized hierarchically in the tests folder: fixtures defined in the conftest.py file at higher levels are available to all the nested-level tests.

Configuration

Deployment

xGov Registry

xGov Council

App Specs

CI/CD

Branch Management

---
title: Trunk-based with CD
---
%%{init: { 'logLevel': 'debug', 'theme': 'base', 'gitGraph': {'showBranches': true, 'showCommitLabel':true,'mainBranchName': 'main'}} }%%
gitGraph
   commit tag: "0.37.0"

   branch "feat/add-foo-123"
   branch "feat/add-bar-123"

   checkout "feat/add-foo-123"
   commit id: "feat(foo): ..."
   commit id: "doc(foo): ..."
   checkout main
   merge "feat/add-foo-123" tag: "v1.0.0.canary.1"

   branch "feat/add-baz-123"
   commit id: "feat(baz): ..."
   commit id: "doc(baz): ..."
   commit id: "test(baz): ..."

   checkout "feat/add-bar-123"
   commit id: "chore(bar): ..."
   commit id: "feat(bar): ..."
   checkout main
   merge "feat/add-bar-123" tag: "v1.0.0.canary.2"

   checkout main
   branch "version/1.0.0"
   commit id: "bump(v1.0.0): pyproject.toml"

   checkout main
   branch release
   merge "version/1.0.0"
   commit id: "release(v1.0.0): ..." tag: "v1.0.0"

   checkout main
   merge release
   checkout main
   merge "feat/add-baz-123" tag: "v1.1.0.canary.1"

Protected Branches

• main (default), the trunk
• release

The trunk is considered stable and MUST:

• Reject commits not included in a Pull Request
• Require Docs and TestNet deployments to be healthy to accept commits from release
• Meet the quality criteria defined in the CI/CD pipeline

The release branch MUST:

• Be kept in sync with main
• Be used to generate release tags
• Reject commits from branches other than main that are:
  • Not included in a Pull Request
  • Have a diff that is not strictly equal to the pyproject.toml version bump.

The CI/CD pipeline ensures that:

• The main branch contains release-grade code at any time (both for Smart Contracts and Docs)

• The release branch is synced with main and used only to generate release tags (reflected as pyproject.toml version)

Unprotected Branches

Features, major refactoring, dependency bumps, or bugfixes SHALL be carried out on a dedicated unprotected branch pointing to the trunk (main).

The pyproject.toml release version bumps SHALL be carried out on a dedicated unprotected branch pointing to the release branch.

Draft Pull Requests from unprotected branches, either to main or release, SHOULD skip the CI.

Deployments

The CD makes use of the following deployment environments:

• github-pages: to host the static documentation (mdBook)

• contract-testnet: to continuously deploy Smart Contracts to the Algorand TestNet

• contract-mainnet: to deploy Smart Contracts to the Algorand MainNet on release

Implementation

The CI/CD pipeline is implemented with the following automated workflows:

• Smart Contracts CI (tests, lint, output stability, mock deployment)

• Smart Contracts CD (to TestNet)

• Documentation CI (tests, lint)

• Documentation CD (to GitHub Pages)

• Release CI (validate release tag, version, etc.)

• Release (to MainNet)

And two manually dispatchable workflows:

• xGov Registry parameters configuration
• xGov Registry RBAC management

Security Policy

We take the security of the xGov architecture very seriously. This document outlines our security policy and the process for reporting vulnerabilities.

Reporting a Vulnerability

If you discover a security vulnerability, we ask that you report it to us as quickly as possible.

Please:

• Do not disclose it publicly,
• Do not create an issue/pull request on GitHub.

Private Disclosure Process

To ensure the security of the xGov platform, we require all vulnerability findings to be disclosed privately.

Please follow these guidelines:

1. Reporting Channel: All bug reports MUST be submitted to the dedicated Algorand Foundation security email address: security@algorand.foundation.

2. Confidentiality: All communications and information shared during the disclosure process MUST be kept confidential.

3. No Public Disclosure: Please do not publicly disclose any vulnerability until it has been patched and approved for public release by the Algorand Foundation. Unauthorized public disclosure will result in disqualification from the bug bounty program.

4. Documentation: Your report should be as detailed as possible, including:

   • Repository version and commit hash.
   • A clear description of the vulnerability.
   • Steps to reproduce the vulnerability.
   • Any relevant proof-of-concept code or scripts.
   • The potential impact of the vulnerability.
   • Recommendations for remediation, if applicable.
   • A template table with finding logs on the source code references, example:

Upon receiving your report, the Algorand Foundation security team will acknowledge the receipt and begin the validation process.

The security team will communicate with you regularly regarding the status of your submission and any necessary follow-up.

Bug Bounty

The Algorand Foundation offers a bug bounty focused on the smart contracts that power the xGov Beta program.

This initiative aims to enhance the security and robustness of the xGov Beta architecture by leveraging the expertise of the white-hat hacker community.

The bug bounty program rewards participants who successfully identify and privately report vulnerabilities within the xGov Beta smart contracts implementation.

Rewards (in ALGO) will be tiered based on the criticality of the discovered flaws, categorized as follows:

We encourage all interested security researchers to participate and contribute to the secure evolution of the xGov platform.

Contribution Guidelines

The xGov Architecture source code is released on the official GitHub repository.

Issues can be submitted on the GitHub issues page.

External contributions to tests and documentation are welcome. If you would like to contribute, please read these guidelines and consider submitting a Pull Request.

Docs Guidelines

By clicking on the “Suggest an edit” icon in the top-right corner, while reading this book, you will be redirected to the relevant documentation source code file to be referenced in an Issue or edited in a Pull Request.

The xGov Architecture Specifications book is built with mdBook.

The book is written in CommonMark.

The CI pipeline enforces Markdown linting, formatting, and style checking with markdownlint.

Numbered Lists

Numbered lists MUST be defined with 1-only style.

📎 EXAMPLE

1. First item
1. Second item
1. Third item

Result:

1. First item
2. Second item
3. Third item

Tables

Table rows MUST use the same column widths.

📎 EXAMPLE

✅ Correct table format

| Month    | Savings |
|----------|---------|
| January  | €250    |
| February | €80     |
| March    | €420    |

❌ Wrong table format

| Month | Savings |
|----------|---------|
| January | €250 |
| February | €80 |
| March | €420 |

Result:

Month	Savings
January	€250
February	€80
March	€420

Consider aligning text in the columns to the left, right, or center by adding a colon : to the left, right, or on both sides of the dashes --- within the header row.

📎 EXAMPLE

| Name   | Quantity | Size |
|:-------|:--------:|-----:|
| Item A |    1     |    S |
| Item B |    5     |    M |
| Item C |    10    |   XL |

Result:

Name	Quantity	Size
Item A	1	S
Item B	5	M
Item C	10	XL

MathJax

Mathematical formulas are defined with MathJax.

mdBook MathJax documentation.

Block Styles

Block styles are defined in the ./docs/_include/styles.md file using the mdBook include feature.

Block styles (e.g., examples, implementation notes, etc.) are “styled quote” blocks included in the book.

📎 EXAMPLE

This example block has been included with the following syntax:

{{#include ./_include/styles.md:example}}
> This example block has been included with the following syntax:

License

                    GNU AFFERO GENERAL PUBLIC LICENSE
                       Version 3, 19 November 2007

 Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
 Everyone is permitted to copy and distribute verbatim copies
 of this license document, but changing it is not allowed.

                            Preamble

  The GNU Affero General Public License is a free, copyleft license for
software and other kinds of works, specifically designed to ensure
cooperation with the community in the case of network server software.

  The licenses for most software and other practical works are designed
to take away your freedom to share and change the works.  By contrast,
our General Public Licenses are intended to guarantee your freedom to
share and change all versions of a program--to make sure it remains free
software for all its users.

  When we speak of free software, we are referring to freedom, not
price.  Our General Public Licenses are designed to make sure that you
have the freedom to distribute copies of free software (and charge for
them if you wish), that you receive source code or can get it if you
want it, that you can change the software or use pieces of it in new
free programs, and that you know you can do these things.

  Developers that use our General Public Licenses protect your rights
with two steps: (1) assert copyright on the software, and (2) offer
you this License which gives you legal permission to copy, distribute
and/or modify the software.

  A secondary benefit of defending all users' freedom is that
improvements made in alternate versions of the program, if they
receive widespread use, become available for other developers to
incorporate.  Many developers of free software are heartened and
encouraged by the resulting cooperation.  However, in the case of
software used on network servers, this result may fail to come about.
The GNU General Public License permits making a modified version and
letting the public access it on a server without ever releasing its
source code to the public.

  The GNU Affero General Public License is designed specifically to
ensure that, in such cases, the modified source code becomes available
to the community.  It requires the operator of a network server to
provide the source code of the modified version running there to the
users of that server.  Therefore, public use of a modified version, on
a publicly accessible server, gives the public access to the source
code of the modified version.

  An older license, called the Affero General Public License and
published by Affero, was designed to accomplish similar goals.  This is
a different license, not a version of the Affero GPL, but Affero has
released a new version of the Affero GPL which permits relicensing under
this license.

  The precise terms and conditions for copying, distribution and
modification follow.

                       TERMS AND CONDITIONS

  0. Definitions.

  "This License" refers to version 3 of the GNU Affero General Public License.

  "Copyright" also means copyright-like laws that apply to other kinds of
works, such as semiconductor masks.

  "The Program" refers to any copyrightable work licensed under this
License.  Each licensee is addressed as "you".  "Licensees" and
"recipients" may be individuals or organizations.

  To "modify" a work means to copy from or adapt all or part of the work
in a fashion requiring copyright permission, other than the making of an
exact copy.  The resulting work is called a "modified version" of the
earlier work or a work "based on" the earlier work.

  A "covered work" means either the unmodified Program or a work based
on the Program.

  To "propagate" a work means to do anything with it that, without
permission, would make you directly or secondarily liable for
infringement under applicable copyright law, except executing it on a
computer or modifying a private copy.  Propagation includes copying,
distribution (with or without modification), making available to the
public, and in some countries other activities as well.

  To "convey" a work means any kind of propagation that enables other
parties to make or receive copies.  Mere interaction with a user through
a computer network, with no transfer of a copy, is not conveying.

  An interactive user interface displays "Appropriate Legal Notices"
to the extent that it includes a convenient and prominently visible
feature that (1) displays an appropriate copyright notice, and (2)
tells the user that there is no warranty for the work (except to the
extent that warranties are provided), that licensees may convey the
work under this License, and how to view a copy of this License.  If
the interface presents a list of user commands or options, such as a
menu, a prominent item in the list meets this criterion.

  1. Source Code.

  The "source code" for a work means the preferred form of the work
for making modifications to it.  "Object code" means any non-source
form of a work.

  A "Standard Interface" means an interface that either is an official
standard defined by a recognized standards body, or, in the case of
interfaces specified for a particular programming language, one that
is widely used among developers working in that language.

  The "System Libraries" of an executable work include anything, other
than the work as a whole, that (a) is included in the normal form of
packaging a Major Component, but which is not part of that Major
Component, and (b) serves only to enable use of the work with that
Major Component, or to implement a Standard Interface for which an
implementation is available to the public in source code form.  A
"Major Component", in this context, means a major essential component
(kernel, window system, and so on) of the specific operating system
(if any) on which the executable work runs, or a compiler used to
produce the work, or an object code interpreter used to run it.

  The "Corresponding Source" for a work in object code form means all
the source code needed to generate, install, and (for an executable
work) run the object code and to modify the work, including scripts to
control those activities.  However, it does not include the work's
System Libraries, or general-purpose tools or generally available free
programs which are used unmodified in performing those activities but
which are not part of the work.  For example, Corresponding Source
includes interface definition files associated with source files for
the work, and the source code for shared libraries and dynamically
linked subprograms that the work is specifically designed to require,
such as by intimate data communication or control flow between those
subprograms and other parts of the work.

  The Corresponding Source need not include anything that users
can regenerate automatically from other parts of the Corresponding
Source.

  The Corresponding Source for a work in source code form is that
same work.

  2. Basic Permissions.

  All rights granted under this License are granted for the term of
copyright on the Program, and are irrevocable provided the stated
conditions are met.  This License explicitly affirms your unlimited
permission to run the unmodified Program.  The output from running a
covered work is covered by this License only if the output, given its
content, constitutes a covered work.  This License acknowledges your
rights of fair use or other equivalent, as provided by copyright law.

  You may make, run and propagate covered works that you do not
convey, without conditions so long as your license otherwise remains
in force.  You may convey covered works to others for the sole purpose
of having them make modifications exclusively for you, or provide you
with facilities for running those works, provided that you comply with
the terms of this License in conveying all material for which you do
not control copyright.  Those thus making or running the covered works
for you must do so exclusively on your behalf, under your direction
and control, on terms that prohibit them from making any copies of
your copyrighted material outside their relationship with you.

  Conveying under any other circumstances is permitted solely under
the conditions stated below.  Sublicensing is not allowed; section 10
makes it unnecessary.

  3. Protecting Users' Legal Rights From Anti-Circumvention Law.

  No covered work shall be deemed part of an effective technological
measure under any applicable law fulfilling obligations under article
11 of the WIPO copyright treaty adopted on 20 December 1996, or
similar laws prohibiting or restricting circumvention of such
measures.

  When you convey a covered work, you waive any legal power to forbid
circumvention of technological measures to the extent such circumvention
is effected by exercising rights under this License with respect to
the covered work, and you disclaim any intention to limit operation or
modification of the work as a means of enforcing, against the work's
users, your or third parties' legal rights to forbid circumvention of
technological measures.

  4. Conveying Verbatim Copies.

  You may convey verbatim copies of the Program's source code as you
receive it, in any medium, provided that you conspicuously and
appropriately publish on each copy an appropriate copyright notice;
keep intact all notices stating that this License and any
non-permissive terms added in accord with section 7 apply to the code;
keep intact all notices of the absence of any warranty; and give all
recipients a copy of this License along with the Program.

  You may charge any price or no price for each copy that you convey,
and you may offer support or warranty protection for a fee.

  5. Conveying Modified Source Versions.

  You may convey a work based on the Program, or the modifications to
produce it from the Program, in the form of source code under the
terms of section 4, provided that you also meet all of these conditions:

    a) The work must carry prominent notices stating that you modified
    it, and giving a relevant date.

    b) The work must carry prominent notices stating that it is
    released under this License and any conditions added under section
    7.  This requirement modifies the requirement in section 4 to
    "keep intact all notices".

    c) You must license the entire work, as a whole, under this
    License to anyone who comes into possession of a copy.  This
    License will therefore apply, along with any applicable section 7
    additional terms, to the whole of the work, and all its parts,
    regardless of how they are packaged.  This License gives no
    permission to license the work in any other way, but it does not
    invalidate such permission if you have separately received it.

    d) If the work has interactive user interfaces, each must display
    Appropriate Legal Notices; however, if the Program has interactive
    interfaces that do not display Appropriate Legal Notices, your
    work need not make them do so.

  A compilation of a covered work with other separate and independent
works, which are not by their nature extensions of the covered work,
and which are not combined with it such as to form a larger program,
in or on a volume of a storage or distribution medium, is called an
"aggregate" if the compilation and its resulting copyright are not
used to limit the access or legal rights of the compilation's users
beyond what the individual works permit.  Inclusion of a covered work
in an aggregate does not cause this License to apply to the other
parts of the aggregate.

  6. Conveying Non-Source Forms.

  You may convey a covered work in object code form under the terms
of sections 4 and 5, provided that you also convey the
machine-readable Corresponding Source under the terms of this License,
in one of these ways:

    a) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by the
    Corresponding Source fixed on a durable physical medium
    customarily used for software interchange.

    b) Convey the object code in, or embodied in, a physical product
    (including a physical distribution medium), accompanied by a
    written offer, valid for at least three years and valid for as
    long as you offer spare parts or customer support for that product
    model, to give anyone who possesses the object code either (1) a
    copy of the Corresponding Source for all the software in the
    product that is covered by this License, on a durable physical
    medium customarily used for software interchange, for a price no
    more than your reasonable cost of physically performing this
    conveying of source, or (2) access to copy the
    Corresponding Source from a network server at no charge.

    c) Convey individual copies of the object code with a copy of the
    written offer to provide the Corresponding Source.  This
    alternative is allowed only occasionally and noncommercially, and
    only if you received the object code with such an offer, in accord
    with subsection 6b.

    d) Convey the object code by offering access from a designated
    place (gratis or for a charge), and offer equivalent access to the
    Corresponding Source in the same way through the same place at no
    further charge.  You need not require recipients to copy the
    Corresponding Source along with the object code.  If the place to
    copy the object code is a network server, the Corresponding Source
    may be on a different server (operated by you or a third party)
    that supports equivalent copying facilities, provided you maintain
    clear directions next to the object code saying where to find the
    Corresponding Source.  Regardless of what server hosts the
    Corresponding Source, you remain obligated to ensure that it is
    available for as long as needed to satisfy these requirements.

    e) Convey the object code using peer-to-peer transmission, provided
    you inform other peers where the object code and Corresponding
    Source of the work are being offered to the general public at no
    charge under subsection 6d.

  A separable portion of the object code, whose source code is excluded
from the Corresponding Source as a System Library, need not be
included in conveying the object code work.

  A "User Product" is either (1) a "consumer product", which means any
tangible personal property which is normally used for personal, family,
or household purposes, or (2) anything designed or sold for incorporation
into a dwelling.  In determining whether a product is a consumer product,
doubtful cases shall be resolved in favor of coverage.  For a particular
product received by a particular user, "normally used" refers to a
typical or common use of that class of product, regardless of the status
of the particular user or of the way in which the particular user
actually uses, or expects or is expected to use, the product.  A product
is a consumer product regardless of whether the product has substantial
commercial, industrial or non-consumer uses, unless such uses represent
the only significant mode of use of the product.

  "Installation Information" for a User Product means any methods,
procedures, authorization keys, or other information required to install
and execute modified versions of a covered work in that User Product from
a modified version of its Corresponding Source.  The information must
suffice to ensure that the continued functioning of the modified object
code is in no case prevented or interfered with solely because
modification has been made.

  If you convey an object code work under this section in, or with, or
specifically for use in, a User Product, and the conveying occurs as
part of a transaction in which the right of possession and use of the
User Product is transferred to the recipient in perpetuity or for a
fixed term (regardless of how the transaction is characterized), the
Corresponding Source conveyed under this section must be accompanied
by the Installation Information.  But this requirement does not apply
if neither you nor any third party retains the ability to install
modified object code on the User Product (for example, the work has
been installed in ROM).

  The requirement to provide Installation Information does not include a
requirement to continue to provide support service, warranty, or updates
for a work that has been modified or installed by the recipient, or for
the User Product in which it has been modified or installed.  Access to a
network may be denied when the modification itself materially and
adversely affects the operation of the network or violates the rules and
protocols for communication across the network.

  Corresponding Source conveyed, and Installation Information provided,
in accord with this section must be in a format that is publicly
documented (and with an implementation available to the public in
source code form), and must require no special password or key for
unpacking, reading or copying.

  7. Additional Terms.

  "Additional permissions" are terms that supplement the terms of this
License by making exceptions from one or more of its conditions.
Additional permissions that are applicable to the entire Program shall
be treated as though they were included in this License, to the extent
that they are valid under applicable law.  If additional permissions
apply only to part of the Program, that part may be used separately
under those permissions, but the entire Program remains governed by
this License without regard to the additional permissions.

  When you convey a copy of a covered work, you may at your option
remove any additional permissions from that copy, or from any part of
it.  (Additional permissions may be written to require their own
removal in certain cases when you modify the work.)  You may place
additional permissions on material, added by you to a covered work,
for which you have or can give appropriate copyright permission.

  Notwithstanding any other provision of this License, for material you
add to a covered work, you may (if authorized by the copyright holders of
that material) supplement the terms of this License with terms:

    a) Disclaiming warranty or limiting liability differently from the
    terms of sections 15 and 16 of this License; or

    b) Requiring preservation of specified reasonable legal notices or
    author attributions in that material or in the Appropriate Legal
    Notices displayed by works containing it; or

    c) Prohibiting misrepresentation of the origin of that material, or
    requiring that modified versions of such material be marked in
    reasonable ways as different from the original version; or

    d) Limiting the use for publicity purposes of names of licensors or
    authors of the material; or

    e) Declining to grant rights under trademark law for use of some
    trade names, trademarks, or service marks; or

    f) Requiring indemnification of licensors and authors of that
    material by anyone who conveys the material (or modified versions of
    it) with contractual assumptions of liability to the recipient, for
    any liability that these contractual assumptions directly impose on
    those licensors and authors.

  All other non-permissive additional terms are considered "further
restrictions" within the meaning of section 10.  If the Program as you
received it, or any part of it, contains a notice stating that it is
governed by this License along with a term that is a further
restriction, you may remove that term.  If a license document contains
a further restriction but permits relicensing or conveying under this
License, you may add to a covered work material governed by the terms
of that license document, provided that the further restriction does
not survive such relicensing or conveying.

  If you add terms to a covered work in accord with this section, you
must place, in the relevant source files, a statement of the
additional terms that apply to those files, or a notice indicating
where to find the applicable terms.

  Additional terms, permissive or non-permissive, may be stated in the
form of a separately written license, or stated as exceptions;
the above requirements apply either way.

  8. Termination.

  You may not propagate or modify a covered work except as expressly
provided under this License.  Any attempt otherwise to propagate or
modify it is void, and will automatically terminate your rights under
this License (including any patent licenses granted under the third
paragraph of section 11).

  However, if you cease all violation of this License, then your
license from a particular copyright holder is reinstated (a)
provisionally, unless and until the copyright holder explicitly and
finally terminates your license, and (b) permanently, if the copyright
holder fails to notify you of the violation by some reasonable means
prior to 60 days after the cessation.

  Moreover, your license from a particular copyright holder is
reinstated permanently if the copyright holder notifies you of the
violation by some reasonable means, this is the first time you have
received notice of violation of this License (for any work) from that
copyright holder, and you cure the violation prior to 30 days after
your receipt of the notice.

  Termination of your rights under this section does not terminate the
licenses of parties who have received copies or rights from you under
this License.  If your rights have been terminated and not permanently
reinstated, you do not qualify to receive new licenses for the same
material under section 10.

  9. Acceptance Not Required for Having Copies.

  You are not required to accept this License in order to receive or
run a copy of the Program.  Ancillary propagation of a covered work
occurring solely as a consequence of using peer-to-peer transmission
to receive a copy likewise does not require acceptance.  However,
nothing other than this License grants you permission to propagate or
modify any covered work.  These actions infringe copyright if you do
not accept this License.  Therefore, by modifying or propagating a
covered work, you indicate your acceptance of this License to do so.

  10. Automatic Licensing of Downstream Recipients.

  Each time you convey a covered work, the recipient automatically
receives a license from the original licensors, to run, modify and
propagate that work, subject to this License.  You are not responsible
for enforcing compliance by third parties with this License.

  An "entity transaction" is a transaction transferring control of an
organization, or substantially all assets of one, or subdividing an
organization, or merging organizations.  If propagation of a covered
work results from an entity transaction, each party to that
transaction who receives a copy of the work also receives whatever
licenses to the work the party's predecessor in interest had or could
give under the previous paragraph, plus a right to possession of the
Corresponding Source of the work from the predecessor in interest, if
the predecessor has it or can get it with reasonable efforts.

  You may not impose any further restrictions on the exercise of the
rights granted or affirmed under this License.  For example, you may
not impose a license fee, royalty, or other charge for exercise of
rights granted under this License, and you may not initiate litigation
(including a cross-claim or counterclaim in a lawsuit) alleging that
any patent claim is infringed by making, using, selling, offering for
sale, or importing the Program or any portion of it.

  11. Patents.

  A "contributor" is a copyright holder who authorizes use under this
License of the Program or a work on which the Program is based.  The
work thus licensed is called the contributor's "contributor version".

  A contributor's "essential patent claims" are all patent claims
owned or controlled by the contributor, whether already acquired or
hereafter acquired, that would be infringed by some manner, permitted
by this License, of making, using, or selling its contributor version,
but do not include claims that would be infringed only as a
consequence of further modification of the contributor version.  For
purposes of this definition, "control" includes the right to grant
patent sublicenses in a manner consistent with the requirements of
this License.

  Each contributor grants you a non-exclusive, worldwide, royalty-free
patent license under the contributor's essential patent claims, to
make, use, sell, offer for sale, import and otherwise run, modify and
propagate the contents of its contributor version.

  In the following three paragraphs, a "patent license" is any express
agreement or commitment, however denominated, not to enforce a patent
(such as an express permission to practice a patent or covenant not to
sue for patent infringement).  To "grant" such a patent license to a
party means to make such an agreement or commitment not to enforce a
patent against the party.

  If you convey a covered work, knowingly relying on a patent license,
and the Corresponding Source of the work is not available for anyone
to copy, free of charge and under the terms of this License, through a
publicly available network server or other readily accessible means,
then you must either (1) cause the Corresponding Source to be so
available, or (2) arrange to deprive yourself of the benefit of the
patent license for this particular work, or (3) arrange, in a manner
consistent with the requirements of this License, to extend the patent
license to downstream recipients.  "Knowingly relying" means you have
actual knowledge that, but for the patent license, your conveying the
covered work in a country, or your recipient's use of the covered work
in a country, would infringe one or more identifiable patents in that
country that you have reason to believe are valid.

  If, pursuant to or in connection with a single transaction or
arrangement, you convey, or propagate by procuring conveyance of, a
covered work, and grant a patent license to some of the parties
receiving the covered work authorizing them to use, propagate, modify
or convey a specific copy of the covered work, then the patent license
you grant is automatically extended to all recipients of the covered
work and works based on it.

  A patent license is "discriminatory" if it does not include within
the scope of its coverage, prohibits the exercise of, or is
conditioned on the non-exercise of one or more of the rights that are
specifically granted under this License.  You may not convey a covered
work if you are a party to an arrangement with a third party that is
in the business of distributing software, under which you make payment
to the third party based on the extent of your activity of conveying
the work, and under which the third party grants, to any of the
parties who would receive the covered work from you, a discriminatory
patent license (a) in connection with copies of the covered work
conveyed by you (or copies made from those copies), or (b) primarily
for and in connection with specific products or compilations that
contain the covered work, unless you entered into that arrangement,
or that patent license was granted, prior to 28 March 2007.

  Nothing in this License shall be construed as excluding or limiting
any implied license or other defenses to infringement that may
otherwise be available to you under applicable patent law.

  12. No Surrender of Others' Freedom.

  If conditions are imposed on you (whether by court order, agreement or
otherwise) that contradict the conditions of this License, they do not
excuse you from the conditions of this License.  If you cannot convey a
covered work so as to satisfy simultaneously your obligations under this
License and any other pertinent obligations, then as a consequence you may
not convey it at all.  For example, if you agree to terms that obligate you
to collect a royalty for further conveying from those to whom you convey
the Program, the only way you could satisfy both those terms and this
License would be to refrain entirely from conveying the Program.

  13. Remote Network Interaction; Use with the GNU General Public License.

  Notwithstanding any other provision of this License, if you modify the
Program, your modified version must prominently offer all users
interacting with it remotely through a computer network (if your version
supports such interaction) an opportunity to receive the Corresponding
Source of your version by providing access to the Corresponding Source
from a network server at no charge, through some standard or customary
means of facilitating copying of software.  This Corresponding Source
shall include the Corresponding Source for any work covered by version 3
of the GNU General Public License that is incorporated pursuant to the
following paragraph.

  Notwithstanding any other provision of this License, you have
permission to link or combine any covered work with a work licensed
under version 3 of the GNU General Public License into a single
combined work, and to convey the resulting work.  The terms of this
License will continue to apply to the part which is the covered work,
but the work with which it is combined will remain governed by version
3 of the GNU General Public License.

  14. Revised Versions of this License.

  The Free Software Foundation may publish revised and/or new versions of
the GNU Affero General Public License from time to time.  Such new versions
will be similar in spirit to the present version, but may differ in detail to
address new problems or concerns.

  Each version is given a distinguishing version number.  If the
Program specifies that a certain numbered version of the GNU Affero General
Public License "or any later version" applies to it, you have the
option of following the terms and conditions either of that numbered
version or of any later version published by the Free Software
Foundation.  If the Program does not specify a version number of the
GNU Affero General Public License, you may choose any version ever published
by the Free Software Foundation.

  If the Program specifies that a proxy can decide which future
versions of the GNU Affero General Public License can be used, that proxy's
public statement of acceptance of a version permanently authorizes you
to choose that version for the Program.

  Later license versions may give you additional or different
permissions.  However, no additional obligations are imposed on any
author or copyright holder as a result of your choosing to follow a
later version.

  15. Disclaimer of Warranty.

  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
ALL NECESSARY SERVICING, REPAIR OR CORRECTION.

  16. Limitation of Liability.

  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
SUCH DAMAGES.

  17. Interpretation of Sections 15 and 16.

  If the disclaimer of warranty and limitation of liability provided
above cannot be given local legal effect according to their terms,
reviewing courts shall apply local law that most closely approximates
an absolute waiver of all civil liability in connection with the
Program, unless a warranty or assumption of liability accompanies a
copy of the Program in return for a fee.

                     END OF TERMS AND CONDITIONS

            How to Apply These Terms to Your New Programs

  If you develop a new program, and you want it to be of the greatest
possible use to the public, the best way to achieve this is to make it
free software which everyone can redistribute and change under these terms.

  To do so, attach the following notices to the program.  It is safest
to attach them to the start of each source file to most effectively
state the exclusion of warranty; and each file should have at least
the "copyright" line and a pointer to where the full notice is found.

    <one line to give the program's name and a brief idea of what it does.>
    Copyright (C) <year>  <name of author>

    This program is free software: you can redistribute it and/or modify
    it under the terms of the GNU Affero General Public License as published
    by the Free Software Foundation, either version 3 of the License, or
    (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Affero General Public License for more details.

    You should have received a copy of the GNU Affero General Public License
    along with this program.  If not, see <https://www.gnu.org/licenses/>.

Also add information on how to contact you by electronic and paper mail.

  If your software can interact with users remotely through a computer
network, you should also make sure that it provides a way for users to
get its source.  For example, if your program is a web application, its
interface could display a "Source" link that leads users to an archive
of the code.  There are many ways you could offer source, and different
solutions will be better for different programs; see section 13 for the
specific requirements.

  You should also get your employer (if you work as a programmer) or school,
if any, to sign a "copyright disclaimer" for the program, if necessary.
For more information on this, and how to apply and follow the GNU AGPL, see
<https://www.gnu.org/licenses/>.