Module types

Source
Expand description

NextGraph Repo types

Corresponds to the BARE schema

Structs§

AddBranchV0
Add a branch to the repository
AddFileV0
Add a new binary file in a branch
AddLinkV0
Adds a link into the user branch, so that a user can share with all its device a new Link they received.
AddMemberV0
Add member to a repo
AddNameV0
Add a new name in the repo that can point to a branch or a commit
AddPermissionV0
Add permission to a member in a repo
AddRepoV0
Adds a repo into the store branch.
AddSignerCapV0
Adds a SignerCap into the user branch,
BlockContentV0
unencrypted part of the Block
BlockRef
Block reference
BlockV0
Immutable block with encrypted content
BloomFilterV0
Bloom filter (variable size)
BranchCapRefreshV0
BranchCapRefresh renew the capabilities of one specific transactional branch
BranchCapRefreshedV0
BranchCapRefreshed is a singleton in a new topic. it has no ACKS nor DEPS.
BranchV0
Branch definition
CertificateContentV0
A Certificate content, that will be signed by the previous certificate signers.
CertificateV0
A Certificate object (not a commit) containing all the information needed to verify a signature.
CommitContentV0
Content of a Commit
CommitHeaderKeysV0
Keys for the corresponding IDs contained in the Header
CommitHeaderRef
CommitHeaderV0
Header of a Commit, can be embedded or as a ref
CommitV0
Commit object
CompactV0
Compact: Hard Snapshot of a Branch
EventContentV0
Content of EventV0
EventV0
Pub/sub event published in a topic
QuorumV0
Quorum definition V0
RandomAccessFileMetaV0
Random Access File Object
ReducedSiteV0
Reduced Site (for QRcode)
RefreshCapV0
RefreshSecretV0
the second tuple member is only set when a write_cap refresh is performed, and for users that are Editor (any Member that also has at least one permission, plus all the Owners)
RemoveLinkV0
Removes a link from the user branch.
RemoveMemberV0
Remove member from a repo
RemoveNameV0
Remove a name from the repo, using ORset CRDT logic
RemovePermissionV0
Remove permission from a user in a repo
RemoveRepoV0
Removes a repo from the store branch.
RemoveSignerCapV0
Removes a SignerCap from the user branch.
RepositoryV0
Repository definition
RootBranchV0
Root Branch definition V0
RootCapRefreshV0
RootCapRefresh. renew the capabilities of the root branch, or all transactional branches and the root_branch.
SignatureContentV0
A Threshold Signature content
SignatureV0
A Threshold Signature object (not a commit) containing all the information that the signers have prepared.
SignerCap
when a signing capability is removed, a new SignerCap should be committed to User branch, with the removed key set to None
SiteStore
Site Store
SmallFileV0
File Object
SnapshotV0
Snapshot of a Branch
StoreUpdateV0
Updates the ReadCap of the public, protected sites, Group and Dialog stores of the User
WalletUpdateV0
Adds a wallet operation so all the devices can sync their locally saved wallet on disk (at the next wallet opening)

Enums§

AddBranch
Add a branch to the repository
AddFile
AddLink
AddMember
AddName
AddPermission
AddRepo
AddSignerCap
AsyncSignature
Async Threshold Signature of a commit based on the partial order quorum
Block
Immutable block with encrypted content
BlockContent
Immutable object with encrypted content
BloomFilter
Branch
Branch definition
BranchCapRefresh
BranchCapRefresh
BranchCapRefreshed
BranchCapRefreshed
BranchCrdt
BranchType
Certificate
A certificate object
CertificateSignatureV0
A Signature of a Certificate, with an indication of which the threshold keyset or private key used to generate it
ChunkContentV0
encrypted_content of BlockContentV0: a Merkle tree node
Commit
Commit Object
CommitBody
Commit body
CommitBodyV0
Commit body V0
CommitContent
Content of a Commit
CommitHeader
CommitHeaderKeys
CommitHeaderObject
CommitType
Compact
Snapshot of a Branch
Digest
Hash digest
Event
Pub/sub event published in a topic
ObjectContent
Immutable data stored encrypted in a Merkle tree
ObjectContentV0
Immutable data stored encrypted in a Merkle tree V0
OrdersPublicKeySetsV0
Enum for “orders” PKsets.
OverlayId
Overlay ID
PeerId
Peer ID: public key of the node, or an encrypted version of it
PermissionV0
Permissions
PrivKey
Private key
PubKey
Public key
Quorum
Quorum definition, is part of the RootBranch commit
QuorumType
RandomAccessFileMeta
A Random Access file stored in an Object
RefreshCap
RefreshCap
RelTime
Relative time (e.g. delay from current time)
RemoveBranch
Remove a branch from the repository
RemoveFile
RemoveLink
RemoveMember
RemoveName
RemovePermission
RemoveRepo
RemoveSignerCap
RepoNamedItem
RepoNamedItemV0
Repository
Repository definition
RootBranch
RootBranch definition
RootCapRefresh
Sig
Cryptographic signature
Signature
A Signature object (it is not a commit), referenced in AsyncSignature or SyncSignature
SignatureContent
A Signature content
SiteName
Site Name
SiteStoreType
Site Store type
SiteType
Site type
SmallFile
A file stored in an Object
Snapshot
Snapshot of a Branch
StoreOverlay
StoreOverlayV0
List of Store Overlay types
StoreRepo
StoreRepoV0
List of Store Root Repo types
StoreUpdate
SymKey
Symmetric cryptographic key
SyncSignature
Sync Threshold Signature of one or a chain of commits . V0
ThresholdSignatureV0
A Threshold Signature and the set used to generate it
Transaction
WalletUpdate

Constants§

EPOCH_AS_UNIX_TIMESTAMP

Traits§

IObject

Type Aliases§

Blake3Digest32
32-byte Blake3 hash digest
BlockId
Block ID: BLAKE3 hash over the serialized BlockContent (contains encrypted content)
BlockKey
BranchId
BranchId is a PubKey
BranchWriteCapSecret
Write capability secret (for a branch’s topic)
ChaCha20Key
ChaCha20 symmetric key
DirectPeerId
Ed25519PrivKey
Curve25519 private key Edwards form
Ed25519PubKey
Curve25519 public key Edwards form
Ed25519Sig
Ed25519 signature
ForwardedPeerId
InnerOverlayId
InternalNode
Internal node of a Merkle tree
ObjectId
Object ID
ObjectKey
Object Key
ObjectRef
Object reference
OuterOverlayId
ReadCap
Read capability (for a commit, branch, whole repo, or store)
ReadCapSecret
Read capability secret (for a commit, branch, whole repo, or store)
RemoveBranchV0
RemoveFileV0
Remove a file from the branch, using ORset CRDT logic
RepoHash
RepoHash is the BLAKE3 Digest over the RepoId
RepoId
RepoId is a PubKey
RepoWriteCapSecret
Write capability secret (for a whole repo)
Timestamp
Timestamp: absolute time in minutes since 2022-02-22 22:22 UTC
TopicId
Topic ID: public key of the topic
TransactionV0
Transaction with CRDT operations
UserId
User ID: user account for broker and member of a repo
X25519PrivKey
Curve25519 private key Montgomery form
X25519PubKey
Curve25519 public key Montgomery form