Skip to content

manosbatsis/vaultaire

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Vaultaire Maven Central Build Status

Query DSL and data access utilities for Corda developers.

See complete documentation at https://manosbatsis.github.io/vaultaire

Query DSL

Use DSL will make your queries much easier to read and maintain. Each query DSL is automatically (re)generated at build time using annotation processing.

Usage example:

val queryCriteria: QueryCriteria = booksQuery {
    and {
    	// Check publisher?
        if(checkPublisher) fields.publisher `==` "Corda Books Ltd."
        or {
            fields.title  `==` "A book on Corda"
            fields.author `!=` "John Doe"
        }
    }
    orderBy {
        fields.title sort DESC
    }
}.toCriteria()

For more details see Query DSL.

State Services

Vaultaire's StateService components provide a simple, consistent API to load, query and track vault states.

StateService implementations are usually auto-generated at build-time and specific to a ContractState type. They also help decouple your code from ServiceHub and CordaRPCOps amd help increase code reuse in and out of a Node, i.e. between cordapps and their clients.

For more details see State Services.

RSQL Plugin

A plugin with support for RSQL, a URL-friendly query language for dynamic, complex queries and maintenance-free REST endpoints for searching the Vault.

For more details see RSQL Support.

Accounts Plugin

A plugin for adding Corda Accounts support to Vaultaire's runtime and build-time modules.

For more details see Corda Accounts.

State DTOs

Maintaining Data Transfer Objects for your contract states can be a mundane, error-prone task. Vaultaire’s annotation processing automates this by (re)generating those DTOs for you.

For more info checkout State DTOs

Other Utils

Vaultaire includes a few other utilities like:

  • REST-friendly pages for query results.
  • Annotation to generate responder flows from commonly used supertypes.

For more info checkout Other Utilities

Sample Projects

  1. For simple examples, checkout the vaultaire-example-contract and vaultaire-example-workflow modules in Vaultaire's repository on Github.
  2. For an extensive Cordapp example including a Spring Boot client checkout the corbeans-yo-cordapp repository.