standards: add DRC20 primitive and reference

Author: HDauven

Makefile

@@ -1,4 +1,4 @@
-STANDARDS_EXAMPLES := standards/examples/multisig_controller
+STANDARDS_EXAMPLES := standards/examples/drc20_roles_pausable standards/examples/multisig_controller
 STANDARDS_WASM_CONTRACTS := $(STANDARDS_EXAMPLES)
 LEGACY_SUBDIRS := tests/alice tests/bob tests/charlie genesis/transfer genesis/stake tests/host_fn
 STANDARDS_PROPTEST_CASES ?= 8192

standards/Cargo.lock

@@ -1,6 +1,7 @@
 [workspace]
 members = [
     "dusk-contract-standards",
+    "examples/drc20_roles_pausable",
     "examples/multisig_controller",
 ]
 

standards/Cargo.toml

@@ -83,6 +83,20 @@ impl AccessControl {
 
     /// Bootstraps the default admin role.
     pub fn init_admin(&mut self, admin: Principal) {
+        self.init_admin_with_roles(admin, core::iter::empty::<Role>());
+    }
+
+    /// Bootstraps the default admin role and seeds additional initial roles.
+    ///
+    /// This is intended for contract initialization only. It keeps initial role
+    /// seeding inside the same one-time initialization gate as the default
+    /// admin, while regular role changes still require a fresh authorization
+    /// witness.
+    pub fn init_admin_with_roles(
+        &mut self,
+        admin: Principal,
+        roles: impl IntoIterator<Item = Role>,
+    ) {
         if admin.is_zero() {
             panic!("{}", error::ZERO_PRINCIPAL);
         }
@@ -94,6 +108,13 @@ impl AccessControl {
             .or_insert_with(|| RoleData::new(DEFAULT_ADMIN_ROLE))
             .members
             .insert(admin);
+        for role in roles {
+            self.roles
+                .entry(role)
+                .or_insert_with(|| RoleData::new(DEFAULT_ADMIN_ROLE))
+                .members
+                .insert(admin);
+        }
     }
 
     /// Returns true when `account` has `role`.

standards/dusk-contract-standards/src/access/access_control.rs

@@ -18,3 +18,4 @@ pub const INVALID_OPERATION: &str = "DuskStandards: invalid operation";
 pub const EXPIRED: &str = "DuskStandards: expired";
 pub const REENTRANCY: &str = "DuskStandards: reentrant call";
 pub const OVERFLOW: &str = "DuskStandards: arithmetic overflow";
+pub const UNDERFLOW: &str = "DuskStandards: arithmetic underflow";

standards/dusk-contract-standards/src/core/error.rs

@@ -30,3 +30,4 @@ pub mod auth;
 pub mod core;
 pub mod governance;
 pub mod security;
+pub mod token;

standards/dusk-contract-standards/src/lib.rs

@@ -0,0 +1,57 @@
+// This Source Code Form is subject to the terms of the Mozilla Public
+// License, v. 2.0. If a copy of the MPL was not distributed with this
+// file, You can obtain one at http://mozilla.org/MPL/2.0/.
+//
+// Copyright (c) DUSK NETWORK. All rights reserved.
+
+//! DRC20 event payloads.
+
+use bytecheck::CheckBytes;
+use rkyv::{Archive, Deserialize, Serialize};
+
+use crate::core::Principal;
+
+/// Transfer event topic.
+pub const TRANSFER_TOPIC: &str = "drc20/transfer";
+/// Approval event topic.
+pub const APPROVAL_TOPIC: &str = "drc20/approval";
+
+/// Transfer event.
+#[derive(
+    Archive, Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq,
+)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[archive_attr(derive(CheckBytes))]
+pub struct Transfer {
+    /// Sender.
+    pub from: Principal,
+    /// Recipient.
+    pub to: Principal,
+    /// Amount.
+    pub amount: u64,
+}
+
+/// Approval event.
+#[derive(
+    Archive, Serialize, Deserialize, Clone, Copy, Debug, PartialEq, Eq,
+)]
+#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
+#[archive_attr(derive(CheckBytes))]
+pub struct Approval {
+    /// Owner.
+    pub owner: Principal,
+    /// Spender.
+    pub spender: Principal,
+    /// Amount.
+    pub amount: u64,
+}
+
+#[cfg(feature = "forge")]
+impl dusk_forge::ContractEvent for Transfer {
+    const TOPICS: &'static [&'static str] = &[TRANSFER_TOPIC];
+}
+
+#[cfg(feature = "forge")]
+impl dusk_forge::ContractEvent for Approval {
+    const TOPICS: &'static [&'static str] = &[APPROVAL_TOPIC];
+}