Wire system contracts

Wire system contracts are a collection of contracts deployable to a Wire blockchain. These system contracts extend the robust foundation provided by the sysio.contracts with enhancements from Antelope protocol and some of the key features include:

• Accounts and Permissions: Flexible permission system for transaction-specific actions via multi-signature authorizations.
• Advanced Consensus: Extends the basic consensus framework to include detailed processes for selecting Node Operators and aligning their incentives, using a system of rewards and penalties.
• Sophisticated Resource Management(REX + ROA): Extended systems for tracking and usage of CPU/NET and RAM, and facilitates the establishment of markets where users can dynamically trade and manage resource rights.
• Token Functionality: Support for creation and management of both fungible and non-fungible tokens.

The collection of system contracts consists of the following individual contracts:

• boot contract: A minimal contract that only serves the purpose of activating protocol features which enables other more sophisticated contracts to be deployed onto the blockchain. (Note: this contract must be deployed to the privileged sysio account.)
• bios contract: A simple alternative to the core contract which is suitable for test chains or perhaps centralized blockchains. (Note: this contract must be deployed to the privileged sysio account.)
• token contract: A contract enabling fungible tokens.
• core contract: A monolithic contract that includes a variety of different functions. Note: This contract must be deployed to the privileged sysio account. Additionally, this contract requires that the token contract is deployed to the sysio.token account and has already been used to setup the core token.) The functions contained within this monolithic contract include (non-exhaustive):
  • Appointed Proof of Stake (APoS) consensus mechanism for selecting and paying (via core token inflation) a set of Node Operators that are chosen through delegation of the staked core tokens.
  • Allocation of CPU/NET resources based on core tokens in which the core tokens are either staked for an indefinite allocation of some fraction of available CPU/NET resources, or they are paid as a fee in exchange for a time-limited allocation of CPU/NET resources via ROA.
  • An automated market maker enabling a market for RAM resources which allows users to buy or sell available RAM allocations.
  • An auction for bidding for premium account names.
• multisig contract: A contract that enables proposing transactions on the blockchain, collecting authorization approvals for many accounts, and then executing the actions within the transaction after authorization requirements of the transaction have been reached. (Note: this contract must be deployed to a privileged account.)
• wrap contract: A contract that wraps around any transaction and allows for executing its actions without needing to satisfy the authorization requirements of the transaction. If used, the permissions of the account hosting this contract should be configured to only allow highly trusted parties (e.g. the operators of the blockchain) to have the ability to execute its actions. (Note: this contract must be deployed to a privileged account.)

Branches

The master branch contains the latest stable branch

Supported Operating Systems

We currently support the following operating systems.

Operating Systems
Ubuntu 22.04 Jammy
Ubuntu 20.04 Focal

---

Building

The build guide below will assume you are running Ubuntu 20.04 and 22.04. However, as mentioned above, other operating systems may also be supported.

Prerequisites

Before proceeding with the instructions below, please ensure the following prerequisites are met:

• CDT Dependency: Ensure that the Wire Contract Development Toolkit (CDT) is installed on your system.
• Optional - Wire Sysio Built from Source: If you wish to run build system contracts with tests, you should have already built Wire Sysio from source and installed it on your system.

Build or install CDT dependency

The CDT dependency is required. This release of the system contracts requires at least version 3.0 of CDT.

At the moment, we only support building from source for CDT. Please refer to the guide in the CDT README for instructions on how to do this.

It is important to keep the path to the build directory in the shell environment variable CDT_BUILD_PATH for later use when building the system contracts.

Optionally build Wire Sysio dependency

The Wire Sysio dependency is optional and it is only needed if you wish to >build the tests using the BUILD_TESTS CMake flag.

If want to build the contract tests, you will first need to build Wire Sysio from source.

Please refer to the guide in the Wire Sysio README for instructions on how to do this. Please keep the path to the build directory in the shell environment variable WIRE_SYSIO_BUILD_PATH for later use when building the system contracts.

Build system contracts

You could either use the ./build.sh script or build the system contracts manually.

---

• Build system contracts using the build script

 

Build contracts without tests

./build.sh

Build contracts using with tests

export WIRE_SYSIO_BUILD_PATH=/absolute/path/to/wire-sysio/build

export CMAKE_PREFIX_PATH=${WIRE_SYSIO_BUILD_PATH}/lib/cmake/sysio

./build.sh -l $WIRE_SYSIO_BUILD_PATH

  Build script opions

   -c DIR: Path to CDT installation/build directory (optional if installed in a standard location).
   -l DIR: Path to WIRE_SYSIO build directory (optional, required for building tests).
   -h: Show the help menu.

---

• Build contracts manually

Build system contracts with tests using Wire Sysio built from source and with installed CDT package:

export WIRE_SYSIO_BUILD_PATH=/absolute/path/to/wire-sysio/build

rm -rf build && mkdir build && cd build

cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=ON -Dsysio_DIR="${WIRE_SYSIO_BUILD_PATH}/lib/cmake/sysio" ..

make -j $(nproc)

Note: CMAKE_BUILD_TYPE has no impact on the WASM files generated for the contracts. It only impacts how the test binaries are built. Use -DCMAKE_BUILD_TYPE=Debug if you want to create test binaries that you can debug.

Build system contracts with tests using Wire Sysio and CDT both built from source

rm -rf build && mkdir build && cd build

cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=ON -Dcdt_DIR="${CDT_BUILD_PATH}/lib/cmake/cdt" -Dsysio_DIR="${WIRE_SYSIO_BUILD_PATH}/lib/cmake/sysio" ..
make -j $(nproc)

Build system contracts without tests and with CDT build from source

rm -rf build && mkdir build && cd build

cmake -DCMAKE_BUILD_TYPE=Release -DBUILD_TESTS=OFF -Dcdt_DIR="${CDT_BUILD_PATH}/lib/cmake/cdt" ..
make -j $(nproc)

Supported CMake options

The following is a list of custom CMake options supported in building the system contracts (default values are shown below):

-DBUILD_TESTS=OFF                       Do not build the tests

-DSYSTEM_CONFIGURABLE_WASM_LIMITS=ON    Enable use of the CONFIGURABLE_WASM_LIMITS
                                        protocol feature

-DSYSTEM_BLOCKCHAIN_PARAMETERS=ON       Enable use of the BLOCKCHAIN_PARAMETERS
                                        protocol feature

Running tests

Assuming you built with BUILD_TESTS=ON, you can run the tests.

cd build/tests
ctest -j $(nproc)

---

License

FSL-1.1-Apache-2.0

---

Wire Network Website | Twitter | LinkedIn © 2024 Wire Network. All rights reserved.