Crate rgb

Source

Re-exports§

pub use pay::TransferParams;
pub use pay::WalletProvider;

Modules§

assignments
containers
RGB containers are data packages which can be transferred between smart contract users. The main type of container is the Consignment, containing information about partial state of a single contract, extending from its genesis up to certain contract endpoints.
contract
indexers
info
invoice
pay
persistence
Module defines API used by providers of persistent data for RGB contracts.
resolvers
schema
seal
stl
validation
vm
API for interfacing different virtual machines

Macros§

rgbasm

Structs§

Allocation
Amount
AssignmentCommitment
AssignmentDetails
AssignmentIndex
AssignmentType
Assignments
BaseCommitment
BundleDisclosure
BundleId
Unique state transition bundle identifier equivalent to the bundle commitment hash
CoinAmount
ContractId
Unique contract identifier equivalent to the contract genesis commitment
DiscloseHash
Hash committing to all data which are disclosed by a contract or some part of it (operation, bundle, consignment, disclosure).
Genesis
GenesisSchema
GlobalCommitment
GlobalDetails
GlobalState
GlobalStateSchema
GlobalStateType
GlobalValues
Identity
An ASCII printable string up to 4096 chars representing identity of the developer.
Inputs
KnownTransition
MetaDetails
MetaType
MetaValue
Metadata
OccurrencesMismatch
OpCommitment
OpDisclose
OpId
Unique operation (genesis & state transition) identifier equivalent to the commitment hash
Opout
RGB contract operation output pointer, defined by the operation ID and output number.
Outpoint
OutputAssignment
OwnedFraction
RevealedData
RevealedValue
State item for a homomorphically-encryptable state.
RgbWallet
Schema
SchemaId
Schema identifier.
SecretSeal
Confidential version of transaction outpoint-based single-use-seal
Signature
TapretKey
TokenIndex
Transition
TransitionBundle
TransitionDetails
TransitionSchema
TransitionType
Txid
TypeSystem
Type system represents a set of strict types assembled from multiple libraries. It is designed to provide all necessary type information to analyze a type with all types it depends onto.
UnrelatedTransition
VoidState
Struct using for storing Void (i.e. absent) state
WalletOutpointsFilter
WalletUnspentFilter
WalletWitnessFilter
WitnessInfo

Enums§

Assign
State data are assigned to a seal definition, which means that they are owned by a person controlling spending of the seal UTXO, unless the seal is closed, indicating that a transfer of ownership had taken place
AssignmentsRef
ChainNet
CompletionError
CompositionError
FungibleState
An atom of an additive state, which thus can be monomorphically encrypted.
FungibleType
Layer1
MergeRevealError
MetadataError
Occurrences
OpFullType
Aggregated type used to supply full contract operation type and transition type information
OpoutParseError
OwnedStateSchema
PayError
Precision
RevealedState
Categories of the state
RgbDescr
RgbKeychain
SealClosingStrategy
StateType
Categories of the state
TypeCommitment
TypedAssigns
WalletError

Constants§

LIB_NAME_RGB_CONTRACT
LIB_NAME_RGB_OPS
LIB_NAME_RGB_STORAGE
RGB_NATIVE_DERIVATION_INDEX
BIP32 derivation index for outputs which may contain assigned RGB state.
RGB_TAPRET_DERIVATION_INDEX
BIP32 derivation index for outputs which are tweaked with Tapret commitment and may also optionally contain assigned RGB state.

Traits§

DescriptorRgb
ExposedSeal
ExposedState
Marker trait for types of state holding explicit state data.
KnownState
Trait used by contract state. Unlike [ExposedState] it doesn’t allow concealment of the state, i.e. may contain incomplete data without blinding factors, asset tags etc.
MergeReveal
A trait to merge two structures modifying the revealed status of the first one. The merge operation will consume both the structures and return a new structure with revealed states.
OpSchema
Trait defining common API for all operation type schemata
Operation
RGB contract operation API, defined as trait
TxoSeal
Methods common for all transaction-output based seal types.

Type Aliases§

AssignData
AssignFungible
AssignRights
AssignmentsSchema
GenesisSeal
GlobalSchema
GraphSeal
MetaSchema
OutputSeal
Vin