COM API Reference
Last updated
Last updated
typeNamespace
vBase.Infrastructure
Summary
Some dependencies are referenced transitively multiple times with different versions. Only the latest version is available in the application folder. To resolve older versions at runtime and return the latest version, we use the AssemblyResolver class.
typeNamespace
vBase
Summary
Contains the GUIDs for the COM interfaces and classes.
typeNamespace
vBase.Receipts
Summary
Represents a transaction receipt.
propertySummary
The transaction timestamp in Unix time format (seconds).
typeNamespace
vBase
Summary
Represents the result of a verification operation.
propertySummary
A collection of verification findings.
propertySummary
Indicates whether the verification passed.
typeNamespace
vBase.Receipts
Summary
WEB3-specific receipt. Additionally to the base timestamp, it contains the transaction hash.
In COM interfaces can inherit from one another. However, the .NET implementation that exposes the .NET interface to COM does not support inheritance. Therefore, you must replicate any interface members in a base interface to the derived interface. The interop code does not look at base interface types when building the exposed COM interface.
propertySummary
The transaction timestamp in Unix time format (seconds).
propertySummary
The transaction hash.
typeNamespace
vBase
Summary
COM does not support constructors with parameters, so we need to use a factory method to create the objects.
methodSummary
Create a COM visible dataset object.
Returns
Newly created dataset object.
Parameters
client
vBase client.
name
The name of the dataset.
objectType
Type of the objects that will be stored in the dataset.
methodSummary
Create a COM visible dataset object.
Returns
Newly created dataset object.
Parameters
client
vBase client.
json
Json that contains all data records, and dataset properties.
methodSummary
Create a COM visible client for the vBase API.
Returns
Newly created client object.
Parameters
forwarderUrl
Forwarder API url.
apiKey
API key.
privateKey
Private key.
typeNamespace
vBase
Summary
COM visible client interface for the vBase API. It's a shim between the COM client and the vBase.Core client class.
propertySummary
Return the default user address used in vBase transactions.
methodSummary
Creates a commitment for a set with a given name. The set will be added for the account associated with the client object.
Parameters
name
The name of the set.
methodSummary
Records a set commitment.
Parameters
setCid
The HEX encoded CID (hash) identifying the set.
methodSummary
Adds a record to the dataset.
Returns
The transaction timestamp of the record addition in Unix time format (seconds).
Parameters
setCid
HEX encoded CID for the set containing the object.
objectCid
HEX encoded CID of the object to record.
methodSummary
Checks if a named dataset exists.
Returns
True if the set with the given name exists; False otherwise.
Parameters
user
The address for the user who recorded the commitment.
name
The name of the set.
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.
objectCid
The HEX encoded CID of the object.
timestamp
The timestamp of the object's creation, in Unix time format (seconds).
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.
userSetObjectsCidSum
The sum of all object hashes for the user set.
typeNamespace
vBase
Summary
Represents a set of records created on the Validity Base platform.
methodSummary
Adds a record to the dataset.
Parameters
recordData
Record to add.
methodSummary
Serializes the dataset to a JSON string.
Returns
JSON string that can be deserialized using vBase SDK on any other platform.
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
Summary
Types of objects that can be stored in a dataset.
typeNamespace
vBase.Infrastructure
Summary
methodSummary
Returns
The converted receipt.
Parameters
receipt
The receipt to convert.
typeNamespace
vBase.Infrastructure
Summary
When running the shim in the VBA environment, we observed on some machines that the security protocol is explicitly set to Ssl3 or Tls. Such a configuration is incompatible with TLS 1.2, which is the protocol used by the Forwarder server. Experimentally, we found that setting the security protocol to 0 (SystemDefault) does not resolve the issue. Setting explicitly to Tls12 does.
methodSummary
Updates the security protocol to Tls12.
Parameters
This method has no parameters.
typeNamespace
vBase.Infrastructure
Summary
It's important to register the assembly using both versions of regasm—32-bit and 64-bit. Even though the Excel process is 64-bit, it seems that the VBA execution process is 32-bit, so it doesn't recognize the registrations in the 64-bit registry.
typeNamespace
vBase
Summary
Utility methods.
methodSummary
Executes an action and logs any exceptions that occur. Additionally, converts the exception into a VBA-friendly exception.
Parameters
action
Action to execute.
logger
Logger.
methodSummary
Converts a regular .NET exception into a VBA-friendly exception with all relevant information aggregated into the exception message. This improves the user experience in a VBA environment, where the error object does not include the stack trace or the original exception type.
Returns
A VBA-friendly exception with aggregated information.
Parameters
ex
The original exception.
methodSummary
Executes a function and logs any exceptions that occur. Additionally, converts the exception into a VBA-friendly exception.
Returns
Function execution result.
Parameters
func
Function to execute.
logger
Logger.
Generic Types
T
Function return type.
Converts between and COM-compatible .
Converts a to a .