C#
Last updated
Last updated
typeNamespace
vBase.Core
Summary
Content Identifier (CID) is used to uniquely identify objects.
constructorSummary
Creates a new CID from the provided byte array.
Parameters
This constructor has no parameters.
constructorSummary
Creates a new CID from the provided hex string.
Parameters
data
propertySummary
The data of the CID.
propertySummary
Empty CID.
methodSummary
Returns the CID as a hex string.
Returns
Hex string.
Parameters
This method has no parameters.
typeNamespace
vBase.Core.Utilities
Summary
Provides conversion methods.
typeNamespace
vBase.Core.Utilities
Summary
Provides cryptographic utilities.
methodSummary
Get SHA3 256 hash of the input integer.
Returns
SHA3 256 hash object.
Parameters
value
Integer value.
size
Size in bits.
methodSummary
Get SHA3 256 hash of the input string.
Returns
SHA3 256 hash object
Parameters
value
input string
typeNamespace
vBase.Core.Web3CommitmentService
Summary
Provides access to the CommitmentService smart contract over vBase forwarder.
typeNamespace
vBase.Core
Summary
Common interface for commitment services.
propertySummary
Current user identifier.
methodSummary
Records a set commitment. If the set already exists, no action will be taken.
Parameters
setCid
The CID identifying the set.
methodSummary
Adds an object CID to the specified set.
Returns
Receipt of the operation.
Parameters
setCid
CID of the set where the objectCid will be added.
objectCid
Object CID to add.
methodSummary
Checks if the specified object set exists.
Parameters
user
Set owner.
setCid
CID of the set.
methodSummary
Checks whether the object with the specified CID was stamped at the given time.
Returns
True if the commitment has been verified successfully; False otherwise.
Parameters
user
The address for the user who recorded the commitment.
objectCid
The CID identifying the object.
timestamp
The timestamp of the transaction.
methodSummary
Verifies an object commitment previously recorded.
Returns
True if the commitment has been verified successfully; False otherwise.
Parameters
user
The address for the user who recorded the commitment.
setCid
The CID for the set containing the object.
userSetObjectCidSum
The sum of all object hashes for the user set.
typeNamespace
vBase.Core.Dataset
Summary
DTO for dataset JSON serialization. It's important to keep this class in sync with the Python and other SDKs.
typeNamespace
vBase.Core
Summary
Represents a transaction receipt.
constructorSummary
Represents a transaction receipt.
Parameters
This constructor has no parameters.
typeNamespace
vBase.Core.Utilities
Summary
Provides utility methods.
typeNamespace
vBase.Core.Dataset
Summary
propertySummary
A collection of verification findings.
propertySummary
Indicates whether the verification passed.
methodSummary
Adds a finding to the verification result.
Parameters
finding
typeNamespace
vBase.Core.Web3CommitmentService
Summary
Provides access to the CommitmentService smart contract.
methodSummary
Executes Smart Contract function.
Returns
Parameters
function
Function descriptor.
functionData
Data which will be passed as a function arguments.
methodSummary
Calls the specified contract function.
Returns
The result of the contract function execution.
Parameters
functionName
The name of the function to call.
functionInput
The input parameters for the function.
methodSummary
Fetches the specified state variable from the contract.
Returns
Variable value
Parameters
stateVariableName
Name of the variable to fetch
functionInput
Context identifying the set
Generic Types
TResultType
Expected variable type
methodSummary
Fetches state variable from the Smart Contract.
Returns
Variable value
Parameters
functionData
Encoded state variable
Generic Types
TResultType
Expected result type
typeNamespace
vBase.Core.Web3CommitmentService
Summary
WEB3-specific receipt. Additionally to the base timestamp, it contains the transaction hash.
constructorSummary
WEB3-specific receipt. Additionally to the base timestamp, it contains the transaction hash.
Parameters
This constructor has no parameters.
typeNamespace
vBase.Core
Summary
Provides Python validityBase (vBase) access.
propertySummary
Return the default user address used in vBase transactions.
methodSummary
Adds a new named set.
Returns
A task representing the asynchronous operation.
Parameters
name
The name of the set to add.
methodSummary
Adds a new set.
Returns
A task representing the asynchronous operation.
Parameters
setCid
The identifier of the set.
methodSummary
Adds a new object to the set.
Returns
Receipt of the operation.
Parameters
setCid
Set CID.
objectCid
Object to add CID.
methodSummary
Checks if the user has a set with the specified CID.
Returns
Parameters
user
User's identifier.
name
Name of the set.
methodSummary
Verifies if the specified object was stamped at the given time by the given user.
Returns
True if the object was stamped; otherwise, false.
Parameters
user
The object owner.
objectCid
The object identifier.
timestamp
The time when the object was stamped.
methodSummary
Verifies if the sum of all CIDs in the current dataset matches the sum of the dataset stored in the commitment service.
Returns
A boolean indicating whether the sums match.
Parameters
user
The set owner.
setCid
The CID of the set.
userSetObjectsCidSum
The sum of the CIDs of all objects belonging to the set.
typeNamespace
vBase.Core.Dataset
Summary
vBase dataset.
constructorSummary
Creates a new instance of the vBase dataset.
Parameters
vBaseClient
The vBaseClient used for communication with the vBase smart protocol.
name
The name of the dataset.
recordTypeName
The type of records to be stored in the dataset.
Exceptions
Thrown if an unknown record type is provided.
constructorSummary
Creates a new instance of the vBase dataset from JSON.
Parameters
vBaseClient
The vBaseClient used for communication with the vBase smart protocol.
json
The JSON representation of the dataset. JSON created by vBase SDKs for other platforms, such as Python or Java, is also supported.
Exceptions
Thrown when the current CID generation algorithm does not match the one used to generate the provided JSON.
methodSummary
Adds a record to the dataset.
Returns
A transaction receipt.
Parameters
recordData
The record to add. The record type must match the dataset type.
methodSummary
Creates a new dataset on the blockchain if it does not already exist.
Returns
A task representing the asynchronous operation.
Parameters
This method has no parameters.
methodSummary
Serializes the dataset into a vBase-compatible JSON representation.
Returns
A JSON string.
Parameters
This method has no parameters.
methodSummary
Verifies if all records in the dataset were actually created on the Validity Base platform at the specified timestamps.
Returns
Validation result: A collection of errors. For each record that was not found on the Validity Base platform, or was added with a different timestamp, there will be a separate error item in the collection. Additionally, an error item will be added if the dataset on the Validity Base platform contains more records than exist in this client-side dataset.
Parameters
This method has no parameters.
typeNamespace
vBase.Core.Exceptions
Summary
Base exception for all vBase exceptions.
typeNamespace
vBase.Core.Dataset.vBaseObjects
Summary
Base class for all vBase objects. Each implementation should provide a constructor with one object parameter, and parameterless constructor.
propertySummary
The data stored in the object.
propertySummary
String representation of the data.
methodSummary
Returns
CID (Content Identifiers) for the current object
Parameters
This method has no parameters.
methodSummary
Serializes the object to a JSON value.
Returns
Parameters
This method has no parameters.
methodSummary
Initializes the object from a JSON object.
Parameters
jData
Json value.
typeNamespace
vBase.Core.Dataset.vBaseObjects
Summary
vBase Object representing a string data.
constantsSummary
vBase string object name for bidirectional compatibility with vBase Python SDK the V letter is capitalized
Contains a list of verification findings.
Returns the of the object.