You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+5-34
Original file line number
Diff line number
Diff line change
@@ -6,17 +6,17 @@ The ONIXLabs Corda BNMS (Business Network Management System) is a framework desi
6
6
7
7
## Prerequisites
8
8
9
-
The ONIXLabs Corda BNMS utilizes the ONIXLabs Corda Claims API as an underlying mechanism for creating, distributing and attesting to identity credentials used to define membership. In order to fully understand how identity is managed within the ONIXLabs Corda BNMS, please see the readme for the ONIXLabs Corda Claims API.
9
+
The ONIXLabs Corda BNMS utilizes the [ONIXLabs Corda Identity Framework](https://github.com/onix-labs/onixlabs-corda-identity-framework) as an underlying mechanism for creating, distributing and attesting to identity credentials used to define membership, as well as extending the claim and attestation models to create roles, permissions, settings, and membership and relationship attestations.
10
10
11
11
## Design Goals
12
12
13
13
### Business Network Interoperability
14
14
15
-
Corda nodes may require participation in multiple business networks, each with their own standards governing identity and configuration. Without standard APIs for construction of business networks, there is a high likeliness that different business network implementations will be incompatible.
15
+
Corda nodes may require participation in multiple business networks, each with their own standards governing identity and configuration. Without standard APIs for constructiing business networks, there is a high likeliness that different business network implementations will be incompatible.
16
16
17
17
The ONIXLabs Corda BNMS solves this problem by providing protocol level, configurable standards for membership and multi-lateral relationship management implementations, allowing business networks to scale independently whilst remaining interoperable with one another.
18
18
19
-
The ONIXLabs Corda BNMS is built on top of the ONIXLabs Corda Claims API which not only improves business network interoperability, but also Corda application interoperability. Claims can be shared between applications and distributed across the network, helping to reduce data duplication and inconsistency.
19
+
The ONIXLabs Corda BNMS is built on top of the ONIXLabs Corda Identity Framework which not only improves business network interoperability, but also Corda application interoperability. Claims can be shared between applications and distributed across the network, helping to reduce data duplication and inconsistency.
20
20
21
21
The ONIXLabs Corda BNMS has been designed from the ground up to support centralised business networks that are governed by a business network operator and decentralised business networks that are governed autonomously by the network members themselves.
22
22
@@ -34,7 +34,7 @@ This constitutes a partial trust model, with respect to the network as a whole s
34
34
35
35
### Data Privacy
36
36
37
-
Data privacy surrounding member identity is handled by the underlying ONIXLabs Corda Claims API. Membership in either centralised or decetralised networks will require either the business network operator or other members of the network to obtain and/or verify identity information. Claims can be issued, distributed and attested independly to membership states, thus allowing verified membership states to be distributed whilst keeping identity information private.
37
+
Data privacy surrounding member identity is handled by the underlying ONIXLabs Corda Identity Framework. Membership in either centralised or decetralised networks will require either the business network operator or other members of the network to obtain and/or verify identity information. Claims can be issued, distributed and attested independly to membership states, thus allowing verified membership states to be distributed whilst keeping identity information private.
38
38
39
39
### Dynamic Smart Contract Execution
40
40
@@ -44,7 +44,7 @@ The ONIXLabs Corda BNMS facilitates the ability to perform dynamic smart contrac
44
44
45
45
## Membership Management
46
46
47
-
Membership is defined as a reference to a business network, complete with configurable identity (using the ONIXLabs Corda Claims API) as well as rolesand grants which provide levels of access and authorisation for utilitsation within the business network. A Corda node may define many relationship states; one per business network. These can be managed by the member or optionally by a network operator.
47
+
Membership is defined as a reference to a business network, complete with configurable identity as well as roles, permissions and settings which provide levels of access and authorisation for utilitsation within the business network. A Corda node may define many relationship states; one per business network. These can be managed by the member or optionally by a network operator.
48
48
49
49
### Membership Issuance
50
50
@@ -58,10 +58,6 @@ Membership amendment can be performed by the member themselves, or optionally by
58
58
59
59
Membership revocation can be performed by the member themselves, or optionally by the network operator. This represents the exit of a member from a business network. All participants are required to sign a membership revocation transaction.
60
60
61
-
### Membership Discovery
62
-
63
-
INSERT TEXT HERE
64
-
65
61
## Relationship Management
66
62
67
63
A relationship is defined as reference to a business network, complete with a multi-lateral agreement defining configurable governance about how individual members of the relationship interact with one another. A Corda node may define many relationship states. These can be managed by the members of the relationship or by the network operator.
@@ -109,28 +105,3 @@ Membership attestation amendment can only be performed by the attestor. This rep
109
105
### Membership Attestation Revocation
110
106
111
107
Membership attestation revocation can only be performed by the attestor. This represents complete revocation of an attestation to a membership state, which can be used when a membership state is revoked. Only the attestor is required to sign a membership attestation issuance transaction.
112
-
113
-
114
-
# Local setup
115
-
116
-
## How to publish to local maven repo
117
-
- With tests
118
-
-`./gradlew releaseLocal`
119
-
- Without tests
120
-
-`./gradlew clean build -x test publishToMavenLocal`
121
-
122
-
## How to delete local maven repo
123
-
-`rm -rf ~/.m2/repository/io/onixlabs`
124
-
125
-
## How to setup to publish to maven repo
126
-
-[Create a GitHub Personal Access Token](https://docs.github.com/en/github/authenticating-to-github/creating-a-personal-access-token)
127
-
- Ensure it has the [correct permissions](https://docs.github.com/en/packages/publishing-and-managing-packages/about-github-packages#about-scopes-and-permissions-for-github-container-registry)
128
-
- Add the following to your `~/.gradle/gradle.properties` file, replacing `GITHUB_USERNAME` and `GITHUB_ACCESS_KEY`
129
-
> Note this file is in your home directory - not the root of the repo
130
-
```
131
-
gpr.user=GITHUB_USERNAME
132
-
gpr.key=GITHUB_ACCESS_KEY
133
-
```
134
-
## Publish a new version
135
-
- Update the version name in the root `build.gradle` file
Copy file name to clipboardExpand all lines: onixlabs-corda-bnms-contract/src/main/kotlin/io/onixlabs/corda/bnms/contract/membership/MembershipAttestation.kt
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
-
/**
2
-
* Copyright 2020 Matthew Layton
1
+
/*
2
+
* Copyright 2020-2021 ONIXLabs
3
3
*
4
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
5
* you may not use this file except in compliance with the License.
6
6
* You may obtain a copy of the License at
7
7
*
8
-
* http://www.apache.org/licenses/LICENSE-2.0
8
+
* http://www.apache.org/licenses/LICENSE-2.0
9
9
*
10
10
* Unless required by applicable law or agreed to in writing, software
11
11
* distributed under the License is distributed on an "AS IS" BASIS,
Copy file name to clipboardExpand all lines: onixlabs-corda-bnms-contract/src/main/kotlin/io/onixlabs/corda/bnms/contract/membership/MembershipAttestationContract.kt
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
-
/**
2
-
* Copyright 2020 Matthew Layton
1
+
/*
2
+
* Copyright 2020-2021 ONIXLabs
3
3
*
4
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
5
* you may not use this file except in compliance with the License.
6
6
* You may obtain a copy of the License at
7
7
*
8
-
* http://www.apache.org/licenses/LICENSE-2.0
8
+
* http://www.apache.org/licenses/LICENSE-2.0
9
9
*
10
10
* Unless required by applicable law or agreed to in writing, software
11
11
* distributed under the License is distributed on an "AS IS" BASIS,
Copy file name to clipboardExpand all lines: onixlabs-corda-bnms-contract/src/main/kotlin/io/onixlabs/corda/bnms/contract/membership/MembershipAttestationSchema.kt
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
-
/**
2
-
* Copyright 2020 Matthew Layton
1
+
/*
2
+
* Copyright 2020-2021 ONIXLabs
3
3
*
4
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
5
* you may not use this file except in compliance with the License.
6
6
* You may obtain a copy of the License at
7
7
*
8
-
* http://www.apache.org/licenses/LICENSE-2.0
8
+
* http://www.apache.org/licenses/LICENSE-2.0
9
9
*
10
10
* Unless required by applicable law or agreed to in writing, software
11
11
* distributed under the License is distributed on an "AS IS" BASIS,
Copy file name to clipboardExpand all lines: onixlabs-corda-bnms-contract/src/main/kotlin/io/onixlabs/corda/bnms/contract/membership/MembershipContract.kt
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
-
/**
2
-
* Copyright 2020 Matthew Layton
1
+
/*
2
+
* Copyright 2020-2021 ONIXLabs
3
3
*
4
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
5
* you may not use this file except in compliance with the License.
6
6
* You may obtain a copy of the License at
7
7
*
8
-
* http://www.apache.org/licenses/LICENSE-2.0
8
+
* http://www.apache.org/licenses/LICENSE-2.0
9
9
*
10
10
* Unless required by applicable law or agreed to in writing, software
11
11
* distributed under the License is distributed on an "AS IS" BASIS,
Copy file name to clipboardExpand all lines: onixlabs-corda-bnms-contract/src/main/kotlin/io/onixlabs/corda/bnms/contract/membership/MembershipSchema.kt
+3-3
Original file line number
Diff line number
Diff line change
@@ -1,11 +1,11 @@
1
-
/**
2
-
* Copyright 2020 Matthew Layton
1
+
/*
2
+
* Copyright 2020-2021 ONIXLabs
3
3
*
4
4
* Licensed under the Apache License, Version 2.0 (the "License");
5
5
* you may not use this file except in compliance with the License.
6
6
* You may obtain a copy of the License at
7
7
*
8
-
* http://www.apache.org/licenses/LICENSE-2.0
8
+
* http://www.apache.org/licenses/LICENSE-2.0
9
9
*
10
10
* Unless required by applicable law or agreed to in writing, software
11
11
* distributed under the License is distributed on an "AS IS" BASIS,
0 commit comments