aprismatic / weave-commons

Basic models and dataset storage plugin interface for WEAVE.

Weave-Commons

The Weave.Commons project contains basic models for WEAVE, as well as the plugin interface to process and store datasets in the authority node.

NuGet Feed: https://ci.appveyor.com/nuget/aprismatic-weave-commons

IDatasetStore

The IDatasetStore interface defines the following methods:

• LoadConfig(IConfiguration configuration) This method receives all configuration parameters, and is called on WEAVE authority node startup.

• DatasetReady(Dataset dataset) This method receives a submitted dataset for storage, and is called whenever a dataset is ready (tokenized and joined).

• UpdateDatasets(byte[] updateKey, byte[] publicKey) This method gets an update key and public key, to update all datasets in your own data store. It is called whenever datasets needs to be updated due to key changes. The updateKey and publicKey parameters are BigInteger values represented by an byte array. To get the new token, the equation is represented by: newToken = (oldToken^updateKey) mod publicKey.

Usage Example

public class CustomDatasetPlugin : IDatasetStore
{
    public bool LoadConfig(IConfiguration configuration)
    {
        var customConfig = configuration["CUSTOM_CONFIG"];
		return true;
    }

    public bool DatasetReady(Dataset dataset)
    {
        Console.WriteLine($"Dataset received: {dataset.DatasetName}");
		return true;
    }

    public bool UpdateDatasets(byte[] updateKey, byte[] publicKey)
    {
        var newToken = BigInteger.ModPow(new BigInteger(oldValue), new BigInteger(updateKey), new BigInteger(publicKey));
		return true;
    }
}