origami_security 1.8.0
Security library for Dojo based games.
Readme
Security
The Origami Security crate is a library that provides security-related primitives for Dojo-based games. It offers implementations of common security patterns and utilities to enhance the safety and integrity of game development on the Dojo framework.
Overview
The Security crate focuses on providing fundamental security mechanisms that are essential for game development. Its primary scope includes:
- Commitment schemes
The crate is designed to work seamlessly with the Dojo engine and other Origami crates.
Features
Commitment schemes
A Commitment is a cryptographic primitive that allows you to commit to a chosen value while keeping it hidden, with the ability to reveal it later. This is useful in scenarios where you want to make a binding commitment to a value, meaning that once a commitment is made, it cannot be changed or altered.
Features of the Commitment implementation include:
- Creation of new commitments
- Committing to a hash value
- Revealing and verifying committed values
Installation
Add the Origami Security crate from the scarbs.xyz registry:
scarb add origami_security@1.8.0
Or from git, in the [dependencies] section of your Scarb.toml:
[dependencies]
origami_security = { git = "https://github.com/dojoengine/origami" }
Make sure you have dojo installed and configured in your project.
How to use it?
Here are some examples of how to use the Security crate:
Commit/Reveal
use core::poseidon::poseidon_hash_span;
use origami_security::commitment::{Commitment, CommitmentTrait};
// Create a new commitment
let mut commitment = CommitmentTrait::new();
// Commit to a value (in this case, a string)
let value = 'secret';
let mut serialized = array![];
value.serialize(ref serialized);
let hash = poseidon_hash_span(serialized.span());
commitment.commit(hash);
// Later, reveal and verify the commitment
let is_valid = commitment.reveal('secret');
assert(is_valid, 'Invalid reveal for commitment');
Remember to import the necessary traits and types when using the Security crate in your project.
Metadata
Version 1.8.0
Uploaded 12 hours ago
License MIT
Size 2.9 KB
Installation
Run the following command in your project dir
scarb add origami_security@1.8.0
Or add the following line to your Scarb.toml
origami_security = "1.8.0"
Monthly downloads
Links
Keywords
- dojo
- starknet
- cairo
- game
- security
- commitment
- commit-reveal
