https://manosbatsis.github.io/corda-lean-state/

Generate Corda Contract and Persistent states from a simplified interface
https://manosbatsis.github.io/corda-lean-state/

corda corda-developers corda-framework cordapp cordapps

Last synced: about 1 month ago
JSON representation

Generate Corda Contract and Persistent states from a simplified interface

• Host: GitHub
• URL: https://manosbatsis.github.io/corda-lean-state/
• Owner: manosbatsis
• License: gpl-3.0
• Created: 2021-08-08T15:04:50.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2021-08-29T20:16:04.000Z (about 3 years ago)
• Last Synced: 2024-07-23T19:55:35.848Z (about 2 months ago)
• Topics: corda, corda-developers, corda-framework, cordapp, cordapps
• Language: Kotlin
• Homepage: https://manosbatsis.github.io/corda-lean-state/
• Size: 1.31 MB
• Stars: 2
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-corda - Corda Lean State - Generate Corda Contract and Persistent states from a simplified interface. (Tools)

README

        
# Corda LeanState [![Maven Central](https://img.shields.io/maven-central/v/com.github.manosbatsis.corda.leanstate/leanstate-contracts.svg)](https://repo1.maven.org/maven2/com/github/manosbatsis/corda/leanstate/)

Shamelessly lazy or simply tired of manually maintaining `ContractState` / `PersistentState` mappings?

LeanState (re)generates perfectly synced and consistent state classes at build-time, 

based on model interfaces like `NewsPaper` bellow as input:

```kotlin

@LeanStateModel

interface NewsPaper {

   val publisher: Party?

   //...

}

```

You can (optionally!) extend Corda's standard interfaces if you really need  

custom overrides VS those added by the processor (e.g.  for `supportedSchemas()`). 

The processor will refrain from generating its own  if you do.  

Such a requirement should be rare as generation is configurable in a few ways, 

see [state model](https://manosbatsis.github.io/corda-lean-state/state-model)  

and [full example](https://manosbatsis.github.io/corda-lean-state/full-example) 

sections for details.

Here's what `NewsPaper` above will generate with default settings (edited for brevity). 

Contract state:

```kotlin

@BelongsToContract(value = NewsPaperContract::class)

data class NewsPaperContractState(

        override val linearId: UniqueIdentifier = UniqueIdentifier(),

        override val publisher: Party? = null,

        //...

) : NewsPaperContract.NewsPaper, ParticipantsState, LinearState, QueryableState {

    override val participants: List = //...

    override fun generateMappedObject(schema: MappedSchema): NewsPaperPersistentState = //...

    override fun supportedSchemas(): Iterable = listOf(SchemaV1)

    object Schema

    object SchemaV1 : MappedSchema(Schema::class.java, 1,

            listOf(NewsPaperPersistentState::class.java))

}

```

Persistent state (edited for brevity):

```kotlin

@Entity @Table(name = "news_paper")

class NewsPaperPersistentState(

  @Column(name = "linear_id_id",nullable = false) val linearIdId: UUID,

  @Column(name = "linear_id_external_id") val linearIdExternalId: String? = null,

  @Column(name = "publisher_name_common_name") val publisherNameCommonName: String? = null,

  @Column(name = "publisher_name_organisation_unit") val publisherNameOrganisationUnit: String? = null,

  @Column(name = "publisher_name_organisation") val publisherNameOrganisation: String?,

  @Column(name = "publisher_name_locality") val publisherNameLocality: String?,

  @Column(name = "publisher_name_state") val publisherNameState: String? = null,

  @Column(name = "publisher_name_country") val publisherNameCountry: String?,

  //...

) : PersistentState()

```