README.md

Jeton Network Pallet Rock-Paper-Scissor (RPS)

This is a rock-paper-scissor Substrate pallet which lives as its own crate so it can be imported into multiple runtimes.

Important: For a real usage, the choose extrinsic needs to take hash and not a salt, the salt should only be provided in the last reveal step.

Purpose

This pallet implements the rock-paper-scissor game as a pattern for obfuscating player informations and reavel them later in game.

Dependencies

Traits

This pallet does not depend on any externally defined traits.

Pallets

This pallet does not depend on any other FRAME pallet or externally developed modules.

Installation

Runtime Cargo.toml

To add this pallet to your runtime, simply include the following to your runtime's Cargo.toml file:

# external pallets
pallet-rps = {default-features = false, version = '0.1.0', git = 'https://github.com/JetonNetwork/pallet-jton-rps.git'}

and update your runtime's std feature to include this pallet:

std = [
    # --snip--
    'pallet-rps/std',
]

Runtime lib.rs

You should implement it's trait like so:

// matchmaker parameters
parameter_types! {
    pub const AmountPlayers: u8 = 2;
    pub const AmountBrackets: u8 = 2;
}

/// pallet used for matchmaking in pallet-rps.
impl pallet_matchmaker::Config for Test {
    type Event = Event;
    type AmountPlayers = AmountPlayers;
    type AmountBrackets = AmountBrackets;
}

/// pallet rps main logic
impl pallet_rps::Config for Runtime {
    type Event = Event;
    type Randomness = TestRandomness<Self>;
    type MatchMaker = MatchMaker;
}

and include it in your construct_runtime! macro:

    MatchMaker: pallet_matchmaker::{Pallet, Call, Storage, Event<T>},
    RockPaperScissor: pallet_rps::{Pallet, Call, Storage, Event<T>},

Genesis Configuration

This rps pallet does not have any genesis configuration.

Reference Docs

You can view the reference docs for this pallet by running:

cargo doc --open