Icon LinkSway Standards

The purpose of the Sway Standards repository Icon Link is to contain standards for the Sway Language which users can import and use.

Standards in this repository may be in various stages of development. Use of draft standards and feedback on the proposed standards is encouraged. To use a draft, search for a standard using the appropriate GitHub label and implement the standard ABI into your contract.

If you don't find what you're looking for, feel free to create an issue and propose a new standard!

Icon InfoCircle

Note All standards currently use forc v0.61.0.

Icon LinkUsing a standard

To import a standard the following should be added to the project's Forc.toml file under [dependencies] with the most recent release:

standards = { git = "https://github.com/FuelLabs/sway-standards", tag = "v0.5.2" }

Icon InfoCircle

NOTE: Be sure to set the tag to the latest release.

You may then import your desired standard in your Sway Smart Contract as so:

use standards::<standard>::<standard_abi>;

For example, to import the SRC-20 Native Asset Standard use the following statement in your Sway Smart Contract file:

use standards::src20::SRC20;

Icon LinkStandards

Icon LinkNative Assets

• SRC-20; Native Asset Standard defines the implementation of a standard API for Native Assets Icon Link using the Sway Language.
• SRC-3; Mint and Burn is used to enable mint and burn functionality for fungible assets.
• SRC-7; Arbitrary Asset Metadata Standard is used to store metadata for Native Assets Icon Link.
• SRC-9; Metadata Keys Standard is used to store standardized metadata keys for Native Assets Icon Link in combination with the SRC-7 standard.
• SRC-6; Vault Standard defines the implementation of a standard API for asset vaults developed in Sway.
• SRC-13; Soulbound Address defines the implementation of a soulbound address.

Icon LinkSecurity and Access Control

• SRC-5; Ownership Standard is used to restrict function calls to admin users in contracts.
• SRC-11; Security Information Standard is used to make communication information readily available in the case white hat hackers find a vulnerability in a contract.

Icon LinkContracts

• SRC-12; Contract Factory defines the implementation of a standard API for contract factories.
• SRC-14; Simple Upgradeable Proxies defines the implementation of an upgradeable proxy contract.

Icon LinkBridge

• SRC-8; Bridged Asset defines the metadata required for an asset bridged to the Fuel Network.
• SRC-10; Native Bridge Standard defines the standard API for the Native Bridge between the Fuel Chain and the canonical base chain.

Icon LinkDocumentation

• SRC-2; Inline Documentation defines how to document your Sway files.