Publishing version 2.0.0-rc1

Author: MrMatthewLayton

build.gradle

@@ -5,7 +5,7 @@ buildscript {
 
         corda_artifactory_url = 'https://software.r3.com/artifactory'
         corda_group = 'net.corda'
-        corda_release_version = '4.6'
+        corda_release_version = '4.8'
 
         corda_gradle_plugin_group = 'net.corda.plugins'
         corda_gradle_plugin_version = '5.0.4'

gradle.properties

@@ -1,5 +1,5 @@
 name=onixlabs-corda-bnms
 group=io.onixlabs
-version=2.0.0
+version=2.0.0-rc1
 onixlabs.development.jarsign.keystore=../lib/onixlabs.development.pkcs12
 onixlabs.development.jarsign.password=5891f47942424d2acbe108691fdb5ba258712fca7e4762be4327241ebf3dbfa3

onixlabs-corda-bnms-contract/src/main/kotlin/io/onixlabs/corda/bnms/contract/Extensions.Iterable.kt

@@ -19,56 +19,128 @@ package io.onixlabs.corda.bnms.contract.membership
 import io.onixlabs.corda.identityframework.contract.attestations.AttestationStatus
 import io.onixlabs.corda.identityframework.contract.toStaticAttestationPointer
 import net.corda.core.contracts.StateAndRef
+import net.corda.core.contracts.StateRef
 import net.corda.core.contracts.UniqueIdentifier
 import net.corda.core.identity.AbstractParty
 
+/**
+ * Gets the next [Membership] output, appending the previous [Membership] state's [StateRef].
+ *
+ * @return Returns the next [Membership] output, appending the previous [Membership] state's [StateRef].
+ */
 fun StateAndRef<Membership>.getNextOutput(): Membership {
     return state.data.copy(previousStateRef = ref)
 }
 
+/**
+ * Creates a [MembershipAttestation] for the specified [Membership].
+ *
+ * @param attestor The attestor who is attesting to the [Membership].
+ * @param status The status of the attestation.
+ * @param metadata Any extra metadata that should be applied to the attestation.
+ * @param linearId The linear ID of the attestation.
+ * @return Returns a [MembershipAttestation] for the specified [Membership].
+ */
 fun StateAndRef<Membership>.attest(
     attestor: AbstractParty,
     status: AttestationStatus,
     metadata: Map<String, String> = emptyMap(),
     linearId: UniqueIdentifier = UniqueIdentifier()
 ) = MembershipAttestation(attestor, this, status, metadata, linearId)
 
+/**
+ * Creates an accepted [MembershipAttestation] for the specified [Membership].
+ *
+ * @param attestor The attestor who is attesting to the [Membership].
+ * @param metadata Any extra metadata that should be applied to the attestation.
+ * @param linearId The linear ID of the attestation.
+ * @return Returns an accepted [MembershipAttestation] for the specified [Membership].
+ */
 fun StateAndRef<Membership>.accept(
     attestor: AbstractParty,
     metadata: Map<String, String> = emptyMap(),
     linearId: UniqueIdentifier = UniqueIdentifier()
 ) = attest(attestor, AttestationStatus.ACCEPTED, metadata, linearId)
 
+/**
+ * Creates a rejected [MembershipAttestation] for the specified [Membership].
+ *
+ * @param attestor The attestor who is attesting to the [Membership].
+ * @param metadata Any extra metadata that should be applied to the attestation.
+ * @param linearId The linear ID of the attestation.
+ * @return Returns a rejected [MembershipAttestation] for the specified [Membership].
+ */
 fun StateAndRef<Membership>.reject(
     attestor: AbstractParty,
     metadata: Map<String, String> = emptyMap(),
     linearId: UniqueIdentifier = UniqueIdentifier()
 ) = attest(attestor, AttestationStatus.REJECTED, metadata, linearId)
 
+/**
+ * Amends a [MembershipAttestation] pointing to the existing [Membership] state.
+ *
+ * @param status The amended status of the [MembershipAttestation].
+ * @param metadata Any extra metadata that should be applied to the attestation.
+ * @return Returns an amended [MembershipAttestation] pointing to the existing [Membership] state.
+ */
 fun StateAndRef<MembershipAttestation>.amend(
     status: AttestationStatus,
     metadata: Map<String, String> = this.state.data.metadata
 ) = this.state.data.amend(ref, status, state.data.pointer, metadata)
 
+/**
+ * Amends a [MembershipAttestation] pointing to an evolved [Membership] state.
+ *
+ * @param status The amended status of the [MembershipAttestation].
+ * @param membership The evolved [Membership] state that the amended [MembershipAttestation] will point to.
+ * @param metadata Any extra metadata that should be applied to the attestation.
+ * @return Returns an amended [MembershipAttestation] pointing to an evolved [Membership] state.
+ */
 fun StateAndRef<MembershipAttestation>.amend(
     membership: StateAndRef<Membership>,
     status: AttestationStatus,
     metadata: Map<String, String> = this.state.data.metadata
 ) = this.state.data.amend(ref, status, membership.toStaticAttestationPointer(), metadata)
 
+/**
+ * Amends and accepts a [MembershipAttestation] pointing to the existing [Membership] state.
+ *
+ * @param metadata Any extra metadata that should be applied to the attestation.
+ * @return Returns an amended and accepted [MembershipAttestation] pointing to the existing [Membership] state.
+ */
 fun StateAndRef<MembershipAttestation>.accept(
     metadata: Map<String, String> = this.state.data.metadata
 ) = amend(AttestationStatus.ACCEPTED, metadata)
 
+/**
+ * Amends and accepts a [MembershipAttestation] pointing to an evolved [Membership] state.
+ *
+ * @param membership The evolved [Membership] state that the amended [MembershipAttestation] will point to.
+ * @param metadata Any extra metadata that should be applied to the attestation.
+ * @return Returns an amended and accepted [MembershipAttestation] pointing to an evolved [Membership] state.
+ */
 fun StateAndRef<MembershipAttestation>.accept(
     membership: StateAndRef<Membership>,
     metadata: Map<String, String> = this.state.data.metadata
 ) = amend(membership, AttestationStatus.ACCEPTED, metadata)
 
+/**
+ * Amends and rejects a [MembershipAttestation] pointing to the existing [Membership] state.
+ *
+ * @param metadata Any extra metadata that should be applied to the attestation.
+ * @return Returns an amended and rejected [MembershipAttestation] pointing to the existing [Membership] state.
+ */
 fun StateAndRef<MembershipAttestation>.reject(
     metadata: Map<String, String> = this.state.data.metadata
 ) = amend(AttestationStatus.REJECTED, metadata)
 
+/**
+ * Amends and rejects a [MembershipAttestation] pointing to an evolved [Membership] state.
+ *
+ * @param membership The evolved [Membership] state that the amended [MembershipAttestation] will point to.
+ * @param metadata Any extra metadata that should be applied to the attestation.
+ * @return Returns an amended and rejected [MembershipAttestation] pointing to an evolved [Membership] state.
+ */
 fun StateAndRef<MembershipAttestation>.reject(
     membership: StateAndRef<Membership>,
     metadata: Map<String, String> = this.state.data.metadata