Every Protocol Core

Every Protocol enables intuitive, collaborative, secure, and rewarding onchain co-creation.

Every Protocol introduces the Object Token (or simply, object) — a next-gen token with structure, semantics, and interoperability. Each object has a kind, is minted from a set, and is composed of elements. Objects can interact with one another through relations defined at the kind level. Every aspect of an object can be created or developed by anyone, unlocking true onchain collaboration.

This repository contains the core contracts that power Every Protocol.

Contracts

• SetRegistry — registers and manages object sets
• KindRegistry — registers and manages kinds
• ElementRegistry — registers object building blocks such as values, uniques, and matters
• OmniRegistry — registers relations and enables object-to-object interactions
• ObjectMinter — optional minting module allowing sets to define pricing, access, and sales logic

The contracts in this repository are in an early stage. We’re releasing the draft code now to build in public — with open feedback, shared exploration, and meaningful community contributions. We expect this to be an evolving, months-long process and welcome all forms of participation.

License

Every Protocol Core is licensed under the Business Source License 1.1 (BUSL-1.1), see BUSL_LICENSE, and the MIT License (MIT), See MIT_LICENSE. Each file declares its applicable license via the SPDX header.

Contents

• Constraints
• IdScheme
• KindIds
• SetIds
• RelationIds
• ValueIds
• UniqueIds
• Revisions

Constraints

Git Source

State Variables

MAX_KIND_ELEMENTS

uint256 constant MAX_KIND_ELEMENTS = 16

MAX_KIND_RELATIONS

uint256 constant MAX_KIND_RELATIONS = 16

MAX_RELATION_ADJACENCIES

uint256 constant MAX_RELATION_ADJACENCIES = 16

IdScheme

Git Source

State Variables

SYSTEM_OBJECT_MAX

0~16 are reserved for system objects

uint64 constant SYSTEM_OBJECT_MAX = 16

PLAIN_OBJECT_UNSPECIFIED

uint64 constant PLAIN_OBJECT_UNSPECIFIED = 0

PLAIN_OBJECT_MIN

uint64 constant PLAIN_OBJECT_MIN = 1

PLAIN_OBJECT_USER_MIN

uint64 constant PLAIN_OBJECT_USER_MIN = 1

PLAIN_OBJECT_MAX

uint64 constant PLAIN_OBJECT_MAX = 0xFFFFFFFF_FFFFFFFE

PLAIN_OBJECT_ANY

uint64 constant PLAIN_OBJECT_ANY = 0xFFFFFFFF_FFFFFFFF

SEMANTIC_OBJECT_MIN

uint64 constant SEMANTIC_OBJECT_MIN = 1

SEMANTIC_OBJECT_SYSTEM_MAX

uint64 constant SEMANTIC_OBJECT_SYSTEM_MAX = 16

SEMANTIC_OBJECT_USER_MIN

uint64 constant SEMANTIC_OBJECT_USER_MIN = 17

SEMANTIC_OBJECT_MAX

uint64 constant SEMANTIC_OBJECT_MAX = 0x0000FFFF_FFFFFFFE

KindIds

Git Source

State Variables

SET

uint64 constant SET = 1

KIND

uint64 constant KIND = 2

RELATION

uint64 constant RELATION = 3

VALUE

uint64 constant VALUE = 4

UNIQUE

uint64 constant UNIQUE = 5

USER_START

uint64 constant USER_START = 17

SetIds

Git Source

State Variables

SET

uint64 constant SET = 1

KIND

uint64 constant KIND = 2

RELATION

uint64 constant RELATION = 3

VALUE

uint64 constant VALUE = 4

UNIQUE

uint64 constant UNIQUE = 5

USER_START

uint64 constant USER_START = 17

RelationIds

Git Source

State Variables

USER_START

uint64 constant USER_START = 17

ValueIds

Git Source

State Variables

NATIVE

uint64 constant NATIVE = 0

USER_START

uint64 constant USER_START = 17

UniqueIds

Git Source

State Variables

USER_START

uint64 constant USER_START = 17

Revisions

Git Source

State Variables

UNSPECIFIED

uint32 constant UNSPECIFIED = 0

LATEST

uint32 constant LATEST = 0

INITIAL

uint32 constant INITIAL = 1

Contents

• elemr
• kindr
• minter
• omnir
• setr
• Soke

Contents

• ElementRegistryErrors
• UniqueElements
• UniqueRegistry
• ValueElements
• ValueRegistry

ElementRegistryErrors

Git Source

Errors

TokenNotExist

error TokenNotExist(uint64 token);

UnsupportedTokenStandard

error UnsupportedTokenStandard(uint8 std);

InvalidTokenContract

error InvalidTokenContract(address addr);

InvalidTokenAddress

error InvalidTokenAddress();

InvalidTokenData

error InvalidTokenData();

InvalidTokenRange

error InvalidTokenRange(uint64 begin, uint64 end);

UniqueElements

Git Source

State Variables

CODE

uint256 constant CODE = 0

DATA

uint256 constant DATA = 1

TOKEN_SPEC

uint256 constant TOKEN_SPEC = 2

COUNT

uint256 constant COUNT = 3

Structs

View

struct View {
    MatterHash code;
    MatterHash data;
    Info tokenSpec;
}

UniqueRegistry

Git Source

Inherits: IUniqueRegistry, ElementRegistryErrors, Initializable, Soke

State Variables

UNIQUEREGISTRY_STORAGE_LOCATION

Deterministic storage slot per ERC-7201

keccak256(abi.encode(uint256(keccak256("every.storage.UniqueRegistry")) - 1)) & ~bytes32(uint256(0xff))

bytes32 private constant UNIQUEREGISTRY_STORAGE_LOCATION =
    0x04dc4921879709492146fc19ec213a3e22c8a01b900b814a9bdf73ef2a847900

Functions

_getUniqueRegistryStorage

function _getUniqueRegistryStorage() private pure returns (UniqueRegistryStorage storage $);

__UniqueRegistry_init

function __UniqueRegistry_init(uint64 idStart) internal onlyInitializing;

uniqueRegister

Registers a new unique token

function uniqueRegister(address code, bytes32 data, TokenStandard std, uint8 decimals, string memory symbol)
    external
    override
    returns (uint64 id, Descriptor memory meta);

Parameters

Returns

uniqueUpdate

Updates the data hash of a unique

function uniqueUpdate(uint64 id, bytes32 data) external override returns (Descriptor memory meta);

Parameters

Returns

uniqueUpdate

Updates the data hash of a unique

function uniqueUpdate(uint64 id, bytes32 data, string memory symbol)
    external
    override
    returns (Descriptor memory meta);

Parameters

Returns

uniqueUpgrade

Upgrades the kind and/or set revision of a unique

function uniqueUpgrade(uint64 id, uint32 kindRev0, uint32 setRev0)
    external
    override
    returns (Descriptor memory meta);

Parameters

Returns

uniqueTouch

Bumps the revision of a unique with no content change

function uniqueTouch(uint64 id) external override returns (Descriptor memory meta);

Parameters

Returns

uniqueTransfer

Transfers ownership of a unique token

function uniqueTransfer(uint64 id, address to) external override returns (address from);

Parameters

Returns

uniqueRevision

Resolves and validates a revision

function uniqueRevision(uint64 id, uint32 rev0) external view override returns (uint32 rev);

Parameters

Returns

uniqueDescriptor

Returns the descriptor at a given revision

function uniqueDescriptor(uint64 id, uint32 rev0) external view override returns (Descriptor memory desc);

Parameters

Returns

uniqueSnapshot

Returns descriptor and elements at a specific revision

function uniqueSnapshot(uint64 id, uint32 rev0)
    external
    view
    override
    returns (Descriptor memory desc, bytes32[] memory elems);

Parameters

Returns

uniqueOwner

Returns the current owner of a unique

function uniqueOwner(uint64 id) external view override returns (address owner);

Parameters

Returns

uniqueSota

Returns the latest descriptor and current owner

function uniqueSota(uint64 id) external view override returns (Descriptor memory desc, address owner);

Parameters

Returns

uniqueStatus

function uniqueStatus(uint64[] memory ids) external view override returns (bool active);

_register

function _register(
    uint64 id,
    address code,
    bytes32 data,
    TokenStandard std,
    uint8 decimals,
    bytes30 symbol,
    address owner
) private returns (Descriptor memory meta);

_kindOfUniqueRevision

Returns the latest revision of the Kind-of-Value object

function _kindOfUniqueRevision() private view returns (uint32);

_setOfUniqueRevision

Returns the latest revision of the Set-of-Value object

function _setOfUniqueRevision() private view returns (uint32);

Structs

UniqueRegistryStorage

Note: storage-location: erc7201:every.storage.UniqueRegistry

struct UniqueRegistryStorage {
    Counter48.Counter counter;
    Snapshots.Storage uniques;
}

ValueElements

Git Source

State Variables

CODE

uint256 constant CODE = 0

DATA

uint256 constant DATA = 1

TOKEN_SPEC

uint256 constant TOKEN_SPEC = 2

COUNT

uint256 constant COUNT = 3

Structs

View

struct View {
    MatterHash code;
    MatterHash data;
    Info tokenSpec;
}

ValueRegistry

Git Source

Inherits: IValueRegistry, ElementRegistryErrors, Initializable, Soke

State Variables

VALUEREGISTRY_STORAGE_LOCATION

Deterministic storage slot per ERC-7201

keccak256(abi.encode(uint256(keccak256("every.storage.ValueRegistry")) - 1)) & ~bytes32(uint256(0xff))

bytes32 private constant VALUEREGISTRY_STORAGE_LOCATION =
    0x7e2fb0066d5c30a775c561af98650c8a5856bdd87a1fa6e7b509179e09d6c200

Functions

_getValueRegistryStorage

function _getValueRegistryStorage() private pure returns (ValueRegistryStorage storage $);

__ValueRegistry_init

function __ValueRegistry_init(uint64 idStart, address owner, bytes32 data, uint8 decimals, string memory symbol)
    internal
    onlyInitializing;

valueRegister

Registers a new value token

function valueRegister(address code, bytes32 data, TokenStandard std, uint8 decimals, string memory symbol)
    external
    override
    returns (uint64 id, Descriptor memory meta);

Parameters

Returns

valueUpdate

Updates the data hash of an existing value

function valueUpdate(uint64 id, bytes32 data) external override returns (Descriptor memory meta);

Parameters

Returns

valueUpdate

Updates the data hash of an existing value

function valueUpdate(uint64 id, bytes32 data, string memory symbol)
    external
    override
    returns (Descriptor memory meta);

Parameters

Returns

valueUpgrade

Upgrades the kind/set revision of a value

function valueUpgrade(uint64 id, uint32 kindRev0, uint32 setRev0)
    external
    override
    returns (Descriptor memory meta);

Parameters

Returns

valueTouch

Touches a value, bumping its revision without changing its content

function valueTouch(uint64 id) external override returns (Descriptor memory meta);

Parameters

Returns

valueTransfer

Transfers ownership of a value to a new address

function valueTransfer(uint64 id, address to) external override returns (address from);

Parameters

Returns

valueRevision

Resolves and validates a revision of a value

function valueRevision(uint64 id, uint32 rev0) external view override returns (uint32 rev);

Parameters

Returns

valueDescriptor

Returns the descriptor of a value at a specific revision

function valueDescriptor(uint64 id, uint32 rev0) external view override returns (Descriptor memory desc);

Parameters

Returns

valueSnapshot

Returns descriptor and elements of a value at a specific revision

function valueSnapshot(uint64 id, uint32 rev0)
    external
    view
    override
    returns (Descriptor memory desc, bytes32[] memory elems);

Parameters

Returns

valueOwner

Returns the current owner of a value

function valueOwner(uint64 id) external view override returns (address owner);

Parameters

Returns

valueSota

Returns the latest descriptor and current owner of a value

function valueSota(uint64 id) external view override returns (Descriptor memory desc, address owner);

Parameters

Returns

valueStatus

Checks whether all specified values are active (revision > 0)

function valueStatus(uint64[] memory ids) external view override returns (bool active);

Parameters

Returns

_register

function _register(
    uint64 id,
    address code,
    bytes32 data,
    TokenStandard std,
    uint8 decimals,
    string memory symbol,
    address owner
) private returns (Descriptor memory);

_kindOfValueRevision

Returns the latest revision of the Kind-of-Value object

function _kindOfValueRevision() private view returns (uint32);

_setOfValueRevision

Returns the latest revision of the Set-of-Value object

function _setOfValueRevision() private view returns (uint32);

Structs

ValueRegistryStorage

Note: storage-location: erc7201:every.storage.ValueRegistry

struct ValueRegistryStorage {
    Counter48.Counter counter;
    Snapshots.Storage values;
}

Contents

• KindElements
• KindRegistryErrors

KindElements

Git Source

State Variables

CODE

uint256 constant CODE = 0

DATA

uint256 constant DATA = 1

ELEM_SPEC

uint256 constant ELEM_SPEC = 2

RELS0

uint256 constant RELS0 = 3

RELS1

uint256 constant RELS1 = 4

RELS2

uint256 constant RELS2 = 5

RELS3

uint256 constant RELS3 = 6

COUNT

uint256 constant COUNT = 7

Functions

packRelationSpec

function packRelationSpec(uint64[] memory rels) internal pure returns (bytes32, bytes32, bytes32, bytes32);

unpackRelationSpec

function unpackRelationSpec(bytes32 p0, bytes32 p1, bytes32 p2, bytes32 p3)
    internal
    pure
    returns (uint64[] memory);

packElementSpec

function packElementSpec(uint8[] memory elemSpec) internal pure returns (bytes32);

unpackElementSpec

function unpackElementSpec(bytes32 packed) internal pure returns (uint8[] memory);

Structs

View

struct View {
    MatterHash code;
    MatterHash data;
    Info elemSpec;
    Info rels0;
    Info rels1;
    Info rels2;
    Info rels3;
}

KindRegistryErrors

Git Source

Errors

InvalidIntializeArguments

error InvalidIntializeArguments();

InvalidCode

error InvalidCode();

InvalidData

error InvalidData();

TooManyElementTypes

error TooManyElementTypes();

InvalidElementType

error InvalidElementType();

TooManyRelations

error TooManyRelations();

InvalidRelation

error InvalidRelation();

UnauthorizedAccess

error UnauthorizedAccess(uint64 id, address vistor);

Contents

• ObjectMinterErrors

ObjectMinterErrors

Git Source

Custom error definitions used throughout the ObjectMinter contract

Errors

MintPolicyInvalidIDRange

ID range is invalid (rangeStart >= rangeEnd)

error MintPolicyInvalidIDRange();

MintPolicyInvalidSaleTime

Sale period is invalid (saleStart >= saleEnd)

error MintPolicyInvalidSaleTime();

MintPolicyInvalidRecipient

Creator address (fundsRecipient) cannot be the zero address

error MintPolicyInvalidRecipient();

MintPolicyInvalidPrice

Price must be zero or valid depending on permission type

error MintPolicyInvalidPrice();

MintPolicyInvalidMintLimit

Mint limit must be non-zero (except for AllowTable)

error MintPolicyInvalidMintLimit();

MintPolicyInvalidPermissionType

Invalid permission type (out of enum range)

error MintPolicyInvalidPermissionType();

MintPolicyInvalidPermissionData

Permission data is incompatible with the permission type

error MintPolicyInvalidPermissionData();

MintPolicyInvalidStatus

Invalid or unexpected status value

error MintPolicyInvalidStatus();

MintPolicyUnavailable

No matching policy found for given object ID and constraints

error MintPolicyUnavailable();

MintPolicyNotFound

Specified policy index does not exist

error MintPolicyNotFound();

MintPolicyIndexOverflow

Policy index exceeds uint32 maximum (overflow)

error MintPolicyIndexOverflow();

MintPolicyInvalidContract

error MintPolicyInvalidContract();

MintInvalidProof

Merkle proof verification failed

error MintInvalidProof();

MintIncorrectPayment

Incorrect ETH amount sent for mint

error MintIncorrectPayment();

MintExceedsMintLimit

Caller has exceeded the allowed number of mints

error MintExceedsMintLimit();

MintCallbackFailed

Callback to IObjectMintable.onObjectMint failed

error MintCallbackFailed();

FeeConfigInvalidRate

Fee basis points exceeds 10,000 (100%)

error FeeConfigInvalidRate();

FeeConfigInvalidRecipient

Protocol fee recipient is the zero address

error FeeConfigInvalidRecipient();

Contents

• AdjacencySpecUtils_
• ObjectAuthorization
• ObjectInteraction
• OmniRegistryErrors
• RelationAdjacencies
• RelationElements
• RelationRegistry

AdjacencySpecUtils_

Git Source

State Variables

MAX_ADJACENCIES

uint256 private constant MAX_ADJACENCIES = 16

Functions

packQuad

function packQuad(Adjacency[] memory adjs, uint256 offset) internal pure returns (bytes32 out);

pack

function pack(Adjacency[] memory adjs)
    internal
    pure
    returns (bytes32 adjs0, bytes32 adjs1, bytes32 adjs2, bytes32 adjs3);

unpackQuad

function unpackQuad(bytes32 packed) internal pure returns (Adjacency[] memory out);

unpack

function unpack(bytes32 adjs0, bytes32 adjs1, bytes32 adjs2, bytes32 adjs3)
    internal
    pure
    returns (Adjacency[] memory adjs);

ObjectAuthorization

Git Source

Inherits: IObjectAuthorization, OmniRegistryErrors, Initializable

Manages directional authorization rules for object relations. Grants define who can initiate a relation (from or to) based on various criteria, such as ownership, token holding, delegation, or external contract verification.

State Variables

OBJECTAUTHORIZATION_STORAGE_LOCATION

Deterministic storage slot per ERC-7201

bytes32 private constant OBJECTAUTHORIZATION_STORAGE_LOCATION =
    0x66533e6d1966c5548931afa2a923bcafa00e1e6794f41ca0f03bbc3ab865ab00

Functions

_getObjectAuthorizationStorage

function _getObjectAuthorizationStorage() private pure returns (ObjectAuthorizationStorage storage $);

__ObjectAuthorization_init

function __ObjectAuthorization_init() internal onlyInitializing;

grantFrom

Issues a grant to allow initiating relations from a tail object

function grantFrom(uint128 tail, RelationGrant memory grant) external;

Parameters

revokeFrom

Revokes a previously issued from grant

function revokeFrom(uint128 tail, uint32 grantId) external;

Parameters

grantTo

Issues a grant to allow accepting relations to a head object

function grantTo(uint128 head, RelationGrant memory grant) external;

Parameters

revokeTo

Revokes a previously issued to grant

function revokeTo(uint128 head, uint32 grantId) external;

Parameters

allowFrom

Checks whether a sender is authorized to initiate a relation from a tail object

function allowFrom(uint32 grantId, address sender, uint128 tail, uint64 rel, uint64 headKind, uint64 headSet)
    external
    view
    returns (bool allow);

Parameters

Returns

allowTo

Checks whether a sender is authorized to accept a relation to a head object

function allowTo(uint32 grantId, address sender, uint128 head, uint64 rel, uint64 tailKind, uint64 tailSet)
    external
    view
    returns (bool);

Parameters

Returns

_objectInfo

function _objectInfo(uint64 set, uint64 id)
    internal
    view
    virtual
    returns (Descriptor memory meta, address setContract, address owner);

_objectInfo

function _objectInfo(uint128 sid)
    private
    view
    returns (uint64 id, Descriptor memory meta, address setContract, address owner);

_validateHolder

function _validateHolder(address holder, bytes32 holding) internal view virtual returns (bool);

_validateGrantSpec

function _validateGrantSpec(RelationGrant memory grant) private view;

_validateGrant

function _validateGrant(
    RelationGrant memory grant,
    address sender,
    uint128 sid,
    uint64 rel,
    uint64 kind,
    uint64 set
) private view returns (bool);

_grantKey

function _grantKey(uint8 direction, uint128 sid, uint32 grantId) private pure returns (uint256);

_pointerKey

function _pointerKey(uint8 direction, uint128 sid) private pure returns (uint256);

Structs

GrantPointer

struct GrantPointer {
    uint32 lastId;
    uint32 minValidId;
}

ObjectAuthorizationStorage

Note: storage-location: erc7201:every.storage.ObjectAuthorization

struct ObjectAuthorizationStorage {
    mapping(uint256 => GrantPointer) pointers; // dir_sid_00 => pointer
    mapping(uint256 => RelationGrant) grants; // dir_sid_id => grant
}

Enums

Direction

enum Direction {
    None,
    From,
    To
}

GrantStatus

enum GrantStatus {
    None,
    Granted,
    Revoked
}

ObjectInteraction

Git Source

Inherits: IObjectInteraction, OmniRegistryErrors, Soke

Tracks directed arcs between objects

State Variables

OBJECTDIGRAPH_STORAGE_LOCATION

Deterministic storage slot per ERC-7201

keccak256(abi.encode(uint256(keccak256("every.storage.ObjectDigraph")) - 1)) & ~bytes32(uint256(0xff))

bytes32 private constant OBJECTDIGRAPH_STORAGE_LOCATION =
    0x3df9584b527247f4900a5c6b7a8400cffee00eb89e1f2f5ad0861af4fb4c0500

Functions

_getObjectDigraphStorage

function _getObjectDigraphStorage() private pure returns (ObjectDigraphStorage storage $);

__ObjectInteraction_init

function __ObjectInteraction_init() internal onlyInitializing;

relate

Links a tail object to a head object through a relation

function relate(uint256 tail, uint64 rel, uint256 head) external override;

Parameters

unrelate

Unlinks a tail object from a head object

function unrelate(uint256 tail, uint64 rel, uint256 head) external override;

Parameters

_kindAdmit

function _kindAdmit(uint64 kind, uint32 rev, uint64 rel) internal view virtual returns (bool admit, uint32 relRev);

_relationAdmit

function _relationAdmit(uint64 rel, uint32 rev, uint64 kind)
    internal
    view
    virtual
    returns (bool admit, uint48 effKind, uint16 effDegs, uint48 totalKind, uint16 totalDegs);

_relationRule

function _relationRule(uint64 rel) internal view virtual returns (RelationRule memory rule);

_objectInfo

function _objectInfo(uint64 set, uint64 id)
    internal
    view
    virtual
    returns (Descriptor memory meta, address setContract, address owner);

_allowFrom

function _allowFrom(uint32 grant, address sender, uint128 tail, uint64 rel, uint64 headKind, uint64 headSet)
    internal
    view
    virtual
    returns (bool allow);

_allowTo

function _allowTo(uint32 grant, address sender, uint128 head, uint64 rel, uint64 tailKind, uint64 tailSet)
    internal
    view
    virtual
    returns (bool allow);

_transferTailObjectOnRelate

function _transferTailObjectOnRelate(
    RelationRule memory rule,
    ObjectInfo memory tail,
    ObjectInfo memory head,
    address caller
) private returns (HoldingState holdingState, address holdingExtra);

_transferTailObjectOnUnrelate

function _transferTailObjectOnUnrelate(
    RichArc memory arc,
    RelationRule memory rule,
    ObjectInfo memory tail,
    ObjectInfo memory head,
    address caller
) private;

_executeHeadHookOnRelate

function _executeHeadHookOnRelate(ObjectInfo memory head, uint64 rel, uint64 tailData, ObjectInfo memory tail)
    private
    returns (Descriptor memory meta);

_executeHeadHookOnUnrelate

function _executeHeadHookOnUnrelate(ObjectInfo memory head, uint64 rel, uint64 tailData, ObjectInfo memory tail)
    private
    returns (Descriptor memory meta);

_requireKindAdmitRelation

function _requireKindAdmitRelation(uint64 headKind, uint32 kindRev, uint64 rel) private view returns (uint32);

_requireRelationAdmitKind

function _requireRelationAdmitKind(uint64 rel, uint32 relRev, uint64 tailKind)
    private
    view
    returns (DegreeBounds memory bounds, RelationRule memory rule);

_requireNoOutgoingArc

function _requireNoOutgoingArc(uint128 tail) private view;

_requireArcExists

function _requireArcExists(uint128 tail, uint128 head, uint64 rel) private view returns (RichArc memory arc);

_requirePostDegreeInRange

function _requirePostDegreeInRange(uint128 headSid, uint64 rel, int256 delta, DegreeBounds memory bounds)
    private
    view
    returns (uint256 effkindKey, uint256 totalKey);

_requireObjectExists

function _requireObjectExists(uint128 sid) private view returns (ObjectInfo memory);

_requireRelateAllowed

function _requireRelateAllowed(
    uint64 rel,
    ObjectInfo memory tail,
    ObjectInfo memory head,
    address caller,
    uint32 tailGrant,
    uint32 headGrant
) private view;

_requireUnrelateAllowed

function _requireUnrelateAllowed(
    RichArc memory arc,
    RelationRule memory rule,
    ObjectInfo memory tail,
    ObjectInfo memory head,
    address caller
) private view;

_requireDegreeInRange

function _requireDegreeInRange(uint256 deg, uint48 kind, uint16 degs) private pure;

_calcNewOwner

function _calcNewOwner(address tailOwner, address headOwner, address caller, address extra, HoldingState s)
    private
    pure
    returns (address newOwner);

_makeDegreeKey

function _makeDegreeKey(uint128 sid, uint64 rel, uint48 kind) private pure returns (uint256);

_encodeArc

function _encodeArc(uint64 rel, uint64 data, uint128 sid) private pure returns (uint256 arc);

_decodeVertex

function _decodeVertex(uint256 vtx) private pure returns (uint64 data, uint32 grant, uint128 sid);

Structs

RichArc

struct RichArc {
    uint48 time; // timestamp in seconds that the link established
    uint48 effKind; // Kind ID (0 = others, 1..2^48-2 = specific kind)
    uint48 rel; // the realtion id
    uint112 head; // head object sid(set(u48), id(u64)), since set id < ypte(uint48).max
    uint8 holdingState; // HoldFor
    address holdingExtra; // address if HoldForFixed, 0 ohterwise
    uint24 padding;
    uint64 relData; // relation data
}

RelationOwnerShiftPlan

struct RelationOwnerShiftPlan {
    bool transfer;
    HoldingState holdingState;
    address from;
    address to;
    address holdingExtra;
}

ObjectInfo

struct ObjectInfo {
    uint64 id;
    uint128 sid;
    Descriptor meta;
    address setContract;
    address owner;
}

DegreeBounds

struct DegreeBounds {
    uint48 kind;
    uint16 kindDegs;
    uint48 totalKind;
    uint16 totalDegs;
}

ObjectDigraphStorage

Note: storage-location: erc7201:every.storage.ObjectDigraph

struct ObjectDigraphStorage {
    /// @dev Tracks outgoing links of each tail object
    mapping(uint128 => RichArc) outArcs;
    /// @dev Tracks indegrees of each head object per relation and kind((effKind, rel, headSet, headId))
    mapping(uint256 => uint256) inDegs;
}

Enums

HoldingState

enum HoldingState {
    None,
    TailOwner,
    HeadOwner,
    Caller,
    Preset,
    Burned,
    Resolved,
    Pending
}

OmniRegistryErrors

Git Source

Errors

InvalidCode

error InvalidCode();

InvalidData

error InvalidData();

Unimplemented

error Unimplemented();

RecordNotExist

error RecordNotExist(uint64 id);

AdjacencyUnderflow

error AdjacencyUnderflow();

AdjacencyOverflow

error AdjacencyOverflow();

AdjacencyUnordered

error AdjacencyUnordered();

AdjacencyKindNotExist

error AdjacencyKindNotExist();

HeadKindRejectsRelation

error HeadKindRejectsRelation();

RelationRejectsTailKind

error RelationRejectsTailKind();

HeadSetRejectsTailObject

error HeadSetRejectsTailObject();

DegreeOverflow

error DegreeOverflow(uint48 kind);

DegreeUnderflow

error DegreeUnderflow(uint48 kind);

ArcExists

error ArcExists();

ArcNotExist

error ArcNotExist();

ArcMismatch

error ArcMismatch();

InvalidKind

error InvalidKind();

InvalidRelation

error InvalidRelation();

InvalidRelateShift

error InvalidRelateShift();

InvalidUnrelateShift

error InvalidUnrelateShift();

UnsupportedHoldingState

error UnsupportedHoldingState();

UnrelateLocked

error UnrelateLocked();

GrantNotFound

error GrantNotFound();

GrantRevoked

error GrantRevoked();

GrantFilterRelationInvalid

error GrantFilterRelationInvalid();

GrantFilterKindInvalid

error GrantFilterKindInvalid();

GrantFilterSetInvalid

error GrantFilterSetInvalid();

GrantInitiatorAnyoneExtraNotAllowed

error GrantInitiatorAnyoneExtraNotAllowed();

GrantInitiatorOwnerExtraNotAllowed

error GrantInitiatorOwnerExtraNotAllowed();

GrantInitiatorDelegateAddressInvalid

error GrantInitiatorDelegateAddressInvalid();

GrantInitiatorEligibleAddressInvalid

error GrantInitiatorEligibleAddressInvalid();

GrantInitiatorEligibleNotContract

error GrantInitiatorEligibleNotContract();

GrantInitiatorHolderValueParamsInvalid

error GrantInitiatorHolderValueParamsInvalid();

GrantInitiatorHolderUniqueParamsInvalid

error GrantInitiatorHolderUniqueParamsInvalid();

GrantInitiatorHolderObjectParamsInvalid

error GrantInitiatorHolderObjectParamsInvalid();

GrantInitiatorHolderTokenTypeUnknown

error GrantInitiatorHolderTokenTypeUnknown();

GrantInitiatorTypeUnknown

error GrantInitiatorTypeUnknown();

UnauthorizedAccess

error UnauthorizedAccess(uint64 id, address vistor);

Unauthorized

error Unauthorized();

RelationAdjacencies

Git Source

Inherits: OmniRegistryErrors, Initializable

Stores and verifies relation adjacency specs

State Variables

RELATIONADJACENCIES_STORAGE_LOCATION

Deterministic storage slot per ERC-7201

keccak256(abi.encode(uint256(keccak256("every.storage.RelationAdjacencies")) - 1)) & ~bytes32(uint256(0xff))

bytes32 private constant RELATIONADJACENCIES_STORAGE_LOCATION =
    0x8f9f6b9dd32d65efadc33d5cec42974db93f3ef45f03c2694c960af8740c1c00

Functions

_getRelationAdjacenciesStorage

function _getRelationAdjacenciesStorage() private pure returns (RelationAdjacenciesStorage storage $);

__RelationAdjacencies_init

function __RelationAdjacencies_init() internal onlyInitializing;

_insert

function _insert(Adjacency[] memory adjs) internal returns (bytes32 specId);

_admit

function _admit(bytes32 specId, uint48 kind)
    internal
    view
    returns (bool admit, uint48 effKind, uint16 effDegs, uint48 totalKind, uint16 totalDegs);

_validate

function _validate(Adjacency[] memory adjs) internal pure returns (SpecIndex memory result);

_hash

function _hash(Adjacency[] memory adjs) private pure returns (bytes32 specId);

_hash

function _hash(bytes32 a0, bytes32 a1, bytes32 a2, bytes32 a3) private pure returns (bytes32 specId);

Structs

KindIndex

struct KindIndex {
    uint16 kindDegs;
    uint16 totalDegs; // duplicated to faciliate queries
    bool status;
    bool totalSpecified;
}

SpecIndex

struct SpecIndex {
    uint16 othersDegs;
    uint16 totalDegs; // duplicated to faciliate queries
    bool status;
    bool totalSpecified;
    bool othersSpecified;
    uint8 kindsSpecified;
}

RelationAdjacenciesStorage

Note: storage-location: erc7201:every.storage.RelationAdjacencies

struct RelationAdjacenciesStorage {
    mapping(bytes32 => mapping(uint48 => KindIndex)) kindIndices;
    mapping(bytes32 => SpecIndex) specIndices;
}

RelationElements

Git Source

State Variables

CODE

uint256 constant CODE = 0

DATA

uint256 constant DATA = 1

RULE

uint256 constant RULE = 2

ADJS0

uint256 constant ADJS0 = 3

ADJS1

uint256 constant ADJS1 = 4

ADJS2

uint256 constant ADJS2 = 5

ADJS3

uint256 constant ADJS3 = 6

INDICES

uint256 constant INDICES = 7

COUNT

uint256 constant COUNT = 8

Structs

View

struct View {
    MatterHash code; // Logic for processing the relation
    MatterHash data; // Metadata about the relation
    Info rule; // Relation rule
    Info adjs0; // Adjacency slot 0
    Info adjs1; // Adjacency slot 1
    Info adjs2; // Adjacency slot 2
    Info adjs3; // Adjacency slot 3
    Info indices; // Adjacency indices
}

RelationRegistry

Git Source

Inherits: IRelationRegistry, OmniRegistryErrors, Soke, RelationAdjacencies

Relation registration and management

State Variables

RELATIONREGISTRY_STORAGE_LOCATION

Deterministic storage slot per ERC-7201

keccak256(abi.encode(uint256(keccak256("every.storage.RelationRegistry")) - 1)) & ~bytes32(uint256(0xff))

bytes32 private constant RELATIONREGISTRY_STORAGE_LOCATION =
    0xb889e63ac5a7d4985910c5a264fb181e381a8a3f46d10618004be5e9438ffc00

Functions

_getRelationRegistryStorage

function _getRelationRegistryStorage() private pure returns (RelationRegistryStorage storage $);

__RelationRegistry_init

function __RelationRegistry_init() internal onlyInitializing;

relationRegister

Registers a new relation

function relationRegister(address code, bytes32 data, RelationRule memory rule, Adjacency[] memory adjs)
    external
    override
    returns (uint64 id, Descriptor memory meta);

Parameters

Returns

relationUpdate

Updates the data hash of a relation

function relationUpdate(uint64 id, bytes32 data) external override returns (Descriptor memory meta);

Parameters

Returns

relationUpdate

Updates the data hash of a relation

function relationUpdate(uint64 id, bytes32 data, Adjacency[] memory adjs)
    external
    override
    returns (Descriptor memory meta);

Parameters

Returns

relationUpgrade

Upgrades the kind or set revision of a relation

function relationUpgrade(uint64 id, uint32 kindRev, uint32 setRev)
    external
    override
    returns (Descriptor memory meta);

Parameters

Returns

relationTouch

Touches a relation (bumps revision without modifying content)

function relationTouch(uint64 id) external override returns (Descriptor memory meta);

Parameters

Returns

relationTransfer

Transfers ownership of a relation to a new address

function relationTransfer(uint64 id, address to) external override returns (address from);

Parameters

Returns

relationRevision

Resolves and validates a revision number

function relationRevision(uint64 id, uint32 rev0) external view override returns (uint32 rev);

Parameters

Returns

relationDescriptor

Returns descriptor of a relation at a specific revision

function relationDescriptor(uint64 id, uint32 rev0) external view override returns (Descriptor memory desc);

Parameters

Returns

relationSnapshot

Returns descriptor and packed elements at a specific revision

function relationSnapshot(uint64 id, uint32 rev0)
    external
    view
    override
    returns (Descriptor memory desc, bytes32[] memory elems);

Parameters

Returns

relationOwner

Gets the current owner of a relation

function relationOwner(uint64 id) external view override returns (address owner);

Parameters

Returns

relationSota

Returns the latest descriptor and current owner of a relation

function relationSota(uint64 id) external view override returns (Descriptor memory desc, address owner);

Parameters

Returns

relationStatus

Checks whether all specified relations are active (rev > 0)

function relationStatus(uint64[] memory ids) external view override returns (bool active);

Parameters

Returns

relationRule

Returns the rule definition for a relation

function relationRule(uint64 id) external view override returns (RelationRule memory rule);

Parameters

Returns

relationAdmit

Checks if a relation admits a specific kind as tail

function relationAdmit(uint64 id, uint32 rev, uint64 kind)
    external
    view
    override
    returns (bool admit, uint48 effKind, uint16 effDegs, uint48 totalKind, uint16 totalDegs);

Parameters

Returns

_relationAdmit

function _relationAdmit(uint64 id, uint32 rev, uint64 kind)
    internal
    view
    virtual
    returns (bool admit, uint48 effKind, uint16 effDegs, uint48 totalKind, uint16 totalDegs);

_relationRule

function _relationRule(uint64 id) internal view virtual returns (RelationRule memory rule);

_kindOfRelationRevision

Returns the latest revision of the Kind-of-Value object

function _kindOfRelationRevision() private view returns (uint32);

_setOfRelationRevision

Returns the latest revision of the Set-of-Value object

function _setOfRelationRevision() private view returns (uint32);

Structs

RelationRegistryStorage

Note: storage-location: erc7201:every.storage.RelationRegistry

struct RelationRegistryStorage {
    Counter48.Counter counter;
    Snapshots.Storage relations;
}

Contents

• SetElements
• SetRegistryErrors

SetElements

Git Source

State Variables

CODE

uint256 constant CODE = 0

DATA

uint256 constant DATA = 1

COUNT

uint256 constant COUNT = 2

Structs

View

struct View {
    MatterHash code;
    MatterHash data;
}

SetRegistryErrors

Git Source

Errors

InvalidIntializeArguments

error InvalidIntializeArguments();

InvalidCode

error InvalidCode();

InvalidData

error InvalidData();

SetContractNoCode

error SetContractNoCode();

SetContractNotIObjectInteractionHook

error SetContractNotIObjectInteractionHook();

SetContractNotISet

error SetContractNotISet();

SetContractAlreadyRegistered

error SetContractAlreadyRegistered();

SetContractNotRegistered

error SetContractNotRegistered();

OnSetRegisterRejected

error OnSetRegisterRejected();

OnSetRegisterReverted

error OnSetRegisterReverted();

OnSetUpdateRejected

error OnSetUpdateRejected();

OnSetUpdateReverted

error OnSetUpdateReverted();

OnSetUpgradeRejected

error OnSetUpgradeRejected();

OnSetUpgradeReverted

error OnSetUpgradeReverted();

OnSetTouchRejected

error OnSetTouchRejected();

OnSetTouchReverted

error OnSetTouchReverted();

NoRevisionSpecified

error NoRevisionSpecified();

UnauthorizedAccess

error UnauthorizedAccess(uint64 id, address vistor);

Soke

Git Source

Inherits: Initializable

State Variables

SOKE_STORAGE_LOCATION

bytes32 private constant SOKE_STORAGE_LOCATION = 0x389a4784c2c3e8284bc1418c5b9cf4b556f52088a652459a6e23aae4f7902700

Functions

_getSokeStorage

function _getSokeStorage() private pure returns (SokeStorage storage $);

__Soke_init

function __Soke_init(address setr, address omnir, address kindr, address elemr) internal onlyInitializing;

setRegistry

function setRegistry() public view returns (address);

omniRegistry

function omniRegistry() public view returns (address);

kindRegistry

function kindRegistry() public view returns (address);

elementRegistry

function elementRegistry() public view returns (address);

Structs

SokeStorage

Note: storage-location: erc7201:every.storage.Soke

struct SokeStorage {
    address setRegistry;
    address omniRegistry;
    address kindRegistry;
    address elementRegistry;
}

Contents

• core
• external
• user
• ISoke

Contents

• IElementRegistry
• IKindRegistry
• IObjectAuthorization
• IObjectInteraction
• IObjectMinter
• IOmniRegistry
• IRelationRegistry
• ISetRegistry
• IUniqueRegistry
• IValueRegistry

IElementRegistry

Git Source

Inherits: IValueRegistry, IUniqueRegistry

Element registration and management

IKindRegistry

Git Source

Interface for managing and registering object kinds

Functions

kindRegister

Registers a new kind

function kindRegister(bytes32 code, bytes32 data, uint8[] memory elemSpec, uint64[] memory rels)
    external
    returns (uint64 id, Descriptor memory desc);

Parameters

Returns

kindUpdate

Updates code and/or data of an existing kind

function kindUpdate(uint64 id, bytes32 code, bytes32 data) external returns (Descriptor memory desc);

Parameters

Returns

kindUpdate

Updates supported relations of an existing kind

function kindUpdate(uint64 id, uint64[] memory rels) external returns (Descriptor memory desc);

Parameters

Returns

kindUpdate

Updates code, data, and relations of an existing kind

function kindUpdate(uint64 id, bytes32 code, bytes32 data, uint64[] memory rels)
    external
    returns (Descriptor memory desc);

Parameters

Returns

kindUpgrade

Upgrades kind/set revision of an existing kind

function kindUpgrade(uint64 id, uint32 kindRev, uint32 setRev) external returns (Descriptor memory desc);

Parameters

Returns

kindTouch

Touches a kind (bumps revision with no content changes)

function kindTouch(uint64 id) external returns (Descriptor memory desc);

Parameters

Returns

kindTransfer

Transfers ownership of a kind

function kindTransfer(uint64 id, address to) external returns (address from);

Parameters

Returns

kindRevision

Resolves and validates a specific revision

function kindRevision(uint64 id, uint32 rev0) external view returns (uint32 rev);

Parameters

Returns

kindDescriptor

Returns the descriptor at a given revision

function kindDescriptor(uint64 id, uint32 rev0) external view returns (Descriptor memory desc);

Parameters

Returns

kindSnapshot

Returns descriptor and elements at a specific revision

function kindSnapshot(uint64 id, uint32 rev0) external view returns (Descriptor memory desc, bytes32[] memory elems);

Parameters

Returns

kindOwner

Returns the current owner of a kind

function kindOwner(uint64 id) external view returns (address owner);

Parameters

Returns

kindSota

Returns the latest descriptor and current owner of a kind

function kindSota(uint64 id) external view returns (Descriptor memory desc, address owner);

Parameters

Returns

kindStatus

Checks whether all specified kinds are active (rev > 0)

function kindStatus(uint64[] memory ids) external view returns (bool active);

Parameters

Returns

kindAdmit

Checks whether a kind at a given revision admits a specific relation

function kindAdmit(uint64 kind, uint32 rev, uint64 rel) external view returns (bool admit, uint32 relRev);

Parameters

Returns

Events

KindRegistered

Emitted when a new kind is registered

event KindRegistered(
    uint64 id, Descriptor desc, bytes32 code, bytes32 data, uint8[] elemSpec, uint64[] rels, address owner
);

Parameters

KindUpdated

Emitted when a kind is updated

event KindUpdated(uint64 id, Descriptor desc, bytes32 code, bytes32 data, uint64[] rels);

Parameters

KindUpgraded

Emitted when a kind is upgraded

event KindUpgraded(uint64 id, Descriptor desc);

Parameters

KindTouched

Emitted when a kind is touched (revision bump only)

event KindTouched(uint64 id, Descriptor desc);

Parameters

KindTransferred

Emitted when kind ownership is transferred

event KindTransferred(uint64 id, Descriptor desc, address from, address to);

Parameters

IObjectAuthorization

Git Source

Handles fine-grained authorization for object relations.

Grants control who can initiate (from) or accept (to) object-to-object relations, scoped by direction, relation ID, kind, and set.

Functions

grantFrom

Issues a grant to allow initiating relations from a tail object

function grantFrom(uint128 tail, RelationGrant memory grant) external;

Parameters

revokeFrom

Revokes a previously issued from grant

function revokeFrom(uint128 tail, uint32 grantId) external;

Parameters

grantTo

Issues a grant to allow accepting relations to a head object

function grantTo(uint128 head, RelationGrant memory grant) external;

Parameters

revokeTo

Revokes a previously issued to grant

function revokeTo(uint128 head, uint32 grantId) external;

Parameters

allowFrom

Checks whether a sender is authorized to initiate a relation from a tail object

function allowFrom(uint32 grantId, address sender, uint128 tail, uint64 rel, uint64 headKind, uint64 headSet)
    external
    view
    returns (bool allowed);

Parameters

Returns

allowTo

Checks whether a sender is authorized to accept a relation to a head object

function allowTo(uint32 grantId, address sender, uint128 head, uint64 rel, uint64 tailKind, uint64 tailSet)
    external
    view
    returns (bool allowed);

Parameters

Returns

Events

GrantFrom

Emitted when a grant is issued to authorize initiating a relation from a tail object

event GrantFrom(uint128 tail, RelationGrant grant);

Parameters

RevokeFrom

Emitted when a grant from a tail object is revoked

event RevokeFrom(uint128 tail, uint32 grantId);

Parameters

GrantTo

Emitted when a grant is issued to authorize accepting a relation to a head object

event GrantTo(uint128 head, RelationGrant grant);

Parameters

RevokeTo

Emitted when a grant to a head object is revoked

event RevokeTo(uint128 head, uint32 grantId);

Parameters

IObjectInteraction

Git Source

Handles object interactions via directed relations (arcs).

Encodings:

• SID : {uint64 set | uint64 id} → uint128
• Node : {uint64 data | uint32 _ | uint32 grant | uint64 set | uint64 id} → uint256
• Arc : {uint64 data | uint64 rel | uint64 set | uint64 id} → uint256

Functions

relate

Links a tail object to a head object through a relation

function relate(uint256 tail, uint64 rel, uint256 head) external;

Parameters

unrelate

Unlinks a tail object from a head object

function unrelate(uint256 tail, uint64 rel, uint256 head) external;

Parameters

Events

Related

Emitted when a tail is linked to a head through a relation

event Related(uint128 head, Descriptor desc, uint256 arc);

Parameters

Related

Emitted when multiple tails are linked to a head

event Related(uint128 head, Descriptor desc, uint256[] arcs);

Parameters

Unrelated

Emitted when a tail is unlinked from a head

event Unrelated(uint128 head, Descriptor desc, uint256 arc);

Parameters

Unrelated

Emitted when multiple tails are unlinked from a head

event Unrelated(uint128 head, Descriptor desc, uint256[] arcs);

Parameters

IObjectMinter

Git Source

Interface for minting objects with configurable policies

Functions

mint

Mint an object (public permission)

function mint(address to, address set, uint64 id) external payable;

Parameters

mint

Mint an object with additional data

function mint(address to, address set, uint64 id, bytes memory data) external payable;

Parameters

mint

Mint an object with allowlist proof

function mint(address to, address set, uint64 id, bytes memory auth, uint32 policy) external payable;

Parameters

mint

Mint an object with allowlist proof and additional data

function mint(address to, address set, uint64 id, bytes memory data, bytes memory auth, uint32 policy)
    external
    payable;

Parameters

mintPolicyAdd

Add a new mint policy (callable only by set contracts)

function mintPolicyAdd(MintPolicy memory policy) external returns (uint32 index);

Parameters

Returns

mintPolicyDisable

Disable a mint policy (callable only by set contracts)

function mintPolicyDisable(uint32 index) external;

Parameters

mintPolicyEnable

Enable a mint policy (callable only by set contracts)

function mintPolicyEnable(uint32 index) external;

Parameters

mintPolicyCount

Get number of mint policies for a set

function mintPolicyCount(address set) external view returns (uint256 count);

Parameters

Returns

mintPolicyGet

Get mint policy by index

function mintPolicyGet(address set, uint32 index) external view returns (MintPolicy memory policy);

Parameters

Returns

mintPolicySearch

Search for applicable mint policy with permission mask

function mintPolicySearch(address set, uint64 id, uint8 mask) external view returns (MintPolicy memory policy);

Parameters

Returns

mintPolicySearch

Search for applicable mint policy with offset and permission mask

function mintPolicySearch(address set, uint64 id, uint8 mask, uint32 offset)
    external
    view
    returns (MintPolicy memory policy);

Parameters

Returns

Events

MintPolicyEnabled

Emitted when a mint policy is enabled

event MintPolicyEnabled(address set, MintPolicy policy);

Parameters

MintPolicyDisabled

Emitted when a mint policy is disabled

event MintPolicyDisabled(address set, MintPolicy policy);

Parameters

ObjectMinted

Emitted when an object is successfully minted

event ObjectMinted(
    address set,
    uint64 id,
    address operator,
    address to,
    address currency,
    uint96 payment,
    address fundsRecipient,
    uint96 funds,
    address feeRecipient,
    uint96 fee
);

Parameters

IOmniRegistry

Git Source

Inherits: IRelationRegistry, IObjectAuthorization, IObjectInteraction

Interface for object interactions

IRelationRegistry

Git Source

Interface for registering and managing relations

Functions

relationRegister

Registers a new relation

function relationRegister(address code, bytes32 data, RelationRule memory rule, Adjacency[] memory adjs)
    external
    returns (uint64 id, Descriptor memory desc);

Parameters

Returns

relationUpdate

Updates the data hash of a relation

function relationUpdate(uint64 id, bytes32 data) external returns (Descriptor memory desc);

Parameters

Returns

relationUpdate

Updates the data hash and adjacency configuration of a relation

function relationUpdate(uint64 id, bytes32 data, Adjacency[] memory adjs) external returns (Descriptor memory desc);

Parameters

Returns

relationUpgrade

Upgrades the kind or set revision of a relation

function relationUpgrade(uint64 id, uint32 kindRev, uint32 setRev) external returns (Descriptor memory desc);

Parameters

Returns

relationTouch

Touches a relation (bumps revision without modifying content)

function relationTouch(uint64 id) external returns (Descriptor memory desc);

Parameters

Returns

relationTransfer

Transfers ownership of a relation to a new address

function relationTransfer(uint64 id, address to) external returns (address from);

Parameters

Returns

relationRevision

Resolves and validates a revision number

function relationRevision(uint64 id, uint32 rev0) external view returns (uint32 rev);

Parameters

Returns

relationDescriptor

Returns descriptor of a relation at a specific revision

function relationDescriptor(uint64 id, uint32 rev0) external view returns (Descriptor memory desc);

Parameters

Returns

relationSnapshot

Returns descriptor and packed elements at a specific revision

function relationSnapshot(uint64 id, uint32 rev0)
    external
    view
    returns (Descriptor memory desc, bytes32[] memory elems);

Parameters

Returns

relationOwner

Gets the current owner of a relation

function relationOwner(uint64 id) external view returns (address owner);

Parameters

Returns

relationSota

Returns the latest descriptor and current owner of a relation

function relationSota(uint64 id) external view returns (Descriptor memory desc, address owner);

Parameters

Returns

relationStatus

Checks whether all specified relations are active (rev > 0)

function relationStatus(uint64[] memory ids) external view returns (bool active);

Parameters

Returns

relationRule

Returns the rule definition for a relation

function relationRule(uint64 id) external view returns (RelationRule memory rule);

Parameters

Returns

relationAdmit

Checks if a relation admits a specific kind as tail

function relationAdmit(uint64 id, uint32 rev, uint64 kind)
    external
    view
    returns (bool admit, uint48 effKind, uint16 effDegs, uint48 totalKind, uint16 totalDegs);

Parameters

Returns

Events

RelationRegistered

Emitted when a new relation is registered

event RelationRegistered(
    uint64 id, Descriptor desc, address code, bytes32 data, RelationRule rule, Adjacency[] adjs, address owner
);

Parameters

RelationUpdated

Emitted when a relation is updated

event RelationUpdated(uint64 id, Descriptor desc, bytes32 data);

Parameters

RelationUpdated

Emitted when a relation is updated

event RelationUpdated(uint64 id, Descriptor desc, bytes32 data, Adjacency[] adjs);

Parameters

RelationUpgraded

Emitted when a relation is upgraded (kind/set revision bumped)

event RelationUpgraded(uint64 id, Descriptor desc);

Parameters

RelationTouched

Emitted when a relation is touched (revision incremented without content change)

event RelationTouched(uint64 id, Descriptor desc);

Parameters

RelationTransferred

Emitted when ownership of a relation is transferred

event RelationTransferred(uint64 id, Descriptor desc, address from, address to);

Parameters

ISetRegistry

Git Source

Interface for registering and managing sets

Functions

setRegister

Registers a new set

function setRegister(bytes32 data) external returns (uint64 id, Descriptor memory desc);

Parameters

Returns

setUpdate

Updates the data hash of an existing set

function setUpdate(uint64 id, bytes32 data) external returns (Descriptor memory desc);

Parameters

Returns

setUpgrade

Upgrades the kind or set revision

function setUpgrade(uint64 id, uint32 kindRev, uint32 setRev) external returns (Descriptor memory desc);

Parameters

Returns

setTouch

Touches a set (increments revision without any changes)

function setTouch(uint64 id) external returns (Descriptor memory desc);

Parameters

Returns

setURI

Returns the URI template for objects in the given set

The returned template includes {id} and {rev} placeholders, which clients should replace with the object ID and revision number to construct the full object URI off-chain.

function setURI(uint64 id) external view returns (string memory uri);

Parameters

Returns

setURI

Returns the fully resolved URI for a specific object in a set

Substitutes {id} and {rev} in the set’s URI template using the provided object ID and revision.

function setURI(uint64 id, uint64 objId, uint32 objRev) external view returns (string memory uri);

Parameters

Returns

setRevision

Resolves and validates a specific revision

function setRevision(uint64 id, uint32 rev0) external view returns (uint32 rev);

Parameters

Returns

setDescriptor

Returns the descriptor at a given revision

function setDescriptor(uint64 id, uint32 rev0) external view returns (Descriptor memory desc);

Parameters

Returns

setSnapshot

Returns descriptor and elements of a set at a specific revision

function setSnapshot(uint64 id, uint32 rev0) external view returns (Descriptor memory desc, bytes32[] memory elems);

Parameters

Returns

setOwner

Returns the current owner of a set

function setOwner(uint64 id) external view returns (address owner);

Parameters

Returns

setSota

Returns the latest descriptor and current owner

function setSota(uint64 id) external view returns (Descriptor memory desc, address owner);

Parameters

Returns

setStatus

Checks whether all provided set IDs are active

function setStatus(uint64[] memory ids) external view returns (bool active);

Parameters

Returns

setContract

Returns the contract address associated with a set

function setContract(uint64 id) external view returns (address code);

Parameters

Returns

Events

SetRegistered

Emitted when a new set is registered

event SetRegistered(uint64 id, Descriptor desc, address code, bytes32 data, address owner);

Parameters

SetUpdated

Emitted when a set is updated

event SetUpdated(uint64 id, Descriptor desc, bytes32 data);

Parameters

SetUpgraded

Emitted when a set is upgraded

event SetUpgraded(uint64 id, Descriptor desc);

Parameters

SetTouched

Emitted when a set is touched (revision bumped without content change)

event SetTouched(uint64 id, Descriptor desc);

Parameters

IUniqueRegistry

Git Source

Interface for registering and managing uniques

Functions

uniqueRegister

Registers a new unique token

function uniqueRegister(address code, bytes32 data, TokenStandard std, uint8 decimals, string memory symbol)
    external
    returns (uint64 id, Descriptor memory desc);

Parameters

Returns

uniqueUpdate

Updates the data hash of a unique

function uniqueUpdate(uint64 id, bytes32 data) external returns (Descriptor memory desc);

Parameters

Returns

uniqueUpdate

Updates the data hash and symbol of a unique

function uniqueUpdate(uint64 id, bytes32 data, string memory symbol) external returns (Descriptor memory desc);

Parameters

Returns

uniqueUpgrade

Upgrades the kind and/or set revision of a unique

function uniqueUpgrade(uint64 id, uint32 kindRev, uint32 setRev) external returns (Descriptor memory desc);

Parameters

Returns

uniqueTouch

Bumps the revision of a unique with no content change

function uniqueTouch(uint64 id) external returns (Descriptor memory desc);

Parameters

Returns

uniqueTransfer

Transfers ownership of a unique token

function uniqueTransfer(uint64 id, address to) external returns (address from);

Parameters

Returns

uniqueRevision

Resolves and validates a revision

function uniqueRevision(uint64 id, uint32 rev0) external view returns (uint32 rev);

Parameters

Returns

uniqueDescriptor

Returns the descriptor at a given revision

function uniqueDescriptor(uint64 id, uint32 rev0) external view returns (Descriptor memory desc);

Parameters

Returns

uniqueSnapshot

Returns descriptor and elements at a specific revision

function uniqueSnapshot(uint64 id, uint32 rev0)
    external
    view
    returns (Descriptor memory desc, bytes32[] memory elems);

Parameters

Returns

uniqueOwner

Returns the current owner of a unique

function uniqueOwner(uint64 id) external view returns (address owner);

Parameters

Returns

uniqueSota

Returns the latest descriptor and current owner

function uniqueSota(uint64 id) external view returns (Descriptor memory desc, address owner);

Parameters

Returns

uniqueStatus

Checks whether all given uniques are active (revision > 0)

function uniqueStatus(uint64[] memory ids) external view returns (bool active);

Parameters

Returns

Events

UniqueRegistered

Emitted when a new unique is registered

event UniqueRegistered(uint64 id, Descriptor desc, address code, bytes32 data, TokenSpec spec, address owner);

Parameters

UniqueUpdated

Emitted when a unique is updated

event UniqueUpdated(uint64 id, Descriptor desc, bytes32 data, TokenSpec spec);

Parameters

UniqueUpgraded

Emitted when a unique is upgraded to a new revision

event UniqueUpgraded(uint64 id, Descriptor desc);

Parameters

UniqueTouched

Emitted when a unique is touched (revision bumped with no content change)

event UniqueTouched(uint64 id, Descriptor desc);

Parameters

UniqueTransferred

Emitted when ownership of a unique is transferred

event UniqueTransferred(uint64 id, Descriptor desc, address from, address to);

Parameters

IValueRegistry

Git Source

Interface for registering and managing values

Functions

valueRegister

Registers a new value token

function valueRegister(address code, bytes32 data, TokenStandard std, uint8 decimals, string memory symbol)
    external
    returns (uint64 id, Descriptor memory desc);

Parameters

Returns

valueUpdate

Updates the data hash of an existing value

function valueUpdate(uint64 id, bytes32 data) external returns (Descriptor memory desc);

Parameters

Returns

valueUpdate

Updates the data hash and symbol of an existing value

function valueUpdate(uint64 id, bytes32 data, string memory symbol) external returns (Descriptor memory desc);

Parameters

Returns

valueUpgrade

Upgrades the kind/set revision of a value

function valueUpgrade(uint64 id, uint32 kindRev0, uint32 setRev0) external returns (Descriptor memory desc);

Parameters

Returns

valueTouch

Touches a value, bumping its revision without changing its content