Uke Protocol Pallet

⚠️ This pallet is not ready for production, and is in the proof of concept stage.

The Uke pallet implements a basic username and message storage system that adheres to the Uke Protocol.

Each conversation is stored on the blockchain under an id, which is a hash of the recipient and sender's address to ensure uniqueness.

Overview

The Uke pallet provides the functionality to perform basic messaging and identity assignment to users on a given Substrate chain.

Allows for the propagation and retrieval of messages through a given Substrate instance.
Allows for a username to be mapped / assigned to a given Account ID, to be retrieved later.

Terminology

Conversations: Defined as having a initiator and recipient with a list of messages.
Conversations can be marked as active or inactive. If the Conversation is active, it is added to the ActiveConversations StorageMap for both participants.
Convo ID: A conversation id is how conversations are identified. It is the recipients and senders addresses hashed (right now, via SHA3-256), and is intended to be deterministic but unique.
Messages: Defined as having a sender and receiver of a particular string of text.
Usernames: Usernames are simple UTF-8 strings assigned to Account IDs for the purpose of human-readable identification of on-chain addresses. (inspired by the nicks pallet)).

Testing & building

To test this repository, simply clone it and run:

cargo test --package pallet-uke --features runtime-benchmarks

To build it, run:

cargo build --release

Running tests via Docker

It's possible to test / build the pallet via the provided Dockerfile.

docker build -t uke .

Implementation & Usage

To add this to an existing runtime, you may utilize the Substrate Node Template.

Add the following in runtime/Cargo.toml under [dependencies]:

pallet-uke = { version = "4.0.0-dev", default-features = false, git = "https://github.com/Uke-Messaging/uke-pallet.git", branch = "m1-delivery" }

And in std in that same Cargo.toml, add:

"pallet-uke/std",

In runtime-benchmarks, add:

"pallet-uke/runtime-benchmarks",

In try-runtime, add:

"pallet-uke/try-runtime",

Finally, add the pallet in the runtime as follows in runtime/src/lib.rs:

// Import the pallet
pub use pallet_uke;

// Implement the config
impl pallet_uke::Config for Runtime {
	type RuntimeEvent = RuntimeEvent;
	type MaxUsernameLength = ConstU32<16>;
	type MaxConvoIdLength = ConstU32<64>;
	type WeightInfo = pallet_uke::weights::PalletWeight<Runtime>;
}

Make sure to add it to the construct_runtime! macro:

construct_runtime!(
	pub struct Runtime
	where
		Block = Block,
		NodeBlock = opaque::Block,
		UncheckedExtrinsic = UncheckedExtrinsic,
	{
        ...
		Uke: pallet_uke,
        ...
    }

Lastly, add it in mod benches:

#[cfg(feature = "runtime-benchmarks")]
mod benches {
	define_benchmarks!(
        ...
		[pallet_uke, Uke]
        ...
	);
}

You can then run the node as normal and utilize the pallet as needed. If you have any doubts or issues, feel free to look at the uke-node implementation for clarification.

License: Apache 2.0

Uke-Messaging / uke-pallet