ENCRYPT¶
Overview¶
ENCRYPT is the encryption library for secure user-to-user messaging. It uses the SHIO reaction mechanism to perform stream cipher encryption, allowing users to send encrypted data that only the intended recipient can decrypt.
- Kind: Contract
- License: Sharia
- Solidity: ^0.8.21
- Source:
lib/encrypt.sol
Inheritance Chain (C3 Linearized)¶
- self — ENCRYPT
- DYSNOMIA
- MultiOwnable
Immediate Parents¶
What This Means For Players¶
Plain English Summary: ENCRYPT enables secret messaging - send private messages that only the recipient can read. It uses your SHIO's cryptographic properties to scramble messages so that only someone with the right key and SHIO ownership can unscramble them.
Real-World Analogy: Think of ENCRYPT like a sealed letter system where only you and the recipient have the key to open the envelope. You write a message, seal it with your key, and only the person with the matching key can read it. Messages even expire after 10 days to keep the system clean.
How It Affects Your Gameplay: - Private messages - Send encrypted data to specific players using their Soul ID - Key-based security - You choose a password/key, and only someone with that key can decrypt - Temporary storage - Encrypted messages expire after 10 days - SHIO authorization - Only SHIO owners can encrypt/decrypt their messages
State Variables¶
| Variable | Type | Visibility | Mutability | Initial Value | NatSpec |
|---|---|---|---|---|---|
Type |
string |
public | constant | LibEncrypt |
|
Zheng |
ZHENG |
public | mutable | `` | |
Void |
VOID |
public | mutable | `` | |
_encryptions |
mapping(uint64 => Encryption) |
private | mutable | `` | |
_indexes |
uint64[] |
private | mutable | `` |
Errors¶
| Error | Parameters | NatSpec |
|---|---|---|
NotParty |
address from, address to, address party | |
ChromosomeLength |
uint8 minimum, uint256 length | |
TooManyCrypts |
uint64 max, uint256 count |
Constructor¶
constructor¶
constructor(address VoidAddress) DYSNOMIA(unicode"CHATLOG LibCrypt", unicode"LibCrypt", address(DYSNOMIA(VoidAddress).Xiao()))
- Modifiers:
DYSNOMIA(unicode"CHATLOG LibCrypt", unicode"LibCrypt", address(DYSNOMIA(VoidAddress).Xiao())) - Parameters: address VoidAddress
Functions¶
External & Public¶
Encrypt¶
function Encrypt(uint64 From, uint64 to, string memory Key, string memory Data) public returns (uint64 index)
- Visibility: public
- Parameters: uint64 From, uint64 to, string memory Key, string memory Data
- Returns: uint64 index
Encapsulate¶
function Encapsulate(Bao memory From, uint64 Gamma, uint64 Rho, uint64 Upsilon, uint64 Ohm) public returns (uint64 Entropy, bytes memory Geng)
- Visibility: public
- Parameters: Bao memory From, uint64 Gamma, uint64 Rho, uint64 Upsilon, uint64 Ohm
- Returns: uint64 Entropy, bytes memory Geng
Saat¶
- Visibility: public
- State Mutability: pure
- Parameters: bytes memory Geng
- Returns: uint64[3] memory Go
Encrypt¶
function Encrypt(uint64 From, uint64 to, bytes memory Key, bytes memory Data) public returns (uint64 index)
- Visibility: public
- Parameters: uint64 From, uint64 to, bytes memory Key, bytes memory Data
- Returns: uint64 index
Decrypt¶
function Decrypt(uint64 From, uint64 to, uint64 Index, string memory Key) public returns (bytes memory)
- Visibility: public
- Parameters: uint64 From, uint64 to, uint64 Index, string memory Key
- Returns: bytes memory
Prune¶
- Visibility: public
Decrypt¶
function Decrypt(uint64 From, uint64 to, uint64 Index, bytes memory Key) public returns (bytes memory result)
- Visibility: public
- Parameters: uint64 From, uint64 to, uint64 Index, bytes memory Key
- Returns: bytes memory result
hashKey¶
- Visibility: public
- Parameters: bytes memory Key
- Returns: uint64 result
Internal¶
Crypt¶
function Crypt(Bao memory From, Bao memory to, bytes memory Key, bytes memory Data) internal returns (uint64 indexable, bytes memory result)
- Visibility: internal
- Parameters: Bao memory From, Bao memory to, bytes memory Key, bytes memory Data
- Returns: uint64 indexable, bytes memory result
Inherited Members¶
This contract inherits the members below from its parents. See each parent's dedicated MD for full signatures, NatSpec, and semantics.
From DYSNOMIA¶
External & Public Functions
| Function | Signature | State Mutability |
|---|---|---|
Rename |
function Rename(string memory newName, string memory newSymbol) public onlyOwners |
nonpayable |
mintToCap |
function mintToCap() public onlyOwners |
nonpayable |
GetMarketRate |
function GetMarketRate(address _a) public view returns (uint256) |
view |
Purchase |
function Purchase(address _t, uint256 _a) public |
nonpayable |
Redeem |
function Redeem(address _t, uint256 _a) public |
nonpayable |
name |
function name() public view virtual returns (string memory) |
view |
symbol |
function symbol() public view virtual returns (string memory) |
view |
decimals |
function decimals() public view virtual returns (uint8) |
view |
totalSupply |
function totalSupply() public view virtual returns (uint256) |
view |
balanceOf |
function balanceOf(address account) public view virtual returns (uint256) |
view |
transfer |
function transfer(address to, uint256 value) public virtual returns (bool) |
nonpayable |
allowance |
function allowance(address owner, address spender) public view virtual returns (uint256) |
view |
approve |
function approve(address spender, uint256 value) public virtual returns (bool) |
nonpayable |
transferFrom |
function transferFrom(address from, address to, uint256 value) public virtual returns (bool) |
nonpayable |
Internal Functions
| Function | Signature |
|---|---|
_mintToCap |
function _mintToCap() internal |
AddMarketRate |
function AddMarketRate(address _a, uint256 _r) internal |
_transfer |
function _transfer(address from, address to, uint256 value) internal |
_update |
function _update(address from, address to, uint256 value) internal virtual |
_mint |
function _mint(address account, uint256 value) internal |
_approve |
function _approve(address owner, address spender, uint256 value) internal |
_spendAllowance |
function _spendAllowance(address owner, address spender, uint256 value) internal virtual |
log10 |
function log10(uint256 value) internal pure returns (uint256) |
String |
function String(uint256 value) internal pure returns (string memory buffer) |
Hex |
function Hex(address account) internal pure returns (string memory) |
Events
| Event | Parameters |
|---|---|
Transfer |
address indexed from, address indexed to, uint256 value |
Approval |
address indexed owner, address indexed spender, uint256 value |
Errors
| Error | Parameters |
|---|---|
MarketRateNotFound |
address asset |
DysnomiaInsufficientBalance |
address origin, address sender, address from, address to, address what, uint256 balance, uint256 needed |
DysnomiaInsufficientAllowance |
address origin, address sender, address owner, address spender, address what, uint256 allowance, uint256 needed |
State Variables (private parent storage is not reachable and is omitted)
| Variable | Type | Visibility | Mutability |
|---|---|---|---|
__name |
string |
internal | mutable |
__symbol |
string |
internal | mutable |
MotzkinPrime |
uint64 |
public | constant |
Xiao |
atropaMath |
public | mutable |
maxSupply |
uint256 |
public | mutable |
From MultiOwnable¶
External & Public Functions
| Function | Signature | State Mutability |
|---|---|---|
owner |
function owner() external view virtual returns (address) |
view |
renounceOwnership |
function renounceOwnership(address toRemove) public virtual onlyOwners |
nonpayable |
addOwner |
function addOwner(address newOwner) public virtual onlyOwners |
nonpayable |
Internal Functions
| Function | Signature |
|---|---|
_checkOwner |
function _checkOwner() internal view virtual |
_changeOwnership |
function _changeOwnership(address cOwner, bool cState) internal virtual |
Events
| Event | Parameters |
|---|---|
OwnershipUpdate |
address indexed newOwner, bool indexed state |
Errors
| Error | Parameters |
|---|---|
OwnableUnauthorizedAccount |
address origin, address account, address what |
OwnableInvalidOwner |
address origin, address owner, address what |
Modifiers
| Modifier | Parameters |
|---|---|
onlyOwners |
(none) |
Contract Interactions¶
Depends On¶
- DYSNOMIA - Base token functionality
- VOID - Session management
- ZHENG - Installation access
- SHIO - Reaction mechanism
- SHA - React function
Registered In¶
- VOID library registry as "encrypt"
Special Mechanisms¶
Stream Cipher¶
The Crypt function implements a stream cipher: 1. React with hashed key to get initial (Eta, Kappa) 2. For each 8-byte block: - React on recipient's Cone to get new state - XOR data with Kappa bytes - React on sender's Rod for next iteration
for(uint256 i = 0; i < Data.length; ) {
(_b, _m) = to.Shio.Rho().Cone.React(_e, to.Shio.Rho().Rod.View().Channel);
for(uint256 j = 0; j < 8 && i < Data.length; j++) {
result[i] = bytes8(_m)[j] ^ Data[i];
i++;
}
(_e, _m) = From.Shio.Rho().Rod.React(_b, From.Shio.Rho().Cone.View().Channel);
}
Authorization Check¶
Only the sender can encrypt, only the recipient can decrypt:
// Encrypt
if(!_from.Shio.owner(msg.sender)) revert NotParty(...);
// Decrypt
if(!_to.Shio.owner(msg.sender)) revert NotParty(...);
Expiration System¶
Encrypted data expires after 10 days:
Auto-Cleanup¶
The Prune function removes expired entries, and decryption auto-cleans expired data.
Usage Pattern¶
// Sender encrypts
uint64 index = encrypt.Encrypt(mySoul, recipientSoul, "password", "secret message");
// Recipient decrypts
bytes memory message = encrypt.Decrypt(senderSoul, mySoul, index, "password");
// Clean up old data
encrypt.Prune();
Security Considerations¶
- Key is hashed before use (keccak256)
- Encryption depends on SHIO state
- Only SHIO owners can encrypt/decrypt
- Data expires to limit storage
- Index limit prevents DoS
Contract Verification¶
| Property | Value |
|---|---|
| Keccak256 Hash | 0xccf31161b82a33b8f516eaa7a49cb1b9095759dfdd0bce5c777ec20f7ce12fb3 |
| Source URL | https://raw.githubusercontent.com/busytoby/atropa_pulsechain/main/solidity/dysnomia/lib/encrypt.sol |
| Hash Generated | 2026-04-17T20:48:16Z |